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

tests/extension-redis/onAwarenessChange.ts

@@ -0,0 +1,106 @@
+import { Redis } from "@hocuspocus/extension-redis";
+import type { onAwarenessChangeParameters } from "@hocuspocus/provider";
+import test from "ava";
+import {
+	newHocuspocus,
+	newHocuspocusProvider,
+	redisConnectionSettings,
+} from "../utils/index.ts";
+
+test("syncs existing awareness state", async (t) => {
+	const documentName = `test-${crypto.randomUUID()}`;
+
+	await new Promise(async (resolve) => {
+		const server = await newHocuspocus(t, {
+			extensions: [
+				new Redis({
+					...redisConnectionSettings,
+					identifier: `server${crypto.randomUUID()}`,
+				}),
+			],
+		});
+
+		const anotherServer = await newHocuspocus(t, {
+			extensions: [
+				new Redis({
+					...redisConnectionSettings,
+					identifier: `anotherServer${crypto.randomUUID()}`,
+				}),
+			],
+		});
+
+		const provider = newHocuspocusProvider(t, server, {
+			name: documentName,
+			onSynced() {
+				// Once we're set up, change the local Awareness state.
+				// The updated state then needs to go through Redis:
+				// provider -> server -> Redis -> anotherServer -> anotherProvider
+				provider.setAwarenessField("name", "first");
+
+				// Time to initialize a second provider, and connect to `anotherServer`
+				// to check whether existing Awareness states are synced through Redis.
+				newHocuspocusProvider(t, anotherServer, {
+					name: documentName,
+					onAwarenessChange({ states }: onAwarenessChangeParameters) {
+						// Wait until we have exactly 2 states with the expected data
+						const state = states.find(
+							(state) => state.clientId === provider.document.clientID,
+						);
+						if (states.length === 2 && state?.name === "first") {
+							t.pass();
+							resolve("done");
+						}
+					},
+				});
+			},
+		});
+	});
+});
+
+test("syncs awareness between servers and clients", async (t) => {
+	const documentName = `test-${crypto.randomUUID()}`;
+
+	await new Promise(async (resolve) => {
+		const server = await newHocuspocus(t, {
+			extensions: [
+				new Redis({
+					...redisConnectionSettings,
+					identifier: `server${crypto.randomUUID()}`,
+				}),
+			],
+		});
+
+		const anotherServer = await newHocuspocus(t, {
+			extensions: [
+				new Redis({
+					...redisConnectionSettings,
+					identifier: `anotherServer${crypto.randomUUID()}`,
+				}),
+			],
+		});
+
+		const provider = newHocuspocusProvider(t, anotherServer, {
+			name: documentName,
+			onSynced() {
+				// once we're setup change awareness on provider, to get to client it will
+				// need to pass through the pubsub extension:
+				// provider -> anotherServer -> pubsub -> server -> client
+				provider.setAwarenessField("name", "second");
+			},
+		});
+
+		newHocuspocusProvider(t, server, {
+			name: documentName,
+			onAwarenessChange: ({ states }: onAwarenessChangeParameters) => {
+				// Wait until we have exactly 2 states with the expected data
+				const state = states.find(
+					(state) => state.clientId === provider.document.clientID,
+				);
+				if (states.length === 2 && state?.name === "second") {
+					t.pass();
+					resolve("done");
+				}
+			},
+		});
+	});
+});