@fedify/testing 2.0.0-dev.241 → 2.0.0-dev.279

package/dist/mod.cjs

@@ -44,7 +44,7 @@ const noopTracerProvider$1 = { getTracer: () => ({
 }) };
 function createContext(values) {
 	const { federation, url = new URL("http://example.com/"), canonicalOrigin, data, documentLoader, contextLoader, tracerProvider, clone, getNodeInfoUri, getActorUri, getObjectUri, getCollectionUri, getOutboxUri, getInboxUri, getFollowingUri, getFollowersUri, getLikedUri, getFeaturedUri, getFeaturedTagsUri, parseUri, getActorKeyPairs, getDocumentLoader, lookupObject, traverseCollection, lookupNodeInfo, lookupWebFinger, sendActivity, routeActivity } = values;
-	function throwRouteError() {
+	function throwRouterError() {
 		throw new __fedify_fedify_federation.RouterError("Not implemented");
 	}
 	return {
@@ -61,17 +61,17 @@ function createContext(values) {
 			...values,
 			data: data$1
 		})),
-		getNodeInfoUri: getNodeInfoUri ?? throwRouteError,
-		getActorUri: getActorUri ?? throwRouteError,
-		getObjectUri: getObjectUri ?? throwRouteError,
-		getCollectionUri: getCollectionUri ?? throwRouteError,
-		getOutboxUri: getOutboxUri ?? throwRouteError,
-		getInboxUri: getInboxUri ?? throwRouteError,
-		getFollowingUri: getFollowingUri ?? throwRouteError,
-		getFollowersUri: getFollowersUri ?? throwRouteError,
-		getLikedUri: getLikedUri ?? throwRouteError,
-		getFeaturedUri: getFeaturedUri ?? throwRouteError,
-		getFeaturedTagsUri: getFeaturedTagsUri ?? throwRouteError,
+		getNodeInfoUri: getNodeInfoUri ?? throwRouterError,
+		getActorUri: getActorUri ?? throwRouterError,
+		getObjectUri: getObjectUri ?? throwRouterError,
+		getCollectionUri: getCollectionUri ?? throwRouterError,
+		getOutboxUri: getOutboxUri ?? throwRouterError,
+		getInboxUri: getInboxUri ?? throwRouterError,
+		getFollowingUri: getFollowingUri ?? throwRouterError,
+		getFollowersUri: getFollowersUri ?? throwRouterError,
+		getLikedUri: getLikedUri ?? throwRouterError,
+		getFeaturedUri: getFeaturedUri ?? throwRouterError,
+		getFeaturedTagsUri: getFeaturedTagsUri ?? throwRouterError,
 		parseUri: parseUri ?? ((_uri) => {
 			throw new Error("Not implemented");
 		}),
@@ -774,6 +774,8 @@ var MockContext = class MockContext {
 * - `enqueueMany()`: Bulk message enqueueing
 * - `enqueueMany()` with delay: Delayed bulk message enqueueing
 * - Multiple listeners: Ensures messages are processed by only one listener
+* - Ordering key support (optional): Ensures messages with the same ordering
+*   key are processed in order
 *
 * @example
 * ```typescript ignore
@@ -789,6 +791,7 @@ var MockContext = class MockContext {
 *       await mq1.close();
 *       await mq2.close();
 *     },
+*     { testOrderingKey: true },  // Enable ordering key tests
 *   )
 * );
 * ```
@@ -800,9 +803,10 @@ var MockContext = class MockContext {
 * @param onFinally A cleanup function called after all tests complete.
 *                  It receives both message queue instances and the abort
 *                  controller used for the listeners.
+* @param options Optional configuration for the test suite.
 * @returns A promise that resolves when all tests pass.
 */
-async function testMessageQueue(getMessageQueue, onFinally) {
+async function testMessageQueue(getMessageQueue, onFinally, options = {}) {
 	const mq1 = await getMessageQueue();
 	const mq2 = await getMessageQueue();
 	const controller = new AbortController();
@@ -846,9 +850,81 @@ async function testMessageQueue(getMessageQueue, onFinally) {
 		await waitFor(() => messages.length >= bulkCount, 3e4);
 		const expectedMessages = new Set(Array.from({ length: bulkCount }, (_, i) => `message-${i}`));
 		(0, node_assert_strict.deepStrictEqual)(new Set(messages), expectedMessages);
-		controller.abort();
-		await listening1;
-		await listening2;
+		if (options.testOrderingKey) {
+			while (messages.length > 0) messages.pop();
+			const orderTracker = {
+				keyA: [],
+				keyB: [],
+				noKey: []
+			};
+			controller.abort();
+			await listening1;
+			await listening2;
+			const orderController = new AbortController();
+			const orderMessages = [];
+			const orderListening1 = mq1.listen((message) => {
+				orderMessages.push(message);
+				const trackKey = message.key ?? "noKey";
+				if (trackKey in orderTracker) orderTracker[trackKey].push(message.value);
+			}, { signal: orderController.signal });
+			const orderListening2 = mq2.listen((message) => {
+				orderMessages.push(message);
+				const trackKey = message.key ?? "noKey";
+				if (trackKey in orderTracker) orderTracker[trackKey].push(message.value);
+			}, { signal: orderController.signal });
+			await mq1.enqueue({
+				key: "keyA",
+				value: 1
+			}, { orderingKey: "keyA" });
+			await mq1.enqueue({
+				key: "keyB",
+				value: 1
+			}, { orderingKey: "keyB" });
+			await mq1.enqueue({
+				key: "keyA",
+				value: 2
+			}, { orderingKey: "keyA" });
+			await mq1.enqueue({
+				key: "keyB",
+				value: 2
+			}, { orderingKey: "keyB" });
+			await mq1.enqueue({
+				key: "keyA",
+				value: 3
+			}, { orderingKey: "keyA" });
+			await mq1.enqueue({
+				key: "keyB",
+				value: 3
+			}, { orderingKey: "keyB" });
+			await mq1.enqueue({
+				key: null,
+				value: 1
+			});
+			await mq1.enqueue({
+				key: null,
+				value: 2
+			});
+			await waitFor(() => orderMessages.length >= 8, 3e4);
+			(0, node_assert_strict.deepStrictEqual)(orderTracker.keyA, [
+				1,
+				2,
+				3
+			], "Messages with orderingKey 'keyA' should be processed in order");
+			(0, node_assert_strict.deepStrictEqual)(orderTracker.keyB, [
+				1,
+				2,
+				3
+			], "Messages with orderingKey 'keyB' should be processed in order");
+			(0, node_assert_strict.strictEqual)(orderTracker.noKey.length, 2, "Messages without ordering key should all be received");
+			(0, node_assert_strict.ok)(orderTracker.noKey.includes(1) && orderTracker.noKey.includes(2), "Messages without ordering key should contain values 1 and 2");
+			orderController.abort();
+			await orderListening1;
+			await orderListening2;
+		} else {
+			controller.abort();
+			await listening1;
+			await listening2;
+		}
 	} finally {
 		await onFinally({
 			mq1,

package/dist/mod.d.cts

@@ -125,6 +125,22 @@ declare function createFederation<TContextData>(options?: {
 }): TestFederation<TContextData>;
 //#endregion
 //#region src/mq-tester.d.ts
+/**
+ * Options for {@link testMessageQueue}.
+ */
+interface TestMessageQueueOptions {
+  /**
+   * Whether to test ordering key support.  If `true`, tests will verify that
+   * messages with the same ordering key are processed in order, while messages
+   * with different ordering keys can be processed in parallel.
+   *
+   * Set this to `true` only if your message queue implementation supports
+   * the `orderingKey` option.
+   *
+   * @default false
+   */
+  readonly testOrderingKey?: boolean;
+}
 /**
  * Tests a {@link MessageQueue} implementation with a standard set of tests.
  *
@@ -134,6 +150,8 @@ declare function createFederation<TContextData>(options?: {
  * - `enqueueMany()`: Bulk message enqueueing
  * - `enqueueMany()` with delay: Delayed bulk message enqueueing
  * - Multiple listeners: Ensures messages are processed by only one listener
+ * - Ordering key support (optional): Ensures messages with the same ordering
+ *   key are processed in order
  *
  * @example
  * ```typescript ignore
@@ -149,6 +167,7 @@ declare function createFederation<TContextData>(options?: {
  *       await mq1.close();
  *       await mq2.close();
  *     },
+ *     { testOrderingKey: true },  // Enable ordering key tests
  *   )
  * );
  * ```
@@ -160,6 +179,7 @@ declare function createFederation<TContextData>(options?: {
  * @param onFinally A cleanup function called after all tests complete.
  *                  It receives both message queue instances and the abort
  *                  controller used for the listeners.
+ * @param options Optional configuration for the test suite.
  * @returns A promise that resolves when all tests pass.
  */
 declare function testMessageQueue<MQ extends MessageQueue>(getMessageQueue: () => MQ | Promise<MQ>, onFinally: ({
@@ -170,8 +190,8 @@ declare function testMessageQueue<MQ extends MessageQueue>(getMessageQueue: () =
   mq1: MQ;
   mq2: MQ;
   controller: AbortController;
-}) => Promise<void> | void): Promise<void>;
+}) => Promise<void> | void, options?: TestMessageQueueOptions): Promise<void>;
 declare function waitFor(predicate: () => boolean, timeoutMs: number): Promise<void>;
 declare const getRandomKey: (prefix: string) => string;
 //#endregion
-export { createContext, createFederation, createInboxContext, createRequestContext, getRandomKey, testMessageQueue, waitFor };
+export { TestMessageQueueOptions, createContext, createFederation, createInboxContext, createRequestContext, getRandomKey, testMessageQueue, waitFor };

package/dist/mod.d.ts

@@ -126,6 +126,22 @@ declare function createFederation<TContextData>(options?: {
 }): TestFederation<TContextData>;
 //#endregion
 //#region src/mq-tester.d.ts
+/**
+ * Options for {@link testMessageQueue}.
+ */
+interface TestMessageQueueOptions {
+  /**
+   * Whether to test ordering key support.  If `true`, tests will verify that
+   * messages with the same ordering key are processed in order, while messages
+   * with different ordering keys can be processed in parallel.
+   *
+   * Set this to `true` only if your message queue implementation supports
+   * the `orderingKey` option.
+   *
+   * @default false
+   */
+  readonly testOrderingKey?: boolean;
+}
 /**
  * Tests a {@link MessageQueue} implementation with a standard set of tests.
  *
@@ -135,6 +151,8 @@ declare function createFederation<TContextData>(options?: {
  * - `enqueueMany()`: Bulk message enqueueing
  * - `enqueueMany()` with delay: Delayed bulk message enqueueing
  * - Multiple listeners: Ensures messages are processed by only one listener
+ * - Ordering key support (optional): Ensures messages with the same ordering
+ *   key are processed in order
  *
  * @example
  * ```typescript ignore
@@ -150,6 +168,7 @@ declare function createFederation<TContextData>(options?: {
  *       await mq1.close();
  *       await mq2.close();
  *     },
+ *     { testOrderingKey: true },  // Enable ordering key tests
  *   )
  * );
  * ```
@@ -161,6 +180,7 @@ declare function createFederation<TContextData>(options?: {
  * @param onFinally A cleanup function called after all tests complete.
  *                  It receives both message queue instances and the abort
  *                  controller used for the listeners.
+ * @param options Optional configuration for the test suite.
  * @returns A promise that resolves when all tests pass.
  */
 declare function testMessageQueue<MQ extends MessageQueue>(getMessageQueue: () => MQ | Promise<MQ>, onFinally: ({
@@ -171,8 +191,8 @@ declare function testMessageQueue<MQ extends MessageQueue>(getMessageQueue: () =
   mq1: MQ;
   mq2: MQ;
   controller: AbortController;
-}) => Promise<void> | void): Promise<void>;
+}) => Promise<void> | void, options?: TestMessageQueueOptions): Promise<void>;
 declare function waitFor(predicate: () => boolean, timeoutMs: number): Promise<void>;
 declare const getRandomKey: (prefix: string) => string;
 //#endregion
-export { createContext, createFederation, createInboxContext, createRequestContext, getRandomKey, testMessageQueue, waitFor };
+export { TestMessageQueueOptions, createContext, createFederation, createInboxContext, createRequestContext, getRandomKey, testMessageQueue, waitFor };

package/dist/mod.js

@@ -4,7 +4,7 @@
 import { CryptographicKey, Multikey, lookupObject, traverseCollection } from "@fedify/vocab";
 import { RouterError } from "@fedify/fedify/federation";
 import { delay } from "es-toolkit";
-import { deepStrictEqual, ok } from "node:assert/strict";
+import { deepStrictEqual, ok, strictEqual } from "node:assert/strict";
 
 //#region src/docloader.ts
 const mockDocumentLoader = async (url) => ({
@@ -21,7 +21,7 @@ const noopTracerProvider$1 = { getTracer: () => ({
 }) };
 function createContext(values) {
 	const { federation, url = new URL("http://example.com/"), canonicalOrigin, data, documentLoader, contextLoader, tracerProvider, clone, getNodeInfoUri, getActorUri, getObjectUri, getCollectionUri, getOutboxUri, getInboxUri, getFollowingUri, getFollowersUri, getLikedUri, getFeaturedUri, getFeaturedTagsUri, parseUri, getActorKeyPairs, getDocumentLoader, lookupObject: lookupObject$1, traverseCollection: traverseCollection$1, lookupNodeInfo, lookupWebFinger, sendActivity, routeActivity } = values;
-	function throwRouteError() {
+	function throwRouterError() {
 		throw new RouterError("Not implemented");
 	}
 	return {
@@ -38,17 +38,17 @@ function createContext(values) {
 			...values,
 			data: data$1
 		})),
-		getNodeInfoUri: getNodeInfoUri ?? throwRouteError,
-		getActorUri: getActorUri ?? throwRouteError,
-		getObjectUri: getObjectUri ?? throwRouteError,
-		getCollectionUri: getCollectionUri ?? throwRouteError,
-		getOutboxUri: getOutboxUri ?? throwRouteError,
-		getInboxUri: getInboxUri ?? throwRouteError,
-		getFollowingUri: getFollowingUri ?? throwRouteError,
-		getFollowersUri: getFollowersUri ?? throwRouteError,
-		getLikedUri: getLikedUri ?? throwRouteError,
-		getFeaturedUri: getFeaturedUri ?? throwRouteError,
-		getFeaturedTagsUri: getFeaturedTagsUri ?? throwRouteError,
+		getNodeInfoUri: getNodeInfoUri ?? throwRouterError,
+		getActorUri: getActorUri ?? throwRouterError,
+		getObjectUri: getObjectUri ?? throwRouterError,
+		getCollectionUri: getCollectionUri ?? throwRouterError,
+		getOutboxUri: getOutboxUri ?? throwRouterError,
+		getInboxUri: getInboxUri ?? throwRouterError,
+		getFollowingUri: getFollowingUri ?? throwRouterError,
+		getFollowersUri: getFollowersUri ?? throwRouterError,
+		getLikedUri: getLikedUri ?? throwRouterError,
+		getFeaturedUri: getFeaturedUri ?? throwRouterError,
+		getFeaturedTagsUri: getFeaturedTagsUri ?? throwRouterError,
 		parseUri: parseUri ?? ((_uri) => {
 			throw new Error("Not implemented");
 		}),
@@ -751,6 +751,8 @@ var MockContext = class MockContext {
 * - `enqueueMany()`: Bulk message enqueueing
 * - `enqueueMany()` with delay: Delayed bulk message enqueueing
 * - Multiple listeners: Ensures messages are processed by only one listener
+* - Ordering key support (optional): Ensures messages with the same ordering
+*   key are processed in order
 *
 * @example
 * ```typescript ignore
@@ -766,6 +768,7 @@ var MockContext = class MockContext {
 *       await mq1.close();
 *       await mq2.close();
 *     },
+*     { testOrderingKey: true },  // Enable ordering key tests
 *   )
 * );
 * ```
@@ -777,9 +780,10 @@ var MockContext = class MockContext {
 * @param onFinally A cleanup function called after all tests complete.
 *                  It receives both message queue instances and the abort
 *                  controller used for the listeners.
+* @param options Optional configuration for the test suite.
 * @returns A promise that resolves when all tests pass.
 */
-async function testMessageQueue(getMessageQueue, onFinally) {
+async function testMessageQueue(getMessageQueue, onFinally, options = {}) {
 	const mq1 = await getMessageQueue();
 	const mq2 = await getMessageQueue();
 	const controller = new AbortController();
@@ -823,9 +827,81 @@ async function testMessageQueue(getMessageQueue, onFinally) {
 		await waitFor(() => messages.length >= bulkCount, 3e4);
 		const expectedMessages = new Set(Array.from({ length: bulkCount }, (_, i) => `message-${i}`));
 		deepStrictEqual(new Set(messages), expectedMessages);
-		controller.abort();
-		await listening1;
-		await listening2;
+		if (options.testOrderingKey) {
+			while (messages.length > 0) messages.pop();
+			const orderTracker = {
+				keyA: [],
+				keyB: [],
+				noKey: []
+			};
+			controller.abort();
+			await listening1;
+			await listening2;
+			const orderController = new AbortController();
+			const orderMessages = [];
+			const orderListening1 = mq1.listen((message) => {
+				orderMessages.push(message);
+				const trackKey = message.key ?? "noKey";
+				if (trackKey in orderTracker) orderTracker[trackKey].push(message.value);
+			}, { signal: orderController.signal });
+			const orderListening2 = mq2.listen((message) => {
+				orderMessages.push(message);
+				const trackKey = message.key ?? "noKey";
+				if (trackKey in orderTracker) orderTracker[trackKey].push(message.value);
+			}, { signal: orderController.signal });
+			await mq1.enqueue({
+				key: "keyA",
+				value: 1
+			}, { orderingKey: "keyA" });
+			await mq1.enqueue({
+				key: "keyB",
+				value: 1
+			}, { orderingKey: "keyB" });
+			await mq1.enqueue({
+				key: "keyA",
+				value: 2
+			}, { orderingKey: "keyA" });
+			await mq1.enqueue({
+				key: "keyB",
+				value: 2
+			}, { orderingKey: "keyB" });
+			await mq1.enqueue({
+				key: "keyA",
+				value: 3
+			}, { orderingKey: "keyA" });
+			await mq1.enqueue({
+				key: "keyB",
+				value: 3
+			}, { orderingKey: "keyB" });
+			await mq1.enqueue({
+				key: null,
+				value: 1
+			});
+			await mq1.enqueue({
+				key: null,
+				value: 2
+			});
+			await waitFor(() => orderMessages.length >= 8, 3e4);
+			deepStrictEqual(orderTracker.keyA, [
+				1,
+				2,
+				3
+			], "Messages with orderingKey 'keyA' should be processed in order");
+			deepStrictEqual(orderTracker.keyB, [
+				1,
+				2,
+				3
+			], "Messages with orderingKey 'keyB' should be processed in order");
+			strictEqual(orderTracker.noKey.length, 2, "Messages without ordering key should all be received");
+			ok(orderTracker.noKey.includes(1) && orderTracker.noKey.includes(2), "Messages without ordering key should contain values 1 and 2");
+			orderController.abort();
+			await orderListening1;
+			await orderListening2;
+		} else {
+			controller.abort();
+			await listening1;
+			await listening2;
+		}
 	} finally {
 		await onFinally({
 			mq1,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/testing",
-  "version": "2.0.0-dev.241+58c8126c",
+  "version": "2.0.0-dev.279+ce1bdc22",
   "description": "Testing utilities for Fedify applications",
   "keywords": [
     "fedify",
@@ -50,7 +50,7 @@
     "package.json"
   ],
   "peerDependencies": {
-    "@fedify/fedify": "^2.0.0-dev.241+58c8126c"
+    "@fedify/fedify": "^2.0.0-dev.279+ce1bdc22"
   },
   "dependencies": {
     "es-toolkit": "1.43.0"
@@ -67,8 +67,10 @@
     "build:self": "tsdown",
     "build": "pnpm --filter @fedify/testing... run build:self",
     "prepublish": "pnpm build",
-    "test": "pnpm build && node --experimental-transform-types --test",
-    "test:bun": "pnpm build && bun test --timeout 15000",
+    "pretest": "pnpm build",
+    "test": "node --experimental-transform-types --test",
+    "pretest:bun": "pnpm build",
+    "test:bun": "bun test --timeout 15000",
     "test:deno": "deno task test",
     "test-all": "pnpm build && node --experimental-transform-types --test && bun test --timeout 15000 && deno task test"
   }