@remit/mailbox-service 0.0.104 → 0.0.106

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/mailbox-service",
-  "version": "0.0.104",
+  "version": "0.0.106",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/index.ts

@@ -219,6 +219,8 @@ export {
 	FolderRenameSettleError,
 	isMailboxAbsentUpstream,
 	isMailboxPresentUpstream,
+	isMailboxRefusedUpstream,
+	upstreamFailureReason,
 } from "./mailbox-upstream.js";
 export {
 	denormalizeMessageCategory,

package/src/mailbox-delete-intent.test.ts

@@ -227,7 +227,7 @@ describe("MailboxManagementService.failDelete", () => {
 		]);
 		const service = new MailboxManagementService(repo);
 
-		await service.failDelete("acc-1", "mbx-1");
+		await service.failDelete("acc-1", "mbx-1", "Permission denied");
 
 		assert.equal(byId.get("mbx-1")?.syncStatus, MailboxSyncStatus.failed);
 		assert.equal(byId.get("mbx-1")?.fullPath, "Receipts");
@@ -239,7 +239,7 @@ describe("MailboxManagementService.failDelete", () => {
 		const service = new MailboxManagementService(repo);
 
 		await assert.rejects(
-			service.failDelete("acc-1", "mbx-1"),
+			service.failDelete("acc-1", "mbx-1", "Permission denied"),
 			(error: unknown) => (error as Error).name === "NotFoundError",
 		);
 	});

package/src/mailbox-management.ts

@@ -598,6 +598,7 @@ export class MailboxManagementService {
 		mailboxId: string,
 		oldPath: string,
 		newPath: string,
+		reason: string,
 	): Promise<void> => {
 		const root = await this.mailboxService
 			.get(accountId, mailboxId)
@@ -643,6 +644,7 @@ export class MailboxManagementService {
 					from: [MailboxSyncStatus.pending],
 					wherePendingPath: row.pendingPath,
 					to: MailboxSyncStatus.failed,
+					set: { syncFailureReason: reason },
 				},
 			);
 			this.log.info(
@@ -811,10 +813,15 @@ export class MailboxManagementService {
 	 * target is written, which is how the client tells a failed delete from a
 	 * failed rename.
 	 */
-	failDelete = async (accountId: string, mailboxId: string): Promise<void> => {
+	failDelete = async (
+		accountId: string,
+		mailboxId: string,
+		reason: string,
+	): Promise<void> => {
 		const failed = await this.mailboxService.transition(accountId, mailboxId, {
 			from: [MailboxSyncStatus.deleting],
 			to: MailboxSyncStatus.failed,
+			set: { syncFailureReason: reason },
 		});
 		if (!failed) throw new NotFoundError(`Mailbox not found: ${mailboxId}`);
 		this.log.info(

package/src/mailbox-rename-subtree.test.ts

@@ -361,7 +361,13 @@ describe("MailboxManagementService.syncRename — rows it must not claim", () =>
 		]);
 		const service = new MailboxManagementService(repo);
 
-		await service.failRename("acc-1", "mbx-parent", "Work", "Projects");
+		await service.failRename(
+			"acc-1",
+			"mbx-parent",
+			"Work",
+			"Projects",
+			"Permission denied",
+		);
 
 		assert.equal(rowOf("mbx-parent")?.syncStatus, MailboxSyncStatus.failed);
 		assert.equal(rowOf("mbx-other")?.syncStatus, MailboxSyncStatus.pending);
@@ -572,7 +578,13 @@ describe("MailboxManagementService.failRename", () => {
 		]);
 		const service = new MailboxManagementService(repo);
 
-		await service.failRename("acc-1", "mbx-parent", "Work", "Projects");
+		await service.failRename(
+			"acc-1",
+			"mbx-parent",
+			"Work",
+			"Projects",
+			"Permission denied",
+		);
 
 		for (const [id, path, target] of [
 			["mbx-parent", "Work", "Projects"],
@@ -593,7 +605,13 @@ describe("MailboxManagementService.failRename", () => {
 		const service = new MailboxManagementService(repo);
 
 		await assert.rejects(
-			service.failRename("acc-1", "mbx-parent", "Work", "Projects"),
+			service.failRename(
+				"acc-1",
+				"mbx-parent",
+				"Work",
+				"Projects",
+				"Permission denied",
+			),
 			(error: unknown) => (error as Error).name === "NotFoundError",
 		);
 	});
@@ -606,7 +624,13 @@ describe("MailboxManagementService.failRename", () => {
 		const service = new MailboxManagementService(repo);
 
 		await assert.doesNotReject(
-			service.failRename("acc-1", "mbx-parent", "Work", "Projects"),
+			service.failRename(
+				"acc-1",
+				"mbx-parent",
+				"Work",
+				"Projects",
+				"Permission denied",
+			),
 		);
 	});
 
@@ -627,7 +651,13 @@ describe("MailboxManagementService.failRename", () => {
 			/not ready/,
 		);
 
-		await service.failRename("acc-1", "mbx-parent", "Work", "Projects");
+		await service.failRename(
+			"acc-1",
+			"mbx-parent",
+			"Work",
+			"Projects",
+			"Permission denied",
+		);
 		assert.equal(rowOf("mbx-parent")?.syncStatus, MailboxSyncStatus.failed);
 		assert.equal(rowOf("mbx-parent")?.fullPath, "Work");
 	});

package/src/mailbox-upstream.ts

@@ -36,6 +36,18 @@ export const isMailboxPresentUpstream = (error: unknown): boolean => {
 	return /already exists/i.test(saidByServer(error));
 };
 
+const PERMANENT_REFUSALS = new Set(["NOPERM", "CANNOT"]);
+
+export const isMailboxRefusedUpstream = (error: unknown): boolean =>
+	error instanceof Error &&
+	PERMANENT_REFUSALS.has(stringField(error, "serverResponseCode"));
+
+export const upstreamFailureReason = (error: unknown): string => {
+	const serverText = stringField(error, "responseText").trim();
+	if (serverText.length > 0) return serverText;
+	return error instanceof Error ? error.message : String(error);
+};
+
 /**
  * Something after the server RENAME failed — the local settle, not the
  * mutation. The rename landed, so this is never a refused rename: marking the

package/src/outbox-failed-recovery.test.ts

@@ -125,7 +125,9 @@ const createHarness = (
 		outboxAttachmentService: {
 			unfinishedUpload: async () => undefined,
 		} as unknown as OutboxAttachmentService,
-		accountService: {} as unknown as IAccountRepository,
+		accountService: {
+			get: async () => ({ syncedServices: ["Mail"] }),
+		} as unknown as IAccountRepository,
 		sqsSmtpQueueUrl: "http://localhost/queue",
 		sqsClient: {
 			send: async (command: { input: { MessageBody: string } }) => {

package/src/outbox-queue-settled-row.test.ts

@@ -89,7 +89,9 @@ const createHarness = (stored: OutboxMessageItem): Harness => {
 			},
 			unfinishedUpload: async () => undefined,
 		} as unknown as OutboxAttachmentService,
-		accountService: {} as unknown as IAccountRepository,
+		accountService: {
+			get: async () => ({ syncedServices: ["Mail"] }),
+		} as unknown as IAccountRepository,
 		sqsSmtpQueueUrl: "http://localhost/queue",
 		sqsClient: {
 			send: async (command: { input: { MessageBody: string } }) => {

package/src/outbox-queue.test.ts

@@ -18,7 +18,7 @@ import type {
 	OutboxAttachmentItem,
 	OutboxMessageItem,
 } from "@remit/data-ports";
-import { BadRequestError } from "@remit/data-ports/errors";
+import { BadRequestError, MailSyncOffError } from "@remit/data-ports/errors";
 import { OutboxMessageStatus } from "@remit/domain-enums";
 import type { OutboxAttachmentService } from "./outbox-attachment.js";
 import { OutboxQueueService } from "./outbox-queue.js";
@@ -55,6 +55,7 @@ const createHarness = (
 	stored: OutboxMessageItem,
 	attachments: OutboxAttachmentItem[] = [],
 	lateAttachments: OutboxAttachmentItem[] = [],
+	syncedServices: string[] = ["Mail"],
 ): Harness => {
 	let unfinishedChecks = 0;
 	const harness: Harness = {
@@ -98,7 +99,9 @@ const createHarness = (
 				return held.find((item) => item.state !== "Stored");
 			},
 		} as unknown as OutboxAttachmentService,
-		accountService: {} as unknown as IAccountRepository,
+		accountService: {
+			get: async () => ({ syncedServices }),
+		} as unknown as IAccountRepository,
 		sqsSmtpQueueUrl: "http://localhost/queue",
 		sqsClient: {
 			send: async (command: { input: { MessageBody: string } }) => {
@@ -241,3 +244,48 @@ describe("OutboxQueueService and a message with nowhere to go", () => {
 		assert.equal(harness.enqueued.length, 1);
 	});
 });
+
+describe("OutboxQueueService and an account with mail off", () => {
+	const refusesWithTheFix = (error: unknown): boolean => {
+		assert.ok(error instanceof MailSyncOffError);
+		assert.equal(error.statusCode, 400);
+		assert.equal(error.publicApiError?.code, "mail_sync_off");
+		assert.match(error.message, /Turn Mail back on .* in Settings/);
+		return true;
+	};
+
+	it("refuses to queue a stored draft and leaves it a draft", async () => {
+		const harness = createHarness(draft({}), [], [], ["Calendar"]);
+
+		await assert.rejects(
+			() => harness.service.send(ACCOUNT_CONFIG_ID, OUTBOX_MESSAGE_ID),
+			refusesWithTheFix,
+		);
+
+		assert.deepEqual(harness.statusWrites, []);
+		assert.deepEqual(harness.enqueued, []);
+	});
+
+	it("refuses a send-immediately create before writing a row", async () => {
+		const harness = createHarness(draft({}), [], [], ["Calendar"]);
+
+		await assert.rejects(
+			() =>
+				harness.service.createAndSend(
+					sendInput({ toAddresses: ["them@example.com"] }),
+				),
+			refusesWithTheFix,
+		);
+
+		assert.equal(harness.created, 0);
+		assert.deepEqual(harness.enqueued, []);
+	});
+
+	it("sends from an account syncing mail and calendar", async () => {
+		const harness = createHarness(draft({}), [], [], ["Mail", "Calendar"]);
+
+		await harness.service.send(ACCOUNT_CONFIG_ID, OUTBOX_MESSAGE_ID);
+
+		assert.equal(harness.enqueued.length, 1);
+	});
+});

package/src/outbox-queue.ts

@@ -5,8 +5,12 @@ import type {
 	IOutboxMessageRepository,
 	OutboxMessageItem,
 } from "@remit/data-ports";
-import { BadRequestError, ConflictError } from "@remit/data-ports/errors";
-import { OutboxMessageStatus } from "@remit/domain-enums";
+import {
+	BadRequestError,
+	ConflictError,
+	MailSyncOffError,
+} from "@remit/data-ports/errors";
+import { AccountService, OutboxMessageStatus } from "@remit/domain-enums";
 import { createQueueProducer } from "@remit/sqs-client/producer";
 import type { OutboxAttachmentService } from "./outbox-attachment.js";
 import { isOpenForWork } from "./outbox-status.js";
@@ -88,6 +92,9 @@ const hasNowhereToGo = (message: {
 const NO_RECIPIENT_MESSAGE =
 	"This message has nobody to send to. Add a recipient before sending it.";
 
+const MAIL_SYNC_OFF_SEND_MESSAGE =
+	"Mail is turned off for this account, so it cannot send. Turn Mail back on for this account in Settings to send from it.";
+
 const ENQUEUE_FAILED_MESSAGE =
 	"This message could not be handed to the outgoing queue, so it was not sent. Send it again.";
 
@@ -250,6 +257,12 @@ export class OutboxQueueService {
 		return updated;
 	};
 
+	private refuseWithoutMail = async (accountId: string): Promise<void> => {
+		const account = await this.accountService.get(accountId);
+		if (account.syncedServices.includes(AccountService.Mail)) return;
+		throw new MailSyncOffError(MAIL_SYNC_OFF_SEND_MESSAGE, accountId);
+	};
+
 	send = async (
 		accountConfigId: string,
 		outboxMessageId: string,
@@ -268,6 +281,7 @@ export class OutboxQueueService {
 		if (hasNowhereToGo(existing)) {
 			throw new BadRequestError(NO_RECIPIENT_MESSAGE);
 		}
+		await this.refuseWithoutMail(existing.accountId);
 
 		const unfinished = await this.outboxAttachmentService.unfinishedUpload(
 			accountConfigId,
@@ -339,6 +353,7 @@ export class OutboxQueueService {
 		if (hasNowhereToGo(input)) {
 			throw new BadRequestError(NO_RECIPIENT_MESSAGE);
 		}
+		await this.refuseWithoutMail(input.accountId);
 
 		const domain = extractDomain(input.fromAddress);
 		const messageIdValue = generateMessageId(domain);