@remit/mailbox-service 0.0.110 → 0.0.112

package/src/placement-move-terminal.test.ts

@@ -1,300 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import type {
-	MessageItem,
-	PlacementPredicate,
-	PlacementTransitionInput,
-} from "@remit/data-ports";
-import {
-	MessageMutation,
-	MessageStatus,
-	MessageSyncStatus,
-} from "@remit/domain-enums";
-import type { PlacementMoveLogger } from "./placement-move.js";
-import {
-	type ResolveExhaustedPlacementMoveDeps,
-	resolveExhaustedPlacementMoveFailure,
-} from "./placement-move-terminal.js";
-import type { IImapConnection } from "./types.js";
-
-interface LogEntry {
-	obj: Record<string, unknown>;
-	msg: string;
-}
-
-interface Transition {
-	messageId: string;
-	expected: PlacementPredicate;
-	next: PlacementTransitionInput;
-}
-
-interface Recorder {
-	deps: ResolveExhaustedPlacementMoveDeps;
-	infos: LogEntry[];
-	errors: LogEntry[];
-	markerDeletes: string[];
-	deletedMessages: string[];
-	deletedThreadMessages: Array<{
-		accountConfigId: string;
-		threadMessageId: string;
-	}>;
-	transitions: Transition[];
-	threadUpdates: string[];
-}
-
-const buildRecorder = (
-	threadMessages: Array<{ accountConfigId: string; threadMessageId: string }>,
-	transitionWins = true,
-): Recorder => {
-	const infos: LogEntry[] = [];
-	const errors: LogEntry[] = [];
-	const markerDeletes: string[] = [];
-	const deletedMessages: string[] = [];
-	const deletedThreadMessages: Array<{
-		accountConfigId: string;
-		threadMessageId: string;
-	}> = [];
-	const transitions: Transition[] = [];
-	const threadUpdates: string[] = [];
-
-	const log: PlacementMoveLogger = {
-		info: (obj, msg) => infos.push({ obj, msg }),
-		error: (obj, msg) => errors.push({ obj, msg }),
-	};
-
-	const deps: ResolveExhaustedPlacementMoveDeps = {
-		markerService: {
-			delete: async (id: string) => {
-				markerDeletes.push(id);
-			},
-		},
-		messageService: {
-			delete: async (id: string) => {
-				deletedMessages.push(id);
-			},
-			transitionPlacement: async (
-				messageId: string,
-				expected: PlacementPredicate,
-				next: PlacementTransitionInput,
-			) => {
-				transitions.push({ messageId, expected, next });
-				return transitionWins ? ({ messageId } as MessageItem) : undefined;
-			},
-		},
-		threadMessageService: {
-			findAllByMessageId: async () => threadMessages as never,
-			deleteMany: async (
-				keys: Array<{ accountConfigId: string; threadMessageId: string }>,
-			) => {
-				deletedThreadMessages.push(...keys);
-			},
-			update: async (_accountConfigId: string, threadMessageId: string) => {
-				threadUpdates.push(threadMessageId);
-				return undefined as never;
-			},
-		},
-		log,
-	};
-
-	return {
-		deps,
-		infos,
-		errors,
-		markerDeletes,
-		deletedMessages,
-		deletedThreadMessages,
-		transitions,
-		threadUpdates,
-	};
-};
-
-const buildConnection = (
-	present: Set<number>,
-	fetchDrops: Set<number> = new Set(),
-): IImapConnection =>
-	({
-		openBox: async () => ({}) as never,
-		fetchMessages: async (uids: number[]) =>
-			uids
-				.filter((uid) => present.has(uid) && !fetchDrops.has(uid))
-				.map((uid) => ({ uid }) as unknown as never),
-		search: async (criteria: unknown[]) => {
-			const [, value] = (criteria as Array<[string, string]>)[0];
-			const uid = Number(value);
-			return present.has(uid) ? [uid] : [];
-		},
-	}) as unknown as IImapConnection;
-
-describe("resolveExhaustedPlacementMoveFailure — the two terminal outcomes (mirrors #1270 for placement moves)", () => {
-	it("RECONCILED (expected): the message is gone from its pending-move source — marker dropped, stale row reconciled, no alarm", async () => {
-		const rec = buildRecorder([
-			{ accountConfigId: "cfg-1", threadMessageId: "tm-msg-gone" },
-		]);
-
-		const result = await resolveExhaustedPlacementMoveFailure(rec.deps, {
-			accountId: "acc-1",
-			accountConfigId: "cfg-1",
-			messageId: "msg-gone",
-			uid: 101,
-			sourceMailboxId: "mbx-junk",
-			sourceMailboxPath: "Junk",
-			getConnection: async () => buildConnection(new Set()),
-		});
-
-		assert.equal(result.outcome, "reconciled");
-		assert.deepEqual(rec.markerDeletes, ["msg-gone"]);
-		assert.deepEqual(rec.deletedMessages, ["msg-gone"]);
-		assert.deepEqual(rec.deletedThreadMessages, [
-			{ accountConfigId: "cfg-1", threadMessageId: "tm-msg-gone" },
-		]);
-		assert.equal(
-			rec.errors.length,
-			0,
-			"no alarm for the expected/routine outcome",
-		);
-		assert.ok(
-			rec.infos.some(
-				(e) => e.obj.metric === "placement_move_stale_row_reconciled",
-			),
-		);
-	});
-
-	it("BROKEN: the message is still at the source — the row goes back to the source pair rather than being left `moving` forever", async () => {
-		const rec = buildRecorder([
-			{ accountConfigId: "cfg-1", threadMessageId: "tm-msg-broken" },
-		]);
-
-		const result = await resolveExhaustedPlacementMoveFailure(rec.deps, {
-			accountId: "acc-1",
-			accountConfigId: "cfg-1",
-			messageId: "msg-broken",
-			uid: 202,
-			sourceMailboxId: "mbx-inbox",
-			sourceMailboxPath: "INBOX",
-			getConnection: async () => buildConnection(new Set([202])),
-		});
-
-		assert.equal(result.outcome, "broken");
-		assert.deepEqual(rec.transitions, [
-			{
-				messageId: "msg-broken",
-				expected: {
-					status: [MessageStatus.moving, MessageStatus.deleting],
-				},
-				next: {
-					mailboxId: "mbx-inbox",
-					uid: 202,
-					status: MessageStatus.active,
-					syncStatus: MessageSyncStatus.synced,
-					// Remit's own classification filing, not something the user asked
-					// for, so no per-message give-up marker — the alert is the surface.
-					abandonedMutation: MessageMutation.none,
-				},
-			},
-		]);
-		assert.deepEqual(rec.threadUpdates, ["tm-msg-broken"]);
-		// The marker predicted a move that has now been given up on; leaving it
-		// would keep a folder-count prediction nothing will ever settle.
-		assert.deepEqual(rec.markerDeletes, ["msg-broken"]);
-		assert.deepEqual(rec.deletedMessages, []);
-		assert.ok(
-			rec.errors.some((e) => e.obj.alert === "placement_move_failed"),
-			"the operator signal is the alert, not a stuck row",
-		);
-	});
-
-	// The marker is the operator's evidence that this move still owed IMAP a
-	// push. Dropping it first meant a restore that threw left the row stuck
-	// `moving` with nothing left to say why.
-	it("BROKEN: a restore that throws leaves the marker standing", async () => {
-		const rec = buildRecorder([
-			{ accountConfigId: "cfg-1", threadMessageId: "tm-msg-broken" },
-		]);
-		rec.deps.messageService.transitionPlacement = async () => {
-			throw new Error("ProvisionedThroughputExceeded");
-		};
-
-		await assert.rejects(
-			() =>
-				resolveExhaustedPlacementMoveFailure(rec.deps, {
-					accountId: "acc-1",
-					accountConfigId: "cfg-1",
-					messageId: "msg-broken",
-					uid: 202,
-					sourceMailboxId: "mbx-inbox",
-					sourceMailboxPath: "INBOX",
-					getConnection: async () => buildConnection(new Set([202])),
-				}),
-			/ProvisionedThroughputExceeded/,
-		);
-
-		assert.deepEqual(
-			rec.markerDeletes,
-			[],
-			"the record of the owed push outlives a failed restore",
-		);
-	});
-
-	it("BROKEN with another lane already settled: the restore loses its predicate and writes nothing", async () => {
-		const rec = buildRecorder(
-			[{ accountConfigId: "cfg-1", threadMessageId: "tm-msg-raced" }],
-			false,
-		);
-
-		const result = await resolveExhaustedPlacementMoveFailure(rec.deps, {
-			accountId: "acc-1",
-			accountConfigId: "cfg-1",
-			messageId: "msg-raced",
-			uid: 404,
-			sourceMailboxId: "mbx-inbox",
-			sourceMailboxPath: "INBOX",
-			getConnection: async () => buildConnection(new Set([404])),
-		});
-
-		assert.equal(result.outcome, "broken");
-		assert.equal(rec.transitions.length, 1);
-		assert.deepEqual(
-			rec.threadUpdates,
-			[],
-			"a lost predicate leaves the listing rows to whoever won",
-		);
-	});
-
-	it("a dropped FETCH row is not absence: the message is still at the source — local rows survive", async () => {
-		const rec = buildRecorder([
-			{ accountConfigId: "cfg-1", threadMessageId: "tm-msg-live" },
-		]);
-
-		const result = await resolveExhaustedPlacementMoveFailure(rec.deps, {
-			accountId: "acc-1",
-			accountConfigId: "cfg-1",
-			messageId: "msg-live",
-			uid: 303,
-			sourceMailboxId: "mbx-inbox",
-			sourceMailboxPath: "INBOX",
-			getConnection: async () =>
-				buildConnection(new Set([303]), new Set([303])),
-		});
-
-		assert.equal(result.outcome, "broken");
-		assert.deepEqual(rec.deletedMessages, []);
-		assert.deepEqual(rec.deletedThreadMessages, []);
-		assert.ok(rec.errors.some((e) => e.obj.alert === "placement_move_failed"));
-	});
-
-	it("never throws — both outcomes are terminal, the caller always acks", async () => {
-		const rec = buildRecorder([]);
-
-		await assert.doesNotReject(() =>
-			resolveExhaustedPlacementMoveFailure(rec.deps, {
-				accountId: "acc-1",
-				accountConfigId: "cfg-1",
-				messageId: "msg-x",
-				uid: 1,
-				sourceMailboxId: "mbx-inbox",
-				sourceMailboxPath: "INBOX",
-				getConnection: async () => buildConnection(new Set([1])),
-			}),
-		);
-	});
-});

package/src/placement-move-unsettled.test.ts

@@ -1,275 +0,0 @@
-/**
- * Issue #496's rule applied to the placement move's own re-entry: a second
- * verdict, for a different destination, arriving while the first move is still
- * unconfirmed. The row then names the first destination but still carries the
- * uid of the folder before it, so binding a fresh marker to that pair sends the
- * reconciler to move the destination folder's OWN message at that uid.
- */
-
-import assert from "node:assert/strict";
-import { afterEach, beforeEach, describe, it, mock } from "node:test";
-import { SQSClient } from "@aws-sdk/client-sqs";
-import type {
-	IAddressRepository,
-	IMessagePlacementMoveRepository,
-	IMessageRepository,
-	IThreadMessageRepository,
-	MessageItem,
-	MessagePlacementMoveItem,
-	PlacementPredicate,
-	PlacementTransitionInput,
-	PutMessagePlacementMoveInput,
-} from "@remit/data-ports";
-import { PlacementMoveService } from "./placement-move.js";
-import { noFolderRoles } from "./test-helpers/folder-roles.js";
-
-const ACCOUNT_ID = "acc-pm";
-const ACCOUNT_CONFIG_ID = "cfg-pm";
-const MESSAGE_ID = "msg-pm";
-const INBOX_ID = "mbx-inbox";
-const ARCHIVE_ID = "mbx-archive";
-const JUNK_ID = "mbx-junk";
-const INBOX_UID = 42;
-
-interface Harness {
-	service: PlacementMoveService;
-	row: MessageItem;
-	puts: PutMessagePlacementMoveInput[];
-	marker: MessagePlacementMoveItem | null;
-	reconciled: string[];
-}
-
-const buildHarness = (): Harness => {
-	const row = {
-		messageId: MESSAGE_ID,
-		accountConfigId: ACCOUNT_CONFIG_ID,
-		mailboxId: INBOX_ID,
-		uid: INBOX_UID,
-		status: "active",
-		syncStatus: "synced",
-	} as unknown as MessageItem;
-
-	const puts: PutMessagePlacementMoveInput[] = [];
-	const reconciled: string[] = [];
-	const harness = { row, puts, marker: null, reconciled } as Harness;
-
-	const addressService = {
-		reconcileJunkOnlyForMessage: async (messageId: string) => {
-			reconciled.push(`${messageId}@${row.mailboxId}`);
-		},
-	} as unknown as IAddressRepository;
-
-	const messageService = {
-		get: async () => row,
-		transitionPlacement: async (
-			_messageId: string,
-			expected: PlacementPredicate,
-			next: PlacementTransitionInput,
-		) => {
-			if (expected.status !== undefined && expected.status !== row.status) {
-				return undefined;
-			}
-			if (expected.uid !== undefined && expected.uid !== row.uid) {
-				return undefined;
-			}
-			if (
-				expected.mailboxId !== undefined &&
-				expected.mailboxId !== row.mailboxId
-			) {
-				return undefined;
-			}
-			Object.assign(row, next);
-			return row;
-		},
-	} as unknown as IMessageRepository;
-
-	const threadMessageService = {
-		getByMessageId: async () => ({
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			threadMessageId: "tm-pm",
-			sentDate: 1,
-			mailboxId: row.mailboxId,
-			isRead: false,
-			isDeleted: false,
-			hasStars: false,
-			hasAttachment: false,
-		}),
-		update: async () => {},
-	} as unknown as IThreadMessageRepository;
-
-	const markerService = {
-		put: async (input: PutMessagePlacementMoveInput) => {
-			puts.push(input);
-			harness.marker = {
-				...input,
-				state: "pending",
-				createdAt: Date.now(),
-			} as unknown as MessagePlacementMoveItem;
-			return harness.marker;
-		},
-		find: async () => harness.marker,
-		updateState: async (
-			_messageId: string,
-			state: MessagePlacementMoveItem["state"],
-		) => {
-			if (!harness.marker) throw new Error("no marker");
-			harness.marker.state = state;
-			return harness.marker;
-		},
-		delete: async () => {
-			harness.marker = null;
-		},
-	} as unknown as IMessagePlacementMoveRepository;
-
-	harness.service = new PlacementMoveService({
-		messageService,
-		threadMessageService,
-		markerService,
-		addressService,
-		mailboxSpecialUseService: noFolderRoles,
-		sqsQueueUrl: "https://sqs.eu-west-1.amazonaws.com/000/message-mgmt",
-		moveSettleTimeoutMs: 200,
-		moveSettlePollMs: 10,
-	});
-
-	return harness;
-};
-
-describe("PlacementMoveService — a second destination while the first move is unsettled (#496)", () => {
-	let harness: Harness;
-
-	beforeEach(() => {
-		mock.method(SQSClient.prototype, "send", async () => ({}));
-		harness = buildHarness();
-	});
-
-	afterEach(() => mock.restoreAll());
-
-	it("binds to the settled row once the earlier move confirms", async () => {
-		await harness.service.moveMessage(
-			ACCOUNT_CONFIG_ID,
-			MESSAGE_ID,
-			ARCHIVE_ID,
-			ACCOUNT_ID,
-		);
-		assert.equal(harness.row.status, "moving");
-		assert.equal(harness.row.uid, INBOX_UID);
-
-		// What the reconciler writes when the IMAP move lands: Archive's own
-		// COPYUID, and the status back to active.
-		setTimeout(() => {
-			Object.assign(harness.row, { uid: 907, status: "active" });
-			harness.marker = null;
-		}, 30);
-
-		await harness.service.moveMessage(
-			ACCOUNT_CONFIG_ID,
-			MESSAGE_ID,
-			JUNK_ID,
-			ACCOUNT_ID,
-		);
-
-		assert.equal(harness.puts.length, 2);
-		assert.equal(
-			harness.puts[1]?.sourceMailboxId,
-			ARCHIVE_ID,
-			"the source is where the confirmed move left the message",
-		);
-		assert.equal(harness.row.originalUid, 907, "and its confirmed uid");
-	});
-
-	it("does not apply the move when the earlier one never settles", async () => {
-		await harness.service.moveMessage(
-			ACCOUNT_CONFIG_ID,
-			MESSAGE_ID,
-			ARCHIVE_ID,
-			ACCOUNT_ID,
-		);
-
-		await assert.rejects(
-			() =>
-				harness.service.moveMessage(
-					ACCOUNT_CONFIG_ID,
-					MESSAGE_ID,
-					JUNK_ID,
-					ACCOUNT_ID,
-				),
-			/has not settled/,
-		);
-
-		assert.equal(harness.puts.length, 1, "no second marker was written");
-		assert.equal(
-			harness.puts[0]?.sourceMailboxId,
-			INBOX_ID,
-			"the surviving marker still names the folder the message is actually in",
-		);
-		assert.equal(harness.marker?.destinationMailboxId, ARCHIVE_ID);
-	});
-
-	it("drives a surviving pending marker for the same destination forward", async () => {
-		await harness.service.moveMessage(
-			ACCOUNT_CONFIG_ID,
-			MESSAGE_ID,
-			ARCHIVE_ID,
-			ACCOUNT_ID,
-		);
-		// The enqueue failed on the earlier call, so the marker never advanced.
-		if (harness.marker) harness.marker.state = "pending";
-
-		await harness.service.moveMessage(
-			ACCOUNT_CONFIG_ID,
-			MESSAGE_ID,
-			ARCHIVE_ID,
-			ACCOUNT_ID,
-		);
-
-		assert.equal(harness.puts.length, 1, "the local move is never re-derived");
-		assert.equal(harness.marker?.state, "queued");
-	});
-
-	it("moves a settled row normally", async () => {
-		await harness.service.moveMessage(
-			ACCOUNT_CONFIG_ID,
-			MESSAGE_ID,
-			ARCHIVE_ID,
-			ACCOUNT_ID,
-		);
-		Object.assign(harness.row, { uid: 907, status: "active" });
-		harness.marker = null;
-
-		await harness.service.moveMessage(
-			ACCOUNT_CONFIG_ID,
-			MESSAGE_ID,
-			JUNK_ID,
-			ACCOUNT_ID,
-		);
-
-		assert.equal(harness.puts.length, 2);
-		assert.equal(harness.puts[1]?.sourceMailboxId, ARCHIVE_ID);
-		assert.equal(harness.puts[1]?.destinationMailboxId, JUNK_ID);
-	});
-
-	it("marks the sender when the classifier demotes the message", async () => {
-		await harness.service.moveMessage(
-			ACCOUNT_CONFIG_ID,
-			MESSAGE_ID,
-			JUNK_ID,
-			ACCOUNT_ID,
-		);
-
-		assert.deepEqual(harness.reconciled, [`${MESSAGE_ID}@${JUNK_ID}`]);
-	});
-
-	it("asks nothing of a destination the message is already in", async () => {
-		Object.assign(harness.row, { mailboxId: JUNK_ID });
-
-		await harness.service.moveMessage(
-			ACCOUNT_CONFIG_ID,
-			MESSAGE_ID,
-			JUNK_ID,
-			ACCOUNT_ID,
-		);
-
-		assert.deepEqual(harness.reconciled, []);
-	});
-});