@remit/backend 0.0.52 → 0.0.54

package/package.json

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

package/scripts/backfill-list-id.ts

@@ -1,5 +1,5 @@
 import { existsSync } from "node:fs";
-import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
+import { mkdir, readFile, rename, rm, writeFile } from "node:fs/promises";
 import { dirname } from "node:path";
 import { logger } from "@remit/logger-lambda";
 import {
@@ -29,15 +29,29 @@ const CHECKPOINT_PATH =
 	process.env.LIST_ID_BACKFILL_CHECKPOINT_PATH ??
 	"/data/sqlite/list-id-backfill-checkpoint.json";
 
+const isCheckpoint = (value: unknown): value is ListIdBackfillCheckpoint => {
+	if (typeof value !== "object" || value === null) return false;
+	if (!("accountConfigId" in value)) return false;
+	const candidate = value as Record<string, unknown>;
+	return (
+		typeof candidate.accountConfigId === "string" &&
+		(candidate.continuationToken === undefined ||
+			typeof candidate.continuationToken === "string")
+	);
+};
+
 const fileCheckpointStore: ListIdBackfillCheckpointStore = {
 	load: async () => {
 		if (!existsSync(CHECKPOINT_PATH)) return undefined;
 		const raw = await readFile(CHECKPOINT_PATH, "utf8");
-		return JSON.parse(raw) as ListIdBackfillCheckpoint;
+		const parsed: unknown = JSON.parse(raw);
+		return isCheckpoint(parsed) ? parsed : undefined;
 	},
 	save: async (checkpoint) => {
 		await mkdir(dirname(CHECKPOINT_PATH), { recursive: true });
-		await writeFile(CHECKPOINT_PATH, JSON.stringify(checkpoint));
+		const staging = `${CHECKPOINT_PATH}.writing`;
+		await writeFile(staging, JSON.stringify(checkpoint));
+		await rename(staging, CHECKPOINT_PATH);
 	},
 	clear: async () => {
 		await rm(CHECKPOINT_PATH, { force: true });

package/src/handlers/thread.test.ts

@@ -241,6 +241,41 @@ describe("executeThreadSearch", () => {
 		);
 	});
 
+	// #509: `limit` is a page size. A response that carries a page of rows and a
+	// count has to state how many messages match, not how many it handed back.
+	it("counts the whole match when rows are asked for as well", async () => {
+		const pageSize = 2;
+		const matches = 4753;
+		const windowCalls: number[] = [];
+		const client: ThreadSearchClient = {
+			threadMessage: {
+				async searchByMailboxWindow(_account, _mailbox, _search, options) {
+					windowCalls.push(options?.limit ?? 0);
+					return {
+						items: ACCOUNT_ROWS.slice(0, pageSize),
+						continuationToken: "next",
+					};
+				},
+				async countByMailbox() {
+					return matches;
+				},
+			},
+			message: { get: async () => [] },
+			address: { getAddress: async () => [] },
+			messageLabel: { listByMessageIds: async () => [] },
+			label: { listByAccountConfig: async () => [] },
+		};
+
+		const response = await executeThreadSearch(client, ACCOUNT, MAILBOX, {
+			count: true,
+			limit: pageSize,
+		});
+
+		assert.deepEqual(windowCalls, [pageSize]);
+		assert.equal(response.items?.length, pageSize);
+		assert.equal(response.count, matches);
+	});
+
 	it("projects category, so the DynamoDB port reads it with the row", () => {
 		assert.ok(buildSearchThreadsOptions({}).attributes.includes("category"));
 		assert.ok(buildListThreadsOptions({}).attributes.includes("category"));

package/src/handlers/thread.ts

@@ -131,7 +131,6 @@ export interface ThreadSearchClient extends EnrichClient {
 			mailboxId: string,
 			search: ThreadSearch,
 			options?: {
-				limit?: number;
 				excludeDeleted?: boolean;
 				order?: "asc" | "desc";
 			},
@@ -160,8 +159,12 @@ export type ThreadSearchParams = {
  * Run a per-mailbox thread search: select the index/window read, optionally
  * count, and resolve off-row criteria by enriching+filtering the window. The
  * `results` toggle omits `items` (count-only) and `count` adds the match count.
- * Off-row criteria force a window read+enrich even in count-only mode, since no
- * Select:COUNT can see fields that aren't on the row.
+ *
+ * `count` names the whole match, never the page: a page size bounds the rows a
+ * response carries and has no bearing on how many messages match (#509). The
+ * one exception is an off-row criterion, which no Select:COUNT can see — those
+ * force a window read+enrich even in count-only mode, and the count that comes
+ * back is over the enriched window, which the API documents as such.
  */
 export const executeThreadSearch = async (
 	client: ThreadSearchClient,
@@ -226,11 +229,6 @@ export const executeThreadSearch = async (
 			accountConfigId,
 		);
 		response.continuationToken = window.continuationToken;
-		// The window read already yielded the exact match set, so the count is
-		// its length — no separate Select:COUNT, and count == items.length by
-		// construction.
-		if (wantCount) response.count = response.items.length;
-		return response;
 	}
 
 	if (wantCount) {
@@ -238,7 +236,7 @@ export const executeThreadSearch = async (
 			accountConfigId,
 			mailboxId,
 			search,
-			{ limit: params.limit, excludeDeleted: true, order: params.order },
+			{ excludeDeleted: true, order: params.order },
 		);
 	}