@remit/imap-worker 0.0.1 → 0.0.3

package/package.json

@@ -1,50 +1,60 @@
 {
-	"name": "@remit/imap-worker",
-	"version": "0.0.1",
-	"type": "module",
-	"main": "dist/index.js",
-	"bin": {
-		"remit-worker": "./dist/cli.js"
-	},
-	"scripts": {
-		"bundle": "esbuild src/index.ts --sourcemap --bundle --platform=node --format=esm --outfile=dist/index.js",
-		"cli": "node --env-file=../../localhost-dev-aws.env src/cli.ts",
-		"test:typecheck": "tsgo --noEmit",
-		"test:run": "node --env-file=../../localhost-test-unit.env --test 'src/**/*.test.ts'",
-		"test": "npm run test:typecheck && npm run test:run"
-	},
-	"devDependencies": {
-		"@aws-sdk/client-sqs": "*",
-		"@aws-sdk/client-ssm": "*",
-		"@aws-sdk/core": "*",
-		"@remit/backend": "*",
-		"@remit/data-ports": "*",
-		"@remit/domain-enums": "*",
-		"@remit/logger-lambda": "*",
-		"@remit/mail-oauth-service": "*",
-		"@remit/mailbox-service": "*",
-		"@remit/search-index-worker": "*",
-		"@remit/secrets-service": "*",
-		"@remit/sqs-client": "*",
-		"@remit/storage-service": "*",
-		"@types/aws-lambda": "*",
-		"@types/nodemailer": "*",
-		"aws-sdk-client-mock": "*",
-		"esbuild": "^0.27.7",
-		"expect-env": "*",
-		"p-map": "*"
-	},
-	"dependencies": {
-		"@aws-sdk/client-s3": "^3.1055.0",
-		"nodemailer": "^9.0.3"
-	},
-	"license": "MIT",
-	"publishConfig": {
-		"access": "public"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/remit-mail/remit.git",
-		"directory": "packages/imap-worker"
-	}
+  "name": "@remit/imap-worker",
+  "version": "0.0.3",
+  "type": "module",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    },
+    "./scheduler": {
+      "types": "./src/scheduler/handler.ts",
+      "default": "./src/scheduler/handler.ts"
+    }
+  },
+  "bin": {
+    "remit-worker": "./dist/cli.js"
+  },
+  "scripts": {
+    "bundle": "esbuild src/index.ts --sourcemap --bundle --platform=node --format=esm --outfile=dist/index.js",
+    "cli": "node --env-file=../../localhost-dev-aws.env src/cli.ts",
+    "test:typecheck": "tsgo --noEmit",
+    "test:run": "node --env-file=../../localhost-test-unit.env --test 'src/**/*.test.ts'",
+    "test": "npm run test:typecheck && npm run test:run"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-sqs": "*",
+    "@aws-sdk/client-ssm": "*",
+    "@aws-sdk/core": "*",
+    "@remit/storage-service": "*",
+    "@types/aws-lambda": "*",
+    "@types/nodemailer": "*",
+    "aws-sdk-client-mock": "*",
+    "esbuild": "^0.27.7",
+    "expect-env": "*",
+    "p-map": "*"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.1055.0",
+    "nodemailer": "^9.0.3",
+    "@remit/data-ports": "*",
+    "@remit/logger-lambda": "*",
+    "@remit/mailbox-service": "*",
+    "@remit/search-index-worker": "*",
+    "@remit/sqs-client": "*",
+    "@remit/backend": "*",
+    "@remit/domain-enums": "*",
+    "@remit/mail-oauth-service": "*",
+    "@remit/secrets-service": "*"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/remit-mail/remit.git",
+    "directory": "packages/imap-worker"
+  }
 }

package/src/handlers/sync-message-body.test.ts

@@ -1,11 +1,18 @@
 import assert from "node:assert";
-import { afterEach, describe, mock, test } from "node:test";
+import { afterEach, before, describe, mock, test } from "node:test";
 import { SendMessageCommand, SQSClient } from "@aws-sdk/client-sqs";
 import { GetParameterCommand, SSMClient } from "@aws-sdk/client-ssm";
-import { getClient } from "@remit/backend/client";
+import {
+	getClient,
+	type RemitClient,
+	setClient,
+} from "@remit/backend/client";
 import type { AccountItem, MailboxItem } from "@remit/data-ports";
 import type { Logger } from "@remit/logger-lambda";
-import { BodySyncService, type SyncedMessage } from "@remit/mailbox-service";
+import {
+	BodySyncService,
+	type SyncedMessage,
+} from "@remit/mailbox-service";
 import { mockClient } from "aws-sdk-client-mock";
 import { resetBodySyncGateCache } from "../body-sync-gate.js";
 import { __warmPoolSizeForTest } from "../connection-scope.js";
@@ -221,6 +228,28 @@ describe("syncMessageBody — DLQ propagation (integrated, #1270)", () => {
 	const cappedMailbox = (): MailboxItem =>
 		({ fullPath: "INBOX" }) as unknown as MailboxItem;
 
+	// On the DynamoDB path (main repo, DATA_BACKEND unset) the client is injected
+	// by the composition root; register a client whose repositories these tests
+	// then mock. On the relational path (reader, DATA_BACKEND=postgres) getClient
+	// builds its own client and this injection is inert.
+	before(() => {
+		setClient({
+			account: { get: async () => cappedAccount() },
+			mailbox: { get: async () => cappedMailbox() },
+			mailboxSpecialUse: {},
+			message: {},
+			threadMessage: {},
+			address: {},
+			envelope: {},
+			placementMove: {},
+			filter: {},
+			filterAnchor: {},
+			messageLabel: {},
+			storage: {},
+			secrets: { decrypt: async () => "fake-password" },
+		} as unknown as RemitClient);
+	});
+
 	afterEach(() => {
 		mock.restoreAll();
 		mockClient(SSMClient).reset();

package/src/scheduler/run-tick.test.ts

@@ -1,7 +1,10 @@
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
 import type { SendMessageCommand, SQSClient } from "@aws-sdk/client-sqs";
-import type { AccountItem, AccountSchedulerPage } from "@remit/data-ports";
+import type {
+	AccountItem,
+	AccountSchedulerPage,
+} from "@remit/data-ports";
 import type { Logger } from "@remit/logger-lambda";
 import { runSchedulerTick } from "./run-tick.js";
 

package/src/handlers/sync-messages-deleted-account.test.ts

@@ -1,141 +0,0 @@
-/**
- * A SYNC_MESSAGES trigger can outlive its account: deletion does not purge the
- * already-queued triggers in lockstep, so a trigger can reference an account
- * whose DDB row is gone. The lookup then raises NotFoundError. That error can
- * never succeed on retry, so it would retry to maxReceiveCount and poison the
- * messages DLQ forever (issue #911).
- *
- * Contract under test:
- *  - missing account (get throws NotFoundError) -> acked + WARN, never thrown
- *  - soft-deleted account (deletedAt set)       -> acked, never thrown
- *  - healthy account                            -> proceeds past the gate (the
- *      handler does real work and fails without a live IMAP server) — proving a
- *      healthy trigger is NOT silently dropped
- *  - transient error (a non-NotFound error)     -> propagates, so SQS retries
- */
-
-import assert from "node:assert/strict";
-import { afterEach, describe, it, mock } from "node:test";
-import {
-	_resetForTest,
-	_setClientForTest,
-	type RemitClient,
-} from "@remit/backend/client";
-import type { AccountItem } from "@remit/data-ports";
-import type { Logger } from "@remit/logger-lambda";
-import type { SyncMessagesEvent } from "../events.js";
-import { syncMessages } from "./sync-messages.js";
-
-const notFoundError = (message: string): Error => {
-	const error = new Error(message);
-	error.name = "NotFoundError";
-	return error;
-};
-
-const setAccountGet = (get: () => Promise<AccountItem>): void => {
-	_setClientForTest({ account: { get } } as unknown as RemitClient);
-};
-
-interface WarnRecord {
-	fields: Record<string, unknown>;
-	message: string;
-}
-
-const recordingLogger = (warns: WarnRecord[]): Logger => {
-	const noop = () => {};
-	const log = {
-		info: noop,
-		warn: (fields: Record<string, unknown>, message: string) => {
-			warns.push({ fields, message });
-		},
-		error: noop,
-		debug: noop,
-		fatal: noop,
-		trace: noop,
-		child: () => log,
-	} as unknown as Logger;
-	return log;
-};
-
-const healthyAccount = (): AccountItem =>
-	({
-		accountId: "acct-live",
-		accountConfigId: "acfg-live",
-		connectionState: "authenticated",
-		username: "alice@imap.example.com",
-		imapHost: "imap.example.com",
-		imapPort: 993,
-		imapTls: true,
-	}) as unknown as AccountItem;
-
-const deletedAccount = (): AccountItem =>
-	({
-		...healthyAccount(),
-		accountId: "acct-deleted",
-		deletedAt: Date.now(),
-	}) as unknown as AccountItem;
-
-const event = (accountId: string): SyncMessagesEvent =>
-	({
-		type: "SYNC_MESSAGES",
-		accountId,
-		mailboxId: "mbox-1",
-		eventId: "evt-1",
-		timestamp: 0,
-	}) as SyncMessagesEvent;
-
-afterEach(() => {
-	mock.restoreAll();
-	_resetForTest();
-});
-
-describe("syncMessages deleted/missing account drop (#911)", () => {
-	it("acks and warns when the account no longer exists", async () => {
-		setAccountGet(async () => {
-			throw notFoundError("Account not found: acct-gone");
-		});
-		const warns: WarnRecord[] = [];
-
-		await assert.doesNotReject(() =>
-			syncMessages(event("acct-gone"), recordingLogger(warns)),
-		);
-
-		const warn = warns.find((w) =>
-			w.message.includes("account no longer exists"),
-		);
-		assert.ok(warn, "expected a WARN for the missing account");
-		assert.equal(warn.fields.accountId, "acct-gone");
-		assert.equal(warn.fields.mailboxId, "mbox-1");
-		assert.equal(warn.fields.eventId, "evt-1");
-	});
-
-	it("acks a soft-deleted account without throwing", async () => {
-		setAccountGet(async () => deletedAccount());
-
-		await assert.doesNotReject(() =>
-			syncMessages(event("acct-deleted"), recordingLogger([])),
-		);
-	});
-
-	it("proceeds past the gate for a healthy account (not silently dropped)", async () => {
-		setAccountGet(async () => healthyAccount());
-
-		// No live IMAP server, so a healthy account must reach real work and fail
-		// there — the not-found gate must not swallow it as a clean ack.
-		await assert.rejects(() =>
-			syncMessages(event("acct-live"), recordingLogger([])),
-		);
-	});
-
-	it("propagates a transient error so SQS retries", async () => {
-		const transient = new Error("ProvisionedThroughputExceededException");
-		setAccountGet(async () => {
-			throw transient;
-		});
-
-		await assert.rejects(
-			() => syncMessages(event("acct-live"), recordingLogger([])),
-			transient,
-		);
-	});
-});

package/src/handlers/sync-reserved-host.test.ts

@@ -1,97 +0,0 @@
-/**
- * Handler-level guard: an account whose IMAP host is a reserved, never-resolvable
- * placeholder name (RFC 2606 — .invalid/.example) must be skipped cleanly.
- * No connection attempt, no thrown error, so SQS acks the event instead of
- * retrying it into the mailboxes DLQ forever (issue #835).
- *
- * The proof is structural: the only AccountService method the handler may touch
- * is `get`. Any of the post-connect writes (`markAuthenticated`, `update`) firing
- * would mean we passed the skip gate and tried to connect — so those are stubbed
- * to throw, and the test asserts the handler still resolves cleanly.
- */
-
-import assert from "node:assert/strict";
-import { afterEach, describe, it, mock } from "node:test";
-import {
-	_resetForTest,
-	_setClientForTest,
-	type RemitClient,
-} from "@remit/backend/client";
-import type { AccountItem } from "@remit/data-ports";
-import type { Logger } from "@remit/logger-lambda";
-import type { SyncMailboxesEvent, SyncMessagesEvent } from "../events.js";
-import { syncMailboxes } from "./sync-mailboxes.js";
-import { syncMessages } from "./sync-messages.js";
-
-const silentLogger = (() => {
-	const noop = () => {};
-	const log = {
-		info: noop,
-		warn: noop,
-		error: noop,
-		debug: noop,
-		fatal: noop,
-		trace: noop,
-		child: () => log,
-	} as unknown as Logger;
-	return log;
-})();
-
-const reservedAccount = (): AccountItem =>
-	({
-		accountId: "acct-reserved",
-		accountConfigId: "acfg-reserved",
-		connectionState: "authenticated",
-		username: "alice@imap.invalid",
-		imapHost: "imap.invalid",
-		imapPort: 993,
-		imapTls: true,
-	}) as unknown as AccountItem;
-
-const failIfReached = () => {
-	throw new Error("post-skip-gate account write must not run");
-};
-
-const setClientWithAccountGet = (get: ReturnType<typeof mock.fn>): void => {
-	_setClientForTest({
-		account: {
-			get,
-			markAuthenticated: failIfReached,
-			update: failIfReached,
-		},
-	} as unknown as RemitClient);
-};
-
-afterEach(() => {
-	mock.restoreAll();
-	_resetForTest();
-});
-
-describe("reserved-host skip gate", () => {
-	it("syncMailboxes skips a reserved host cleanly — no connect, no throw", async () => {
-		const get = mock.fn(async () => reservedAccount());
-		setClientWithAccountGet(get);
-
-		const event = {
-			type: "SYNC_MAILBOXES",
-			accountId: "acct-reserved",
-		} as unknown as SyncMailboxesEvent;
-
-		await assert.doesNotReject(() => syncMailboxes(event, silentLogger));
-		assert.equal(get.mock.callCount(), 1);
-	});
-
-	it("syncMessages skips a reserved host cleanly — no connect, no throw", async () => {
-		const get = mock.fn(async () => reservedAccount());
-		setClientWithAccountGet(get);
-
-		const event = {
-			type: "SYNC_MESSAGES",
-			accountId: "acct-reserved",
-			mailboxId: "mbox-1",
-		} as unknown as SyncMessagesEvent;
-
-		await assert.doesNotReject(() => syncMessages(event, silentLogger));
-		assert.equal(get.mock.callCount(), 1);
-	});
-});