@remit/account-worker 0.0.29 → 0.0.31

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/account-worker",
-  "version": "0.0.29",
+  "version": "0.0.31",
   "type": "module",
   "main": "dist/index.js",
   "exports": {
@@ -23,6 +23,10 @@
     "./finalize": {
       "types": "./src/handlers/account-finalize.ts",
       "default": "./src/handlers/account-finalize.ts"
+    },
+    "./process": {
+      "types": "./src/process.ts",
+      "default": "./src/process.ts"
     }
   },
   "scripts": {

package/src/config.ts

@@ -1,6 +1,9 @@
 import { getClient } from "@remit/backend/client";
 import type { GroupedQueueProducer, QueueProducer } from "@remit/data-ports";
-import { createQueueProducer } from "@remit/sqs-client/producer";
+import {
+	createGroupedQueueProducer,
+	createStandardQueueProducer,
+} from "@remit/sqs-client/producer";
 import type { StorageService } from "@remit/storage-service";
 import { createStorageService } from "@remit/storage-service/s3";
 import { env } from "expect-env";
@@ -26,10 +29,10 @@ export interface FanoutQueues {
 }
 
 export const sqsFanoutQueues = (): FanoutQueues => ({
-	accountFinalize: createQueueProducer({
+	accountFinalize: createStandardQueueProducer({
 		queueUrl: getAccountFinalizeQueueUrl(),
 	}),
-	accountPurgeDelete: createQueueProducer({
+	accountPurgeDelete: createGroupedQueueProducer({
 		queueUrl: getAccountPurgeDeleteQueueUrl(),
 	}),
 });

package/src/handlers/account-fanout.test.ts

@@ -6,34 +6,9 @@ import type { CascadeServices } from "../cascade.js";
 import type { AccountDeleteEvent } from "../events.js";
 import { processAccountFanout } from "./account-fanout.js";
 
-// A CascadeServices fake with one account and no data: enough for
-// enumerateCascadeEntities to yield a single Account row (so the stop-signal
-// loop has one accountId to iterate) without standing up a database.
 const buildServices = (): CascadeServices =>
 	({
-		accountConfigService: {
-			get: async () => ({ userId: "user-1" }),
-			describe: async () => ({
-				account: [{ accountId: "acc-1" }],
-				address: [],
-			}),
-		},
-		accountService: {
-			describe: async () => ({ mailbox: [] }),
-		},
-		messageService: {
-			listAllByMailbox: async () => [],
-			describe: async () => ({}),
-		},
-		outboxMessageService: { listByAccount: async () => ({ items: [] }) },
-		mailboxLockService: { listByAccount: async () => [] },
-		messagePlacementMoveService: { listByAccountId: async () => [] },
-		messageFlagPushService: { listByAccountId: async () => [] },
-		threadMessageService: { listAllByAccount: async () => [] },
-		accountSettingService: { listByAccountConfig: async () => [] },
-		filterService: { listByAccountConfig: async () => [] },
-		labelService: { listByAccountConfig: async () => [] },
-		messageLabelService: { listByLabelId: async () => [] },
+		accountConfigService: { get: async () => ({ userId: "user-1" }) },
 	}) as unknown as CascadeServices;
 
 const deleteEvent: AccountDeleteEvent = {
@@ -48,7 +23,7 @@ describe("processAccountFanout on account delete", () => {
 		await processAccountFanout(deleteEvent, noopLogger, {
 			queues: {
 				accountFinalize,
-				accountPurgeDelete: recordingQueue(),
+				accountPurgeDelete: recordingQueue().grouped,
 			},
 			services: buildServices(),
 			signOut: async () => {},

package/src/handlers/account-fanout.ts

@@ -1,3 +1,4 @@
+import { getClient } from "@remit/backend/client";
 import { createLogger, type Logger } from "@remit/logger";
 import {
 	queueNameFromEventSource,
@@ -20,10 +21,9 @@ import type {
 	AccountFanoutEvent,
 	AccountFinalizeEvent,
 } from "../events.js";
+import { processAccountFanoutEvent } from "../process.js";
 import { processAccountExport } from "./account-export.js";
 import { processAccountDataPurge } from "./account-purge.js";
-import { processOrganizeJob } from "./organize-job.js";
-import { processSenderCategoryBackApply } from "./sender-category-backapply.js";
 
 installNodeLogger();
 
@@ -33,11 +33,6 @@ export interface ProcessAccountFanoutDeps {
 	signOut?: DeletionCapabilities["signOut"];
 }
 
-/**
- * Fanout step of the account-deletion cascade. Signs the user out and
- * enqueues the finalize step. Throws on any non-swallowable error so SQS partial batch-failure
- * retries the whole record.
- */
 export const processAccountFanout = async (
 	event: AccountFanoutEvent,
 	log: Logger,
@@ -58,13 +53,11 @@ export const processAccountFanout = async (
 		return;
 	}
 
-	if (event.type === "OrganizeJob") {
-		await processOrganizeJob(event, log);
-		return;
-	}
-
-	if (event.type === "SenderCategoryBackApply") {
-		await processSenderCategoryBackApply(event, log);
+	if (
+		event.type === "OrganizeJob" ||
+		event.type === "SenderCategoryBackApply"
+	) {
+		await processAccountFanoutEvent(event, { client: await getClient() });
 		return;
 	}
 

package/src/handlers/account-purge.test.ts

@@ -42,7 +42,7 @@ const baseDeps = (queue: RecordingQueue): ProcessPurgeFanoutDeps => ({
 		{ threadMessageId: "tm-1", messageId: "msg-1", mailboxId: "mbx-1" },
 		{ threadMessageId: "tm-2", messageId: "msg-2", mailboxId: "mbx-1" },
 	]),
-	queue,
+	queue: queue.grouped,
 });
 
 describe("processAccountDataPurge", () => {

package/src/handlers/organize-job.ts

@@ -1,4 +1,4 @@
-import { getClient, type RemitClient } from "@remit/backend/client";
+import type { RemitClient } from "@remit/backend/client";
 import {
 	type ApplyOrganizeDeps,
 	applyOrganize,
@@ -16,7 +16,7 @@ import type { Logger } from "@remit/logger";
 import type { OrganizeJobEvent } from "../events.js";
 
 export interface ProcessOrganizeJobDeps {
-	client?: RemitClient;
+	client: RemitClient<"messageManagement">;
 	matchDeps?: OrganizeMatchDeps;
 	moveService?: ApplyOrganizeDeps["moveService"];
 }
@@ -42,7 +42,7 @@ const rejectedOutcome = (rejected: OrganizeRejection): OrganizeOutcome => ({
  * folder, every requested move applied (reader #497).
  */
 const runSnapshot = async (
-	client: RemitClient,
+	client: RemitClient<"messageManagement">,
 	matchDeps: OrganizeMatchDeps,
 	moveService: ApplyOrganizeDeps["moveService"],
 	job: Awaited<ReturnType<RemitClient["organizeJobRequest"]["get"]>>,
@@ -95,10 +95,10 @@ const runSnapshot = async (
 export const processOrganizeJob = async (
 	event: OrganizeJobEvent,
 	log: Logger,
-	deps: ProcessOrganizeJobDeps = {},
+	deps: ProcessOrganizeJobDeps,
 ): Promise<void> => {
 	const { accountConfigId, organizeJobId } = event;
-	const client = deps.client ?? (await getClient());
+	const { client } = deps;
 
 	const job = await client.organizeJobRequest.get(organizeJobId);
 	await client.organizeJobRequest.update(organizeJobId, { state: "Running" });

package/src/handlers/sender-category-backapply.test.ts

@@ -2,9 +2,8 @@ import assert from "node:assert/strict";
 import { describe, it } from "node:test";
 import type { RemitClient } from "@remit/backend/client";
 import { NotFoundError } from "@remit/data-ports/errors";
-import { noopLogger } from "@remit/logger";
 import type { SenderCategoryBackApplyEvent } from "../events.js";
-import { processSenderCategoryBackApply } from "./sender-category-backapply.js";
+import { processAccountFanoutEvent } from "../process.js";
 
 const SET_AT = 1_700;
 
@@ -71,11 +70,11 @@ const clientOver = ({
 		},
 	}) as unknown as RemitClient;
 
-describe("processSenderCategoryBackApply (#415)", () => {
+describe("processAccountFanoutEvent on a sender category back-apply (#415)", () => {
 	it("re-labels the sender's stored mail to the category the event carries", async () => {
 		const relabelled: Array<{ messageId: string; category: unknown }> = [];
 
-		await processSenderCategoryBackApply(event, noopLogger, {
+		await processAccountFanoutEvent(event, {
 			client: clientOver({ relabelled }),
 		});
 
@@ -87,7 +86,7 @@ describe("processSenderCategoryBackApply (#415)", () => {
 	it("applies nothing when the user has since corrected the category", async () => {
 		const relabelled: Array<{ messageId: string; category: unknown }> = [];
 
-		await processSenderCategoryBackApply(event, noopLogger, {
+		await processAccountFanoutEvent(event, {
 			client: clientOver({
 				relabelled,
 				storedFlag: { value: "promotions", setAt: SET_AT + 60 },
@@ -104,7 +103,7 @@ describe("processSenderCategoryBackApply (#415)", () => {
 	it("applies nothing when the same category was cleared and set again", async () => {
 		const relabelled: Array<{ messageId: string; category: unknown }> = [];
 
-		await processSenderCategoryBackApply(event, noopLogger, {
+		await processAccountFanoutEvent(event, {
 			client: clientOver({
 				relabelled,
 				storedFlag: { value: "newsletter", setAt: SET_AT + 60 },
@@ -117,7 +116,7 @@ describe("processSenderCategoryBackApply (#415)", () => {
 	it("applies nothing when the override was cleared outright", async () => {
 		const relabelled: Array<{ messageId: string; category: unknown }> = [];
 
-		await processSenderCategoryBackApply(event, noopLogger, {
+		await processAccountFanoutEvent(event, {
 			client: clientOver({ relabelled, storedFlag: "cleared" }),
 		});
 
@@ -127,7 +126,7 @@ describe("processSenderCategoryBackApply (#415)", () => {
 	it("declines quietly when the address is gone", async () => {
 		const relabelled: Array<{ messageId: string; category: unknown }> = [];
 
-		await processSenderCategoryBackApply(event, noopLogger, {
+		await processAccountFanoutEvent(event, {
 			client: clientOver({ relabelled, storedFlag: "address-gone" }),
 		});
 
@@ -136,7 +135,7 @@ describe("processSenderCategoryBackApply (#415)", () => {
 
 	it("leaves a pass with a failed message unacknowledged so it redelivers", async () => {
 		await assert.rejects(
-			processSenderCategoryBackApply(event, noopLogger, {
+			processAccountFanoutEvent(event, {
 				client: clientOver({
 					relabelled: [],
 					updateMessage: async () => {
@@ -151,7 +150,7 @@ describe("processSenderCategoryBackApply (#415)", () => {
 
 	it("propagates a store failure so partial batch failure redelivers the record", async () => {
 		await assert.rejects(
-			processSenderCategoryBackApply(event, noopLogger, {
+			processAccountFanoutEvent(event, {
 				client: clientOver({
 					relabelled: [],
 					listByFieldTerms: async () => {

package/src/handlers/sender-category-backapply.ts

@@ -1,4 +1,4 @@
-import { getClient, type RemitClient } from "@remit/backend/client";
+import type { RemitClient } from "@remit/backend/client";
 import {
 	backApplySenderCategory,
 	SENDER_CATEGORY_BACKAPPLY_LIMIT,
@@ -8,7 +8,7 @@ import type { Logger } from "@remit/logger";
 import type { SenderCategoryBackApplyEvent } from "../events.js";
 
 export interface ProcessSenderCategoryBackApplyDeps {
-	client?: RemitClient;
+	client: RemitClient<never>;
 }
 
 /**
@@ -23,7 +23,7 @@ export interface ProcessSenderCategoryBackApplyDeps {
  * must not guess.
  */
 const overrideStillStands = async (
-	client: RemitClient,
+	client: RemitClient<never>,
 	event: SenderCategoryBackApplyEvent,
 ): Promise<boolean> => {
 	const address = await client.address
@@ -58,10 +58,10 @@ const overrideStillStands = async (
 export const processSenderCategoryBackApply = async (
 	event: SenderCategoryBackApplyEvent,
 	log: Logger,
-	deps: ProcessSenderCategoryBackApplyDeps = {},
+	deps: ProcessSenderCategoryBackApplyDeps,
 ): Promise<void> => {
 	const { accountConfigId, addressId, normalizedEmail, category } = event;
-	const client = deps.client ?? (await getClient());
+	const { client } = deps;
 
 	if (!(await overrideStillStands(client, event))) {
 		log.warn(

package/src/process-bundle.test.ts

@@ -0,0 +1,66 @@
+import assert from "node:assert/strict";
+import { readFileSync } from "node:fs";
+import { describe, it } from "node:test";
+import { fileURLToPath } from "node:url";
+import { build } from "esbuild";
+
+const LAMBDA_ONLY = [
+	/(^|\/)aws-lambda(\/|$)/,
+	/(^|\/)@aws-sdk\//,
+	/(^|\/)expect-env(\/|$)/,
+	/(^|\/)sqs-client(\/|$)/,
+	/(^|\/)logger-lambda(\/|$)/,
+	/(^|\/)prom-client(\/|$)/,
+];
+
+const ENV_READERS: readonly string[] = [
+	// The organize path reaches body sync through the mailbox-service barrel,
+	// and body sync reads DEFER_BODY_PARTS itself. A new reader fails here.
+	"../mailbox-service/src/body-sync.ts",
+];
+
+const packageDir = fileURLToPath(new URL("..", import.meta.url));
+
+const bundleInputs = async () => {
+	const { metafile } = await build({
+		absWorkingDir: packageDir,
+		entryPoints: ["src/process.ts"],
+		bundle: true,
+		write: false,
+		metafile: true,
+		platform: "node",
+		format: "esm",
+		logLevel: "silent",
+	});
+	return metafile.inputs;
+};
+
+describe("the ./process entry", () => {
+	it("bundles without the Lambda runtime, the AWS SDK, SQS, expect-env or the Node metrics server", async () => {
+		const reached = Object.entries(await bundleInputs()).flatMap(
+			([path, input]) => [path, ...input.imports.map((entry) => entry.path)],
+		);
+
+		assert.deepEqual(
+			reached.filter((path) =>
+				LAMBDA_ONLY.some((pattern) => pattern.test(path)),
+			),
+			[],
+		);
+	});
+
+	it("reaches no workspace source that reads process.env", async () => {
+		const sources = Object.keys(await bundleInputs()).filter(
+			(path) => !path.startsWith("<") && !path.includes("node_modules/"),
+		);
+
+		assert.deepEqual(
+			sources.filter((path) =>
+				/\bprocess\.env\b/.test(
+					readFileSync(new URL(path, `file://${packageDir}`), "utf8"),
+				),
+			),
+			ENV_READERS,
+		);
+	});
+});

package/src/process.ts

@@ -0,0 +1,28 @@
+import type { RemitClient } from "@remit/backend/client";
+import { createLogger } from "@remit/logger";
+import type {
+	OrganizeJobEvent,
+	SenderCategoryBackApplyEvent,
+} from "./events.js";
+import { processOrganizeJob } from "./handlers/organize-job.js";
+import { processSenderCategoryBackApply } from "./handlers/sender-category-backapply.js";
+
+export type ClientFanoutEvent = OrganizeJobEvent | SenderCategoryBackApplyEvent;
+
+export interface AccountFanoutContext {
+	client: RemitClient<"messageManagement">;
+}
+
+const log = createLogger();
+
+export const processAccountFanoutEvent = (
+	event: ClientFanoutEvent,
+	ctx: AccountFanoutContext,
+): Promise<void> => {
+	switch (event.type) {
+		case "OrganizeJob":
+			return processOrganizeJob(event, log, { client: ctx.client });
+		case "SenderCategoryBackApply":
+			return processSenderCategoryBackApply(event, log, { client: ctx.client });
+	}
+};