@remit/web-client 0.0.228 → 0.0.230

package/src/components/compose/quoted-message.ts

@@ -0,0 +1,216 @@
+import type { RemitImapDescribeMessageResponse } from "@remit/api-http-client/types.gen.ts";
+import { type RichTextValue, wrapWithLanguage } from "@remit/ui";
+import type { ComposeBodyMode } from "@remit/ui/rich-text";
+import { formatDate } from "../../lib/format";
+
+type Envelope = RemitImapDescribeMessageResponse["envelope"];
+type EnvelopeAddress = Envelope["from"][number];
+
+/** Whether the original is being answered or passed on. */
+export type QuoteKind = "reply" | "forward";
+
+/** The message being quoted, in both the representations a send carries. */
+export interface QuotedBlock {
+	text: string;
+	html: string;
+}
+
+/**
+ * The original's body as the content route hands it over: one part, either
+ * HTML or plain text, never both. The other representation is derived here,
+ * because a message goes out with both and HTML markup dropped into the
+ * `text/plain` part arrives as visible tags.
+ */
+export type QuotedSourceBody =
+	| { kind: "text"; content: string }
+	| { kind: "html"; content: string };
+
+export const escapeHtml = (text: string): string =>
+	text
+		.replace(/&/g, "&")
+		.replace(/</g, "&lt;")
+		.replace(/>/g, "&gt;")
+		.replace(/"/g, "&quot;");
+
+export const textToHtml = (text: string): string =>
+	text
+		.split("\n")
+		.map((line) => `<p>${escapeHtml(line)}</p>`)
+		.join("");
+
+/**
+ * Elements that end the line they are on. Everything else is inline and runs
+ * into its neighbours, which is what separates a plain-text rendering of a
+ * message from its `textContent` — that returns one long line with the words
+ * of adjacent paragraphs joined together.
+ */
+const LINE_BREAKING_TAGS = new Set([
+	"ADDRESS",
+	"ARTICLE",
+	"BLOCKQUOTE",
+	"BR",
+	"DIV",
+	"H1",
+	"H2",
+	"H3",
+	"H4",
+	"H5",
+	"H6",
+	"HR",
+	"LI",
+	"OL",
+	"P",
+	"PRE",
+	"SECTION",
+	"TABLE",
+	"TR",
+	"UL",
+]);
+
+const htmlToPlainText = (html: string): string => {
+	const parsed = new DOMParser().parseFromString(html, "text/html");
+	const lines: string[] = [];
+	let line = "";
+
+	const endLine = (): void => {
+		lines.push(line.trim());
+		line = "";
+	};
+
+	const visit = (node: Node): void => {
+		if (node.nodeType === node.TEXT_NODE) {
+			line += (node.textContent ?? "").replace(/\s+/g, " ");
+			return;
+		}
+		if (node.nodeType !== node.ELEMENT_NODE) return;
+		const breaks = LINE_BREAKING_TAGS.has((node as Element).tagName);
+		if (breaks && line !== "") endLine();
+		for (const child of node.childNodes) visit(child);
+		if (breaks) endLine();
+	};
+
+	visit(parsed.body);
+	if (line !== "") endLine();
+	return lines
+		.join("\n")
+		.replace(/\n{3,}/g, "\n\n")
+		.trim();
+};
+
+const addressLabel = (address: EnvelopeAddress): string =>
+	address.displayName
+		? `${address.displayName} <${address.normalizedEmail}>`
+		: address.normalizedEmail;
+
+const addressList = (addresses: readonly EnvelopeAddress[]): string =>
+	addresses.map(addressLabel).join(", ");
+
+/**
+ * An absolute date, because the attribution outlives the moment it was written
+ * — the relative form the message list uses would reach the recipient reading
+ * "Yesterday" about a day that is no longer yesterday.
+ */
+const quotedDate = (date: Envelope["date"]): string =>
+	formatDate(date, {
+		year: "numeric",
+		month: "short",
+		day: "numeric",
+		hour: "numeric",
+		minute: "numeric",
+	});
+
+/** The form `snippet.ts` and the search chunker both recognise as a quote. */
+const attributionLine = (envelope: Envelope): string => {
+	const who = addressList(envelope.from) || "the sender";
+	const when = quotedDate(envelope.date);
+	if (!when) return `${who} wrote:`;
+	return `On ${when}, ${who} wrote:`;
+};
+
+const FORWARD_RULE = "---------- Forwarded message ----------";
+
+const forwardHeader = (envelope: Envelope): string[] => {
+	const lines = [
+		FORWARD_RULE,
+		`From: ${addressList(envelope.from)}`,
+		`Date: ${quotedDate(envelope.date)}`,
+		`Subject: ${envelope.subject ?? ""}`,
+		`To: ${addressList(envelope.to)}`,
+	];
+	if (envelope.cc.length > 0) lines.push(`Cc: ${addressList(envelope.cc)}`);
+	return lines;
+};
+
+const quotePrefixed = (text: string): string[] =>
+	text.split("\n").map((line) => (line === "" ? ">" : `> ${line}`));
+
+/**
+ * The original, as the message being written will carry it. One value, so what
+ * the composer shows under the editor is the same block that leaves for the
+ * API rather than a second rendering of the same source (#845.5).
+ *
+ * A reply indents the original behind an attribution line; a forward passes it
+ * on whole under the header block, because a forward is the original message
+ * rather than a passage cited from it.
+ */
+export const buildQuotedBlock = (
+	kind: QuoteKind,
+	envelope: Envelope,
+	body: QuotedSourceBody,
+): QuotedBlock => {
+	const bodyText =
+		body.kind === "text" ? body.content.trim() : htmlToPlainText(body.content);
+	const bodyHtml =
+		body.kind === "html" ? body.content : textToHtml(body.content.trim());
+
+	if (kind === "forward") {
+		const header = forwardHeader(envelope);
+		return {
+			text: [...header, "", bodyText].join("\n"),
+			html: `${textToHtml(header.join("\n"))}${bodyHtml}`,
+		};
+	}
+
+	const attribution = attributionLine(envelope);
+	return {
+		text: [attribution, ...quotePrefixed(bodyText)].join("\n"),
+		html: `<p>${escapeHtml(attribution)}</p><blockquote type="cite">${bodyHtml}</blockquote>`,
+	};
+};
+
+const joinText = (written: string, quoted: string): string =>
+	written === "" ? quoted : `${written}\n\n${quoted}`;
+
+/**
+ * What the two body columns carry for this mode.
+ *
+ * Plain mode writes the empty string rather than omitting `htmlBody`: absent
+ * means "leave alone" at every layer below, so a plain draft that omitted it
+ * would send the HTML it was written as before the switch. The empty string is
+ * defined, so the repository's update guard clears the column, and nodemailer
+ * branches on the value being truthy — an empty one builds no HTML alternative
+ * and the message leaves as a single `text/plain` part. It is also why the
+ * quote reaches a plain message through `textBody` alone: putting its markup in
+ * `htmlBody` would reopen the draft as rich and send the recipient an HTML
+ * alternative of a message written as plain text.
+ *
+ * Rich mode leaves `htmlBody` alone while it has nothing to say, so the moments
+ * before the lazily-loaded editor reports its document cannot write a draft
+ * back as plain. A quote is something to say, so a send pressed in those
+ * moments still carries the message it quotes.
+ */
+export const outgoingBody = (
+	bodyMode: ComposeBodyMode,
+	body: RichTextValue,
+	language: string,
+	quoted: QuotedBlock | undefined,
+): { textBody: string | undefined; htmlBody: string | undefined } => {
+	const text = quoted ? joinText(body.text, quoted.text) : body.text;
+	if (bodyMode === "plain")
+		return { textBody: text || undefined, htmlBody: "" };
+	const html = quoted ? `${body.html}${quoted.html}` : body.html;
+	return {
+		textBody: text || undefined,
+		htmlBody: html ? wrapWithLanguage(html, language) : undefined,
+	};
+};

package/src/components/config-import/ConfigImportWizard.flow.test.ts

@@ -0,0 +1,338 @@
+/**
+ * Walking the config import wizard against a mocked instance.
+ *
+ * Every state here is one the components could already render in Storybook; the
+ * question this file answers is whether the app can ever reach them. Each of
+ * these was unreachable at one point: the 409 came back with its code on the
+ * thrown wrapper's body rather than on the error, an account whose password had
+ * just been verified stayed red because `connectionState` is written later by a
+ * worker, and "Check the file" was live before there was a document to send.
+ *
+ * Held with the real caches wired to `lib/query-error-handler.ts`, because
+ * "does the fatal overlay swallow this" is a question about what those two
+ * handlers pass, and nothing below them can see it. The overlay itself is not
+ * mounted — `getCurrentFatalError` is the same signal without a second app's
+ * worth of chrome in the tree.
+ */
+
+import assert from "node:assert/strict";
+import { afterEach, describe, it } from "node:test";
+import { MutationCache, QueryCache, QueryClient } from "@tanstack/react-query";
+import { createElement } from "react";
+import { ApiError } from "../../lib/api";
+import "../../lib/client";
+import { shouldEscalate, softErrorStatuses } from "../../lib/error-classifier";
+import { __resetFatalError, getCurrentFatalError } from "../../lib/fatal-error";
+import {
+	handleMutationCacheError,
+	handleQueryCacheError,
+} from "../../lib/query-error-handler";
+import { createDomHarness, type DomHarness } from "../../test-support/dom";
+import {
+	type HttpCall,
+	type HttpMock,
+	mockFetch,
+} from "../../test-support/http";
+import { StepWelcome } from "../onboarding/OnboardingWizard";
+import { ConfigImportWizard } from "./ConfigImportWizard";
+
+let harness: DomHarness | undefined;
+let http: HttpMock | undefined;
+
+afterEach(() => {
+	harness?.close();
+	harness = undefined;
+	http?.restore();
+	http = undefined;
+	__resetFatalError();
+});
+
+const ACCOUNT_ID = "acct-imported";
+
+const escalatingClient = (): QueryClient =>
+	new QueryClient({
+		queryCache: new QueryCache({ onError: handleQueryCacheError }),
+		mutationCache: new MutationCache({ onError: handleMutationCacheError }),
+		defaultOptions: {
+			queries: { retry: false },
+			mutations: { retry: false },
+		},
+	});
+
+/** The flat body the API emits, at the status it emits it with. */
+const refusal = (status: number, body: unknown): Response =>
+	new Response(JSON.stringify(body), {
+		status,
+		headers: { "content-type": "application/json" },
+	});
+
+const report = (overrides: Record<string, unknown> = {}) => ({
+	valid: true,
+	schemaVersion: 1,
+	applied: false,
+	items: [{ section: "accounts", key: "a@example.test", verdict: "created" }],
+	errors: [],
+	warnings: [],
+	accountsNeedingCredentials: [],
+	...overrides,
+});
+
+const importedAccount = (): Record<string, unknown> => ({
+	accountId: ACCOUNT_ID,
+	accountConfigId: "cfg-1",
+	username: "a@example.test",
+	email: "a@example.test",
+	authType: "password",
+	imapHost: "imap.example.test",
+	imapPort: 993,
+	imapTls: true,
+	imapStartTls: false,
+	smtpEnabled: false,
+	smtpHost: "",
+	smtpPort: 587,
+	smtpTls: false,
+	smtpStartTls: false,
+	smtpUsername: "",
+	isActive: false,
+	// The server keeps saying this: only the imap worker clears it, on a
+	// connection that has not happened yet.
+	connectionState: "credentials_missing",
+	createdAt: 0,
+	updatedAt: 0,
+	folderAppointments: [],
+});
+
+interface Backend {
+	onImport?: (call: HttpCall) => unknown;
+	accounts?: Array<Record<string, unknown>>;
+}
+
+const done: string[] = [];
+
+const start = (backend: Backend = {}): DomHarness => {
+	done.length = 0;
+	http = mockFetch((call) => {
+		if (call.path === "/config/import") {
+			return backend.onImport?.(call) ?? report();
+		}
+		if (call.path === "/config") {
+			return { accounts: backend.accounts ?? [], mailboxes: [] };
+		}
+		if (call.path === "/accounts/test-connection") {
+			return { imapSuccess: true, smtpSuccess: true };
+		}
+		return {};
+	});
+	harness = createDomHarness({ queryClient: escalatingClient() });
+	harness.renderApp(
+		createElement(ConfigImportWizard, {
+			onDone: (outcome: string) => done.push(outcome),
+		}),
+	);
+	return harness;
+};
+
+/**
+ * Hand the picker a file. jsdom has no `DataTransfer`, so the drop path cannot
+ * be driven from here; the input behind "Choose file" is the same entry point
+ * and takes a `files` list that only needs `item`.
+ */
+const pickFile = async (dom: DomHarness, name: string, text: string) => {
+	const input = dom.query<HTMLInputElement>('input[type="file"]');
+	assert.ok(input, "expected the file input");
+	const file = new File([text], name, { type: "application/json" });
+	Object.defineProperty(input, "files", {
+		configurable: true,
+		value: { 0: file, length: 1, item: (i: number) => (i === 0 ? file : null) },
+	});
+	dom.dispatch(input, new dom.window.Event("change", { bubbles: true }));
+	await dom.flush();
+	await dom.wait(10);
+	await dom.flush();
+};
+
+const CONFIG = JSON.stringify({ kind: "reader.config", schemaVersion: 1 });
+
+const checkButton = (dom: DomHarness): HTMLButtonElement =>
+	dom.byText("button", "Check the file") as HTMLButtonElement;
+
+describe("ConfigImportWizard — a file that cannot be sent", () => {
+	it("keeps the check disabled and says why, for a file that is not JSON", async () => {
+		const dom = start();
+		await pickFile(dom, "photos.zip", "PKnot json");
+
+		assert.match(dom.text(), /That file is not JSON/);
+		assert.equal(checkButton(dom).disabled, true);
+		// Nothing left the browser: the refusal happened before the request.
+		assert.equal(http?.to("/config/import").length, 0);
+	});
+
+	it("arms the check only once a document has parsed", async () => {
+		const dom = start();
+		assert.equal(checkButton(dom).disabled, true);
+
+		await pickFile(dom, "config.json", CONFIG);
+		assert.equal(checkButton(dom).disabled, false);
+	});
+});
+
+describe("ConfigImportWizard — an instance that is not empty", () => {
+	const conflicted = () =>
+		refusal(409, {
+			code: "config_not_empty",
+			message: "already holds configuration",
+			details: { accounts: "2", filters: "14" },
+		});
+
+	it("offers abort or merge on the 409 rather than a connection error", async () => {
+		const dom = start({ onImport: conflicted });
+		await pickFile(dom, "config.json", CONFIG);
+		dom.click(checkButton(dom));
+		await dom.flush();
+
+		assert.match(dom.text(), /This instance already has configuration/);
+		assert.match(dom.text(), /2 accounts, 14 rules are set up here already/);
+	});
+
+	/**
+	 * The other half of reaching that screen: the refusal must not also take the
+	 * app to the fatal page over it. That decision is `shouldEscalate` reading
+	 * the mutation's meta, and it is pinned here rather than through the wizard
+	 * because under this loader `lib/client.ts` and the generated SDK resolve
+	 * `client.gen` through two specifiers (`…/client.gen.ts` and `./client.gen.js`)
+	 * and so hold two client instances — the error interceptor registers on one
+	 * and the request goes through the other, which never happens under Vite,
+	 * where both specifiers resolve to the same module.
+	 */
+	it("keeps the 409 off the fatal page, and still escalates a 401", () => {
+		const meta = softErrorStatuses(409);
+		assert.equal(
+			shouldEscalate(new ApiError("not empty", 409, {}), meta, "user"),
+			false,
+		);
+		assert.equal(
+			shouldEscalate(new ApiError("signed out", 401, {}), meta, "user"),
+			true,
+		);
+		assert.equal(
+			shouldEscalate(new ApiError("broken", 500, {}), meta, "user"),
+			true,
+		);
+	});
+
+	it("does not record an import when the reader aborts the 409", async () => {
+		const dom = start({ onImport: conflicted });
+		await pickFile(dom, "config.json", CONFIG);
+		dom.click(checkButton(dom));
+		await dom.flush();
+
+		dom.click(dom.byText("button", "Stop, keep this instance"));
+		await dom.flush();
+		dom.click(dom.byText("button", "Continue"));
+		await dom.flush();
+
+		assert.deepEqual(done, ["abandoned"]);
+	});
+});
+
+describe("ConfigImportWizard — a session that has lapsed", () => {
+	it("escalates a 401 rather than keeping it in the wizard", async () => {
+		const dom = start({
+			onImport: () => refusal(401, { message: "signed out" }),
+		});
+		await pickFile(dom, "config.json", CONFIG);
+		dom.click(checkButton(dom));
+		await dom.flush();
+
+		assert.ok(
+			getCurrentFatalError(),
+			"expected the 401 to escalate rather than stay in the wizard",
+		);
+	});
+});
+
+describe("ConfigImportWizard — the credentials the file does not carry", () => {
+	const applied = () => {
+		let call = 0;
+		return () => {
+			call += 1;
+			return call === 1
+				? report({ accountsNeedingCredentials: [ACCOUNT_ID] })
+				: report({
+						applied: true,
+						accountsNeedingCredentials: [ACCOUNT_ID],
+						importId: "imp-1",
+					});
+		};
+	};
+
+	it("marks the account ready once its password is verified and stored", async () => {
+		const dom = start({
+			onImport: applied(),
+			accounts: [importedAccount()],
+		});
+		await pickFile(dom, "config.json", CONFIG);
+		dom.click(checkButton(dom));
+		await dom.flush();
+		dom.click(dom.byText("button", "Import 1 changes"));
+		await dom.flush();
+		await dom.wait(20);
+		await dom.flush();
+
+		assert.match(dom.text(), /These accounts need credentials/);
+		assert.match(dom.text(), /credentials needed/);
+
+		dom.click(dom.byText("button", "Enter password"));
+		await dom.flush();
+		const password = dom.query<HTMLInputElement>("#credentials-password");
+		assert.ok(password, "expected the password field");
+		dom.type(password, "mailbox-password");
+		dom.click(dom.byText("button", "Test and continue"));
+		await dom.flush();
+		// The test step stages IMAP then SMTP before it settles, then hands over.
+		await dom.wait(500);
+		await dom.flush();
+		await dom.wait(900);
+		await dom.flush();
+
+		const [stored] = http?.to(`/accounts/${ACCOUNT_ID}`) ?? [];
+		assert.ok(stored, "expected the password to be stored on the account");
+		assert.equal(stored.body?.password, "mailbox-password");
+
+		// GET /config still says `credentials_missing`, and the row is green
+		// anyway: this wizard verified the credential itself.
+		assert.match(dom.text(), /These accounts need credentials/);
+		assert.match(dom.text(), /ready/);
+		assert.doesNotMatch(dom.text(), /credentials needed/);
+	});
+});
+
+describe("The onboarding welcome step", () => {
+	it("offers the import beside adding an account, where /onboarding mounts it", () => {
+		harness = createDomHarness();
+		const imported: string[] = [];
+		harness.renderApp(
+			createElement(StepWelcome, {
+				onStart: () => undefined,
+				onImportConfig: () => imported.push("import"),
+			}),
+		);
+
+		assert.match(harness.text(), /Add your first account/);
+		harness.click(harness.byText("button", "Import a config file"));
+		assert.deepEqual(imported, ["import"]);
+	});
+
+	it("offers no import where the wizard is embedded to add an account", () => {
+		harness = createDomHarness();
+		harness.renderApp(createElement(StepWelcome, { onStart: () => undefined }));
+
+		assert.match(harness.text(), /Add your first account/);
+		assert.equal(
+			harness
+				.queryAll("button")
+				.some((button) => button.textContent === "Import a config file"),
+			false,
+		);
+	});
+});