@remit/web-client 0.0.325 → 0.0.326

package/src/lib/result-folder.test.ts

@@ -1,133 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { provenanceFolderLabel } from "@remit/ui";
-import {
-	type AccountMailboxes,
-	buildResultFolderIndex,
-	resolveResultFolder,
-} from "./result-folder";
-
-const account = (
-	appointments: { role: string; mailboxId: string }[],
-	mailboxes: { mailboxId: string; fullPath: string }[],
-	hierarchyDelimiter = "/",
-): AccountMailboxes =>
-	({
-		folderAppointments: appointments,
-		mailboxes: mailboxes.map((mailbox) => ({ ...mailbox, hierarchyDelimiter })),
-	}) as unknown as AccountMailboxes;
-
-describe("buildResultFolderIndex", () => {
-	it("maps a mailbox to its appointed role and provider path", () => {
-		const index = buildResultFolderIndex([
-			account(
-				[{ role: "Junk", mailboxId: "mb-junk" }],
-				[
-					{ mailboxId: "mb-junk", fullPath: "Bulk Mail" },
-					{ mailboxId: "mb-work", fullPath: "Projects/Bookkeeping" },
-				],
-			),
-		]);
-
-		assert.deepEqual(index.get("mb-junk"), {
-			role: "junk",
-			providerPath: "Bulk Mail",
-			hierarchyDelimiter: "/",
-		});
-		assert.deepEqual(index.get("mb-work"), {
-			providerPath: "Projects/Bookkeeping",
-			hierarchyDelimiter: "/",
-		});
-	});
-
-	it("keeps every account's mailboxes", () => {
-		const index = buildResultFolderIndex([
-			account(
-				[{ role: "Inbox", mailboxId: "a-inbox" }],
-				[{ mailboxId: "a-inbox", fullPath: "INBOX" }],
-			),
-			account(
-				[{ role: "Inbox", mailboxId: "b-inbox" }],
-				[{ mailboxId: "b-inbox", fullPath: "INBOX" }],
-			),
-		]);
-
-		assert.equal(index.get("a-inbox")?.role, "inbox");
-		assert.equal(index.get("b-inbox")?.role, "inbox");
-	});
-});
-
-describe("resolveResultFolder", () => {
-	const index = buildResultFolderIndex([
-		account(
-			[
-				{ role: "Inbox", mailboxId: "mb-inbox" },
-				{ role: "All", mailboxId: "mb-all" },
-				{ role: "Junk", mailboxId: "mb-junk" },
-			],
-			[
-				{ mailboxId: "mb-inbox", fullPath: "INBOX" },
-				{ mailboxId: "mb-all", fullPath: "[Gmail]/All Mail" },
-				{ mailboxId: "mb-junk", fullPath: "[Gmail]/Spam" },
-			],
-		),
-	]);
-
-	it("skips a virtual folder for one that names a real place", () => {
-		assert.deepEqual(resolveResultFolder(index, ["mb-all", "mb-inbox"]), {
-			mailboxId: "mb-inbox",
-			folder: { role: "inbox", providerPath: "INBOX", hierarchyDelimiter: "/" },
-		});
-	});
-
-	it("resolves Spam by its appointed role, not its path", () => {
-		assert.equal(resolveResultFolder(index, ["mb-junk"]).folder?.role, "junk");
-	});
-
-	it("falls back to the first id when none names a real place", () => {
-		assert.deepEqual(resolveResultFolder(index, ["mb-all"]), {
-			mailboxId: "mb-all",
-			folder: {
-				role: "all",
-				providerPath: "[Gmail]/All Mail",
-				hierarchyDelimiter: "/",
-			},
-		});
-	});
-
-	it("returns the id but no folder when the mailbox is unknown", () => {
-		assert.deepEqual(resolveResultFolder(index, ["mb-gone"]), {
-			mailboxId: "mb-gone",
-		});
-	});
-
-	it("returns nothing for a result with no mailboxes", () => {
-		assert.deepEqual(resolveResultFolder(index, []), {});
-	});
-
-	it("still names a mailbox before the index has loaded", () => {
-		assert.deepEqual(resolveResultFolder(undefined, ["mb-inbox"]), {
-			mailboxId: "mb-inbox",
-		});
-	});
-});
-
-describe("buildResultFolderIndex before the mailbox list arrives", () => {
-	it("still knows the appointed role, so spam is never let through", () => {
-		const index = buildResultFolderIndex([
-			account([{ role: "Junk", mailboxId: "mb-junk" }], []),
-		]);
-
-		assert.deepEqual(index.get("mb-junk"), { role: "junk" });
-	});
-});
-
-describe("buildResultFolderIndex on a dotted server", () => {
-	it("carries the delimiter the account reports, so the chip reads the leaf", () => {
-		const index = buildResultFolderIndex([
-			account([], [{ mailboxId: "mb-q3", fullPath: "INBOX.Projects.Q3" }], "."),
-		]);
-
-		assert.equal(provenanceFolderLabel(index.get("mb-q3") ?? {}), "Q3");
-	});
-});

package/src/lib/result-folder.ts

@@ -1,111 +0,0 @@
-/**
- * Where a search result was read from.
- *
- * A global search returns rows from every folder of every account, so each row
- * says where it came from and spam is held out of the list. Both questions are
- * answered by joining the row's mailbox ids against the mailbox lists the
- * sidebar already loads: the id → folder map here is the only thing either
- * needs, so the search API does not have to carry a folder.
- *
- * The mailbox row carries the hierarchy delimiter its own server reports, and it
- * is kept alongside the path: a chip labelled by path shows the folder's own
- * name, which on a `.`-delimited account cannot be cut on a slash.
- *
- * The role comes from the account's `folderAppointments` map (RFC 032), which
- * the server resolves from the IMAP SPECIAL-USE attributes — so `junk` means the
- * folder the account advertises as `\Junk`, whatever it is called. Names are
- * never consulted.
- */
-import type {
-	RemitImapFolderAppointment,
-	RemitImapMailboxResponse,
-} from "@remit/api-http-client/types.gen.ts";
-import { provenanceFolderLabel, type ResultFolder } from "@remit/ui";
-import { buildMailboxRoleMap } from "./folder-roles.js";
-
-export type ResultFolderIndex = ReadonlyMap<string, ResultFolder>;
-
-export const EMPTY_RESULT_FOLDER_INDEX: ResultFolderIndex = new Map();
-
-export interface AccountMailboxes {
-	folderAppointments: readonly RemitImapFolderAppointment[];
-	mailboxes: readonly Pick<
-		RemitImapMailboxResponse,
-		"mailboxId" | "fullPath" | "hierarchyDelimiter"
-	>[];
-}
-
-/**
- * The appointments and the mailbox list arrive from two different queries, so
- * the roles are seeded first and the provider paths laid over them. A role on
- * its own is enough to hold spam out of a global search, which means the list
- * loading late cannot let a Spam row through into the results.
- */
-export function buildResultFolderIndex(
-	accounts: readonly AccountMailboxes[],
-): ResultFolderIndex {
-	const index = new Map<string, ResultFolder>();
-	for (const account of accounts) {
-		const roles = buildMailboxRoleMap(account.folderAppointments);
-		for (const [mailboxId, role] of roles) index.set(mailboxId, { role });
-		for (const mailbox of account.mailboxes) {
-			const role = roles.get(mailbox.mailboxId);
-			const path = {
-				providerPath: mailbox.fullPath,
-				hierarchyDelimiter: mailbox.hierarchyDelimiter,
-			};
-			index.set(mailbox.mailboxId, role ? { role, ...path } : path);
-		}
-	}
-	return index;
-}
-
-/**
- * Every junk folder the index knows, in index order.
- *
- * The same `\Junk` appointment that holds a row out of a global search, read
- * the other way round: these are the folders whose contents the Spam offer
- * counts. Order is the accounts' own, so the offer's destination does not move
- * between renders (#313).
- */
-export function junkMailboxIds(folders: ResultFolderIndex): string[] {
-	const ids: string[] = [];
-	for (const [mailboxId, folder] of folders) {
-		if (folder.role === "junk") ids.push(mailboxId);
-	}
-	return ids;
-}
-
-export interface ResolvedResultFolder {
-	mailboxId?: string;
-	folder?: ResultFolder;
-}
-
-/**
- * The mailbox a result should be attributed to, and its folder.
- *
- * A message can sit in several mailboxes at once — Gmail files a copy of most
- * mail in All Mail — and the order the ids arrive in carries no meaning, so the
- * first id that names a real place wins. `provenanceFolderLabel` is the test:
- * it is undefined exactly for the folders that are views rather than places.
- * With nothing resolvable the first id is still returned, because opening the
- * result needs a mailbox even when labelling it does not.
- */
-export function resolveResultFolder(
-	folders: ResultFolderIndex | undefined,
-	mailboxIds: readonly string[],
-): ResolvedResultFolder {
-	const first = mailboxIds[0];
-	if (!folders) return first ? { mailboxId: first } : {};
-
-	for (const mailboxId of mailboxIds) {
-		const folder = folders.get(mailboxId);
-		if (folder && provenanceFolderLabel(folder) !== undefined) {
-			return { mailboxId, folder };
-		}
-	}
-
-	if (!first) return {};
-	const folder = folders.get(first);
-	return { mailboxId: first, ...(folder ? { folder } : {}) };
-}

package/src/lib/route-breadcrumbs.test.ts

@@ -1,41 +0,0 @@
-import assert from "node:assert/strict";
-import { beforeEach, describe, it } from "node:test";
-import {
-	__resetRouteBreadcrumbs,
-	getRecentRoutes,
-	recordRoute,
-} from "./route-breadcrumbs";
-
-beforeEach(() => {
-	__resetRouteBreadcrumbs();
-});
-
-describe("recordRoute", () => {
-	it("captures the pathname with a timestamp", () => {
-		recordRoute("/mail/inbox");
-		const [entry] = getRecentRoutes();
-		assert.equal(entry.path, "/mail/inbox");
-		assert.ok(entry.timestamp);
-	});
-
-	it("strips a query string — never the user's search text", () => {
-		recordRoute("/mail/search?q=confidential");
-		const [entry] = getRecentRoutes();
-		assert.equal(entry.path, "/mail/search");
-		assert.ok(!JSON.stringify(entry).includes("confidential"));
-	});
-
-	it("collapses a repeated navigation to the same path", () => {
-		recordRoute("/mail/inbox");
-		recordRoute("/mail/inbox");
-		assert.equal(getRecentRoutes().length, 1);
-	});
-
-	it("keeps only the last eight navigations", () => {
-		for (let i = 0; i < 12; i++) recordRoute(`/mail/${i}`);
-		const entries = getRecentRoutes();
-		assert.equal(entries.length, 8);
-		assert.equal(entries[0].path, "/mail/4");
-		assert.equal(entries[7].path, "/mail/11");
-	});
-});

package/src/lib/route-breadcrumbs.ts

@@ -1,45 +0,0 @@
-/**
- * A constant-size ring of the last few in-app navigations, captured from the
- * router's `onResolved` event (see router.tsx). It gives a bug report a
- * navigation trail, so "Steps to reproduce" has something concrete even when
- * the reporter leaves the template blank.
- *
- * PRIVACY — like request breadcrumbs, this is METADATA ONLY and the tracker is
- * public. A route entry is the resolved PATHNAME and a timestamp. The query
- * string is dropped: a search route's `?q=` carries the user's query text.
- * Opaque path ids (a message id in the path) are acceptable — they already
- * appear in the report's URL section.
- */
-
-export interface RouteBreadcrumb {
-	/** Resolved pathname only — never the query string (see file header). */
-	path: string;
-	timestamp: string;
-}
-
-const MAX_ENTRIES = 8;
-
-const ring: RouteBreadcrumb[] = [];
-
-/**
- * Record a navigation. `path` is expected to be a pathname; any query or hash
- * is stripped defensively so a caller passing a full location cannot leak query
- * text into a breadcrumb.
- */
-export function recordRoute(path: string): void {
-	const clean = path.split(/[?#]/)[0];
-	const last = ring[ring.length - 1];
-	if (last && last.path === clean) return;
-	ring.push({ path: clean, timestamp: new Date().toISOString() });
-	if (ring.length > MAX_ENTRIES) ring.shift();
-}
-
-/** The captured navigations, oldest first. A copy — callers cannot mutate the ring. */
-export function getRecentRoutes(): readonly RouteBreadcrumb[] {
-	return ring.slice();
-}
-
-/** Test-only: clear the ring. */
-export function __resetRouteBreadcrumbs(): void {
-	ring.length = 0;
-}

package/src/lib/route-search-query.test.ts

@@ -1,70 +0,0 @@
-/**
- * `q` lives on the parent `/mail` route, but every list re-declares it: a
- * child's `validateSearch` is authoritative for its own URL, so a list that
- * omits `q` strips it. The top bar mounts a search field on all four lists, so
- * a stripped `q` means typing a query does nothing and the query is lost on the
- * next navigation.
- *
- * Two halves: the schemas carry `q`, and each route is wired to the schema
- * declared for its own path. The second half has to load route files, so it runs
- * out of process — see `test-support/list-search-binding.ts`.
- */
-import assert from "node:assert/strict";
-import { execFileSync } from "node:child_process";
-import { describe, it } from "node:test";
-import { fileURLToPath } from "node:url";
-import { mailIndexSearchSchema, mailListSearchSchemas } from "./mail-search.js";
-
-const schemas = {
-	...mailListSearchSchemas,
-	"/mail/ (the redirect to the brief)": mailIndexSearchSchema,
-};
-
-describe("every /mail list carries `q` through its own validation", () => {
-	for (const [name, schema] of Object.entries(schemas)) {
-		it(`${name} preserves a query`, () => {
-			const parsed = schema.parse({ q: "invoice" }) as { q?: string };
-			assert.equal(
-				parsed.q,
-				"invoice",
-				`${name} drops q, so the top bar's search field is inert there`,
-			);
-		});
-
-		it(`${name} leaves q absent when there is none`, () => {
-			const parsed = schema.parse({}) as { q?: string };
-			assert.equal(parsed.q, undefined);
-		});
-	}
-});
-
-describe("every /mail list route uses the schema declared for its path", () => {
-	it("holds for all four lists", () => {
-		const check = fileURLToPath(
-			new URL("../test-support/list-search-binding.ts", import.meta.url),
-		);
-		const register = fileURLToPath(
-			new URL("../../test-support/register.mjs", import.meta.url),
-		);
-		// The runner re-injects its coverage directory into any child, even one
-		// given an environment without it, and coverage from this child would put
-		// every pane the route files reach into the denominator — the reason the
-		// check is out of process at all. An empty value is the one thing that
-		// stops the child writing there.
-		assert.doesNotThrow(() =>
-			execFileSync(
-				process.execPath,
-				["--import", "tsx", "--import", register, check],
-				{
-					stdio: "pipe",
-					encoding: "utf8",
-					env: {
-						...process.env,
-						NODE_V8_COVERAGE: "",
-						TSX_TSCONFIG_PATH: "./tsconfig.test.json",
-					},
-				},
-			),
-		);
-	});
-});

package/src/lib/row-settlement.ts

@@ -1,28 +0,0 @@
-import type { RemitImapThreadMessageResponse } from "@remit/api-http-client/types.gen.ts";
-import { abandonedMutationOf } from "@remit/data-ports/message-settlement";
-import { MessageMutation } from "@remit/domain-enums";
-import type { ThreadRowData } from "@remit/ui";
-
-/**
- * The row treatment for a message whose mutation Remit gave up on (issue
- * #1002). The client decides nothing: `abandonedMutationOf` owns which values
- * prove a terminal give-up and which operation it was. A copy that gave up
- * leaves a `deleted` row no listing carries, so it reaches no row here; any
- * other row — settled, mid-retry, or in flight — carries no key at all and
- * renders exactly as it always has.
- */
-export const rowSettlement = (
-	thread: Pick<
-		RemitImapThreadMessageResponse,
-		"status" | "syncStatus" | "abandonedMutation"
-	>,
-): Pick<ThreadRowData, "settlement"> => {
-	switch (abandonedMutationOf(thread)) {
-		case MessageMutation.delete:
-			return { settlement: "delete_failed" };
-		case MessageMutation.move:
-			return { settlement: "move_failed" };
-		default:
-			return {};
-	}
-};

package/src/lib/rum-adapter.test.ts

@@ -1,195 +0,0 @@
-import assert from "node:assert/strict";
-import { afterEach, beforeEach, describe, it } from "node:test";
-import { AwsRum } from "aws-rum-web";
-import { createRumTelemetry, initRum } from "./rum-adapter";
-
-interface RumStub {
-	appMonitorId: string;
-	calls: {
-		recordPageView: string[];
-		recordError: Error[];
-		recordEvent: { name: string; attributes: Record<string, unknown> }[];
-	};
-}
-
-function resetInstances(): void {
-	(
-		globalThis as unknown as { __AWS_RUM_MOCKS__: { instances: unknown[] } }
-	).__AWS_RUM_MOCKS__ = { instances: [] };
-}
-
-function getLastInstance(): RumStub {
-	const mocks = (
-		globalThis as unknown as {
-			__AWS_RUM_MOCKS__: { instances: RumStub[] };
-		}
-	).__AWS_RUM_MOCKS__;
-	const instance = mocks.instances.at(-1);
-	assert.ok(instance, "Expected an AwsRum instance to have been created");
-	return instance;
-}
-
-function makeRum(): AwsRum {
-	return new (
-		AwsRum as unknown as new (
-			id: string,
-			v: string,
-			r: string,
-			c: Record<string, unknown>,
-		) => AwsRum
-	)("monitor-id", "1.0.0", "eu-west-1", {});
-}
-
-function stubCalls(rum: AwsRum): RumStub["calls"] {
-	return (rum as unknown as RumStub).calls;
-}
-
-describe("createRumTelemetry", () => {
-	let rum: AwsRum;
-
-	beforeEach(() => {
-		resetInstances();
-		rum = makeRum();
-	});
-
-	it("recordPageView strips the entire query string", () => {
-		const t = createRumTelemetry(rum);
-		t.recordPageView("/callback?token=secret&next=/inbox");
-		assert.equal(stubCalls(rum).recordPageView[0], "/callback");
-	});
-
-	it("recordPageView strips fragment-only paths", () => {
-		const t = createRumTelemetry(rum);
-		t.recordPageView("/inbox#fragment");
-		assert.equal(stubCalls(rum).recordPageView[0], "/inbox");
-	});
-
-	it("recordPageView strips message id path segments", () => {
-		const t = createRumTelemetry(rum);
-		t.recordPageView("/messages/msg_abc123def456");
-		assert.ok(
-			!stubCalls(rum).recordPageView[0]?.includes("msg_abc123def456"),
-			"message id must be redacted",
-		);
-	});
-
-	it("recordError scrubs message id tokens from error messages", () => {
-		const t = createRumTelemetry(rum);
-		const error = new Error("failed to load /messages/msg_abc123def456");
-		t.recordError(error);
-		const recorded = stubCalls(rum).recordError[0] as Error;
-		assert.ok(
-			!recorded.message.includes("msg_abc123def456"),
-			"message id must be scrubbed from error message",
-		);
-	});
-
-	it("recordError preserves error name on scrubbed errors", () => {
-		const t = createRumTelemetry(rum);
-		const error = new TypeError("token=secret leaked into /messages/msg_xyz");
-		t.recordError(error);
-		const recorded = stubCalls(rum).recordError[0] as Error;
-		assert.equal(recorded.name, "TypeError");
-	});
-});
-
-type WindowListener = (event: unknown) => void;
-
-interface WindowStub {
-	listeners: Map<string, WindowListener>;
-	addEventListener(type: string, listener: WindowListener): void;
-}
-
-function installWindowStub(): WindowStub {
-	const stub: WindowStub = {
-		listeners: new Map(),
-		addEventListener(type, listener): void {
-			this.listeners.set(type, listener);
-		},
-	};
-	(globalThis as unknown as { window: WindowStub }).window = stub;
-	return stub;
-}
-
-function getRumConfig(
-	instance: RumStub,
-): { telemetries: string[] } & Record<string, unknown> {
-	return (instance as unknown as { config: { telemetries: string[] } }).config;
-}
-
-describe("initRum", () => {
-	afterEach(() => {
-		delete globalThis.__REMIT_CONFIG__;
-		delete (globalThis as unknown as { window?: unknown }).window;
-	});
-
-	it("does not enable leaky auto-telemetries", () => {
-		resetInstances();
-		installWindowStub();
-		globalThis.__REMIT_CONFIG__ = {
-			rum: { appMonitorId: "test-monitor-id" },
-		};
-		initRum();
-		const config = getRumConfig(getLastInstance());
-		assert.ok(
-			!config.telemetries.includes("errors"),
-			"errors auto-capture must be disabled",
-		);
-		assert.ok(
-			!config.telemetries.includes("http"),
-			"http auto-capture must be disabled",
-		);
-	});
-
-	it("disables auto page view so paths are recorded via the sanitizing adapter", () => {
-		resetInstances();
-		installWindowStub();
-		globalThis.__REMIT_CONFIG__ = {
-			rum: { appMonitorId: "test-monitor-id" },
-		};
-		initRum();
-		const config = getRumConfig(getLastInstance());
-		assert.equal(config.disableAutoPageView, true);
-	});
-
-	it("scrubs uncaught errors before recording them through RUM", () => {
-		resetInstances();
-		const win = installWindowStub();
-		globalThis.__REMIT_CONFIG__ = {
-			rum: { appMonitorId: "test-monitor-id" },
-		};
-		initRum();
-		const handler = win.listeners.get("error");
-		assert.ok(handler, "Expected a global error handler");
-		handler({
-			error: new Error("failed to load /messages/msg_abc123def456"),
-			message: "failed to load /messages/msg_abc123def456",
-		});
-		const recorded = stubCalls(getLastInstance() as unknown as AwsRum)
-			.recordError[0] as Error;
-		assert.ok(
-			!recorded.message.includes("msg_abc123def456"),
-			"uncaught error message must be scrubbed",
-		);
-	});
-
-	it("scrubs unhandled rejections before recording them through RUM", () => {
-		resetInstances();
-		const win = installWindowStub();
-		globalThis.__REMIT_CONFIG__ = {
-			rum: { appMonitorId: "test-monitor-id" },
-		};
-		initRum();
-		const handler = win.listeners.get("unhandledrejection");
-		assert.ok(handler, "Expected a global unhandledrejection handler");
-		handler({
-			reason: new Error("rejected loading /messages/msg_xyz789"),
-		});
-		const recorded = stubCalls(getLastInstance() as unknown as AwsRum)
-			.recordError[0] as Error;
-		assert.ok(
-			!recorded.message.includes("msg_xyz789"),
-			"rejection reason must be scrubbed",
-		);
-	});
-});