@fedify/netlify 2.4.0-dev.0 → 2.4.0-pr.934.40

package/README.md

@@ -38,6 +38,17 @@ yarn add     @fedify/netlify @netlify/async-workloads     # Yarn
 bun  add     @fedify/netlify @netlify/async-workloads     # Bun
 ~~~~
 
+The PostgreSQL-backed `orderingKv` example below also needs
+`@fedify/postgres`, `@netlify/database`, and `postgres`:
+
+~~~~ sh
+deno add jsr:@fedify/postgres npm:@netlify/database npm:postgres  # Deno
+npm  add     @fedify/postgres @netlify/database postgres          # npm
+pnpm add     @fedify/postgres @netlify/database postgres          # pnpm
+yarn add     @fedify/postgres @netlify/database postgres          # Yarn
+bun  add     @fedify/postgres @netlify/database postgres          # Bun
+~~~~
+
 
 Usage
 -----
@@ -137,6 +148,13 @@ table by default; do not pass `unlogged: true` for `orderingKv`.
 Netlify limits an event payload to 500 KB.  Fedify messages, including any
 embedded activity, must remain below that limit.
 
+`enqueueMany()` sends one Async Workloads event per message because Netlify's
+public client has no batch operation.  The queue therefore declares
+`atomicEnqueueMany` as `false`: ordinary batches still send concurrently, but
+Fedify rejects a multi-message `enqueueTaskMany()` call with one
+`deduplicationKey` before sending anything.  Such a key requires an atomic
+batch enqueue so a failed partial send cannot produce duplicates on retry.
+
 See the [deployment manual] and the [Netlify Astro example] for a complete
 setup with Netlify Database.
 

package/dist/mod.cjs

@@ -3617,11 +3617,12 @@ function getOrderingKv(queue, orderingKey) {
 	if (orderingKey.length < 1) throw new TypeError("orderingKey must not be empty.");
 	return requireCas(getOrderingOptions(queue).kv);
 }
-function getOrderingStateKey(orderingKey) {
+function getOrderingStateKey(queue, orderingKey) {
 	return [
 		"fedify",
 		"netlify",
 		"ordering",
+		queue.eventName.toLowerCase(),
 		orderingKey
 	];
 }
@@ -3654,10 +3655,11 @@ function validateOrderingState(value) {
 }
 async function updateOrderingState(queue, orderingKey, update) {
 	const kv = getOrderingKv(queue, orderingKey);
-	const key = getOrderingStateKey(orderingKey);
+	const key = getOrderingStateKey(queue, orderingKey);
 	while (true) {
 		const stored = await kv.get(key);
 		const [updated, result] = update(validateOrderingState(stored));
+		if (updated === void 0) return result;
 		if (await kv.cas(key, stored, updated)) return result;
 	}
 }
@@ -3670,7 +3672,7 @@ async function reserveOrderingSequence(queue, orderingKey) {
 async function cancelOrderingSequence(queue, orderingKey, sequence) {
 	await updateOrderingState(queue, orderingKey, (state) => {
 		if (sequence >= state.nextSequence) throw new RangeError(`Netlify queue ordering sequence ${sequence} has not been reserved.`);
-		if (sequence <= state.completedSequence) return [state, void 0];
+		if (sequence <= state.completedSequence) return [void 0, void 0];
 		return [compactOrderingState({
 			...state,
 			cancelledSequences: [...state.cancelledSequences, sequence]
@@ -3679,12 +3681,12 @@ async function cancelOrderingSequence(queue, orderingKey, sequence) {
 }
 /** Gets the last completed sequence for an ordering key. @internal */
 async function getCompletedOrderingSequence(queue, orderingKey) {
-	return validateOrderingState(await getOrderingKv(queue, orderingKey).get(getOrderingStateKey(orderingKey))).completedSequence;
+	return validateOrderingState(await getOrderingKv(queue, orderingKey).get(getOrderingStateKey(queue, orderingKey))).completedSequence;
 }
 /** Marks an ordered message as completed. @internal */
 async function completeOrderingSequence(queue, orderingKey, sequence) {
 	await updateOrderingState(queue, orderingKey, (state) => {
-		if (state.completedSequence >= sequence) return [state, void 0];
+		if (state.completedSequence >= sequence) return [void 0, void 0];
 		if (state.completedSequence !== sequence - 1) throw new Error(`Cannot complete Netlify queue ordering sequence ${sequence} after ${state.completedSequence}.`);
 		return [compactOrderingState({
 			...state,
@@ -3706,6 +3708,8 @@ var NetlifyMessageQueue = class {
 	eventName;
 	nativeRetrial = true;
 	nativeDeduplication = false;
+	/** {@inheritDoc MessageQueue.atomicEnqueueMany} */
+	atomicEnqueueMany = false;
 	#client;
 	/** Creates a Netlify Async Workloads-backed message queue. */
 	constructor(options) {
@@ -3787,19 +3791,25 @@ const messageTypes = new Set([
 function isObject(value) {
 	return typeof value === "object" && value != null && !Array.isArray(value);
 }
-function decodeEventData(value) {
-	if (!isObject(value) || !isObject(value.message)) throw new _netlify_async_workloads.ErrorDoNotRetry("Invalid Fedify queue event envelope.");
-	if (typeof value.message.type !== "string" || !messageTypes.has(value.message.type)) throw new _netlify_async_workloads.ErrorDoNotRetry("Invalid Fedify queue message type.");
+function decodeOrderingMetadata(value) {
+	if (!isObject(value)) throw new _netlify_async_workloads.ErrorDoNotRetry("Invalid Fedify queue event envelope.");
 	if (value.orderingKey !== void 0 && (typeof value.orderingKey !== "string" || value.orderingKey.length < 1)) throw new _netlify_async_workloads.ErrorDoNotRetry("Invalid Fedify queue ordering key.");
 	const orderingSequence = value.orderingSequence;
 	if (orderingSequence !== void 0 && (typeof orderingSequence !== "number" || !Number.isSafeInteger(orderingSequence) || orderingSequence < 1)) throw new _netlify_async_workloads.ErrorDoNotRetry("Invalid Fedify queue ordering sequence.");
 	if (value.orderingKey === void 0 !== (orderingSequence === void 0)) throw new _netlify_async_workloads.ErrorDoNotRetry("Incomplete Fedify queue ordering metadata.");
 	return {
-		message: value.message,
 		orderingKey: value.orderingKey,
 		orderingSequence
 	};
 }
+function decodeEventData(value, ordering) {
+	if (!isObject(value) || !isObject(value.message)) throw new _netlify_async_workloads.ErrorDoNotRetry("Invalid Fedify queue event envelope.");
+	if (typeof value.message.type !== "string" || !messageTypes.has(value.message.type)) throw new _netlify_async_workloads.ErrorDoNotRetry("Invalid Fedify queue message type.");
+	return {
+		message: value.message,
+		...ordering
+	};
+}
 /**
 * Creates the event callback that processes one Netlify queue event.
 * @internal
@@ -3808,7 +3818,14 @@ function createNetlifyQueueEventHandler(options) {
 	const maxRetries = options.maxRetries ?? 4;
 	if (!Number.isSafeInteger(maxRetries) || maxRetries < 0) throw new RangeError("maxRetries must be a non-negative safe integer.");
 	return async (event) => {
-		const data = decodeEventData(event.eventData);
+		const orderingMetadata = decodeOrderingMetadata(event.eventData);
+		let data;
+		try {
+			data = decodeEventData(event.eventData, orderingMetadata);
+		} catch (error) {
+			if (error instanceof _netlify_async_workloads.ErrorDoNotRetry && orderingMetadata.orderingKey != null && orderingMetadata.orderingSequence != null) await options.queue.skipOrderingSequence(orderingMetadata.orderingKey, orderingMetadata.orderingSequence);
+			throw error;
+		}
 		const ordering = getOrderingOptions(options.queue);
 		if (data.orderingKey != null && data.orderingSequence != null) {
 			let wait = 0;
@@ -3820,9 +3837,16 @@ function createNetlifyQueueEventHandler(options) {
 			}
 		}
 		try {
-			const federation = await options.federation(event);
-			const contextData = options.contextData == null ? void 0 : await options.contextData(event);
-			await federation.processQueuedTask(contextData, data.message);
+			const process = async () => {
+				const federation = await options.federation(event);
+				const contextData = options.contextData == null ? void 0 : await options.contextData(event);
+				await federation.processQueuedTask(contextData, data.message);
+			};
+			if (data.orderingKey != null && data.orderingSequence != null) await event.step.run("fedify-process-queued-task", async () => {
+				await process();
+				return null;
+			});
+			else await process();
 		} catch (error) {
 			if (data.orderingKey != null && data.orderingSequence != null && (error instanceof _netlify_async_workloads.ErrorDoNotRetry || event.attempt >= maxRetries)) await options.queue.skipOrderingSequence(data.orderingKey, data.orderingSequence);
 			throw error;

package/dist/mod.d.cts

@@ -98,6 +98,8 @@ declare class NetlifyMessageQueue implements MessageQueue {
   readonly eventName: string;
   readonly nativeRetrial = true;
   readonly nativeDeduplication = false;
+  /** {@inheritDoc MessageQueue.atomicEnqueueMany} */
+  readonly atomicEnqueueMany = false;
   /** Creates a Netlify Async Workloads-backed message queue. */
   constructor(options: NetlifyMessageQueueOptions);
   /** {@inheritDoc MessageQueue.enqueue} */

package/dist/mod.d.ts

@@ -98,6 +98,8 @@ declare class NetlifyMessageQueue implements MessageQueue {
   readonly eventName: string;
   readonly nativeRetrial = true;
   readonly nativeDeduplication = false;
+  /** {@inheritDoc MessageQueue.atomicEnqueueMany} */
+  readonly atomicEnqueueMany = false;
   /** Creates a Netlify Async Workloads-backed message queue. */
   constructor(options: NetlifyMessageQueueOptions);
   /** {@inheritDoc MessageQueue.enqueue} */

package/dist/mod.js

@@ -57,11 +57,12 @@ function getOrderingKv(queue, orderingKey) {
 	if (orderingKey.length < 1) throw new TypeError("orderingKey must not be empty.");
 	return requireCas(getOrderingOptions(queue).kv);
 }
-function getOrderingStateKey(orderingKey) {
+function getOrderingStateKey(queue, orderingKey) {
 	return [
 		"fedify",
 		"netlify",
 		"ordering",
+		queue.eventName.toLowerCase(),
 		orderingKey
 	];
 }
@@ -94,10 +95,11 @@ function validateOrderingState(value) {
 }
 async function updateOrderingState(queue, orderingKey, update) {
 	const kv = getOrderingKv(queue, orderingKey);
-	const key = getOrderingStateKey(orderingKey);
+	const key = getOrderingStateKey(queue, orderingKey);
 	while (true) {
 		const stored = await kv.get(key);
 		const [updated, result] = update(validateOrderingState(stored));
+		if (updated === void 0) return result;
 		if (await kv.cas(key, stored, updated)) return result;
 	}
 }
@@ -110,7 +112,7 @@ async function reserveOrderingSequence(queue, orderingKey) {
 async function cancelOrderingSequence(queue, orderingKey, sequence) {
 	await updateOrderingState(queue, orderingKey, (state) => {
 		if (sequence >= state.nextSequence) throw new RangeError(`Netlify queue ordering sequence ${sequence} has not been reserved.`);
-		if (sequence <= state.completedSequence) return [state, void 0];
+		if (sequence <= state.completedSequence) return [void 0, void 0];
 		return [compactOrderingState({
 			...state,
 			cancelledSequences: [...state.cancelledSequences, sequence]
@@ -119,12 +121,12 @@ async function cancelOrderingSequence(queue, orderingKey, sequence) {
 }
 /** Gets the last completed sequence for an ordering key. @internal */
 async function getCompletedOrderingSequence(queue, orderingKey) {
-	return validateOrderingState(await getOrderingKv(queue, orderingKey).get(getOrderingStateKey(orderingKey))).completedSequence;
+	return validateOrderingState(await getOrderingKv(queue, orderingKey).get(getOrderingStateKey(queue, orderingKey))).completedSequence;
 }
 /** Marks an ordered message as completed. @internal */
 async function completeOrderingSequence(queue, orderingKey, sequence) {
 	await updateOrderingState(queue, orderingKey, (state) => {
-		if (state.completedSequence >= sequence) return [state, void 0];
+		if (state.completedSequence >= sequence) return [void 0, void 0];
 		if (state.completedSequence !== sequence - 1) throw new Error(`Cannot complete Netlify queue ordering sequence ${sequence} after ${state.completedSequence}.`);
 		return [compactOrderingState({
 			...state,
@@ -146,6 +148,8 @@ var NetlifyMessageQueue = class {
 	eventName;
 	nativeRetrial = true;
 	nativeDeduplication = false;
+	/** {@inheritDoc MessageQueue.atomicEnqueueMany} */
+	atomicEnqueueMany = false;
 	#client;
 	/** Creates a Netlify Async Workloads-backed message queue. */
 	constructor(options) {
@@ -227,19 +231,25 @@ const messageTypes = new Set([
 function isObject(value) {
 	return typeof value === "object" && value != null && !Array.isArray(value);
 }
-function decodeEventData(value) {
-	if (!isObject(value) || !isObject(value.message)) throw new ErrorDoNotRetry("Invalid Fedify queue event envelope.");
-	if (typeof value.message.type !== "string" || !messageTypes.has(value.message.type)) throw new ErrorDoNotRetry("Invalid Fedify queue message type.");
+function decodeOrderingMetadata(value) {
+	if (!isObject(value)) throw new ErrorDoNotRetry("Invalid Fedify queue event envelope.");
 	if (value.orderingKey !== void 0 && (typeof value.orderingKey !== "string" || value.orderingKey.length < 1)) throw new ErrorDoNotRetry("Invalid Fedify queue ordering key.");
 	const orderingSequence = value.orderingSequence;
 	if (orderingSequence !== void 0 && (typeof orderingSequence !== "number" || !Number.isSafeInteger(orderingSequence) || orderingSequence < 1)) throw new ErrorDoNotRetry("Invalid Fedify queue ordering sequence.");
 	if (value.orderingKey === void 0 !== (orderingSequence === void 0)) throw new ErrorDoNotRetry("Incomplete Fedify queue ordering metadata.");
 	return {
-		message: value.message,
 		orderingKey: value.orderingKey,
 		orderingSequence
 	};
 }
+function decodeEventData(value, ordering) {
+	if (!isObject(value) || !isObject(value.message)) throw new ErrorDoNotRetry("Invalid Fedify queue event envelope.");
+	if (typeof value.message.type !== "string" || !messageTypes.has(value.message.type)) throw new ErrorDoNotRetry("Invalid Fedify queue message type.");
+	return {
+		message: value.message,
+		...ordering
+	};
+}
 /**
 * Creates the event callback that processes one Netlify queue event.
 * @internal
@@ -248,7 +258,14 @@ function createNetlifyQueueEventHandler(options) {
 	const maxRetries = options.maxRetries ?? 4;
 	if (!Number.isSafeInteger(maxRetries) || maxRetries < 0) throw new RangeError("maxRetries must be a non-negative safe integer.");
 	return async (event) => {
-		const data = decodeEventData(event.eventData);
+		const orderingMetadata = decodeOrderingMetadata(event.eventData);
+		let data;
+		try {
+			data = decodeEventData(event.eventData, orderingMetadata);
+		} catch (error) {
+			if (error instanceof ErrorDoNotRetry && orderingMetadata.orderingKey != null && orderingMetadata.orderingSequence != null) await options.queue.skipOrderingSequence(orderingMetadata.orderingKey, orderingMetadata.orderingSequence);
+			throw error;
+		}
 		const ordering = getOrderingOptions(options.queue);
 		if (data.orderingKey != null && data.orderingSequence != null) {
 			let wait = 0;
@@ -260,9 +277,16 @@ function createNetlifyQueueEventHandler(options) {
 			}
 		}
 		try {
-			const federation = await options.federation(event);
-			const contextData = options.contextData == null ? void 0 : await options.contextData(event);
-			await federation.processQueuedTask(contextData, data.message);
+			const process = async () => {
+				const federation = await options.federation(event);
+				const contextData = options.contextData == null ? void 0 : await options.contextData(event);
+				await federation.processQueuedTask(contextData, data.message);
+			};
+			if (data.orderingKey != null && data.orderingSequence != null) await event.step.run("fedify-process-queued-task", async () => {
+				await process();
+				return null;
+			});
+			else await process();
 		} catch (error) {
 			if (data.orderingKey != null && data.orderingSequence != null && (error instanceof ErrorDoNotRetry || event.attempt >= maxRetries)) await options.queue.skipOrderingSequence(data.orderingKey, data.orderingSequence);
 			throw error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/netlify",
-  "version": "2.4.0-dev.0",
+  "version": "2.4.0-pr.934.40+3331d302",
   "description": "Integrate Fedify with Netlify Async Workloads",
   "keywords": [
     "Fedify",
@@ -51,7 +51,7 @@
   },
   "peerDependencies": {
     "@netlify/async-workloads": "^0.0.106",
-    "@fedify/fedify": "^2.4.0"
+    "@fedify/fedify": "^2.4.0-pr.934.40+3331d302"
   },
   "devDependencies": {
     "@js-temporal/polyfill": "^0.5.1",
@@ -62,7 +62,7 @@
     "postgres": "^3.4.7",
     "tsdown": "^0.22.0",
     "typescript": "^6.0.0",
-    "@fedify/postgres": "^2.4.0"
+    "@fedify/postgres": "^2.4.0-pr.934.40+3331d302"
   },
   "scripts": {
     "build:self": "tsdown",