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

tests/server/onAwarenessUpdate.ts

@@ -0,0 +1,85 @@
+import test from 'ava'
+import type { onAwarenessUpdatePayload } from '@hocuspocus/server'
+import { newHocuspocus, newHocuspocusProvider } from '../utils/index.ts'
+
+test('executes the onAwarenessUpdate callback', async t => {
+  await new Promise(async resolve => {
+    let resolved = false
+
+    const server = await newHocuspocus(t, {
+      async onAwarenessUpdate({ states }) {
+        if (resolved) return
+        resolved = true
+
+        t.is(states.length, 1)
+        t.is(states[0].foo, 'bar')
+
+        resolve('done')
+      },
+    })
+
+    const provider = newHocuspocusProvider(t, server, {
+      onConnect() {
+        provider.setAwarenessField('foo', 'bar')
+      },
+    })
+  })
+})
+
+test('executes the onAwarenessUpdate callback from a custom extension', async t => {
+  await new Promise(async resolve => {
+    let resolved = false
+
+    class CustomExtension {
+      async onAwarenessUpdate({ states }: onAwarenessUpdatePayload) {
+        if (resolved) return
+        resolved = true
+
+        t.is(states.length, 1)
+        t.is(states[0].foo, 'bar')
+
+        resolve('done')
+      }
+    }
+
+    const server = await newHocuspocus(t, {
+      extensions: [
+        new CustomExtension(),
+      ],
+    })
+
+    const provider = newHocuspocusProvider(t, server, {
+      onConnect() {
+        provider.setAwarenessField('foo', 'bar')
+      },
+    })
+  })
+})
+
+test('forwards the originating connection on onAwarenessUpdate', async t => {
+  await new Promise(async resolve => {
+    let resolved = false
+
+    const server = await newHocuspocus(t, {
+      async onAuthenticate() {
+        return { user: { id: 'u-1', displayName: 'Test User' } }
+      },
+      async onAwarenessUpdate({ connection, states }) {
+        if (resolved || states.length === 0) return
+        resolved = true
+
+        t.truthy(connection, 'connection should be defined for client-originated awareness updates')
+        t.is((connection?.context as { user: { id: string } } | undefined)?.user?.id, 'u-1')
+
+        resolve('done')
+      },
+    })
+
+    const provider = newHocuspocusProvider(t, server, {
+      token: 'anything',
+      onConnect() {
+        provider.setAwarenessField('foo', 'bar')
+      },
+    })
+  })
+})