snapshot of https://github.com/ueberdosis/hocuspocus.git @ cf3cfa355b4d3bb61c6b6c80071f71783e32470e (2026-09-15)

tests/extension-redis/onStoreDocument.ts

@@ -0,0 +1,155 @@
+import test from 'ava'
+import type { onStoreDocumentPayload } from '@hocuspocus/server'
+import { Redis } from '@hocuspocus/extension-redis'
+import type { HocuspocusProvider } from '@hocuspocus/provider'
+import { uuidv4 } from 'lib0/random'
+import { newHocuspocus, newHocuspocusProvider, redisConnectionSettings } from '../utils/index.ts'
+
+test('stores documents without conflicts', async t => {
+  await new Promise(async resolve => {
+    // eslint-disable-next-line prefer-const
+    let anotherProvider: HocuspocusProvider
+
+    class CustomStorageExtension {
+      async onStoreDocument({ document }: onStoreDocumentPayload) {
+        t.is(document.getArray('foo').get(0), 'bar')
+        t.is(document.getArray('foo').get(0), anotherProvider.document.getArray('foo').get(0))
+
+        resolve('done')
+      }
+    }
+
+    const server = await newHocuspocus(t, {
+      name: 'redis-1',
+      extensions: [
+        new Redis({
+          ...redisConnectionSettings,
+          identifier: `server${uuidv4()}`,
+          prefix: 'extension-redis/onStoreDocument1',
+        }),
+        new CustomStorageExtension(),
+      ],
+    })
+
+    const anotherServer = await newHocuspocus(t, {
+      name: 'redis-2',
+      extensions: [
+        new Redis({
+          ...redisConnectionSettings,
+          identifier: `anotherServer${uuidv4()}`,
+          prefix: 'extension-redis/onStoreDocument1',
+        }),
+        new CustomStorageExtension(),
+      ],
+    })
+
+    newHocuspocusProvider(t, server)
+
+    anotherProvider = newHocuspocusProvider(t, anotherServer, {
+      onSynced() {
+        // once we're setup make an edit on anotherProvider, if all succeeds the onStoreDocument
+        // callback will be called after the debounce period and all docs will
+        // be identical
+        anotherProvider.document.getArray('foo').insert(0, ['bar'])
+        anotherProvider.disconnect()
+      },
+    })
+  })
+})
+
+test('stores documents when the last client disconnects', async t => {
+  await new Promise(async resolve => {
+    // eslint-disable-next-line prefer-const
+    let provider: HocuspocusProvider
+
+    const server = await newHocuspocus(t, {
+      extensions: [
+        new Redis({
+          prefix: 'extension-redis/onStoreDocument2',
+          ...redisConnectionSettings,
+        }),
+      ],
+      onStoreDocument: async ({ document }) => {
+        t.is(
+          provider.document.getArray('foo').get(0),
+          document.getArray('foo').get(0),
+        )
+
+        resolve('done')
+      },
+    })
+
+    provider = newHocuspocusProvider(t, server, {
+      onSynced() {
+        provider.document.getArray('foo').insert(0, ['bar'])
+        provider.disconnect()
+      },
+    })
+  })
+})
+
+test('document gets unloaded on both servers after disconnection', async t => {
+  await new Promise(async resolve => {
+    class CustomStorageExtension {
+      priority = 10
+
+      onStoreDocument({ document }: onStoreDocumentPayload) {
+        console.log('storing')
+        return new Promise(resolve2 => {
+          setTimeout(() => {
+            console.log('stored')
+
+            resolve2('')
+          }, 3000)
+        })
+      }
+    }
+
+    const server = await newHocuspocus(t, {
+      name: 'redis-1',
+      extensions: [
+        new Redis({
+          ...redisConnectionSettings,
+          prefix: 'extension-redis/onStoreDocument3',
+        }),
+        new CustomStorageExtension(),
+      ],
+    })
+
+    const anotherServer = await newHocuspocus(t, {
+      name: 'redis-2',
+      extensions: [
+        new Redis({
+          ...redisConnectionSettings,
+          prefix: 'extension-redis/onStoreDocument3',
+        }),
+        new CustomStorageExtension(),
+      ],
+    })
+
+    const provider = newHocuspocusProvider(t, server)
+
+    const anotherProvider = newHocuspocusProvider(t, anotherServer, {
+      onSynced() {
+        // once we're setup make an edit on anotherProvider, if all succeeds the onStoreDocument
+        // callback will be called after the debounce period and all docs will
+        // be identical
+        anotherProvider.document.getArray('foo').insert(0, ['bar'])
+        provider.document.getArray('foo2').insert(0, ['bar'])
+
+        setTimeout(() => {
+          provider.configuration.websocketProvider.disconnect()
+          anotherProvider.configuration.websocketProvider.disconnect()
+
+          setTimeout(() => {
+            t.is(anotherServer.documents.size, 0)
+            t.is(server.documents.size, 0)
+
+            resolve('')
+          }, 10000) // must be higher than CustomStorageExtension delay (3s) + RedisExtension.disconnectDelay (1s)
+        }, 1500)
+
+      },
+    })
+  })
+})