@remit/ui 0.0.93 → 0.0.94

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/ui",
-  "version": "0.0.93",
+  "version": "0.0.94",
   "type": "module",
   "files": [
     "src"

package/src/components/selection-wizard.render.test.ts

@@ -582,6 +582,24 @@ describe("RunStepBody", () => {
 		assert.match(html, /Nothing has changed\./);
 	});
 
+	// #522: the commit resolved no destination, which is a cause the screen knows
+	// and a setting the user can change.
+	it("names why a commit could not start, and where the fix is", () => {
+		const html = renderToString(
+			createElement(RunStepBody, {
+				...runProps,
+				state: "commitFailed",
+				verb: "junk",
+				scope: "once",
+				failureReason:
+					"This account has no Junk folder appointed, so there is nowhere to file these. Appoint one under Settings › Folders.",
+			}),
+		);
+		assert.match(text(html), /no Junk folder appointed/);
+		assert.match(text(html), /Settings › Folders/);
+		assert.doesNotMatch(html, /Nothing has changed\./);
+	});
+
 	// A retry that could not be started is not a pass that never ran (#552): the
 	// pass that did run keeps its counts and its bar.
 	it("keeps a finished pass's counts when its retry could not be started", () => {
@@ -671,6 +689,22 @@ describe("RunFooter", () => {
 		assert.match(html, /Close/);
 	});
 
+	it("offers no retry for a commit the same press cannot get past", () => {
+		// A Try again here re-sends the identical commit to the same absent
+		// destination, forever (#522).
+		const html = renderToString(
+			createElement(RunFooter, {
+				...runProps,
+				state: "commitFailed",
+				verb: "junk",
+				scope: "once",
+				failureReason: "This account has no Junk folder appointed.",
+			}),
+		);
+		assert.doesNotMatch(html, /Try again/);
+		assert.match(html, /Close/);
+	});
+
 	it("offers only a way out once there is nothing outstanding", () => {
 		const html = renderToString(createElement(RunFooter, runProps));
 		assert.match(html, /Done/);

package/src/components/selection-wizard.tsx

@@ -963,6 +963,12 @@ export interface RunStepProps {
 	 * messages behind it; defaults to the ones named here.
 	 */
 	failedCount?: number;
+	/**
+	 * Why the commit never started, when the run knows and sending the same one
+	 * again cannot change it. Stated in place of the generic ending, and in place
+	 * of the retry that would fail identically (#522).
+	 */
+	failureReason?: string;
 	onRetry: () => void;
 	onDismiss: () => void;
 	/**
@@ -981,6 +987,7 @@ const runOutcomeOf = (props: RunStepProps): RunOutcome => ({
 	matched: props.matched,
 	applied: props.applied,
 	failed: props.failedCount ?? props.failures.length,
+	failureReason: props.failureReason,
 });
 
 const runIcon = (tone: RunCopy["tone"]): ReactNode => {

package/src/lib/wizard-steps.test.ts

@@ -595,6 +595,31 @@ describe("runCopy", () => {
 		assert.equal(outcome("commitFailed", "once").title, "Couldn't start move");
 	});
 
+	// #522: a commit that resolved no destination fails the same way every time
+	// it is sent. Stating "Nothing has changed" over a Try again leaves the user
+	// pressing a control that can never work, with nothing naming the setting
+	// that would.
+	it("carries the reason a commit could not start, in place of a retry", () => {
+		const reason =
+			"This account has no Junk folder appointed, so there is nowhere to file these. Appoint one under Settings › Folders.";
+		const blocked = runCopy({
+			state: "commitFailed",
+			verb: "junk",
+			scope: "once",
+			matched: 0,
+			applied: 0,
+			failed: 0,
+			failureReason: reason,
+		});
+
+		assert.equal(blocked.detail, reason);
+		assert.doesNotMatch(blocked.detail, /Nothing has changed/);
+		assert.equal(blocked.retryLabel, undefined);
+		assert.equal(blocked.dismissLabel, "Close");
+		assert.equal(blocked.tone, "danger");
+		assert.match(blocked.title, /^Couldn't start/);
+	});
+
 	it("shows progress only while a pass over existing mail is under way or finished", () => {
 		assert.equal(outcome("saving", "standing").showProgress, false);
 		assert.equal(outcome("backApplyRunning", "standing").showProgress, true);

package/src/lib/wizard-steps.ts

@@ -334,6 +334,13 @@ export interface RunOutcome {
 	applied: number;
 	/** How many the mail server rejected. */
 	failed: number;
+	/**
+	 * Why the commit never started, when sending the same one again cannot get
+	 * past it — no Junk folder appointed, no destination chosen. The ending states
+	 * this in place of the generic one and offers no retry, because the identical
+	 * commit fails identically (#522).
+	 */
+	failureReason?: string;
 }
 
 export interface RunCopy {
@@ -372,6 +379,7 @@ export const runCopy = ({
 	matched,
 	applied,
 	failed,
+	failureReason,
 }: RunOutcome): RunCopy => {
 	const { label, present, past } = verbCopy(verb);
 	const done = past.toLowerCase();
@@ -502,15 +510,17 @@ export const runCopy = ({
 			dismissLabel: "Done",
 		};
 	}
+	// A stated reason is a failure the same commit cannot get past, so the way
+	// out of it is the sentence rather than a retry that fails identically.
 	return {
 		...shared,
 		title: standing
 			? "Couldn't save the rule"
 			: `Couldn't start ${label.toLowerCase()}`,
-		detail: "Nothing has changed.",
+		detail: failureReason ?? "Nothing has changed.",
 		tone: "danger",
-		dismissLabel: "Not now",
-		retryLabel: "Try again",
+		dismissLabel: failureReason === undefined ? "Not now" : "Close",
+		retryLabel: failureReason === undefined ? "Try again" : undefined,
 	};
 };