@remit/backend 0.0.71 → 0.0.73

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/backend",
-  "version": "0.0.71",
+  "version": "0.0.73",
   "description": "Remit Mail Inspector API backend",
   "license": "MIT",
   "author": "",

package/src/error.test.ts

@@ -0,0 +1,114 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+import type { FolderRoleConflict } from "@remit/api-openapi-types";
+import {
+	ClientError,
+	FolderRoleUnresolvedError,
+	ForbiddenError,
+	UnhandledError,
+} from "@remit/data-ports/errors";
+import { NO_TRASH_FOLDER_REASON } from "@remit/data-ports/folder-role";
+import { CanonicalMailboxRole } from "@remit/domain-enums";
+import { NoTrashMailboxError } from "@remit/mailbox-service";
+import { handleError } from "./error.js";
+
+const parseBody = (body: string): Record<string, unknown> =>
+	JSON.parse(body) as Record<string, unknown>;
+
+describe("handleError coded refusals", () => {
+	it("puts the code and every detail of a folder-role 409 on the wire", async () => {
+		const response = await handleError(
+			new FolderRoleUnresolvedError(
+				"The folder you chose for Trash is gone.",
+				CanonicalMailboxRole.Trash,
+				"stale",
+				"account-7",
+			),
+		);
+
+		assert.equal(response.statusCode, 409);
+		assert.deepEqual(parseBody(response.body), {
+			message: "The folder you chose for Trash is gone.",
+			code: "folder_role_unresolved",
+			details: { role: "Trash", reason: "stale", accountId: "account-7" },
+		});
+	});
+
+	it("carries NoTrashMailboxError as the Trash role with reason none", async () => {
+		const response = await handleError(new NoTrashMailboxError("account-7"));
+
+		assert.equal(response.statusCode, 409);
+		assert.deepEqual(parseBody(response.body), {
+			message: NO_TRASH_FOLDER_REASON,
+			code: "folder_role_unresolved",
+			details: { role: "Trash", reason: "none", accountId: "account-7" },
+		});
+	});
+
+	it("keeps an unhandled 500 to a message — no stack, no cause, no code", async () => {
+		const response = await handleError(
+			new UnhandledError("Something went wrong", new Error("connection reset")),
+		);
+
+		assert.equal(response.statusCode, 500);
+		assert.deepEqual(parseBody(response.body), {
+			message: "Something went wrong",
+		});
+	});
+
+	it("strips a code a 5xx should never have carried", async () => {
+		const error = new UnhandledError("Something went wrong");
+		error.publicApiError = {
+			code: "folder_role_unresolved",
+			details: { role: "Trash", reason: "none", accountId: "account-7" },
+		};
+
+		const response = await handleError(error);
+
+		assert.equal(response.statusCode, 500);
+		assert.deepEqual(parseBody(response.body), {
+			message: "Something went wrong",
+		});
+	});
+
+	it("answers an unauthenticated request with a 401 and an error body", async () => {
+		const response = await handleError(new ClientError("Session expired"));
+
+		assert.equal(response.statusCode, 401);
+		assert.deepEqual(parseBody(response.body), { message: "Session expired" });
+	});
+
+	it("answers a forbidden request with a 403 and an error body", async () => {
+		const response = await handleError(new ForbiddenError("Not your account"));
+
+		assert.equal(response.statusCode, 403);
+		assert.deepEqual(parseBody(response.body), { message: "Not your account" });
+	});
+
+	// The contract and the emitter cannot drift apart: this asserts the response
+	// `handleError` actually builds against the generated model. Nesting the body
+	// under `error` again would leave `code` off `keyof FolderRoleConflict` and
+	// fail to compile here, long before a client reads a 409 it cannot parse.
+	it("matches the generated FolderRoleConflict model field for field", async () => {
+		const response = await handleError(
+			new FolderRoleUnresolvedError(
+				"Nobody has confirmed a Trash folder.",
+				CanonicalMailboxRole.Trash,
+				"unconfirmed",
+				"account-7",
+			),
+		);
+		const body: Omit<FolderRoleConflict, "statusCode"> = JSON.parse(
+			response.body,
+		);
+		const declaredFields: ReadonlyArray<keyof typeof body> = [
+			"code",
+			"details",
+			"message",
+		];
+
+		assert.equal(response.statusCode, 409);
+		assert.deepEqual(Object.keys(body).sort(), [...declaredFields].sort());
+		assert.equal(body.code, "folder_role_unresolved");
+	});
+});

package/src/error.ts

@@ -1,3 +1,4 @@
+import { isPublicApiError } from "@remit/data-ports/errors";
 import { logger } from "@remit/logger-lambda";
 import type { APIGatewayProxyResult } from "aws-lambda";
 import { formatResponse } from "./response.js";
@@ -15,9 +16,21 @@ export const handleError = async (
 				},
 				"Error with statusCode",
 			);
+			// Only an error that opted in gets a coded body, and only below 500:
+			// a coded 5xx is a mistake at the throw site, not a contract, and the
+			// status bound keeps it from reaching a client rather than trusting
+			// every future thrower to leave `publicApiError` alone.
+			const statusCode =
+				typeof error.statusCode === "number" ? error.statusCode : 500;
+			const publicApiError =
+				statusCode < 500 &&
+				"publicApiError" in error &&
+				isPublicApiError(error.publicApiError)
+					? error.publicApiError
+					: undefined;
 			return formatResponse(
-				{ message: error.message },
-				error.statusCode as number,
+				{ message: error.message, ...publicApiError },
+				statusCode,
 			);
 		}
 

package/src/handlers/mailbox.ts

@@ -421,7 +421,7 @@ export const TrashOperations: Record<
 			await client.mailboxSpecialUse.findConfirmedTrashMailbox(accountId);
 
 		if (!trashMailbox) {
-			throw new NoTrashMailboxError();
+			throw new NoTrashMailboxError(accountId);
 		}
 
 		const messages = await client.message.listAllByMailbox(

package/src/handlers/outbox.test.ts

@@ -26,6 +26,7 @@ import type {
 	OutboxMessageItem,
 	UpdateOutboxMessageInput,
 } from "@remit/data-ports";
+import { APPENDED_UID_NONE } from "@remit/data-ports";
 import { NotFoundError } from "@remit/data-ports/errors";
 import { OutboxMessageStatus } from "@remit/domain-enums";
 import {
@@ -75,6 +76,7 @@ const createInMemoryOutboxRepository = (): IOutboxMessageRepository => {
 				ccAddresses: input.ccAddresses ?? [],
 				bccAddresses: input.bccAddresses ?? [],
 				references: input.references ?? [],
+				appendedUid: APPENDED_UID_NONE,
 				outboxMessageId: `outbox-${sequence}`,
 				createdAt: now,
 				updatedAt: now,