@remit/web-client 0.0.134 → 0.0.135

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/web-client",
-  "version": "0.0.134",
+  "version": "0.0.135",
   "type": "module",
   "description": "Remit web client, published as composable primitives — the app shell, auth shells, and runtime config. A distributor imports what it composes and bundles it.",
   "exports": {

package/src/components/compose/ComposeForm.tsx

@@ -3,7 +3,6 @@ import {
 	outboxDetailOperationsDeleteOutboxMessageMutation,
 	outboxDetailOperationsGetOutboxMessageOptions,
 	outboxDetailOperationsSendOutboxMessageMutation,
-	outboxOperationsCreateOutboxMessageMutation,
 } from "@remit/api-http-client/@tanstack/react-query.gen.ts";
 import type {
 	RemitImapAccountResponse,
@@ -442,10 +441,11 @@ export const ComposeForm = ({
 		[setOutboxMessageId],
 	);
 
-	const { saveStatus, saveError, saveDraft, stopAutoSave } = useSaveDraft({
-		outboxMessageId,
-		onDraftCreated: adoptCreatedDraft,
-	});
+	const { saveStatus, saveError, saveDraft, saveImmediately, stopAutoSave } =
+		useSaveDraft({
+			outboxMessageId,
+			onDraftCreated: adoptCreatedDraft,
+		});
 
 	// Auto-save runs on a debounce, so a failure has no inline call site to
 	// surface it. Push the real error detail to a banner instead of leaving only
@@ -460,10 +460,6 @@ export const ComposeForm = ({
 		});
 	}, [saveError, pushError]);
 
-	const createMutation = useMutation(
-		outboxOperationsCreateOutboxMessageMutation(),
-	);
-
 	const sendMutation = useMutation(
 		outboxDetailOperationsSendOutboxMessageMutation(),
 	);
@@ -496,7 +492,11 @@ export const ComposeForm = ({
 		? accountIsMissingSmtp(selectedAccount)
 		: false;
 
-	const isSending = createMutation.isPending || sendMutation.isPending;
+	// The action bar refuses a second press while one is in flight, but the
+	// editor's own Cmd+Enter goes straight to `handleSend`, and the write that
+	// now precedes the request widens the window a second press lands in.
+	const sendInFlightRef = useRef(false);
+	const [isSending, setIsSending] = useState(false);
 	const canSend =
 		toAddresses.length > 0 &&
 		!!selectedAccountId &&
@@ -538,76 +538,79 @@ export const ComposeForm = ({
 	]);
 
 	const handleSend = useCallback(async () => {
+		if (sendInFlightRef.current) return;
 		if (!selectedAccountId || toAddresses.length === 0) return;
 
-		stopAutoSave();
-
-		const replyData =
-			sourceMessage && (mode === "reply" || mode === "reply_all")
-				? getReferences(sourceMessage)
-				: {};
+		sendInFlightRef.current = true;
+		setIsSending(true);
+		try {
+			stopAutoSave();
 
-		let messageId = outboxMessageId;
-		let createdThisAttempt = false;
+			const replyData =
+				sourceMessage && (mode === "reply" || mode === "reply_all")
+					? getReferences(sourceMessage)
+					: {};
 
-		if (!messageId) {
 			const { html: htmlBody, text: textBody } = body;
+			const createdThisAttempt = !outboxMessageId;
+
+			// The debounce dropped above may have been holding the last two seconds
+			// of typing, and an existing entry would otherwise go out as the server
+			// last saw it (#674). What is on screen is written first, and a write
+			// that fails stops the send rather than transmitting the older copy.
+			const flushed = await saveImmediately({
+				accountId: selectedAccountId,
+				toAddresses: toAddresses.map((a) => a.email),
+				ccAddresses:
+					ccAddresses.length > 0 ? ccAddresses.map((a) => a.email) : undefined,
+				bccAddresses:
+					bccAddresses.length > 0
+						? bccAddresses.map((a) => a.email)
+						: undefined,
+				subject: subject || undefined,
+				textBody: textBody || undefined,
+				htmlBody: htmlBody || undefined,
+				...replyData,
+			});
 
-			const outboxMessage = await createMutation
+			if (flushed.outcome === "failed") {
+				pushError({
+					title: "Couldn't send message",
+					detail:
+						formatErrorDetail(flushed.error) ??
+						"Saving the message failed, so nothing was sent. Try again.",
+					error: flushed.error,
+				});
+				return;
+			}
+
+			const messageId = flushed.outboxMessageId;
+
+			const sent = await sendMutation
 				.mutateAsync({
-					body: {
-						accountId: selectedAccountId,
-						toAddresses: toAddresses.map((a) => a.email),
-						ccAddresses:
-							ccAddresses.length > 0
-								? ccAddresses.map((a) => a.email)
-								: undefined,
-						bccAddresses:
-							bccAddresses.length > 0
-								? bccAddresses.map((a) => a.email)
-								: undefined,
-						subject: subject || undefined,
-						textBody: textBody || undefined,
-						htmlBody: htmlBody || undefined,
-						sendImmediately: false,
-						...replyData,
-					},
+					path: { outboxMessageId: messageId },
 				})
 				.catch((error: unknown) => {
 					pushError({
 						title: "Couldn't send message",
-						detail: formatErrorDetail(error) ?? "Saving the draft failed.",
+						detail:
+							formatErrorDetail(error) ??
+							(createdThisAttempt
+								? "The draft was saved but the send request failed. Try again from the Outbox."
+								: "The send request failed. Try again."),
 						error,
 					});
 					return null;
 				});
-			if (outboxMessage === null) return;
-			messageId = outboxMessage.outboxMessageId;
-			createdThisAttempt = true;
-			setOutboxMessageId(messageId);
+			if (sent === null) return;
+
+			stopAutoSave(messageId);
+			startSendPolling(messageId);
+			onClose();
+		} finally {
+			sendInFlightRef.current = false;
+			setIsSending(false);
 		}
-
-		const sent = await sendMutation
-			.mutateAsync({
-				path: { outboxMessageId: messageId },
-			})
-			.catch((error: unknown) => {
-				pushError({
-					title: "Couldn't send message",
-					detail:
-						formatErrorDetail(error) ??
-						(createdThisAttempt
-							? "The draft was saved but the send request failed. Try again from the Outbox."
-							: "The send request failed. Try again."),
-					error,
-				});
-				return null;
-			});
-		if (sent === null) return;
-
-		stopAutoSave(messageId);
-		startSendPolling(messageId);
-		onClose();
 	}, [
 		selectedAccountId,
 		toAddresses,
@@ -618,11 +621,10 @@ export const ComposeForm = ({
 		mode,
 		sourceMessage,
 		outboxMessageId,
-		createMutation,
+		saveImmediately,
 		sendMutation,
 		stopAutoSave,
 		startSendPolling,
-		setOutboxMessageId,
 		pushError,
 		onClose,
 	]);

package/src/components/compose/compose-send-stops-autosave.render.test.ts

@@ -14,6 +14,12 @@
  * then sends it — and creating it as already-queued makes that send a second
  * dispatch, which the server refuses.
  *
+ * Issue #674 is the boundary between the two: pressing Send inside the two
+ * seconds the debounce is still counting down. The cancelled timer was carrying
+ * the last edits, and the entry went out as the server last saw it. So the send
+ * writes what is on screen first, and a write that fails takes the send with it
+ * rather than transmitting the older copy behind the user's back.
+ *
  * The stub holds the outbox rule the API holds: only a draft accepts a send.
  */
 
@@ -81,8 +87,18 @@ afterEach(() => {
 const callsTo = (suffix: string) =>
 	(http?.calls ?? []).filter((call) => call.path.endsWith(suffix));
 
-const patchCount = (): number =>
-	(http?.calls ?? []).filter((call) => call.method === "PATCH").length;
+const patches = () =>
+	(http?.calls ?? []).filter((call) => call.method === "PATCH");
+
+const patchCount = (): number => patches().length;
+
+const patchesAfterTheSend = (): number => {
+	const calls = http?.calls ?? [];
+	const sendIndex = calls.findIndex((call) => call.path.endsWith("/send"));
+	if (sendIndex === -1) throw new Error("the send never went out");
+	return calls.slice(sendIndex + 1).filter((call) => call.method === "PATCH")
+		.length;
+};
 
 const Opened = ({ outboxMessageId }: { outboxMessageId?: string }) => {
 	const { state, openCompose } = useCompose();
@@ -108,6 +124,8 @@ interface MountOptions {
 	outboxMessageId?: string;
 	/** Hold the PATCH response open so a save is still in flight at send time. */
 	gatePatch?: boolean;
+	/** Refuse every PATCH, so the write compose makes before sending fails. */
+	failPatch?: boolean;
 }
 
 const mount = async (
@@ -140,6 +158,7 @@ const mount = async (
 
 		if (call.method === "PATCH") {
 			await patchGate;
+			if (options.failPatch) return httpError(409, "The draft moved on.");
 			return outboxEntry(status);
 		}
 
@@ -172,7 +191,7 @@ const sendButton = (): HTMLElement => {
 	return button;
 };
 
-describe("compose and the outbox entry it is sending (#604)", () => {
+describe("compose and the outbox entry it is sending (#604, #674)", () => {
 	it("writes no further PATCH to an entry once it has been sent", async () => {
 		const { releasePatch } = await mount({
 			outboxMessageId: OUTBOX_MESSAGE_ID,
@@ -193,7 +212,76 @@ describe("compose and the outbox entry it is sending (#604)", () => {
 		await harness?.wait(AUTOSAVE_DEBOUNCE_MS + 200);
 
 		assert.equal(callsTo("/send").length, 1, "the send went out");
-		assert.equal(patchCount(), 1, "no autosave PATCH followed the send");
+		assert.equal(patchesAfterTheSend(), 0, "no write followed the send");
+		// The in-flight autosave and the write before the send are the two, in
+		// that order: a second write issued alongside the first could land behind
+		// it and put the older body back.
+		assert.equal(
+			patchCount(),
+			2,
+			"the two writes went out one after the other",
+		);
+	});
+
+	it("writes the edit made inside the debounce window before it sends", async () => {
+		await mount({ outboxMessageId: OUTBOX_MESSAGE_ID });
+
+		harness?.type(subjectField(), "Re: Lunch tomorrow");
+		await harness?.wait(AUTOSAVE_DEBOUNCE_MS + 100);
+		assert.equal(patchCount(), 1, "the typing burst autosaves once");
+
+		// Inside the two seconds the next autosave would have waited.
+		harness?.type(subjectField(), "Re: Lunch on Thursday");
+		harness?.click(sendButton());
+		await harness?.flush();
+		await harness?.wait(100);
+
+		assert.equal(callsTo("/send").length, 1, "the send went out");
+		const written = patches().at(-1);
+		assert.equal(
+			written?.body?.subject,
+			"Re: Lunch on Thursday",
+			"the entry carries the edit the debounce was still holding",
+		);
+		// Autosave never writes these, so an entry autosaved before Send used to
+		// go out unchained from the message it replies to.
+		assert.equal(written?.body?.inReplyTo, "<m1@example.com>");
+		assert.deepEqual(written?.body?.references, ["<m1@example.com>"]);
+		assert.equal(closed, 1, "compose closed on a successful send");
+	});
+
+	it("sends nothing, and says so, when that write fails", async () => {
+		await mount({ outboxMessageId: OUTBOX_MESSAGE_ID, failPatch: true });
+
+		harness?.type(subjectField(), "Re: Lunch on Thursday");
+		harness?.click(sendButton());
+		await harness?.flush();
+		await harness?.wait(100);
+
+		assert.equal(patchCount(), 1, "the write was attempted");
+		assert.equal(callsTo("/send").length, 0, "the older copy stayed put");
+		assert.equal(closed, 0, "compose stayed open");
+		assert.match(harness?.text() ?? "", /Couldn't send message/);
+	});
+
+	it("dispatches once when Send is pressed twice over the write", async () => {
+		const { releasePatch } = await mount({
+			outboxMessageId: OUTBOX_MESSAGE_ID,
+			gatePatch: true,
+		});
+
+		harness?.type(subjectField(), "Re: Lunch on Thursday");
+		harness?.click(sendButton());
+		harness?.click(sendButton());
+		await harness?.flush();
+
+		releasePatch();
+		await harness?.flush();
+		await harness?.wait(100);
+
+		assert.equal(patchCount(), 1, "the entry was written once");
+		assert.equal(callsTo("/send").length, 1, "the message went out once");
+		assert.equal(closed, 1, "compose closed on a successful send");
 	});
 
 	it("sends a reply pressed before the first autosave, in one dispatch", async () => {

package/src/hooks/useSaveDraft.ts

@@ -8,6 +8,10 @@ import { useCallback, useRef, useState } from "react";
 
 export type SaveStatus = "idle" | "saving" | "saved" | "error";
 
+export type ImmediateSave =
+	| { outcome: "saved"; outboxMessageId: string }
+	| { outcome: "failed"; error: unknown };
+
 interface DraftData {
 	accountId: string;
 	toAddresses: string[];
@@ -25,6 +29,12 @@ interface UseSaveDraftOptions {
 	onDraftCreated: (id: string) => void;
 }
 
+const settled = (promise: Promise<unknown>): Promise<void> =>
+	promise.then(
+		() => undefined,
+		() => undefined,
+	);
+
 export const useSaveDraft = ({
 	outboxMessageId,
 	onDraftCreated,
@@ -35,6 +45,17 @@ export const useSaveDraft = ({
 	const closedIdsRef = useRef<Set<string>>(new Set());
 	const queryClient = useQueryClient();
 
+	// The entry a save writes to. That is the prop, except between a save
+	// creating the draft and the id arriving back as the prop — reading the prop
+	// in that window creates the same draft a second time and strands one of the
+	// two in the outbox.
+	const propIdRef = useRef(outboxMessageId);
+	const targetIdRef = useRef(outboxMessageId);
+	if (propIdRef.current !== outboxMessageId) {
+		propIdRef.current = outboxMessageId;
+		targetIdRef.current = outboxMessageId;
+	}
+
 	const createMutation = useMutation(
 		outboxOperationsCreateOutboxMessageMutation(),
 	);
@@ -47,9 +68,10 @@ export const useSaveDraft = ({
 			setSaveStatus("saving");
 			setSaveError(null);
 
-			if (outboxMessageId) {
+			const targetId = targetIdRef.current;
+			if (targetId) {
 				const result = await updateMutation.mutateAsync({
-					path: { outboxMessageId },
+					path: { outboxMessageId: targetId },
 					body: {
 						toAddresses: data.toAddresses,
 						ccAddresses: data.ccAddresses,
@@ -71,6 +93,7 @@ export const useSaveDraft = ({
 					sendImmediately: false,
 				},
 			});
+			targetIdRef.current = result.outboxMessageId;
 			onDraftCreated(result.outboxMessageId);
 			setSaveStatus("saved");
 			queryClient.invalidateQueries({
@@ -78,38 +101,60 @@ export const useSaveDraft = ({
 			});
 			return result;
 		},
-		[
-			outboxMessageId,
-			createMutation,
-			updateMutation,
-			onDraftCreated,
-			queryClient,
-		],
+		[createMutation, updateMutation, onDraftCreated, queryClient],
+	);
+
+	// One entry takes one write at a time. Overlapping writes settle in whatever
+	// order the network gives them, so an older body can land last — and two of
+	// them racing while the draft has no id yet each create one.
+	const writesRef = useRef<Promise<void>>(Promise.resolve());
+	const enqueueSave = useCallback(
+		(data: DraftData) => {
+			const write = writesRef.current.then(() => executeSave(data));
+			writesRef.current = settled(write);
+			return write;
+		},
+		[executeSave],
 	);
 
 	const saveDraft = useCallback(
 		(data: DraftData) => {
-			if (outboxMessageId && closedIdsRef.current.has(outboxMessageId)) return;
 			if (timerRef.current) clearTimeout(timerRef.current);
 			timerRef.current = setTimeout(() => {
+				const targetId = targetIdRef.current;
+				if (targetId && closedIdsRef.current.has(targetId)) return;
 				// Keep the real error, not just a vague "error" status — the caller
 				// surfaces its detail in a banner. A fatal 5xx additionally escalates
 				// through the global MutationCache.onError sink.
-				executeSave(data).catch((error: unknown) => {
+				enqueueSave(data).catch((error: unknown) => {
 					setSaveError(error);
 					setSaveStatus("error");
 				});
 			}, 2000);
 		},
-		[executeSave, outboxMessageId],
+		[enqueueSave],
 	);
 
+	// Whoever asks for this is acting on the draft right now and owns the
+	// outcome, so the failure is returned rather than thrown and `saveError` is
+	// left alone — the caller's own message is the accurate one, and setting
+	// `saveError` would raise a second "Couldn't save draft" banner beside it.
 	const saveImmediately = useCallback(
-		(data: DraftData) => {
+		(data: DraftData): Promise<ImmediateSave> => {
 			if (timerRef.current) clearTimeout(timerRef.current);
-			return executeSave(data);
+			return enqueueSave(data)
+				.then(
+					(result): ImmediateSave => ({
+						outcome: "saved",
+						outboxMessageId: result.outboxMessageId,
+					}),
+				)
+				.catch((error: unknown): ImmediateSave => {
+					setSaveStatus("error");
+					return { outcome: "failed", error };
+				});
 		},
-		[executeSave],
+		[enqueueSave],
 	);
 
 	// Called with an id, the entry is closed to autosave for good. Sending and