@remit/imap-worker 0.0.46 → 0.0.48

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/imap-worker",
-  "version": "0.0.46",
+  "version": "0.0.48",
   "type": "module",
   "main": "dist/index.js",
   "exports": {

package/src/handlers/append-sent-message.test.ts

@@ -31,12 +31,7 @@ interface Harness {
 		deletedAt?: number;
 	};
 	outbox: Record<string, unknown>;
-	specialUseSent: { mailboxId: string; fullPath: string } | null;
-	mailboxes: {
-		mailboxId: string;
-		fullPath: string;
-		hierarchyDelimiter: string;
-	}[];
+	sentMailbox: { mailboxId: string; fullPath: string } | null;
 	append: (
 		path: string,
 		raw: Buffer,
@@ -72,15 +67,7 @@ const fresh = (): Harness => ({
 		inReplyTo: "parent@example.com",
 		sentAt: 1700000000000,
 	},
-	specialUseSent: { mailboxId: "sent-mbx", fullPath: "Sent" },
-	mailboxes: [
-		{ mailboxId: "inbox-mbx", fullPath: "INBOX", hierarchyDelimiter: "/" },
-		{
-			mailboxId: "sent-items-mbx",
-			fullPath: "Sent Items",
-			hierarchyDelimiter: "/",
-		},
-	],
+	sentMailbox: { mailboxId: "sent-mbx", fullPath: "INBOX/Sent" },
 	append: async (path, raw, flags) => {
 		h.calls.push({ method: "connection.append", args: [path, raw, flags] });
 		return { uid: 55, uidValidity: 7 };
@@ -107,10 +94,7 @@ const deps = (): AppendSentMessageDeps =>
 				discardAll: record("outboxAttachment.discardAll"),
 			},
 			mailboxSpecialUse: {
-				findBySpecialUse: async () => h.specialUseSent,
-			},
-			mailbox: {
-				listAllByAccount: async () => h.mailboxes,
+				findSentMailbox: async () => h.sentMailbox,
 			},
 			secrets: {},
 		}),
@@ -141,6 +125,27 @@ const event: AppendSentMessageEvent = {
 const called = (method: string): Call[] =>
 	h.calls.filter((c) => c.method === method);
 
+type BackendClient = Awaited<ReturnType<AppendSentMessageDeps["getClient"]>>;
+
+const depsWithFailingDelete = (): AppendSentMessageDeps => {
+	const base = deps();
+	return {
+		...base,
+		getClient: async (): Promise<BackendClient> => {
+			const client = await base.getClient();
+			return {
+				...client,
+				outboxMessage: {
+					...client.outboxMessage,
+					delete: async (): Promise<void> => {
+						throw new Error("storage down");
+					},
+				},
+			};
+		},
+	};
+};
+
 describe("handleAppendSentMessage", () => {
 	beforeEach(() => {
 		h = fresh();
@@ -150,7 +155,7 @@ describe("handleAppendSentMessage", () => {
 		await handleAppendSentMessage(event, noopLog, 1, deps());
 
 		const append = called("connection.append")[0];
-		assert.equal(append?.args[0], "Sent");
+		assert.equal(append?.args[0], "INBOX/Sent");
 		assert.deepEqual(append?.args[2], ["\\Seen"]);
 		assert.deepEqual(called("outboxMessage.delete")[0]?.args, [
 			"cfg-1",
@@ -194,60 +199,8 @@ describe("handleAppendSentMessage", () => {
 		assert.match(raw, /^From: alice@example\.com$/m);
 	});
 
-	it("falls back to a conventionally-named Sent folder when no special-use flag is set", async () => {
-		h.specialUseSent = null;
-
-		await handleAppendSentMessage(event, noopLog, 1, deps());
-
-		assert.equal(called("connection.append")[0]?.args[0], "Sent Items");
-	});
-
-	it("files into a Sent folder nested under INBOX when no special-use flag is set", async () => {
-		h.specialUseSent = null;
-		h.mailboxes = [
-			{ mailboxId: "inbox-mbx", fullPath: "INBOX", hierarchyDelimiter: "/" },
-			{
-				mailboxId: "sent-mbx",
-				fullPath: "INBOX/Sent",
-				hierarchyDelimiter: "/",
-			},
-			{
-				mailboxId: "sent-messages-mbx",
-				fullPath: "INBOX/Sent Messages",
-				hierarchyDelimiter: "/",
-			},
-		];
-
-		await handleAppendSentMessage(event, noopLog, 1, deps());
-
-		assert.equal(called("connection.append")[0]?.args[0], "INBOX/Sent");
-		assert.deepEqual(called("outboxMessage.delete")[0]?.args, [
-			"cfg-1",
-			"out-1",
-		]);
-	});
-
-	it("files into a nested Sent folder under a non-INBOX prefix and a dot delimiter", async () => {
-		h.specialUseSent = null;
-		h.mailboxes = [
-			{ mailboxId: "inbox-mbx", fullPath: "INBOX", hierarchyDelimiter: "." },
-			{
-				mailboxId: "sent-mbx",
-				fullPath: "Mail.Sent Items",
-				hierarchyDelimiter: ".",
-			},
-		];
-
-		await handleAppendSentMessage(event, noopLog, 1, deps());
-
-		assert.equal(called("connection.append")[0]?.args[0], "Mail.Sent Items");
-	});
-
 	it("settles the row as unfiled when the account has no Sent folder at all", async () => {
-		h.specialUseSent = null;
-		h.mailboxes = [
-			{ mailboxId: "inbox-mbx", fullPath: "INBOX", hierarchyDelimiter: "/" },
-		];
+		h.sentMailbox = null;
 
 		await handleAppendSentMessage(event, noopLog, 1, deps());
 
@@ -261,7 +214,7 @@ describe("handleAppendSentMessage", () => {
 		assert.deepEqual(update?.args.slice(0, 2), ["cfg-1", "out-1"]);
 		const patch = update?.args[2] as { status: string; lastError: string };
 		assert.equal(patch.status, "unfiled");
-		assert.match(patch.lastError, /no Sent folder/);
+		assert.match(patch.lastError, /no folder appointed to the Sent role/);
 	});
 
 	it("skips the append while the outbox row is not yet sent", async () => {
@@ -336,19 +289,8 @@ describe("handleAppendSentMessage", () => {
 	});
 
 	it("leaves the row alone when the APPEND landed but the delete did not", async () => {
-		const failingDeps = deps();
-		const client = await failingDeps.getClient();
-		(
-			client as unknown as { outboxMessage: { delete: () => Promise<void> } }
-		).outboxMessage.delete = async () => {
-			throw new Error("storage down");
-		};
-
 		await assert.rejects(
-			handleAppendSentMessage(event, noopLog, APPEND_SENT_MAX_ATTEMPTS, {
-				...failingDeps,
-				getClient: async () => client,
-			} as AppendSentMessageDeps),
+			handleAppendSentMessage(event, noopLog, 1, depsWithFailingDelete()),
 			/storage down/,
 		);
 
@@ -356,4 +298,18 @@ describe("handleAppendSentMessage", () => {
 		// would say the opposite.
 		assert.equal(called("outboxMessage.update").length, 0);
 	});
+
+	it("stops redelivering a landed APPEND at the budget instead of filing another copy", async () => {
+		// A redelivery starts from the top and appends again, so retrying past the
+		// budget files one copy per attempt in the user's Sent folder (#830).
+		await handleAppendSentMessage(
+			event,
+			noopLog,
+			APPEND_SENT_MAX_ATTEMPTS,
+			depsWithFailingDelete(),
+		);
+
+		assert.equal(called("connection.append").length, 1);
+		assert.equal(called("outboxMessage.update").length, 0);
+	});
 });

package/src/handlers/append-sent-message.ts

@@ -1,9 +1,5 @@
 import { getClient } from "@remit/backend/client";
-import type {
-	IMailboxRepository,
-	IMailboxSpecialUseRepository,
-} from "@remit/data-ports";
-import { MailboxSpecialUse, OutboxMessageStatus } from "@remit/domain-enums";
+import { OutboxMessageStatus } from "@remit/domain-enums";
 import type { Logger } from "@remit/logger-lambda";
 import {
 	buildMailMessage,
@@ -12,29 +8,11 @@ import {
 import { isAccountDeleted } from "../account-check.js";
 import { createConnectionScopeWithCredentials } from "../connection-scope.js";
 import type { AppendSentMessageEvent } from "../events.js";
-import { resolveSentMailboxByName } from "../sent-mailbox.js";
 import { withOAuthLifecycle } from "../with-oauth-lifecycle.js";
 import { buildLifecycleDeps } from "../with-oauth-lifecycle-deps.js";
 
-const findSentMailbox = async (
-	mailboxSpecialUseService: IMailboxSpecialUseRepository,
-	mailboxService: IMailboxRepository,
-	accountId: string,
-): Promise<{ mailboxId: string; fullPath: string } | null> => {
-	const bySpecialUse = await mailboxSpecialUseService.findBySpecialUse(
-		accountId,
-		MailboxSpecialUse.Sent,
-	);
-	if (bySpecialUse) {
-		return bySpecialUse;
-	}
-
-	const mailboxes = await mailboxService.listAllByAccount(accountId);
-	return resolveSentMailboxByName(mailboxes);
-};
-
 const UNFILED_NO_SENT_MAILBOX =
-	"Sent, but not filed: this account has no Sent folder. Create one named Sent and later messages will be filed there.";
+	"Sent, but not filed: this account has no folder appointed to the Sent role and none that a Sent folder could be recognised by. Appoint one in the account's folder settings and later messages will be filed there.";
 
 const UNFILED_SIGNED_OUT =
 	"Sent, but not filed: this account has to be signed in again before a copy can be stored in Sent.";
@@ -100,7 +78,6 @@ export const handleAppendSentMessage = async (
 		outboxMessage: outboxMessageService,
 		outboxAttachment: outboxAttachmentService,
 		mailboxSpecialUse: mailboxSpecialUseService,
-		mailbox: mailboxService,
 		secrets,
 	} = await getClient();
 
@@ -144,11 +121,7 @@ export const handleAppendSentMessage = async (
 		);
 	};
 
-	const sentMailbox = await findSentMailbox(
-		mailboxSpecialUseService,
-		mailboxService,
-		accountId,
-	);
+	const sentMailbox = await mailboxSpecialUseService.findSentMailbox(accountId);
 	if (!sentMailbox) {
 		await settleUnfiled(UNFILED_NO_SENT_MAILBOX);
 		return;
@@ -220,16 +193,27 @@ export const handleAppendSentMessage = async (
 			// attempt to pick up. At the budget the record would dead-letter, and a
 			// dead-lettered APPEND is exactly how a delivered message goes missing.
 			//
-			// Once the APPEND itself has landed the copy is in Sent whatever else
-			// failed, so that case keeps the plain retry semantics.
-			if (appended || receiveCount < APPEND_SENT_MAX_ATTEMPTS) throw error;
+			// The budget binds whether or not the APPEND landed. A redelivery
+			// starts from the top and appends again, so an unbudgeted retry files
+			// one copy per attempt in the user's Sent folder.
+			if (receiveCount < APPEND_SENT_MAX_ATTEMPTS) throw error;
 			return error;
 		},
 	);
 
-	// The APPEND landed: the copy is in Sent even if the row delete that follows
-	// it failed, so there is nothing to settle and a retry may still run.
-	if (appended) return;
+	// The APPEND landed: the copy is in Sent whatever failed after it, so there
+	// is nothing to settle as unfiled. A row that outlives its delete holds
+	// `sent`, which every view hides, until the migrator's boot-time stranded-row
+	// repair settles it — the next container start, not sooner (#824).
+	if (appended) {
+		if (failure) {
+			log.error(
+				{ accountId, outboxMessageId, reason: String(failure) },
+				"Sent message was filed but its outbox row survived its delete and stays hidden until the boot-time repair",
+			);
+		}
+		return;
+	}
 
 	// A terminal auth failure returns here without throwing — withOAuthLifecycle
 	// flips the account to reauth_required and ACKs the record, which without

package/src/handlers/sync-messages.ts

@@ -383,6 +383,7 @@ const syncMailboxMessages = async (
 	const syncService = new MessageSyncService(
 		connectionFactory,
 		mailboxService,
+		mailboxSpecialUseService,
 		messageService,
 		envelopeService,
 		addressService,

package/src/sent-mailbox.test.ts

@@ -1,112 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import {
-	resolveSentMailboxByName,
-	type SentMailboxCandidate,
-} from "./sent-mailbox.js";
-
-const mailbox = (
-	fullPath: string,
-	hierarchyDelimiter = "/",
-): SentMailboxCandidate => ({
-	mailboxId: `mbx-${fullPath}`,
-	fullPath,
-	hierarchyDelimiter,
-});
-
-describe("resolveSentMailboxByName", () => {
-	it("finds a top-level Sent folder", () => {
-		const found = resolveSentMailboxByName([mailbox("INBOX"), mailbox("Sent")]);
-
-		assert.equal(found?.fullPath, "Sent");
-	});
-
-	it("finds a Sent folder nested under INBOX", () => {
-		const found = resolveSentMailboxByName([
-			mailbox("INBOX"),
-			mailbox("INBOX/Archive"),
-			mailbox("INBOX/Sent"),
-		]);
-
-		assert.equal(found?.fullPath, "INBOX/Sent");
-	});
-
-	it("finds a nested Sent folder under a non-INBOX prefix with a non-slash delimiter", () => {
-		const found = resolveSentMailboxByName([
-			mailbox("Mail.Drafts", "."),
-			mailbox("Mail.Sent Items", "."),
-		]);
-
-		assert.equal(found?.fullPath, "Mail.Sent Items");
-	});
-
-	it("finds the Gmail Sent folder by its leaf name", () => {
-		const found = resolveSentMailboxByName([
-			mailbox("INBOX"),
-			mailbox("[Gmail]/All Mail"),
-			mailbox("[Gmail]/Sent Mail"),
-		]);
-
-		assert.equal(found?.fullPath, "[Gmail]/Sent Mail");
-	});
-
-	it("prefers the shallowest folder when several leaves match", () => {
-		const found = resolveSentMailboxByName([
-			mailbox("INBOX/Clients/Sent"),
-			mailbox("INBOX/Sent"),
-		]);
-
-		assert.equal(found?.fullPath, "INBOX/Sent");
-	});
-
-	it("prefers the plain Sent name over the longer variants", () => {
-		const found = resolveSentMailboxByName([
-			mailbox("INBOX/Sent Messages"),
-			mailbox("INBOX/Sent"),
-		]);
-
-		assert.equal(found?.fullPath, "INBOX/Sent");
-	});
-
-	it("matches the leaf regardless of case", () => {
-		const found = resolveSentMailboxByName([mailbox("INBOX.sent items", ".")]);
-
-		assert.equal(found?.fullPath, "INBOX.sent items");
-	});
-
-	it("does not match a folder that merely starts with a Sent name", () => {
-		const found = resolveSentMailboxByName([
-			mailbox("INBOX/Sent Archive 2024"),
-			mailbox("INBOX/Sentinel"),
-		]);
-
-		assert.equal(found, null);
-	});
-
-	it("prefers a shallower Sent over a deeper better-named one", () => {
-		const found = resolveSentMailboxByName([
-			mailbox("INBOX.Sent Items", "."),
-			mailbox("INBOX.Trash.Sent", "."),
-		]);
-
-		assert.equal(found?.fullPath, "INBOX.Sent Items");
-	});
-
-	it("resolves a flat namespace that reports no delimiter at all", () => {
-		const found = resolveSentMailboxByName([
-			mailbox("INBOX", ""),
-			mailbox("Sent", ""),
-		]);
-
-		assert.equal(found?.fullPath, "Sent");
-	});
-
-	it("returns null when the account has no Sent folder", () => {
-		const found = resolveSentMailboxByName([
-			mailbox("INBOX"),
-			mailbox("INBOX/Trash"),
-		]);
-
-		assert.equal(found, null);
-	});
-});

package/src/sent-mailbox.ts

@@ -1,20 +0,0 @@
-import type { MailboxItem } from "@remit/data-ports";
-import { resolveMailboxByLeafName } from "@remit/data-ports/mailbox-name";
-
-export type SentMailboxCandidate = Pick<
-	MailboxItem,
-	"mailboxId" | "fullPath" | "hierarchyDelimiter"
->;
-
-const SENT_FOLDER_NAMES = ["sent", "sent items", "sent messages", "sent mail"];
-
-/**
- * The Sent folder by conventional name, for servers that advertise no `\Sent`
- * special-use. Matches the folder's own leaf segment, so it resolves at any
- * depth under any prefix (`INBOX/Sent`, `Mail.Sent Items`, `[Gmail]/Sent Mail`)
- * without knowing which prefixes a server uses.
- */
-export const resolveSentMailboxByName = (
-	mailboxes: SentMailboxCandidate[],
-): SentMailboxCandidate | null =>
-	resolveMailboxByLeafName(mailboxes, SENT_FOLDER_NAMES);