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

tests/provider/onSynced.ts

@@ -0,0 +1,109 @@
+import test from 'ava'
+import { newHocuspocus, newHocuspocusProvider, sleep } from '../utils/index.ts'
+
+test('onSynced callback is executed', async t => {
+  await new Promise(async resolve => {
+    const server = await newHocuspocus(t)
+
+    newHocuspocusProvider(t, server, {
+      onSynced() {
+        t.pass()
+        resolve('done')
+      },
+    })
+  })
+})
+
+test("on('synced') callback is executed", async t => {
+  await new Promise(async resolve => {
+    const server = await newHocuspocus(t)
+
+    const provider = newHocuspocusProvider(t, server)
+
+    provider.on('synced', () => {
+      t.pass()
+      resolve('done')
+    })
+  })
+})
+
+test('onSynced callback is executed, even when the onConnect takes longer', async t => {
+  await new Promise(async resolve => {
+    const server = await newHocuspocus(t, {
+      async onConnect(data) {
+        await sleep(100)
+      },
+    })
+
+    newHocuspocusProvider(t, server, {
+      onSynced() {
+        t.pass()
+        resolve('done')
+      },
+    })
+  })
+})
+
+test('onSynced callback is executed when the document is actually synced', async t => {
+  await new Promise(async resolve => {
+    const server = await newHocuspocus(t, {
+      async onLoadDocument({ document }) {
+        document.getArray('foo').insert(0, ['bar'])
+
+        return document
+      },
+    })
+
+    const provider = newHocuspocusProvider(t, server, {
+      onSynced() {
+        const value = provider.document.getArray('foo').get(0)
+        t.is(value, 'bar')
+
+        resolve('done')
+      },
+    })
+  })
+})
+
+test('send all messages according to the protocol', async t => {
+  await new Promise(async resolve => {
+    const server = await newHocuspocus(t, {
+      async onLoadDocument({ document }) {
+        document.getArray('foo').insert(0, ['bar'])
+
+        return document
+      },
+    })
+
+    const provider = newHocuspocusProvider(t, server, {
+      async onSynced() {
+        t.deepEqual(provider.document.getArray('foo').get(0), 'bar')
+
+        resolve('done')
+      },
+    })
+  })
+})
+
+test('onSynced callback is executed when the document is actually synced, even if it takes longer', async t => {
+  await new Promise(async resolve => {
+    const server = await newHocuspocus(t, {
+      async onLoadDocument({ document }) {
+        await sleep(100)
+
+        document.getArray('foo').insert(0, ['bar'])
+
+        return document
+      },
+    })
+
+    const provider = newHocuspocusProvider(t, server, {
+      onSynced() {
+        const value = provider.document.getArray('foo').get(0)
+        t.is(value, 'bar')
+
+        resolve('done')
+      },
+    })
+  })
+})