@remit/imap-worker 0.0.89 → 0.0.91

package/src/body-sync-gate.test.ts

@@ -1,185 +0,0 @@
-import assert from "node:assert/strict";
-import { afterEach, beforeEach, describe, it } from "node:test";
-import {
-	GetParameterCommand,
-	ParameterNotFound,
-	SSMClient,
-} from "@aws-sdk/client-ssm";
-import type { Logger } from "@remit/logger";
-import { mockClient } from "aws-sdk-client-mock";
-import { isBodySyncEnabled, resetBodySyncGateCache } from "./body-sync-gate.js";
-
-const parameterName = "/dev/Remit/bodySyncEnabled";
-
-interface CapturedWarn {
-	args: unknown[];
-}
-
-const createCapturingLogger = (): {
-	log: Logger;
-	warnCalls: CapturedWarn[];
-} => {
-	const warnCalls: CapturedWarn[] = [];
-	const noop = () => {};
-	const log = {
-		info: noop,
-		warn: (...args: unknown[]) => warnCalls.push({ args }),
-		error: noop,
-		debug: noop,
-		fatal: noop,
-		trace: noop,
-		child: () => log,
-	} as unknown as Logger;
-	return { log, warnCalls };
-};
-
-const warnMessage = (warn: CapturedWarn): string => String(warn.args[1]);
-
-describe("isBodySyncEnabled", () => {
-	beforeEach(() => {
-		resetBodySyncGateCache();
-	});
-
-	afterEach(() => {
-		mockClient(SSMClient).reset();
-		resetBodySyncGateCache();
-	});
-
-	it("returns true when the parameter is 'true'", async () => {
-		const ssmMock = mockClient(SSMClient);
-		ssmMock
-			.on(GetParameterCommand, { Name: parameterName })
-			.resolves({ Parameter: { Value: "true" } });
-		const { log } = createCapturingLogger();
-
-		const enabled = await isBodySyncEnabled(
-			parameterName,
-			log,
-			ssmMock as unknown as SSMClient,
-		);
-
-		assert.equal(enabled, true);
-	});
-
-	it("returns false when the parameter is 'false'", async () => {
-		const ssmMock = mockClient(SSMClient);
-		ssmMock
-			.on(GetParameterCommand, { Name: parameterName })
-			.resolves({ Parameter: { Value: "false" } });
-		const { log } = createCapturingLogger();
-
-		const enabled = await isBodySyncEnabled(
-			parameterName,
-			log,
-			ssmMock as unknown as SSMClient,
-		);
-
-		assert.equal(enabled, false);
-	});
-
-	it("treats casing and whitespace as disabled for ' FALSE '", async () => {
-		const ssmMock = mockClient(SSMClient);
-		ssmMock
-			.on(GetParameterCommand, { Name: parameterName })
-			.resolves({ Parameter: { Value: " FALSE " } });
-		const { log } = createCapturingLogger();
-
-		const enabled = await isBodySyncEnabled(
-			parameterName,
-			log,
-			ssmMock as unknown as SSMClient,
-		);
-
-		assert.equal(enabled, false);
-	});
-
-	it("fails open with a warning when the parameter does not exist", async () => {
-		const ssmMock = mockClient(SSMClient);
-		ssmMock
-			.on(GetParameterCommand, { Name: parameterName })
-			.rejects(new ParameterNotFound({ message: "not found", $metadata: {} }));
-		const { log, warnCalls } = createCapturingLogger();
-
-		const enabled = await isBodySyncEnabled(
-			parameterName,
-			log,
-			ssmMock as unknown as SSMClient,
-		);
-
-		assert.equal(enabled, true);
-		assert.equal(warnCalls.length, 1);
-		assert.match(warnMessage(warnCalls[0]), /failing open/i);
-	});
-
-	it("fails open with a warning when the parameter has no value", async () => {
-		const ssmMock = mockClient(SSMClient);
-		ssmMock
-			.on(GetParameterCommand, { Name: parameterName })
-			.resolves({ Parameter: {} });
-		const { log, warnCalls } = createCapturingLogger();
-
-		const enabled = await isBodySyncEnabled(
-			parameterName,
-			log,
-			ssmMock as unknown as SSMClient,
-		);
-
-		assert.equal(enabled, true);
-		assert.equal(warnCalls.length, 1);
-		assert.match(warnMessage(warnCalls[0]), /missing a value/i);
-	});
-
-	it("caches the result within the TTL — second call does not re-fetch", async () => {
-		const ssmMock = mockClient(SSMClient);
-		ssmMock
-			.on(GetParameterCommand, { Name: parameterName })
-			.resolves({ Parameter: { Value: "false" } });
-		const { log } = createCapturingLogger();
-
-		const first = await isBodySyncEnabled(
-			parameterName,
-			log,
-			ssmMock as unknown as SSMClient,
-		);
-		const second = await isBodySyncEnabled(
-			parameterName,
-			log,
-			ssmMock as unknown as SSMClient,
-		);
-
-		assert.equal(first, false);
-		assert.equal(second, false);
-		assert.equal(ssmMock.commandCalls(GetParameterCommand).length, 1);
-	});
-
-	it("coalesces concurrent cold-cache calls into a single GetParameter", async () => {
-		const ssmMock = mockClient(SSMClient);
-		let resolveSend:
-			| ((value: { Parameter: { Value: string } }) => void)
-			| undefined;
-		ssmMock.on(GetParameterCommand, { Name: parameterName }).callsFake(
-			() =>
-				new Promise((resolve) => {
-					resolveSend = resolve;
-				}),
-		);
-		const { log } = createCapturingLogger();
-
-		const a = isBodySyncEnabled(
-			parameterName,
-			log,
-			ssmMock as unknown as SSMClient,
-		);
-		const b = isBodySyncEnabled(
-			parameterName,
-			log,
-			ssmMock as unknown as SSMClient,
-		);
-
-		assert.ok(resolveSend, "GetParameter should have been invoked");
-		resolveSend?.({ Parameter: { Value: "true" } });
-
-		assert.deepEqual(await Promise.all([a, b]), [true, true]);
-		assert.equal(ssmMock.commandCalls(GetParameterCommand).length, 1);
-	});
-});

package/src/body-sync-gate.ts

@@ -1,86 +0,0 @@
-import { GetParameterCommand, SSMClient } from "@aws-sdk/client-ssm";
-import type { Logger } from "@remit/logger";
-
-const CACHE_TTL_MS = 30_000;
-
-interface CacheEntry {
-	readonly enabled: boolean;
-	readonly expiresAt: number;
-}
-
-let cache: CacheEntry | undefined;
-let inFlight: Promise<boolean> | undefined;
-let defaultClient: SSMClient | undefined;
-
-const getDefaultClient = (): SSMClient => {
-	if (!defaultClient) {
-		defaultClient = new SSMClient({});
-	}
-	return defaultClient;
-};
-
-/**
- * Test seam — clears the module-scope TTL cache between unit tests.
- */
-export const resetBodySyncGateCache = (): void => {
-	cache = undefined;
-	inFlight = undefined;
-};
-
-const readParameter = async (
-	ssm: SSMClient,
-	parameterName: string,
-	log: Logger,
-): Promise<boolean> => {
-	const result = await ssm.send(
-		new GetParameterCommand({ Name: parameterName }),
-	);
-	const value = result.Parameter?.Value;
-
-	if (value === undefined) {
-		log.warn(
-			{ parameterName },
-			"Body-sync toggle parameter missing a value, failing open (enabled)",
-		);
-		return true;
-	}
-
-	return value.trim().toLowerCase() !== "false";
-};
-
-/**
- * Reads the `/{stage}/Remit/bodySyncEnabled` SSM parameter, cached at module
- * scope for a short TTL. Returns `true` (enabled) when the parameter is absent
- * or unreadable — body sync fails open so a missing toggle never halts prod.
- */
-export const isBodySyncEnabled = async (
-	parameterName: string,
-	log: Logger,
-	ssm: SSMClient = getDefaultClient(),
-): Promise<boolean> => {
-	if (cache && cache.expiresAt > Date.now()) {
-		return cache.enabled;
-	}
-
-	if (inFlight) {
-		return inFlight;
-	}
-
-	inFlight = readParameter(ssm, parameterName, log)
-		.catch((error) => {
-			log.warn(
-				{ parameterName, error },
-				"Failed to read body-sync toggle parameter, failing open (enabled)",
-			);
-			return true;
-		})
-		.then((enabled) => {
-			cache = { enabled, expiresAt: Date.now() + CACHE_TTL_MS };
-			return enabled;
-		})
-		.finally(() => {
-			inFlight = undefined;
-		});
-
-	return inFlight;
-};

package/src/cli.ts

@@ -1,224 +0,0 @@
-#!/usr/bin/env node
-// Plain text on purpose, and the one deliberate exception to the log field
-// contract in deploy/vps/README.md ("Logs"). That contract covers what a
-// container's log driver ships; this file is the `remit-worker` bin, run by hand
-// against a terminal, and is not an entrypoint of any image (see the target list
-// in npm-scripts/docker-bundle.mjs). Do not route it through the logger — usage
-// text and argument errors are for the person who typed the command.
-import { parseArgs } from "node:util";
-import { emitEvent } from "./emit.js";
-import {
-	setWorkerQueues,
-	sqsWorkerQueues,
-	workerQueueUrlsFromEnv,
-} from "./queues.js";
-
-const HELP = `
-remit-imap-worker - Process IMAP sync events
-
-USAGE:
-  remit-worker -t <type> -a <accountId> [options]
-
-OPTIONS:
-  -t, --type <type>         Event type (required)
-  -a, --accountId <id>      Account ID (required)
-  -m, --mailboxId <id>      Mailbox ID (required for some event types)
-      --messageIds <ids>    Comma-separated message IDs (required for SYNC_MESSAGE_BODY)
-      --fullSync            Force full sync, ignoring lastSyncUid (SYNC_MESSAGES only)
-      --path <path>         Mailbox path (required for MAILBOX_CREATE, MAILBOX_DELETE)
-      --oldPath <path>      Old mailbox path (required for MAILBOX_RENAME)
-      --newPath <path>      New mailbox path (required for MAILBOX_RENAME)
-      --subscribe           Subscribe to mailbox after creation (MAILBOX_CREATE only)
-  -h, --help                Show this help message
-
-EVENT TYPES:
-  SYNC_MAILBOXES     Sync all mailboxes for an account
-  SYNC_MESSAGES      Sync messages in a specific mailbox
-  SYNC_MESSAGE_BODY  Fetch and store message bodies in batch
-  MAILBOX_CREATE     Create a new mailbox
-  MAILBOX_RENAME     Rename a mailbox
-  MAILBOX_DELETE     Delete a mailbox
-
-EXAMPLES:
-  # Sync all mailboxes for an account
-  remit-worker -t SYNC_MAILBOXES -a account-123
-
-  # Sync messages in a mailbox
-  remit-worker -t SYNC_MESSAGES -a account-123 -m mailbox-456
-
-  # Force a full sync of messages (ignore lastSyncUid)
-  remit-worker -t SYNC_MESSAGES -a account-123 -m mailbox-456 --fullSync
-
-  # Sync message bodies for specific messages
-  remit-worker -t SYNC_MESSAGE_BODY -a account-123 -m mailbox-456 --messageIds id1,id2,id3
-
-  # Create a new mailbox
-  remit-worker -t MAILBOX_CREATE -a account-123 -m mailbox-id --path Work/Projects --subscribe
-
-  # Rename a mailbox
-  remit-worker -t MAILBOX_RENAME -a account-123 -m mailbox-id --oldPath Work/Projects --newPath Archive/Projects
-
-  # Delete a mailbox
-  remit-worker -t MAILBOX_DELETE -a account-123 -m mailbox-id --path Work/Projects
-`;
-
-const { values } = parseArgs({
-	options: {
-		type: { type: "string", short: "t" },
-		accountId: { type: "string", short: "a" },
-		mailboxId: { type: "string", short: "m" },
-		messageIds: { type: "string" },
-		fullSync: { type: "boolean", default: false },
-		path: { type: "string" },
-		oldPath: { type: "string" },
-		newPath: { type: "string" },
-		subscribe: { type: "boolean", default: false },
-		help: { type: "boolean", short: "h", default: false },
-	},
-});
-
-if (values.help) {
-	console.log(HELP);
-	process.exit(0);
-}
-
-if (!values.type || !values.accountId) {
-	console.error("Error: --type and --accountId are required\n");
-	console.log(HELP);
-	process.exit(0);
-}
-
-const validTypes = [
-	"SYNC_MAILBOXES",
-	"SYNC_MESSAGES",
-	"SYNC_MESSAGE_BODY",
-	"MAILBOX_CREATE",
-	"MAILBOX_RENAME",
-	"MAILBOX_DELETE",
-];
-if (!validTypes.includes(values.type)) {
-	console.error(
-		`Error: Invalid type "${values.type}". Must be one of: ${validTypes.join(", ")}\n`,
-	);
-	process.exit(1);
-}
-
-if (
-	["SYNC_MESSAGES", "SYNC_MESSAGE_BODY"].includes(values.type) &&
-	!values.mailboxId
-) {
-	console.error(`Error: --mailboxId is required for ${values.type}\n`);
-	process.exit(1);
-}
-
-if (values.type === "SYNC_MESSAGE_BODY" && !values.messageIds) {
-	console.error(`Error: --messageIds is required for ${values.type}\n`);
-	process.exit(1);
-}
-
-// Validation for mailbox management events
-if (
-	["MAILBOX_CREATE", "MAILBOX_DELETE"].includes(values.type) &&
-	!values.path
-) {
-	console.error(`Error: --path is required for ${values.type}\n`);
-	process.exit(1);
-}
-
-if (
-	["MAILBOX_CREATE", "MAILBOX_RENAME", "MAILBOX_DELETE"].includes(
-		values.type,
-	) &&
-	!values.mailboxId
-) {
-	console.error(`Error: --mailboxId is required for ${values.type}\n`);
-	process.exit(1);
-}
-
-if (values.type === "MAILBOX_RENAME" && (!values.oldPath || !values.newPath)) {
-	console.error(
-		`Error: --oldPath and --newPath are required for ${values.type}\n`,
-	);
-	process.exit(1);
-}
-
-// Build the event based on type
-const buildEvent = () => {
-	switch (values.type) {
-		case "SYNC_MAILBOXES":
-			return {
-				type: "SYNC_MAILBOXES" as const,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				accountId: values.accountId!,
-			};
-		case "SYNC_MESSAGES":
-			return {
-				type: "SYNC_MESSAGES" as const,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				accountId: values.accountId!,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				mailboxId: values.mailboxId!,
-				fullSync: values.fullSync,
-			};
-		case "SYNC_MESSAGE_BODY":
-			return {
-				type: "SYNC_MESSAGE_BODY" as const,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				accountId: values.accountId!,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				mailboxId: values.mailboxId!,
-				messageIds: values.messageIds?.split(",").map((id) => id.trim()),
-			};
-		case "MAILBOX_CREATE":
-			return {
-				type: "MAILBOX_CREATE" as const,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				accountId: values.accountId!,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				mailboxId: values.mailboxId!,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				path: values.path!,
-				subscribe: values.subscribe,
-			};
-		case "MAILBOX_RENAME":
-			return {
-				type: "MAILBOX_RENAME" as const,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				accountId: values.accountId!,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				mailboxId: values.mailboxId!,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				oldPath: values.oldPath!,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				newPath: values.newPath!,
-			};
-		case "MAILBOX_DELETE":
-			return {
-				type: "MAILBOX_DELETE" as const,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				accountId: values.accountId!,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				mailboxId: values.mailboxId!,
-				// biome-ignore lint/style/noNonNullAssertion: value is guaranteed by caller contract
-				path: values.path!,
-			};
-		default:
-			throw new Error(`Unknown event type: ${values.type}`);
-	}
-};
-
-const event = buildEvent();
-
-setWorkerQueues(sqsWorkerQueues(workerQueueUrlsFromEnv()));
-
-console.log(`Enqueueing ${event.type} event for account ${event.accountId}...`);
-
-emitEvent(event)
-	.then(() => {
-		console.log("Event enqueued successfully");
-		process.exit(0);
-	})
-	.catch((error) => {
-		console.error("Failed to enqueue event:", error);
-		process.exit(1);
-	});