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

tests/provider/onAwarenessUpdate.ts

@@ -0,0 +1,131 @@
+import test from 'ava'
+import { AwarenessError } from '@hocuspocus/provider'
+import { newHocuspocus, newHocuspocusProvider, sleep } from '../utils/index.ts'
+
+test('onAwarenessUpdate callback is executed', async t => {
+  await new Promise(async resolve => {
+    let resolved = false
+    const server = await newHocuspocus(t, { })
+
+    const provider = newHocuspocusProvider(t, server, {
+      onConnect() {
+        provider.setAwarenessField('foo', 'bar')
+      },
+      onAwarenessUpdate: ({ states }) => {
+        if (resolved) return
+        resolved = true
+
+        t.is(states.length, 1)
+        t.is(states[0].foo, 'bar')
+
+        resolve('done')
+      },
+    })
+  })
+})
+
+test('shares awareness state with other users', async t => {
+  await new Promise(async resolve => {
+    let resolved = false
+    const server = await newHocuspocus(t, { })
+
+    const provider = newHocuspocusProvider(t, server, {
+      onConnect() {
+        provider.setAwarenessField('name', 'player1')
+      },
+      onAwarenessUpdate: ({ states }) => {
+        if (resolved) return
+        const player2 = !!states.filter(state => state.name === 'player2').length
+
+        if (player2) {
+          resolved = true
+          t.is(player2, true)
+          resolve('done')
+        }
+      },
+    })
+
+    const anotherProvider = newHocuspocusProvider(t, server, {
+      onConnect() {
+        anotherProvider.setAwarenessField('name', 'player2')
+      },
+      onAwarenessUpdate: ({ states }) => {
+        if (resolved) return
+        const player1 = !!states.filter(state => state.name === 'player1').length
+
+        if (player1) {
+          t.is(player1, true)
+        }
+      },
+    })
+  })
+})
+
+test('does not share awareness state with users in other documents', async t => {
+  await new Promise(async resolve => {
+    const server = await newHocuspocus(t, { })
+
+    newHocuspocusProvider(t, server, {
+      async onConnect() {
+        await sleep(100)
+
+        t.pass()
+        resolve('done')
+      },
+      onAwarenessUpdate: ({ states }) => {
+        const player2 = !!states.filter(state => state.name === 'player2').length
+
+        if (player2) {
+          throw new Error('Awareness state leaked!')
+        }
+      },
+    })
+
+    const anotherProvider = newHocuspocusProvider(t, server, {
+      name: 'hocuspocus-completely-different-and-unrelated-document',
+      onConnect() {
+        anotherProvider.setAwarenessField('name', 'player2')
+      },
+    })
+  })
+})
+
+test('allows awareness to be null', async t => {
+  await new Promise(async resolve => {
+    const server = await newHocuspocus(t, { })
+
+    newHocuspocusProvider(t, server, {
+      awareness: null,
+      async onConnect() {
+        await sleep(100)
+
+        t.pass()
+        resolve('done')
+      },
+    })
+  })
+})
+
+test('throws an error in setAwarenessFields if awareness is null', async t => {
+  await new Promise(async resolve => {
+    const server = await newHocuspocus(t)
+
+    const provider = newHocuspocusProvider(t, server, {
+      awareness: null,
+      onConnect() {
+        try {
+          provider.setAwarenessField('foo', 'bar')
+          t.fail()
+        } catch (err: any) {
+          if (err instanceof AwarenessError) {
+            t.pass()
+          } else {
+            t.fail()
+          }
+        } finally {
+          resolve('done')
+        }
+      },
+    })
+  })
+})