@remit/web-client 0.0.325 → 0.0.326

package/src/lib/bug-report.ts

@@ -1,320 +0,0 @@
-import type { QuarantineReportSections } from "@remit/ui";
-import { getRuntimeConfig } from "../runtime-config";
-import { APP_BUILD_TIME, APP_SHORT_SHA, GITHUB_COMMIT_URL } from "./app-info";
-import { getRecentErrors } from "./console-errors";
-import {
-	getFailingRequest,
-	getRecentRequests,
-	type RequestBreadcrumb,
-} from "./request-breadcrumbs";
-import { getRecentRoutes, type RouteBreadcrumb } from "./route-breadcrumbs";
-
-/**
- * A GitHub new-issue URL is capped (~8 KB). We budget below that so the stack
- * is truncated to fit rather than producing a URL GitHub silently rejects. The
- * untruncated report is always available via `buildBugReportDetails` (the
- * overlay's "Copy full details" action).
- */
-const MAX_ISSUE_URL_LENGTH = 7500;
-
-const TRUNCATION_MARKER =
-	"\n… (truncated — the copy action on this screen has the full report)";
-
-export interface BugReportContext {
-	appShortSha: string;
-	/** Commit URL for the build, or undefined for a local "dev" build (no link). */
-	appCommitUrl?: string;
-	appBuildTime: string;
-	userAgent: string;
-	viewport: string;
-	timestamp: string;
-	timezone: string;
-	href: string;
-	recentErrors: readonly string[];
-	/** Recent API calls, metadata only — method/path/status/duration/correlation. */
-	requests: readonly RequestBreadcrumb[];
-	/** Recent in-app navigations, oldest first. */
-	routes: readonly RouteBreadcrumb[];
-	/** The request that most likely triggered the report (transport or >= 400). */
-	failingRequest?: RequestBreadcrumb;
-	/** The message of the error that triggered the report, when seeded from one. */
-	errorMessage?: string;
-	/** The error's stacktrace, when available. */
-	stack?: string;
-	/** React component stack from the error boundary, when available. */
-	componentStack?: string;
-	/**
-	 * A quarantined message's diagnostics, when the report is filed from the
-	 * quarantine surface. Split into sections by `quarantineReportSections` in
-	 * @remit/ui so the MIME tree is fenced after truncation, never before.
-	 */
-	quarantine?: QuarantineReportSections;
-	syncWarning?: string;
-	/** Overrides the derived title, e.g. for a quarantine report. */
-	title?: string;
-}
-
-/** Fields callers can seed from a caught error. */
-export interface BugReportSeed {
-	errorMessage?: string;
-	stack?: string;
-	componentStack?: string;
-	quarantine?: QuarantineReportSections;
-	syncWarning?: string;
-	/** Overrides the derived title, e.g. for a quarantine report. */
-	title?: string;
-}
-
-export function buildBugReportContext(seed?: BugReportSeed): BugReportContext {
-	return {
-		appShortSha: APP_SHORT_SHA,
-		appCommitUrl: GITHUB_COMMIT_URL,
-		appBuildTime: APP_BUILD_TIME,
-		userAgent: navigator.userAgent,
-		viewport: `${window.innerWidth}×${window.innerHeight}`,
-		timestamp: new Date().toISOString(),
-		timezone: Intl.DateTimeFormat().resolvedOptions().timeZone,
-		href: window.location.href,
-		recentErrors: getRecentErrors(),
-		requests: getRecentRequests(),
-		routes: getRecentRoutes(),
-		failingRequest: getFailingRequest(),
-		errorMessage: seed?.errorMessage,
-		stack: seed?.stack,
-		componentStack: seed?.componentStack,
-		quarantine: seed?.quarantine,
-		syncWarning: seed?.syncWarning,
-		title: seed?.title,
-	};
-}
-
-function fencedBlock(content: string): string {
-	return ["```", content, "```"].join("\n");
-}
-
-/** `2024-06-12T08:00:01.234Z` → `08:00:01` — the wall-clock time, compact. */
-function clockTime(iso: string): string {
-	const match = /T(\d{2}:\d{2}:\d{2})/.exec(iso);
-	return match ? match[1] : iso;
-}
-
-function versionLine(ctx: BugReportContext): string {
-	const version = ctx.appCommitUrl
-		? `[\`${ctx.appShortSha}\`](${ctx.appCommitUrl})`
-		: `\`${ctx.appShortSha}\``;
-	return `- **Version**: ${version} built ${ctx.appBuildTime}`;
-}
-
-function failingRequestSection(request: RequestBreadcrumb): string[] {
-	const status =
-		request.status === 0
-			? "no response (transport failure)"
-			: `${request.status}`;
-	return [
-		"## Failing request",
-		`- **Endpoint**: \`${request.path}\``,
-		`- **Method**: ${request.method}`,
-		`- **Status**: ${status}`,
-		`- **Correlation id**: ${request.correlationId ?? "(none)"}`,
-		"",
-	];
-}
-
-function requestsSection(requests: readonly RequestBreadcrumb[]): string[] {
-	if (requests.length === 0) {
-		return ["## Recent API requests", "(none)", ""];
-	}
-	const rows = requests.map((r) => {
-		const status = r.status === 0 ? "ERR" : `${r.status}`;
-		return `| ${clockTime(r.timestamp)} | ${r.method} | \`${r.path}\` | ${status} | ${r.durationMs}ms | ${r.correlationId ?? ""} |`;
-	});
-	return [
-		"## Recent API requests",
-		"| Time | Method | Path | Status | Duration | Correlation |",
-		"| --- | --- | --- | --- | --- | --- |",
-		...rows,
-		"",
-	];
-}
-
-function navigationSection(routes: readonly RouteBreadcrumb[]): string[] {
-	if (routes.length === 0) {
-		return ["## Navigation trail", "(none)", ""];
-	}
-	const rows = routes.map((r) => `- ${clockTime(r.timestamp)} \`${r.path}\``);
-	return ["## Navigation trail", ...rows, ""];
-}
-
-interface BodyOverrides {
-	stack?: string;
-	/** Replaces the MIME-tree section only; it is fenced after this is applied. */
-	quarantineStructure?: string;
-}
-
-function buildIssueBody(
-	ctx: BugReportContext,
-	overrides?: BodyOverrides,
-): string {
-	const errorSection =
-		ctx.recentErrors.length > 0
-			? ctx.recentErrors.map((e) => `  - ${e}`).join("\n")
-			: "  (none)";
-
-	const lines: string[] = [
-		"## Environment",
-		versionLine(ctx),
-		`- **Browser**: ${ctx.userAgent}`,
-		`- **Viewport**: ${ctx.viewport}`,
-		`- **Time**: ${ctx.timestamp} (${ctx.timezone})`,
-		"",
-		"## URL",
-		ctx.href,
-		"",
-	];
-
-	if (ctx.errorMessage) {
-		lines.push("## Error", ctx.errorMessage, "");
-	}
-
-	if (ctx.failingRequest) {
-		lines.push(...failingRequestSection(ctx.failingRequest));
-	}
-
-	if (ctx.quarantine) {
-		const structure =
-			overrides?.quarantineStructure ?? ctx.quarantine.structure;
-		lines.push(
-			ctx.quarantine.head,
-			"",
-			fencedBlock(structure),
-			"",
-			ctx.quarantine.disclaimer,
-			"",
-		);
-	}
-
-	if (ctx.syncWarning) {
-		lines.push(ctx.syncWarning, "");
-	}
-
-	const resolvedStack = overrides?.stack ?? ctx.stack;
-	if (resolvedStack) {
-		lines.push("## Stacktrace", fencedBlock(resolvedStack), "");
-	}
-
-	if (ctx.componentStack) {
-		lines.push("## Component stack", fencedBlock(ctx.componentStack), "");
-	}
-
-	lines.push(...requestsSection(ctx.requests));
-	lines.push(...navigationSection(ctx.routes));
-
-	lines.push(
-		"## Recent console errors",
-		errorSection,
-		"",
-		"## Steps to reproduce",
-		"1. ",
-		"",
-		"## Expected behaviour",
-		"",
-		"## Actual behaviour",
-		"",
-	);
-
-	return lines.join("\n");
-}
-
-function buildIssueTitle(ctx: BugReportContext): string {
-	if (ctx.title) return ctx.title;
-	if (!ctx.errorMessage) return "Bug: ";
-	const firstLine = ctx.errorMessage.split("\n")[0].trim();
-	const clipped =
-		firstLine.length > 120 ? `${firstLine.slice(0, 117)}…` : firstLine;
-	return `Bug: ${clipped}`;
-}
-
-function issueUrl(ctx: BugReportContext, overrides?: BodyOverrides): string {
-	const params = new URLSearchParams({
-		title: buildIssueTitle(ctx),
-		body: buildIssueBody(ctx, overrides),
-	});
-	return `${getRuntimeConfig().issuesUrl}?${params.toString()}`;
-}
-
-/**
- * The full, untruncated report — every field including the complete stacktrace
- * and component stack. Backs the overlay's "Copy full details" action so
- * nothing is lost when the URL-bound report has to truncate the stack.
- */
-export function buildBugReportDetails(ctx: BugReportContext): string {
-	return buildIssueBody(ctx);
-}
-
-/**
- * Build a prefilled GitHub new-issue URL. When the full body would exceed the
- * URL budget, the longest truncatable section — a stacktrace, or a quarantine
- * report's MIME tree — is binary-searched to the longest prefix that fits and
- * marked; everything else is preserved. The component stack is dropped from
- * the URL when truncation kicks in — it survives in the copy-details report.
- *
- * The quarantine MIME tree is handed over unfenced and fenced by
- * `buildIssueBody` afterwards, so a cut can never land inside a code fence.
- * The disclaimer is appended by the builder rather than carried in the
- * truncated text, so a truncated report still states what was withheld.
- */
-export function buildGitHubIssueUrl(ctx: BugReportContext): string {
-	const full = issueUrl(ctx);
-	if (full.length <= MAX_ISSUE_URL_LENGTH) return full;
-
-	const withoutComponentStack: BugReportContext = {
-		...ctx,
-		componentStack: undefined,
-	};
-
-	// Both sections can be present — a seed is not discriminated — and cutting
-	// one to nothing does not necessarily fit the other. Truncate the longest
-	// first and keep going while the budget is still exceeded.
-	const sections: Array<[keyof BodyOverrides, string]> = [];
-	if (ctx.stack) sections.push(["stack", ctx.stack]);
-	if (ctx.quarantine?.structure) {
-		sections.push(["quarantineStructure", ctx.quarantine.structure]);
-	}
-	sections.sort((a, b) => b[1].length - a[1].length);
-
-	let overrides: BodyOverrides = {};
-	for (const [field, text] of sections) {
-		if (
-			issueUrl(withoutComponentStack, overrides).length <= MAX_ISSUE_URL_LENGTH
-		) {
-			break;
-		}
-		let lo = 0;
-		let hi = text.length;
-		let best = 0;
-		while (lo <= hi) {
-			const mid = (lo + hi) >> 1;
-			const candidate = issueUrl(withoutComponentStack, {
-				...overrides,
-				[field]: text.slice(0, mid) + TRUNCATION_MARKER,
-			});
-			if (candidate.length <= MAX_ISSUE_URL_LENGTH) {
-				best = mid;
-				lo = mid + 1;
-			} else {
-				hi = mid - 1;
-			}
-		}
-		overrides = {
-			...overrides,
-			[field]: text.slice(0, best) + TRUNCATION_MARKER,
-		};
-	}
-
-	return issueUrl(withoutComponentStack, overrides);
-}
-
-export function openBugReport(): void {
-	const url = buildGitHubIssueUrl(buildBugReportContext());
-	window.open(url, "_blank", "noopener,noreferrer");
-}

package/src/lib/bulk-action-copy.test.ts

@@ -1,123 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, test } from "node:test";
-import {
-	type BulkActionKind,
-	bulkActionCompletionText,
-	bulkActionFailureDetail,
-	bulkActionFailureTitle,
-	bulkActionProgressLabel,
-	bulkActionProgressTone,
-	bulkActionStoppedDetail,
-	bulkActionStoppedTitle,
-} from "./bulk-action-copy.js";
-
-const kinds: BulkActionKind[] = ["delete", "move", "markRead"];
-
-describe("bulkActionProgressLabel", () => {
-	test("names the action and both counts", () => {
-		assert.equal(
-			bulkActionProgressLabel("delete", 1200, 3412),
-			"Deleting 1,200 of 3,412…",
-		);
-		assert.equal(
-			bulkActionProgressLabel("move", 1200, 3412),
-			"Moving 1,200 of 3,412…",
-		);
-		assert.equal(
-			bulkActionProgressLabel("markRead", 1200, 3412),
-			"Marking 1,200 of 3,412 as read…",
-		);
-	});
-});
-
-describe("bulkActionCompletionText", () => {
-	test("says what happened and that the server is still applying it", () => {
-		assert.equal(
-			bulkActionCompletionText("delete", 3412),
-			"3,412 moved to Trash. Your mail server is still catching up.",
-		);
-		assert.equal(
-			bulkActionCompletionText("move", 3412),
-			"3,412 moved. Your mail server is still catching up.",
-		);
-		assert.equal(
-			bulkActionCompletionText("markRead", 3412),
-			"3,412 marked as read. Your mail server is still catching up.",
-		);
-	});
-});
-
-describe("bulkActionFailureTitle", () => {
-	test("reports where a partly-done run stopped", () => {
-		assert.equal(
-			bulkActionFailureTitle("move", 3072),
-			"Stopped after 3,072 — some messages couldn't be moved",
-		);
-	});
-
-	test("drops the count when nothing landed", () => {
-		assert.equal(
-			bulkActionFailureTitle("markRead", 0),
-			"Couldn't mark these messages as read",
-		);
-		assert.equal(
-			bulkActionFailureTitle("delete", 0),
-			"Couldn't delete these messages",
-		);
-	});
-});
-
-describe("a run that stopped short of its match", () => {
-	test("states what it reached and what became of the rest", () => {
-		assert.equal(bulkActionStoppedTitle(1200), "Stopped after 1,200");
-		assert.equal(
-			bulkActionStoppedDetail("delete", 1200, 3412),
-			"1,200 of 3,412 moved to Trash. The rest were not sent, apart from the ones already on their way when you stopped — those may still have gone through.",
-		);
-		assert.equal(
-			bulkActionStoppedDetail("markRead", 1200, 3412),
-			"1,200 of 3,412 marked as read. The rest were not sent, apart from the ones already on their way when you stopped — those may still have gone through.",
-		);
-	});
-
-	// Stopping aborts the request on the wire; it does not un-send one the server
-	// already took (#113). Promising the remainder is untouched would be a claim
-	// the client cannot make about the batch that was in flight.
-	test("stops short of promising the batch in flight never landed", () => {
-		assert.match(
-			bulkActionStoppedDetail("move", 1, 2),
-			/may still have gone through/,
-		);
-	});
-
-	test("never reads as a rejection — nothing was refused", () => {
-		assert.doesNotMatch(
-			bulkActionStoppedDetail("move", 1, 2),
-			/rejected|couldn't/i,
-		);
-	});
-});
-
-describe("every action carries its own wording", () => {
-	test("no two actions share a sentence", () => {
-		const sentences: Array<(kind: BulkActionKind) => string> = [
-			(kind) => bulkActionCompletionText(kind, 5),
-			(kind) => bulkActionFailureTitle(kind, 0),
-			(kind) => bulkActionFailureTitle(kind, 5),
-			bulkActionFailureDetail,
-			(kind) => bulkActionProgressLabel(kind, 1, 2),
-			(kind) => bulkActionStoppedDetail(kind, 1, 2),
-		];
-		for (const render of sentences) {
-			assert.equal(new Set(kinds.map(render)).size, kinds.length);
-		}
-	});
-});
-
-describe("bulkActionProgressTone", () => {
-	test("only delete reads as destructive", () => {
-		assert.equal(bulkActionProgressTone("delete"), "danger");
-		assert.equal(bulkActionProgressTone("move"), "info");
-		assert.equal(bulkActionProgressTone("markRead"), "info");
-	});
-});

package/src/lib/bulk-action-copy.ts

@@ -1,182 +0,0 @@
-import type { ErrorBannerSeverity } from "@remit/ui";
-import type { BulkRunOutcome } from "@/lib/bulk-actions";
-import { type DeleteOutcome, deleteExpunges, formatNumber } from "@/lib/format";
-
-/** A run ending, as the list banners it. */
-export interface RunEndingBanner {
-	severity: ErrorBannerSeverity;
-	title: string;
-	detail?: string;
-}
-
-/**
- * Wording for the three bulk actions a selection can run (#114). One place
- * per sentence the selection bar, the completion banner and the error banner
- * can say, so a new action is a row in these tables rather than a branch in
- * every caller.
- */
-export type BulkActionKind = "delete" | "move" | "markRead";
-
-const progressPhrase: Record<
-	BulkActionKind,
-	(done: string, total: string) => string
-> = {
-	delete: (done, total) => `Deleting ${done} of ${total}…`,
-	move: (done, total) => `Moving ${done} of ${total}…`,
-	markRead: (done, total) => `Marking ${done} of ${total} as read…`,
-};
-
-const pastTense: Record<BulkActionKind, string> = {
-	delete: "moved to Trash",
-	move: "moved",
-	markRead: "marked as read",
-};
-
-/**
- * What the run did, in the past tense. A delete inside Trash expunges rather
- * than moves (#855), and that holds for a run that stopped halfway exactly as
- * it does for one that finished — the half that ran is still erased.
- */
-const pastTenseFor = (kind: BulkActionKind, outcome: DeleteOutcome): string =>
-	kind === "delete" && deleteExpunges(outcome)
-		? "permanently deleted"
-		: pastTense[kind];
-
-const negated: Record<BulkActionKind, string> = {
-	delete: "couldn't be deleted",
-	move: "couldn't be moved",
-	markRead: "couldn't be marked as read",
-};
-
-const failureTitle: Record<BulkActionKind, string> = {
-	delete: "Couldn't delete these messages",
-	move: "Couldn't move these messages",
-	markRead: "Couldn't mark these messages as read",
-};
-
-const failureDetail: Record<BulkActionKind, string> = {
-	delete: "The delete didn't finish.",
-	move: "The move didn't finish.",
-	markRead: "The update didn't finish.",
-};
-
-/** Running status while a chunked or escalated run is in flight. */
-export const bulkActionProgressLabel = (
-	kind: BulkActionKind,
-	done: number,
-	total: number,
-): string => progressPhrase[kind](formatNumber(done), formatNumber(total));
-
-/**
- * Shown once a run finishes with nothing left over. The second sentence is
- * the honest part: the bulk endpoints enqueue the IMAP write, so the mail
- * server is still applying it when this appears.
- *
- * A delete inside Trash expunges rather than moves (#855), so the run that just
- * finished is named by its outcome — telling a reader their mail is "moved to
- * Trash" after it was erased is the same lie the confirmation stopped telling,
- * one screen later.
- */
-export const bulkActionCompletionText = (
-	kind: BulkActionKind,
-	done: number,
-	outcome: DeleteOutcome = "trash",
-): string =>
-	`${formatNumber(done)} ${pastTenseFor(kind, outcome)}. Your mail server is still catching up.`;
-
-/**
- * Shown when a run ended before it covered what it was started against. The
- * remainder was never sent, so that mail is where it was and only the user can
- * decide to run it again — which is why this is stated rather than left to a
- * list that quietly stops changing. Stopping aborts the request already on the
- * wire rather than un-sending it (#113), so what the copy can promise about the
- * remainder stops short of the batch that was in flight.
- */
-export const bulkActionStoppedTitle = (done: number): string =>
-	`Stopped after ${formatNumber(done)}`;
-
-export const bulkActionStoppedDetail = (
-	kind: BulkActionKind,
-	done: number,
-	total: number,
-	outcome: DeleteOutcome = "trash",
-): string =>
-	`${formatNumber(done)} of ${formatNumber(total)} ${pastTenseFor(kind, outcome)}. The rest were not sent, apart from the ones already on their way when you stopped — those may still have gone through.`;
-
-/** Error-banner title for a run stopped by an infrastructure failure. */
-export const bulkActionFailureTitle = (
-	kind: BulkActionKind,
-	done: number,
-): string =>
-	done > 0
-		? `Stopped after ${formatNumber(done)} — some messages ${negated[kind]}`
-		: failureTitle[kind];
-
-export const bulkActionFailureDetail = (kind: BulkActionKind): string =>
-	failureDetail[kind];
-
-const busyPhrase: Record<BulkActionKind, (count: string) => string> = {
-	delete: (count) => `A delete of ${count} messages`,
-	move: (count) => `A move of ${count} messages`,
-	markRead: (count) => `Marking ${count} messages as read`,
-};
-
-/**
- * The commit that could not start, because the one still going owns the bar and
- * the Stop it would need. It names the run in flight and where it is, so the
- * user knows which screen to end it from rather than pressing a commit that
- * silently does nothing.
- */
-export const bulkRunBusyRefusal = (
-	kind: BulkActionKind,
-	matched: number,
-	mailboxLabel: string | undefined,
-): string =>
-	`${busyPhrase[kind](formatNumber(matched))}${
-		mailboxLabel ? ` in ${mailboxLabel}` : ""
-	} is still running — stop it first.`;
-
-/** Progress-bar tone: only delete is destructive. */
-export const bulkActionProgressTone = (
-	kind: BulkActionKind,
-): "danger" | "info" => (kind === "delete" ? "danger" : "info");
-
-/**
- * How a run that has already ended is announced, or `null` when it announces
- * itself elsewhere.
- *
- * The run screen invites the user to close it and keeps going past that, so by
- * the time a run ends there is often no screen of its own left to say how it
- * went (#521) — the list says it instead. Three endings, and they are not the
- * same news: a run stopped short is a warning, because mail the user asked to
- * be acted on was left untouched; a run that covered everything is a passing
- * note; and a run stopped by a thrown batch already bannered where it threw, so
- * saying it twice is the one wrong answer.
- *
- * Pure, so the severity of each ending is pinned by its result rather than by
- * the shape of the caller that produces it.
- */
-export const runEndingBanner = (
-	kind: BulkActionKind,
-	matched: number,
-	outcome: BulkRunOutcome,
-	deleteOutcome: DeleteOutcome,
-): RunEndingBanner | null => {
-	if (outcome.error !== undefined) return null;
-	if (outcome.cancelled) {
-		return {
-			severity: "warning",
-			title: bulkActionStoppedTitle(outcome.done),
-			detail: bulkActionStoppedDetail(
-				kind,
-				outcome.done,
-				matched,
-				deleteOutcome,
-			),
-		};
-	}
-	return {
-		severity: "info",
-		title: bulkActionCompletionText(kind, outcome.done, deleteOutcome),
-	};
-};