@remit/backend 0.0.143 → 0.0.144

package/src/derive/enrichThreadRows.test.ts

@@ -1,360 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, test } from "node:test";
-import type {
-	AddressItem,
-	LabelItem,
-	MessageItem,
-	MessageLabelItem,
-	ThreadMessageItem,
-} from "@remit/data-ports";
-import { deriveAddressId } from "@remit/data-ports/id";
-import { hasAbandonedDelete } from "@remit/data-ports/message-settlement";
-import {
-	MessageMutation,
-	MessageStatus,
-	MessageSyncStatus,
-} from "@remit/domain-enums";
-import { type EnrichClient, enrichThreadRows } from "./enrichThreadRows.js";
-
-const threadRow = (
-	threadMessageId: string,
-	messageId: string,
-	fromEmail?: string,
-): ThreadMessageItem =>
-	({
-		threadMessageId,
-		threadId: "th-1",
-		messageId,
-		accountConfigId: "acc-1",
-		mailboxId: "mbx-1",
-		fromEmail,
-		sentDate: 1,
-		isRead: true,
-		hasAttachment: false,
-		hasStars: false,
-		isDeleted: false,
-		createdAt: 1,
-		updatedAt: 1,
-	}) as unknown as ThreadMessageItem;
-
-const buildClient = (
-	messageLabels: MessageLabelItem[],
-	labels: LabelItem[],
-	addresses: AddressItem[] = [],
-): EnrichClient => ({
-	message: { get: async () => [] as MessageItem[] },
-	address: { getAddress: async () => addresses },
-	messageLabel: {
-		listByMessageIds: async (messageIds: string[]) =>
-			messageLabels.filter((row) => messageIds.includes(row.messageId)),
-	},
-	label: {
-		listByAccountConfig: async () => labels,
-	},
-});
-
-describe("enrichThreadRows — labels", () => {
-	test("attaches every label applied to a message", async () => {
-		const rows = [threadRow("tm-1", "msg-1")];
-		const messageLabels = [
-			{
-				messageLabelId: "ml-1",
-				messageId: "msg-1",
-				labelId: "lbl-1",
-				accountConfigId: "acc-1",
-				createdAt: 1,
-				updatedAt: 1,
-			},
-			{
-				messageLabelId: "ml-2",
-				messageId: "msg-1",
-				labelId: "lbl-2",
-				accountConfigId: "acc-1",
-				createdAt: 1,
-				updatedAt: 1,
-			},
-		] as unknown as MessageLabelItem[];
-		const labels = [
-			{
-				labelId: "lbl-1",
-				accountConfigId: "acc-1",
-				name: "Receipts",
-				normalizedName: "receipts",
-				color: "Blue",
-				createdAt: 1,
-				updatedAt: 1,
-			},
-			{
-				labelId: "lbl-2",
-				accountConfigId: "acc-1",
-				name: "Travel",
-				normalizedName: "travel",
-				color: "Green",
-				createdAt: 1,
-				updatedAt: 1,
-			},
-		] as unknown as LabelItem[];
-
-		const [result] = await enrichThreadRows(
-			rows,
-			buildClient(messageLabels, labels),
-			"acc-1",
-		);
-
-		assert.deepEqual(result?.labels?.map((l) => l.labelId).sort(), [
-			"lbl-1",
-			"lbl-2",
-		]);
-		assert.deepEqual(
-			result?.labels?.find((l) => l.labelId === "lbl-1"),
-			{ labelId: "lbl-1", name: "Receipts", color: "Blue" },
-		);
-	});
-
-	test("omits labels entirely when the message has none", async () => {
-		const rows = [threadRow("tm-1", "msg-1")];
-		const [result] = await enrichThreadRows(rows, buildClient([], []), "acc-1");
-		assert.equal(result?.labels, undefined);
-	});
-
-	test("skips a MessageLabel row whose Label was deleted out from under it", async () => {
-		const rows = [threadRow("tm-1", "msg-1")];
-		const messageLabels = [
-			{
-				messageLabelId: "ml-1",
-				messageId: "msg-1",
-				labelId: "gone",
-				accountConfigId: "acc-1",
-				createdAt: 1,
-				updatedAt: 1,
-			},
-		] as unknown as MessageLabelItem[];
-
-		const [result] = await enrichThreadRows(
-			rows,
-			buildClient(messageLabels, []),
-			"acc-1",
-		);
-		assert.equal(result?.labels, undefined);
-	});
-
-	test("never cross-wires labels between rows for different messages", async () => {
-		const rows = [threadRow("tm-1", "msg-1"), threadRow("tm-2", "msg-2")];
-		const messageLabels = [
-			{
-				messageLabelId: "ml-1",
-				messageId: "msg-1",
-				labelId: "lbl-1",
-				accountConfigId: "acc-1",
-				createdAt: 1,
-				updatedAt: 1,
-			},
-		] as unknown as MessageLabelItem[];
-		const labels = [
-			{
-				labelId: "lbl-1",
-				accountConfigId: "acc-1",
-				name: "Receipts",
-				normalizedName: "receipts",
-				color: "Blue",
-				createdAt: 1,
-				updatedAt: 1,
-			},
-		] as unknown as LabelItem[];
-
-		const [first, second] = await enrichThreadRows(
-			rows,
-			buildClient(messageLabels, labels),
-			"acc-1",
-		);
-		assert.equal(first?.labels?.length, 1);
-		assert.equal(second?.labels, undefined);
-	});
-});
-
-describe("enrichThreadRows — spamReport", () => {
-	test("projects spamReport straight from the Message row", async () => {
-		const rows = [threadRow("tm-1", "msg-1")];
-		const client: EnrichClient = {
-			message: {
-				get: async () =>
-					[
-						{
-							messageId: "msg-1",
-							spamReport: { reportedAt: 1_700_000_000_000 },
-						},
-					] as unknown as MessageItem[],
-			},
-			address: { getAddress: async () => [] },
-			messageLabel: { listByMessageIds: async () => [] },
-			label: { listByAccountConfig: async () => [] },
-		};
-
-		const [result] = await enrichThreadRows(rows, client, "acc-1");
-		assert.deepEqual(result?.spamReport, { reportedAt: 1_700_000_000_000 });
-	});
-
-	test("omits spamReport when the Message has never been reported", async () => {
-		const rows = [threadRow("tm-1", "msg-1")];
-		const [result] = await enrichThreadRows(rows, buildClient([], []), "acc-1");
-		assert.equal(result?.spamReport, undefined);
-	});
-});
-
-describe("enrichThreadRows — muted", () => {
-	const SET_AT = 1_700_000_000_000;
-
-	test("sets muted true from the batch-fetched Address's flags, no extra query", async () => {
-		const fromEmail = "muted@example.com";
-		const addressId = deriveAddressId("acc-1", fromEmail);
-		const rows = [threadRow("tm-1", "msg-1", fromEmail)];
-		const addresses = [
-			{
-				addressId,
-				accountConfigId: "acc-1",
-				flags: { muted: { value: true, setAt: SET_AT } },
-			},
-		] as unknown as AddressItem[];
-
-		let addressCalls = 0;
-		const client: EnrichClient = {
-			message: { get: async () => [] as MessageItem[] },
-			address: {
-				getAddress: async () => {
-					addressCalls += 1;
-					return addresses;
-				},
-			},
-			messageLabel: { listByMessageIds: async () => [] },
-			label: { listByAccountConfig: async () => [] },
-		};
-
-		const [result] = await enrichThreadRows(rows, client, "acc-1");
-		assert.equal(result?.muted, true);
-		assert.equal(addressCalls, 1);
-	});
-
-	test("defaults muted to false when the Address has no muted flag", async () => {
-		const fromEmail = "not-muted@example.com";
-		const addressId = deriveAddressId("acc-1", fromEmail);
-		const rows = [threadRow("tm-1", "msg-1", fromEmail)];
-		const addresses = [
-			{ addressId, accountConfigId: "acc-1", flags: {} },
-		] as unknown as AddressItem[];
-
-		const [result] = await enrichThreadRows(
-			rows,
-			buildClient([], [], addresses),
-			"acc-1",
-		);
-		assert.equal(result?.muted, false);
-	});
-
-	test("defaults muted to false when no Address row resolves", async () => {
-		const rows = [threadRow("tm-1", "msg-1")];
-		const [result] = await enrichThreadRows(rows, buildClient([], []), "acc-1");
-		assert.equal(result?.muted, false);
-	});
-});
-
-describe("enrichThreadRows — the mutation pair", () => {
-	const withMessage = (message: Partial<MessageItem>): EnrichClient => ({
-		message: {
-			get: async () =>
-				[{ messageId: "msg-1", ...message }] as unknown as MessageItem[],
-		},
-		address: { getAddress: async () => [] },
-		messageLabel: { listByMessageIds: async () => [] },
-		label: { listByAccountConfig: async () => [] },
-	});
-
-	const project = async (message: Partial<MessageItem>) => {
-		const [result] = await enrichThreadRows(
-			[threadRow("tm-1", "msg-1")],
-			withMessage(message),
-			"acc-1",
-		);
-		return result;
-	};
-
-	test("projects the pair an abandoned delete leaves behind, and what it gave up on", async () => {
-		const result = await project({
-			status: MessageStatus.active,
-			syncStatus: MessageSyncStatus.abandoned,
-			abandonedMutation: MessageMutation.delete,
-		});
-		assert.equal(result?.status, MessageStatus.active);
-		assert.equal(result?.syncStatus, MessageSyncStatus.abandoned);
-		assert.equal(result?.abandonedMutation, MessageMutation.delete);
-		assert.equal(
-			hasAbandonedDelete({
-				status: result?.status,
-				syncStatus: result?.syncStatus,
-				abandonedMutation: result?.abandonedMutation,
-			}),
-			true,
-		);
-	});
-
-	// Issue #1229. Both give-ups leave the same `status`/`syncStatus` pair, so
-	// the projection has to carry the third field or the client cannot tell a
-	// move that handed back from a delete that was refused.
-	test("projects a move that gave up as a move, never as a delete", async () => {
-		const result = await project({
-			status: MessageStatus.active,
-			syncStatus: MessageSyncStatus.abandoned,
-			abandonedMutation: MessageMutation.move,
-		});
-		assert.equal(result?.abandonedMutation, MessageMutation.move);
-		assert.equal(
-			hasAbandonedDelete({
-				status: result?.status,
-				syncStatus: result?.syncStatus,
-				abandonedMutation: result?.abandonedMutation,
-			}),
-			false,
-		);
-	});
-
-	test("projects a move mid-retry without calling it a give-up", async () => {
-		const result = await project({
-			status: MessageStatus.moving,
-			syncStatus: MessageSyncStatus.failed,
-		});
-		assert.equal(result?.status, MessageStatus.moving);
-		assert.equal(result?.syncStatus, MessageSyncStatus.failed);
-		assert.equal(
-			hasAbandonedDelete({
-				status: result?.status,
-				syncStatus: result?.syncStatus,
-				abandonedMutation: result?.abandonedMutation,
-			}),
-			false,
-		);
-	});
-
-	test("projects an ordinary inbound row", async () => {
-		const result = await project({
-			status: MessageStatus.active,
-			syncStatus: MessageSyncStatus.pending,
-		});
-		assert.equal(result?.status, MessageStatus.active);
-		assert.equal(result?.syncStatus, MessageSyncStatus.pending);
-	});
-
-	test("a row whose Message row is missing claims no mutation", async () => {
-		const [result] = await enrichThreadRows(
-			[threadRow("tm-1", "msg-1")],
-			buildClient([], []),
-			"acc-1",
-		);
-		assert.equal(
-			hasAbandonedDelete({
-				status: result?.status,
-				syncStatus: result?.syncStatus,
-				abandonedMutation: result?.abandonedMutation,
-			}),
-			false,
-		);
-	});
-});

package/src/derive/enrichThreadRows.ts

@@ -1,234 +0,0 @@
-import type { ThreadMessageResponse } from "@remit/api-openapi-types";
-import type {
-	AddressItem,
-	LabelItem,
-	MessageItem,
-	MessageLabelItem,
-	ThreadMessageItem,
-} from "@remit/data-ports";
-import { deriveAddressId } from "@remit/data-ports/id";
-import {
-	MessageMutation,
-	MessageStatus,
-	MessageSyncStatus,
-	SenderTrust,
-	StarColor,
-} from "@remit/domain-enums";
-import { deriveAutoMoved } from "./autoMoved.js";
-import { deriveMuted } from "./deriveMuted.js";
-import { deriveSenderTrust } from "./senderTrust.js";
-
-/**
- * Subset of the ElectroDB client surface used for batch enrichment. Declared
- * structurally so unit tests can pass an in-memory fake without standing up
- * DynamoDB.
- */
-export interface EnrichClient {
-	message: {
-		get(messageIds: string[]): Promise<MessageItem[]>;
-	};
-	address: {
-		getAddress(
-			accountConfigId: string,
-			addressIds: string[],
-		): Promise<AddressItem[]>;
-	};
-	messageLabel: {
-		listByMessageIds(messageIds: string[]): Promise<MessageLabelItem[]>;
-	};
-	label: {
-		listByAccountConfig(accountConfigId: string): Promise<LabelItem[]>;
-	};
-}
-
-const toResponse = (item: ThreadMessageItem): ThreadMessageResponse => ({
-	threadMessageId: item.threadMessageId,
-	threadId: item.threadId,
-	messageId: item.messageId,
-	accountConfigId: item.accountConfigId,
-	mailboxId: item.mailboxId,
-	fromEmail: item.fromEmail,
-	fromName: item.fromName,
-	subject: item.subject,
-	sentDate: item.sentDate,
-	isRead: item.isRead,
-	hasAttachment: item.hasAttachment,
-	star: item.star ?? StarColor.None,
-	hasStars: item.hasStars,
-	isDeleted: item.isDeleted,
-	snippet: item.snippet,
-	category: item.category,
-	createdAt: item.createdAt,
-	updatedAt: item.updatedAt,
-	senderTrust: SenderTrust.Unknown,
-	muted: false,
-	status: MessageStatus.active,
-	syncStatus: MessageSyncStatus.pending,
-	abandonedMutation: MessageMutation.none,
-});
-
-/**
- * Plan the unique batch-fetch keys for a page of ThreadMessage rows.
- *
- * Splitting this out keeps the dedup logic testable without DynamoDB and
- * documents the contract: a page of N rows produces at most one BatchGet
- * for messages and one for addresses, no matter how many rows share the
- * same messageId / sender.
- *
- * `addressId` is derived deterministically from `(accountConfigId, fromEmail)`
- * via `deriveAddressId`, mirroring the write path in
- * `body-sync.ts`. Rows without a `fromEmail` (rare; sentinel/system rows)
- * contribute no addressId and fall back to `senderTrust: "unknown"`.
- */
-export interface BatchPlan {
-	messageIds: string[];
-	addressIds: string[];
-	addressIdByRow: Map<string, string>;
-}
-
-export const planBatchFetch = (rows: ThreadMessageItem[]): BatchPlan => {
-	const messageIds = new Set<string>();
-	const addressIds = new Set<string>();
-	const addressIdByRow = new Map<string, string>();
-
-	for (const row of rows) {
-		messageIds.add(row.messageId);
-
-		if (!row.fromEmail) continue;
-
-		const addressId = deriveAddressId(row.accountConfigId, row.fromEmail);
-		addressIds.add(addressId);
-		addressIdByRow.set(row.threadMessageId, addressId);
-	}
-
-	return {
-		messageIds: [...messageIds],
-		addressIds: [...addressIds],
-		addressIdByRow,
-	};
-};
-
-/**
- * Enrich a page of ThreadMessage rows with `senderTrust` and `muted` (both
- * derived from the From Address's flags map), `authenticity`, `autoMoved` and
- * `spamReport`, and the `status`/`syncStatus` pair an IMAP mutation leaves
- * behind together with the mutation an abandoned one names (all projected
- * straight from the Message row — no ThreadMessage
- * column of their own, see `deriveAutoMoved`). `toResponse` seeds that pair
- * with the ordinary inbound values, which the projection then overwrites; a
- * ThreadMessage row whose Message row is missing from the batch is broken in a
- * way this read path cannot report, and claiming a mutation it has no evidence
- * of would be worse.
- *
- * `category` is not enriched: it is denormalized onto the ThreadMessage row
- * (shared with `Message.category`'s write-once value, see body-sync.ts) 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: `senderTrust` defaults to `"unknown"`,
- * `muted` defaults to `false`, 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 —
- * an explicit annotation here would contextually type the literal below
- * against the currently-*published* shape (which lacks `labels`) and fail
- * `check-consumer-typecheck`/`release:dry-run`. Callers assign the (wider,
- * inferred) result into an already-typed `ThreadMessageResponse[]` property,
- * which is a plain assignability check, not an excess-property one.
- */
-export const enrichThreadRows = async (
-	rows: ThreadMessageItem[],
-	client: EnrichClient,
-	accountConfigId: string,
-) => {
-	if (rows.length === 0) return [];
-
-	const plan = planBatchFetch(rows);
-
-	const [messages, addresses, messageLabels, labels] = await Promise.all([
-		plan.messageIds.length ? client.message.get(plan.messageIds) : [],
-		plan.addressIds.length
-			? client.address.getAddress(accountConfigId, plan.addressIds)
-			: [],
-		client.messageLabel.listByMessageIds(plan.messageIds),
-		client.label.listByAccountConfig(accountConfigId),
-	]);
-
-	const labelById = new Map(labels.map((label) => [label.labelId, label]));
-	const labelsByMessageId = new Map<
-		string,
-		{ labelId: string; name: string; color: LabelItem["color"] }[]
-	>();
-	for (const messageLabel of messageLabels) {
-		const label = labelById.get(messageLabel.labelId);
-		if (!label) continue;
-		const entry = {
-			labelId: label.labelId,
-			name: label.name,
-			color: label.color,
-		};
-		const existing = labelsByMessageId.get(messageLabel.messageId);
-		if (existing) {
-			existing.push(entry);
-		} else {
-			labelsByMessageId.set(messageLabel.messageId, [entry]);
-		}
-	}
-
-	const authenticityByMessageId = new Map(
-		messages.map((m) => [m.messageId, m.authenticity]),
-	);
-	const autoMovedByMessageId = new Map(
-		messages.map((m) => [m.messageId, deriveAutoMoved(m)]),
-	);
-	const spamReportByMessageId = new Map(
-		messages.map((m) => [m.messageId, m.spamReport]),
-	);
-	const settlementByMessageId = new Map(
-		messages.map((m) => [
-			m.messageId,
-			{
-				status: m.status,
-				syncStatus: m.syncStatus,
-				abandonedMutation: m.abandonedMutation,
-			},
-		]),
-	);
-	const trustByAddressId = new Map(
-		addresses.map((a) => [a.addressId, deriveSenderTrust(a.flags)]),
-	);
-	const mutedByAddressId = new Map(
-		addresses.map((a) => [a.addressId, deriveMuted(a.flags)]),
-	);
-
-	return rows.map((row) => {
-		const base = toResponse(row);
-		const authenticity = authenticityByMessageId.get(row.messageId);
-		const autoMoved = autoMovedByMessageId.get(row.messageId);
-		const spamReport = spamReportByMessageId.get(row.messageId);
-		const addressId = plan.addressIdByRow.get(row.threadMessageId);
-		const senderTrust = addressId
-			? (trustByAddressId.get(addressId) ?? SenderTrust.Unknown)
-			: SenderTrust.Unknown;
-		const muted = addressId
-			? (mutedByAddressId.get(addressId) ?? false)
-			: false;
-		const labels = labelsByMessageId.get(row.messageId);
-		const settlement = settlementByMessageId.get(row.messageId);
-		return {
-			...base,
-			...(settlement ?? {}),
-			...(authenticity !== undefined ? { authenticity } : {}),
-			...(autoMoved !== undefined ? { autoMoved } : {}),
-			...(labels !== undefined ? { labels } : {}),
-			...(spamReport !== undefined ? { spamReport } : {}),
-			senderTrust,
-			muted,
-		};
-	});
-};