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

tests/server/beforeUnloadDocument.ts

@@ -0,0 +1,81 @@
+import type { HocuspocusProvider } from "@hocuspocus/provider";
+import test from "ava";
+
+import { newHocuspocus, newHocuspocusProvider } from "../utils/index.ts";
+
+test("executes the beforeUnloadDocument callback", async (t) => {
+	// biome-ignore lint/suspicious/noAsyncPromiseExecutor: <explanation>
+	await new Promise(async (resolve) => {
+		const server = await newHocuspocus(t, {
+			async beforeUnloadDocument() {
+				t.pass();
+				resolve("done");
+			},
+		});
+
+		const p = newHocuspocusProvider(t, server, {
+			onSynced(data) {
+				p.destroy();
+			},
+		});
+	});
+});
+
+test("executes the beforeUnloadDocument callback when all clients disconnect after a document was loaded", async (t) => {
+	// biome-ignore lint/suspicious/noAsyncPromiseExecutor: <explanation>
+	await new Promise(async (resolve) => {
+		// eslint-disable-next-line prefer-const
+		let provider: HocuspocusProvider;
+
+		class CustomExtension {
+			async afterLoadDocument() {
+				provider.destroy();
+			}
+
+			async beforeUnloadDocument() {
+				t.pass();
+				resolve("done");
+			}
+		}
+
+		const server = await newHocuspocus(t, {
+			extensions: [new CustomExtension()],
+		});
+
+		provider = newHocuspocusProvider(t, server);
+	});
+});
+
+test("throwing an exception in beforeUnloadDocument prevents a document from being unloaded", async (t) => {
+	// biome-ignore lint/suspicious/noAsyncPromiseExecutor: <explanation>
+	await new Promise(async (resolve) => {
+		// eslint-disable-next-line prefer-const
+		let provider: HocuspocusProvider;
+
+		class CustomExtension {
+			async beforeUnloadDocument() {
+				throw new Error("my custom error");
+			}
+
+			async afterUnloadDocument() {
+				t.fail("should not be called");
+			}
+		}
+
+		const server = await newHocuspocus(t, {
+			extensions: [new CustomExtension()],
+		});
+
+		const p = newHocuspocusProvider(t, server, {
+			onSynced(data) {
+				p.destroy();
+			},
+		});
+
+		setTimeout(() => {
+			t.is(server.documents.size, 1);
+			t.pass();
+			resolve("done");
+		}, 500);
+	});
+});