@remit/backend 0.0.32 → 0.0.34

package/package.json

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

package/scripts/backfill-list-id.ts

@@ -0,0 +1,68 @@
+import { existsSync } from "node:fs";
+import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
+import { dirname } from "node:path";
+import { logger } from "@remit/logger-lambda";
+import {
+	backfillListIds,
+	type ListIdBackfillCheckpoint,
+	type ListIdBackfillCheckpointStore,
+} from "@remit/mailbox-service";
+import { getClient } from "../src/service/dynamodb.js";
+
+/**
+ * One-time, full-corpus `ThreadMessage.listId` backfill (issue #263). Ships as
+ * an alternate entrypoint baked into the backend image — "the backend image
+ * with a command", the same shape `migrate.mjs` uses — rather than a service
+ * of its own. Unlike `migrate`, it is never wired into a compose one-shot: a
+ * full pass runs once per install, not on every restart. Invoke it by hand:
+ *
+ *   docker compose -f docker-compose.sqlite.yml run --rm backend \
+ *     node backfill-list-id.mjs
+ *
+ * Safe to interrupt: progress is checkpointed to disk after every page and
+ * picked back up on the next run, and every row it touches is read-only
+ * against the stored message, so a rerun after a partial pass is a no-op for
+ * everything already done.
+ */
+
+const CHECKPOINT_PATH =
+	process.env.LIST_ID_BACKFILL_CHECKPOINT_PATH ??
+	"/data/sqlite/list-id-backfill-checkpoint.json";
+
+const fileCheckpointStore: ListIdBackfillCheckpointStore = {
+	load: async () => {
+		if (!existsSync(CHECKPOINT_PATH)) return undefined;
+		const raw = await readFile(CHECKPOINT_PATH, "utf8");
+		return JSON.parse(raw) as ListIdBackfillCheckpoint;
+	},
+	save: async (checkpoint) => {
+		await mkdir(dirname(CHECKPOINT_PATH), { recursive: true });
+		await writeFile(CHECKPOINT_PATH, JSON.stringify(checkpoint));
+	},
+	clear: async () => {
+		await rm(CHECKPOINT_PATH, { force: true });
+	},
+};
+
+const run = async (): Promise<void> => {
+	const client = await getClient();
+
+	const result = await backfillListIds(
+		{
+			accountConfigService: client.accountConfig,
+			threadMessageService: client.threadMessage,
+			messageService: client.message,
+			storageService: client.storage,
+		},
+		{ checkpointStore: fileCheckpointStore, logger },
+	);
+
+	console.log("[backfill-list-id] done", result);
+};
+
+run()
+	.then(() => process.exit(0))
+	.catch((error: unknown) => {
+		console.error("[backfill-list-id] failed", error);
+		process.exit(1);
+	});

package/src/handlers/mailbox.test.ts

@@ -0,0 +1,34 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+import type { MailboxItem } from "@remit/data-ports";
+import { MailboxSyncStatus } from "@remit/domain-enums";
+import { excludeDeletingMailboxes } from "./mailbox.js";
+
+const mailbox = (
+	over: Partial<MailboxItem> & { mailboxId: string },
+): MailboxItem =>
+	({ fullPath: over.mailboxId, ...over }) as unknown as MailboxItem;
+
+describe("excludeDeletingMailboxes", () => {
+	it("drops a folder being deleted so it leaves the list before the worker reaps it", () => {
+		const items = [
+			mailbox({ mailboxId: "inbox", syncStatus: MailboxSyncStatus.synced }),
+			mailbox({ mailboxId: "gone", syncStatus: MailboxSyncStatus.deleting }),
+			mailbox({ mailboxId: "new", syncStatus: MailboxSyncStatus.pending }),
+		];
+		assert.deepEqual(
+			excludeDeletingMailboxes(items).map((m) => m.mailboxId),
+			["inbox", "new"],
+		);
+	});
+
+	it("keeps a folder whose delete failed and was restored off `deleting`", () => {
+		const items = [
+			mailbox({ mailboxId: "restored", syncStatus: MailboxSyncStatus.failed }),
+		];
+		assert.deepEqual(
+			excludeDeletingMailboxes(items).map((m) => m.mailboxId),
+			["restored"],
+		);
+	});
+});

package/src/handlers/mailbox.ts

@@ -4,7 +4,7 @@ import type {
 } from "@remit/api-openapi-types";
 import type { IAccountSettingRepository, MailboxItem } from "@remit/data-ports";
 import { ForbiddenError, NotFoundError } from "@remit/data-ports/errors";
-import { MessageSystemFlag } from "@remit/domain-enums";
+import { MailboxSyncStatus, MessageSystemFlag } from "@remit/domain-enums";
 import type { APIGatewayProxyEvent } from "aws-lambda";
 import { getAccountConfigIdFromEvent } from "../auth.js";
 import {
@@ -185,6 +185,24 @@ const toMailboxResponse = (
 	updatedAt: mailbox.updatedAt,
 });
 
+/**
+ * Drop folders the user has deleted but the imap-worker has not yet reaped.
+ *
+ * A delete is a soft delete: the row lives on with syncStatus=deleting until the
+ * worker confirms the IMAP delete and removes it (mailbox-queue.deleteMailbox).
+ * The list is the settings view a client refetches right after confirming, so a
+ * still-`deleting` row here would keep a deleted folder on screen until the
+ * worker finishes. Hiding it makes the folder leave the list the moment the
+ * delete is confirmed; a delete that fails restores the row off `deleting`,
+ * which brings the folder back on the next read.
+ */
+export const excludeDeletingMailboxes = (
+	mailboxes: readonly MailboxItem[],
+): MailboxItem[] =>
+	mailboxes.filter(
+		(mailbox) => mailbox.syncStatus !== MailboxSyncStatus.deleting,
+	);
+
 export const MailboxOperations: Record<
 	MailboxOperationIds,
 	OperationHandler<MailboxOperationIds>
@@ -205,6 +223,8 @@ export const MailboxOperations: Record<
 			continuationToken,
 		});
 
+		const visibleItems = excludeDeletingMailboxes(result.items);
+
 		// Overrides (mute / display-name / role) live in per-mailbox AccountSetting
 		// rows (RFC 032). Load the whole config's set in one query and key it by
 		// mailboxId so each mailbox surfaces its overrides without an N+1.
@@ -222,7 +242,7 @@ export const MailboxOperations: Record<
 			accountId,
 		);
 		const items = applyPendingMoveCountPrediction(
-			result.items,
+			visibleItems,
 			pendingMoves,
 			pendingUnseenFlagPushes,
 		);

package/tsconfig.json

@@ -3,5 +3,5 @@
 	"compilerOptions": {
 		"outDir": "dist"
 	},
-	"include": ["src/**/*.ts", "dev-server/**/*.ts"]
+	"include": ["src/**/*.ts", "dev-server/**/*.ts", "scripts/**/*.ts"]
 }