@remit/mailbox-service 0.0.105 → 0.0.106

package/package.json

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

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);