@remit/backend 0.0.43 → 0.0.44

package/package.json

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

package/src/derive/enrichThreadRows.ts

@@ -7,7 +7,7 @@ import type {
 	ThreadMessageItem,
 } from "@remit/data-ports";
 import { deriveAddressId } from "@remit/data-ports/id";
-import { MessageCategory, SenderTrust, StarColor } from "@remit/domain-enums";
+import { SenderTrust, StarColor } from "@remit/domain-enums";
 import { deriveAutoMoved } from "./autoMoved.js";
 import { deriveSenderTrust } from "./senderTrust.js";
 
@@ -50,6 +50,7 @@ const toResponse = (item: ThreadMessageItem): ThreadMessageResponse => ({
 	hasStars: item.hasStars,
 	isDeleted: item.isDeleted,
 	snippet: item.snippet,
+	category: item.category,
 	createdAt: item.createdAt,
 	updatedAt: item.updatedAt,
 	senderTrust: SenderTrust.Unknown,
@@ -97,19 +98,20 @@ export const planBatchFetch = (rows: ThreadMessageItem[]): BatchPlan => {
 };
 
 /**
- * Enrich a page of ThreadMessage rows with `category` (from the underlying
- * Message), `senderTrust` (derived from the From Address's flags map) and
- * `autoMoved` (projected from the Message's internal placement verdict, see
- * `deriveAutoMoved`).
+ * Enrich a page of ThreadMessage rows with `senderTrust` (derived from the From
+ * Address's flags map), `authenticity` and `autoMoved` (both projected from the
+ * Message row, see `deriveAutoMoved`).
+ *
+ * `category` is not enriched: it is denormalized onto the ThreadMessage row and
+ * carried straight through by `toResponse`, so the value a client renders is the
+ * value the category filter matched.
  *
  * Two BatchGetItem calls per page, regardless of page size — see
  * `planBatchFetch` for the dedup contract.
  *
- * Missing rows fall back gracefully: `category` is omitted only when the
- * underlying Message row is absent (clients treat as `personal`); a present
- * Message with no stored category coalesces to `uncategorized` (RFC 032 Tier 2).
- * `senderTrust` defaults to `"unknown"`. `autoMoved` is omitted whenever the
- * move isn't a real, in-effect auto-move (or the Message row is absent).
+ * Missing rows fall back gracefully: `senderTrust` defaults to `"unknown"`, and
+ * `authenticity` / `autoMoved` are omitted whenever the Message row is absent or
+ * the move isn't a real, in-effect auto-move.
  *
  * Not annotated `Promise<ThreadMessageResponse[]>`: `labels` is a new field on
  * it in this same PR, and that package publishes separately from this repo —
@@ -158,12 +160,6 @@ export const enrichThreadRows = async (
 		}
 	}
 
-	const categoryByMessageId = new Map(
-		messages.map((m) => [
-			m.messageId,
-			m.category ?? MessageCategory.uncategorized,
-		]),
-	);
 	const authenticityByMessageId = new Map(
 		messages.map((m) => [m.messageId, m.authenticity]),
 	);
@@ -176,7 +172,6 @@ export const enrichThreadRows = async (
 
 	return rows.map((row) => {
 		const base = toResponse(row);
-		const category = categoryByMessageId.get(row.messageId);
 		const authenticity = authenticityByMessageId.get(row.messageId);
 		const autoMoved = autoMovedByMessageId.get(row.messageId);
 		const addressId = plan.addressIdByRow.get(row.threadMessageId);
@@ -186,7 +181,6 @@ export const enrichThreadRows = async (
 		const labels = labelsByMessageId.get(row.messageId);
 		return {
 			...base,
-			...(category !== undefined ? { category } : {}),
 			...(authenticity !== undefined ? { authenticity } : {}),
 			...(autoMoved !== undefined ? { autoMoved } : {}),
 			...(labels !== undefined ? { labels } : {}),

package/src/derive/filterThreadCriteria.test.ts

@@ -25,6 +25,7 @@ const row = (
 	star: StarColor.None,
 	isDeleted: false,
 	snippet: "",
+	category: MessageCategory.uncategorized,
 	createdAt: 0,
 	updatedAt: 0,
 	senderTrust: SenderTrust.Unknown,
@@ -37,7 +38,7 @@ describe("hasOffRowCriteria", () => {
 	});
 
 	it("is false for empty arrays", () => {
-		assert.equal(hasOffRowCriteria({ senderTrust: [], category: [] }), false);
+		assert.equal(hasOffRowCriteria({ senderTrust: [] }), false);
 	});
 
 	it("is true when any criterion is set", () => {
@@ -65,17 +66,12 @@ describe("filterByOffRowCriteria", () => {
 		assert.ok(result.every((r) => r.senderTrust !== SenderTrust.Unknown));
 	});
 
-	it("filters by category any-of and excludes rows with no category", () => {
+	it("leaves category alone — it is a SQL predicate, not an off-row criterion", () => {
 		const rows = [
 			row({ category: MessageCategory.newsletter }),
 			row({ category: MessageCategory.personal }),
-			row({ category: undefined }),
 		];
-		const result = filterByOffRowCriteria(rows, {
-			category: [MessageCategory.newsletter],
-		});
-		assert.equal(result.length, 1);
-		assert.equal(result[0].category, MessageCategory.newsletter);
+		assert.equal(filterByOffRowCriteria(rows, {}).length, 2);
 	});
 
 	it("filters by dkimMismatch and never matches rows lacking an authenticity signal", () => {

package/src/derive/filterThreadCriteria.ts

@@ -1,31 +1,31 @@
 import type {
-	MessageCategory,
 	SenderTrust,
 	ThreadMessageResponse,
 } from "@remit/api-openapi-types";
 
 /**
  * Off-row search criteria — fields that live on the underlying Message/Address,
- * not on the ThreadMessage DynamoDB item. They are resolved by enriching the
- * windowed rows (see enrichThreadRows) and filtering in app code, because no
- * index or FilterExpression can serve them.
+ * not on the ThreadMessage row. They are resolved by enriching the windowed
+ * rows (see enrichThreadRows) and filtering in app code, because no index or
+ * FilterExpression can serve them.
+ *
+ * `senderTrust` derives from AddressItem.flags and `dkimMismatch` from
+ * MessageItem.authenticity. `category` is not one of these: it is denormalized
+ * onto the ThreadMessage row and filtered in SQL, inside the window.
  */
 export interface OffRowCriteria {
 	senderTrust?: SenderTrust[];
-	category?: MessageCategory[];
 	dkimMismatch?: boolean;
 }
 
 export const hasOffRowCriteria = (criteria: OffRowCriteria): boolean =>
-	Boolean(criteria.senderTrust?.length) ||
-	Boolean(criteria.category?.length) ||
-	criteria.dkimMismatch !== undefined;
+	Boolean(criteria.senderTrust?.length) || criteria.dkimMismatch !== undefined;
 
 /**
  * Filter enriched rows by the off-row criteria. Each active criterion is an
- * any-of set (AND across criteria, OR within a set). A row with no `category`
- * never matches a category filter; a row with no `authenticity` signal never
- * matches a `dkimMismatch` filter (absence means no signal, not a verdict).
+ * any-of set (AND across criteria, OR within a set). A row with no
+ * `authenticity` signal never matches a `dkimMismatch` filter (absence means no
+ * signal, not a verdict).
  */
 export const filterByOffRowCriteria = (
 	rows: ThreadMessageResponse[],
@@ -36,19 +36,10 @@ export const filterByOffRowCriteria = (
 	const trustSet = criteria.senderTrust?.length
 		? new Set(criteria.senderTrust)
 		: undefined;
-	const categorySet = criteria.category?.length
-		? new Set(criteria.category)
-		: undefined;
 	const { dkimMismatch } = criteria;
 
 	return rows.filter((row) => {
 		if (trustSet && !trustSet.has(row.senderTrust)) return false;
-		if (
-			categorySet &&
-			(row.category === undefined || !categorySet.has(row.category))
-		) {
-			return false;
-		}
 		if (
 			dkimMismatch !== undefined &&
 			row.authenticity?.dkimMismatch !== dkimMismatch

package/src/handlers/thread.test.ts

@@ -1,10 +1,19 @@
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
+import type { ThreadMessageItem } from "@remit/data-ports";
+import { MessageCategory, SenderTrust, StarColor } from "@remit/domain-enums";
 import {
 	buildListThreadMessagesOptions,
+	buildListThreadsOptions,
+	buildSearchThreadsOptions,
 	dedupeThreadMessages,
+	executeThreadSearch,
+	type ThreadSearchClient,
 } from "./thread.js";
 
+const ACCOUNT = "cfg-1";
+const MAILBOX = "mbx-inbox";
+
 type Row = {
 	threadMessageId: string;
 	messageIdHeader?: string;
@@ -84,3 +93,156 @@ describe("dedupeThreadMessages", () => {
 		assert.deepEqual(dedupeThreadMessages([]), []);
 	});
 });
+
+// #304: `category` is a column on the thread_message row, so it is a SQL
+// predicate the port applies inside its window — not a criterion resolved by
+// enriching whatever the window happened to return. These assertions are on the
+// routing, because that is what a later refactor can silently undo: the SQL
+// clause goes dead and the filter falls back to a window-sized filter with no
+// test failing.
+describe("executeThreadSearch", () => {
+	type Category = ThreadMessageItem["category"];
+
+	const threadRow = (
+		threadMessageId: string,
+		category: Category,
+	): ThreadMessageItem => ({
+		threadMessageId,
+		threadId: `t-${threadMessageId}`,
+		messageId: `m-${threadMessageId}`,
+		accountConfigId: ACCOUNT,
+		mailboxId: MAILBOX,
+		uid: 1,
+		referenceOrder: 0,
+		internalDate: 0,
+		sentDate: 0,
+		isRead: false,
+		hasAttachment: false,
+		star: StarColor.None,
+		hasStars: false,
+		isDeleted: false,
+		category,
+		createdAt: 0,
+		updatedAt: 0,
+	});
+
+	type RecordedCall = { search: { category?: Category[] } };
+
+	const fakeClient = (rows: ThreadMessageItem[]) => {
+		const windowCalls: RecordedCall[] = [];
+		const countCalls: RecordedCall[] = [];
+
+		// The fake applies the category predicate itself, the way a port does, so
+		// a request that never reaches `search` cannot answer correctly by
+		// accident.
+		const matching = (categories?: Category[]) =>
+			categories?.length
+				? rows.filter((row) => categories.includes(row.category))
+				: rows;
+
+		const client: ThreadSearchClient = {
+			threadMessage: {
+				async searchByMailboxWindow(_account, _mailbox, search) {
+					windowCalls.push({ search });
+					return {
+						items: matching(search.category),
+						continuationToken: undefined,
+					};
+				},
+				async countByMailbox(_account, _mailbox, search) {
+					countCalls.push({ search });
+					return matching(search.category).length;
+				},
+			},
+			message: { get: async () => [] },
+			address: { getAddress: async () => [] },
+			messageLabel: { listByMessageIds: async () => [] },
+			label: { listByAccountConfig: async () => [] },
+		};
+
+		return { client, windowCalls, countCalls };
+	};
+
+	const ACCOUNT_ROWS = [
+		threadRow("tm-1", MessageCategory.personal),
+		threadRow("tm-2", MessageCategory.marketing),
+		threadRow("tm-3", MessageCategory.uncategorized),
+	];
+
+	it("passes category to the port's search, not to the off-row filter", async () => {
+		const { client, windowCalls } = fakeClient(ACCOUNT_ROWS);
+
+		const response = await executeThreadSearch(client, ACCOUNT, MAILBOX, {
+			category: [MessageCategory.personal],
+		});
+
+		assert.deepEqual(windowCalls.length, 1);
+		assert.deepEqual(windowCalls[0].search.category, [
+			MessageCategory.personal,
+		]);
+		assert.deepEqual(
+			response.items?.map((item) => item.threadMessageId),
+			["tm-1"],
+		);
+	});
+
+	it("takes the count-only path for a category-only query", async () => {
+		const { client, windowCalls, countCalls } = fakeClient(ACCOUNT_ROWS);
+
+		const response = await executeThreadSearch(client, ACCOUNT, MAILBOX, {
+			category: [MessageCategory.personal, MessageCategory.marketing],
+			count: true,
+			results: false,
+		});
+
+		assert.equal(windowCalls.length, 0, "no window read in count-only mode");
+		assert.equal(countCalls.length, 1);
+		assert.deepEqual(countCalls[0].search.category, [
+			MessageCategory.personal,
+			MessageCategory.marketing,
+		]);
+		assert.equal(response.count, 2);
+		assert.equal(response.items, undefined);
+	});
+
+	// The one request shape that still takes the off-row branch. `category` must
+	// reach `search` anyway, so the window is category-filtered before the
+	// enrichment the off-row criterion needs.
+	it("keeps category in search when an off-row criterion is also set", async () => {
+		const { client, windowCalls } = fakeClient(ACCOUNT_ROWS);
+
+		const response = await executeThreadSearch(client, ACCOUNT, MAILBOX, {
+			category: [MessageCategory.personal],
+			senderTrust: [SenderTrust.Unknown],
+		});
+
+		assert.equal(windowCalls.length, 1);
+		assert.deepEqual(windowCalls[0].search.category, [
+			MessageCategory.personal,
+		]);
+		assert.deepEqual(
+			response.items?.map((item) => item.threadMessageId),
+			["tm-1"],
+		);
+	});
+
+	it("serves category from the row, so it survives an absent message row", async () => {
+		const { client } = fakeClient(ACCOUNT_ROWS);
+
+		const response = await executeThreadSearch(client, ACCOUNT, MAILBOX, {});
+
+		assert.deepEqual(
+			response.items?.map((item) => item.category),
+			[
+				MessageCategory.personal,
+				MessageCategory.marketing,
+				MessageCategory.uncategorized,
+			],
+		);
+	});
+
+	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

@@ -48,6 +48,7 @@ const THREAD_LIST_ATTRIBUTES: ReadonlyArray<keyof ThreadMessageItem> = [
 	"hasStars",
 	"isDeleted",
 	"snippet",
+	"category",
 	"createdAt",
 	"updatedAt",
 ];
@@ -109,6 +110,7 @@ type ThreadSearch = {
 	unread?: boolean;
 	starred?: boolean;
 	attachments?: boolean;
+	category?: MessageCategory[];
 };
 
 /**
@@ -174,10 +176,10 @@ export const executeThreadSearch = async (
 		unread: params.unread,
 		starred: params.starred,
 		attachments: params.attachments,
+		category: params.category,
 	};
 	const offRow = {
 		senderTrust: params.senderTrust,
-		category: params.category,
 		dkimMismatch: params.dkimMismatch,
 	};
 	const wantCount = params.count === true;

package/src/handlers/unified-threads.ts

@@ -325,7 +325,7 @@ export const dedupeByMessageId = <T extends { messageId: string }>(
 /**
  * Attach accountId to each enriched ThreadMessageResponse row using the
  * mailboxId→accountId map built from inbox discovery. Same read-time-attach
- * pattern as senderTrust/category in enrichThreadRows.
+ * pattern as senderTrust in enrichThreadRows.
  */
 export const attachAccountIds = (
 	rows: Awaited<ReturnType<typeof enrichThreadRows>>,