@remit/mailbox-service 0.0.111 → 0.0.113

package/src/mailbox-management.test.ts

@@ -1,356 +0,0 @@
-import assert from "node:assert";
-import { describe, it } from "node:test";
-import type {
-	IMailboxRepository,
-	MailboxItem,
-	MailboxTransitionIntent,
-} from "@remit/data-ports";
-import { MailboxSyncStatus } from "@remit/domain-enums";
-import {
-	MailboxManagementService,
-	parseMailboxPath,
-	validateMailboxOperation,
-	validateMailboxPath,
-} from "./mailbox-management.js";
-import type {
-	FlatMailboxInfo,
-	IImapConnection,
-	ImapBoxStatus,
-} from "./types.js";
-
-describe("parseMailboxPath", () => {
-	it("parses simple path", () => {
-		const result = parseMailboxPath("INBOX");
-		assert.strictEqual(result.name, "INBOX");
-		assert.strictEqual(result.parent, null);
-		assert.strictEqual(result.depth, 1);
-	});
-
-	it("parses nested path with default delimiter", () => {
-		const result = parseMailboxPath("Work/Projects/ClientA");
-		assert.strictEqual(result.name, "ClientA");
-		assert.strictEqual(result.parent, "Work/Projects");
-		assert.strictEqual(result.depth, 3);
-	});
-
-	it("parses nested path with custom delimiter", () => {
-		const result = parseMailboxPath("Work.Projects.ClientA", ".");
-		assert.strictEqual(result.name, "ClientA");
-		assert.strictEqual(result.parent, "Work.Projects");
-		assert.strictEqual(result.depth, 3);
-	});
-
-	it("handles two-level path", () => {
-		const result = parseMailboxPath("Personal/Archive");
-		assert.strictEqual(result.name, "Archive");
-		assert.strictEqual(result.parent, "Personal");
-		assert.strictEqual(result.depth, 2);
-	});
-});
-
-describe("validateMailboxPath", () => {
-	it("throws on empty path", () => {
-		assert.throws(() => validateMailboxPath(""), {
-			message: "Mailbox path cannot be empty",
-		});
-	});
-
-	it("throws on whitespace-only path", () => {
-		assert.throws(() => validateMailboxPath("   "), {
-			message: "Mailbox path cannot be empty",
-		});
-	});
-
-	it("throws on double delimiters", () => {
-		assert.throws(() => validateMailboxPath("Work//Projects"), {
-			message: "Mailbox path cannot contain empty hierarchy levels",
-		});
-	});
-
-	it("throws on leading delimiter", () => {
-		assert.throws(() => validateMailboxPath("/Work/Projects"), {
-			message: "Mailbox path cannot start or end with hierarchy delimiter",
-		});
-	});
-
-	it("throws on trailing delimiter", () => {
-		assert.throws(() => validateMailboxPath("Work/Projects/"), {
-			message: "Mailbox path cannot start or end with hierarchy delimiter",
-		});
-	});
-
-	it("accepts valid simple path", () => {
-		assert.doesNotThrow(() => validateMailboxPath("INBOX"));
-	});
-
-	it("accepts valid nested path", () => {
-		assert.doesNotThrow(() => validateMailboxPath("Work/Projects/ClientA"));
-	});
-});
-
-const boxStatus = (path: string): ImapBoxStatus => ({
-	name: path,
-	readOnly: true,
-	uidvalidity: 42,
-	uidnext: 7,
-	flags: [],
-	permFlags: [],
-	persistentUIDs: true,
-	messages: { total: 0, new: 0 },
-	newKeywords: false,
-});
-
-const recordingRepo = (
-	held: Pick<MailboxItem, "mailboxId" | "fullPath">[] = [],
-) => {
-	const removed: string[] = [];
-	const updates: Array<{ mailboxId: string; patch: Record<string, unknown> }> =
-		[];
-	const settles: Array<{
-		mailboxId: string;
-		intent: MailboxTransitionIntent;
-	}> = [];
-	const repo: Pick<
-		IMailboxRepository,
-		| "update"
-		| "transition"
-		| "findByPathPrefix"
-		| "findByPath"
-		| "deleteMailboxWithMail"
-	> = {
-		update: async (
-			_accountId: string,
-			mailboxId: string,
-			patch: Record<string, unknown>,
-		) => {
-			updates.push({ mailboxId, patch });
-			return {} as never;
-		},
-		transition: async (
-			_accountId: string,
-			mailboxId: string,
-			intent: MailboxTransitionIntent,
-		) => {
-			settles.push({ mailboxId, intent });
-			return {} as never;
-		},
-		findByPathPrefix: async () => [],
-		findByPath: async (_accountId: string, fullPath: string) =>
-			(held.find((row) => row.fullPath === fullPath) as MailboxItem) ?? null,
-		deleteMailboxWithMail: async (_accountId: string, mailboxId: string) => {
-			removed.push(mailboxId);
-		},
-	};
-	return { repo: repo as IMailboxRepository, updates, settles, removed };
-};
-
-const stubConnection = (
-	createdPath: string,
-	listed: string[],
-): { connection: IImapConnection; opened: string[] } => {
-	const opened: string[] = [];
-	const connection = {
-		createMailbox: async (_path: string) => ({
-			path: createdPath,
-			created: true,
-		}),
-		subscribeMailbox: async () => undefined,
-		listMailboxes: async (): Promise<FlatMailboxInfo[]> =>
-			listed.map((fullPath) => ({
-				fullPath,
-				name: fullPath.split("/").pop() ?? fullPath,
-				delimiter: "/",
-				attributes: [],
-				parentPath: null,
-			})),
-		openBox: async (path: string) => {
-			opened.push(path);
-			return boxStatus(path);
-		},
-		closeBox: async () => undefined,
-	} as unknown as IImapConnection;
-	return { connection, opened };
-};
-
-describe("MailboxManagementService.syncCreate — server path normalization", () => {
-	it("adopts the server-materialized path as the row's identity when it is prefixed", async () => {
-		const { repo, settles } = recordingRepo();
-		const { connection, opened } = stubConnection("INBOX/Notifications", [
-			"INBOX/Notifications",
-		]);
-		const service = new MailboxManagementService(repo);
-
-		const result = await service.syncCreate(
-			"acc-1",
-			"mbx-1",
-			"Notifications",
-			async () => connection,
-		);
-
-		assert.strictEqual(result.success, true);
-		// The mailbox is opened at the server's path, not the requested leaf.
-		assert.deepStrictEqual(opened, ["INBOX/Notifications"]);
-		assert.strictEqual(settles.length, 1);
-		// The row keeps its id and takes on the prefixed path, so the next reconcile
-		// updates it in place instead of insert+delete — every reference survives.
-		assert.strictEqual(settles[0].mailboxId, "mbx-1");
-		assert.strictEqual(settles[0].intent.set?.fullPath, "INBOX/Notifications");
-		assert.strictEqual(settles[0].intent.to, MailboxSyncStatus.synced);
-	});
-
-	it("drops the pending row when the prefixed path already has a folder (#318)", async () => {
-		const { repo, settles, updates, removed } = recordingRepo([
-			{ mailboxId: "mbx-existing", fullPath: "INBOX/Notifications" },
-		]);
-		const connection = {
-			createMailbox: async (_path: string) => ({
-				path: "INBOX/Notifications",
-				created: false,
-			}),
-			subscribeMailbox: async () => undefined,
-			listMailboxes: async (): Promise<FlatMailboxInfo[]> => [],
-			openBox: async (path: string) => boxStatus(path),
-			closeBox: async () => undefined,
-		} as unknown as IImapConnection;
-		const service = new MailboxManagementService(repo);
-
-		const result = await service.syncCreate(
-			"acc-1",
-			"mbx-recreated",
-			"Notifications",
-			async () => connection,
-		);
-
-		assert.deepStrictEqual(result, {
-			success: true,
-			existing: { mailboxId: "mbx-existing", fullPath: "INBOX/Notifications" },
-		});
-		assert.deepStrictEqual(removed, ["mbx-recreated"]);
-		assert.deepStrictEqual(settles, []);
-		assert.deepStrictEqual(updates, []);
-	});
-
-	it("leaves the path untouched when the server keeps it as requested", async () => {
-		const { repo, settles } = recordingRepo();
-		const { connection } = stubConnection("Work", ["Work"]);
-		const service = new MailboxManagementService(repo);
-
-		await service.syncCreate("acc-1", "mbx-2", "Work", async () => connection);
-
-		assert.strictEqual(settles.length, 1);
-		assert.deepStrictEqual(settles[0].intent.set, {});
-		assert.strictEqual(settles[0].intent.to, MailboxSyncStatus.synced);
-	});
-
-	it("still adopts the server path when the fresh list cannot resolve it", async () => {
-		const { repo, settles } = recordingRepo();
-		const { connection, opened } = stubConnection("INBOX/Notifications", []);
-		const service = new MailboxManagementService(repo);
-
-		await service.syncCreate(
-			"acc-1",
-			"mbx-3",
-			"Notifications",
-			async () => connection,
-		);
-
-		assert.deepStrictEqual(opened, []);
-		assert.strictEqual(settles.length, 1);
-		assert.strictEqual(settles[0].intent.set?.fullPath, "INBOX/Notifications");
-		assert.strictEqual(settles[0].intent.to, MailboxSyncStatus.synced);
-	});
-
-	it("falls back to the requested path when the create result carries none", async () => {
-		const { repo, settles } = recordingRepo();
-		const opened: string[] = [];
-		const subscribed: string[] = [];
-		const connection = {
-			createMailbox: async (_path: string) => ({ created: true }),
-			subscribeMailbox: async (p: string) => {
-				subscribed.push(p);
-			},
-			listMailboxes: async (): Promise<FlatMailboxInfo[]> => [
-				{
-					fullPath: "Archive",
-					name: "Archive",
-					delimiter: "/",
-					attributes: [],
-					parentPath: null,
-				},
-			],
-			openBox: async (p: string) => {
-				opened.push(p);
-				return boxStatus(p);
-			},
-			closeBox: async () => undefined,
-		} as unknown as IImapConnection;
-		const service = new MailboxManagementService(repo);
-
-		await service.syncCreate(
-			"acc-1",
-			"mbx-4",
-			"Archive",
-			async () => connection,
-			true,
-		);
-
-		// A thin result never blanks fullPath — the requested path is used throughout.
-		assert.deepStrictEqual(subscribed, ["Archive"]);
-		assert.deepStrictEqual(opened, ["Archive"]);
-		assert.strictEqual(settles.length, 1);
-		assert.deepStrictEqual(settles[0].intent.set, {});
-		assert.strictEqual(settles[0].intent.to, MailboxSyncStatus.synced);
-	});
-
-	it("settles only a row with no rename target on it", async () => {
-		// The predicate the seventh state turns on (D3). A create redelivered
-		// after a lost acknowledgement, against a row a rename has since claimed,
-		// passes a `pending`-only guard, gets `{created: false}` — which #346
-		// correctly reads as success — and would settle `synced` with the rename
-		// target still on it, killing the rename silently.
-		const { repo, settles } = recordingRepo();
-		const { connection } = stubConnection("Archive", ["Archive"]);
-		const service = new MailboxManagementService(repo);
-
-		await service.syncCreate(
-			"acc-1",
-			"mbx-5",
-			"Archive",
-			async () => connection,
-		);
-
-		assert.strictEqual(settles[0].intent.wherePendingPath, null);
-		assert.deepStrictEqual(settles[0].intent.from, [MailboxSyncStatus.pending]);
-	});
-});
-
-describe("validateMailboxOperation", () => {
-	it("throws when deleting INBOX", () => {
-		assert.throws(() => validateMailboxOperation("delete", "INBOX"), {
-			message: "Cannot delete INBOX",
-		});
-	});
-
-	it("throws when deleting INBOX (case insensitive)", () => {
-		assert.throws(() => validateMailboxOperation("delete", "inbox"), {
-			message: "Cannot delete INBOX",
-		});
-	});
-
-	it("allows deleting other mailboxes", () => {
-		assert.doesNotThrow(() => validateMailboxOperation("delete", "Archive"));
-	});
-
-	it("throws when renaming INBOX", () => {
-		// The server would move INBOX's mail to the new name and leave an empty
-		// INBOX behind — a bulk move, not a path update (D5). The API refuses it;
-		// this is the worker's backstop.
-		assert.throws(() => validateMailboxOperation("rename", "INBOX"), {
-			message: "Cannot rename INBOX",
-		});
-	});
-
-	it("allows renaming other mailboxes", () => {
-		assert.doesNotThrow(() => validateMailboxOperation("rename", "Archive"));
-	});
-});