Skip to content

Commit 75599d3

Browse files
committed
Harden onboarding defaults persistence
1 parent 78a394b commit 75599d3

5 files changed

Lines changed: 422 additions & 15 deletions

File tree

‎desktop/src/features/agents/AGENTS.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ with a TypeScript lookup table or an id comparison in a component.
6868
- `ui/agentConfigFieldsContract.test.mjs` — canonical behaviors + disclosure
6969
presets. If this fails, you probably reintroduced a per-surface flag.
7070
- `desktop/tests/e2e/onboarding-agent-defaults.spec.ts` — onboarding behavior
71-
pin (35 tests).
71+
acceptance coverage for readiness, failure states, defaults, navigation, and
72+
persistence races.
7273
- Rust: `runtime_metadata_env_vars` tests pin spawn-time key application.
7374

7475
## Keep this file true

‎desktop/src/features/onboarding/ui/DefaultConfigStep.tsx‎

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,13 @@ function formatHarnessLabel(runtime: AcpRuntimeCatalogEntry | undefined) {
4040
}
4141

4242
function AgentDefaultsSection({
43-
onHasDefaultRuntimeChange,
43+
onPersistenceStateChange,
4444
readyRuntimeIds,
4545
}: {
46-
onHasDefaultRuntimeChange: (hasDefaultRuntime: boolean) => void;
46+
onPersistenceStateChange: (state: {
47+
canComplete: boolean;
48+
flush: () => Promise<void>;
49+
}) => void;
4750
readyRuntimeIds: readonly string[];
4851
}) {
4952
const runtimesQuery = useAcpRuntimesQuery();
@@ -55,8 +58,10 @@ function AgentDefaultsSection({
5558
const [bakedEnv, setBakedEnv] = React.useState<BakedEnvEntry[]>([]);
5659
const coalescerRef = React.useRef<{
5760
enqueue: (value: GlobalAgentConfig) => void;
61+
flush: () => Promise<void>;
5862
cancel: () => void;
5963
} | null>(null);
64+
const [isSaving, setIsSaving] = React.useState(false);
6065

6166
React.useEffect(() => {
6267
let unmounted = false;
@@ -87,7 +92,9 @@ function AgentDefaultsSection({
8792
// set_global_agent_config returns a save result (config + restart
8893
// counts); the coalescer round-trips the persisted config only.
8994
async (next) => (await setGlobalAgentConfig(next)).config,
90-
() => undefined, // saving state not surfaced in this autosave UX
95+
(saving) => {
96+
if (!unmounted) setIsSaving(saving);
97+
},
9198
(saved) => {
9299
if (!unmounted) setConfig(saved);
93100
},
@@ -157,9 +164,16 @@ function AgentDefaultsSection({
157164
selectedRuntimeId,
158165
]);
159166

167+
const flushPersistence = React.useCallback(
168+
() => coalescerRef.current?.flush() ?? Promise.resolve(),
169+
[],
170+
);
160171
React.useEffect(() => {
161-
onHasDefaultRuntimeChange(selectedRuntimeId.length > 0);
162-
}, [onHasDefaultRuntimeChange, selectedRuntimeId]);
172+
onPersistenceStateChange({
173+
canComplete: selectedRuntimeId.length > 0 && !isSaving,
174+
flush: flushPersistence,
175+
});
176+
}, [flushPersistence, isSaving, onPersistenceStateChange, selectedRuntimeId]);
163177

164178
return (
165179
<section className="w-full space-y-4 text-left text-sm">
@@ -230,7 +244,26 @@ export function DefaultConfigStep({
230244
direction,
231245
readyRuntimeIds,
232246
}: DefaultConfigStepProps) {
233-
const [hasDefaultRuntime, setHasDefaultRuntime] = React.useState(false);
247+
const [persistenceState, setPersistenceState] = React.useState<{
248+
canComplete: boolean;
249+
flush: () => Promise<void>;
250+
}>({ canComplete: false, flush: () => Promise.resolve() });
251+
const [completionError, setCompletionError] = React.useState<string | null>(
252+
null,
253+
);
254+
const [isCompleting, setIsCompleting] = React.useState(false);
255+
256+
const handleComplete = React.useCallback(async () => {
257+
setIsCompleting(true);
258+
setCompletionError(null);
259+
try {
260+
await persistenceState.flush();
261+
actions.complete();
262+
} catch {
263+
setCompletionError("Couldn't save your default harness. Try again.");
264+
setIsCompleting(false);
265+
}
266+
}, [actions, persistenceState]);
234267

235268
return (
236269
<OnboardingSlideTransition
@@ -253,18 +286,26 @@ export function DefaultConfigStep({
253286
<div className="flex w-full flex-1 items-center justify-center py-10">
254287
<div className="w-full max-w-[328px]">
255288
<AgentDefaultsSection
256-
onHasDefaultRuntimeChange={setHasDefaultRuntime}
289+
onPersistenceStateChange={setPersistenceState}
257290
readyRuntimeIds={readyRuntimeIds}
258291
/>
292+
{completionError ? (
293+
<p
294+
className="mt-3 text-center text-xs text-destructive"
295+
role="alert"
296+
>
297+
{completionError}
298+
</p>
299+
) : null}
259300
</div>
260301
</div>
261302

262303
<OnboardingFooter>
263304
<Button
264305
className={`${ONBOARDING_PRIMARY_CTA_CLASS} text-sm`}
265306
data-testid="onboarding-finish"
266-
disabled={!hasDefaultRuntime}
267-
onClick={actions.complete}
307+
disabled={!persistenceState.canComplete || isCompleting}
308+
onClick={() => void handleComplete()}
268309
type="button"
269310
>
270311
Next

‎desktop/src/features/onboarding/ui/saveCoalescer.test.mjs‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,47 @@ test("saveCoalescer_isSaving_transitions_true_then_false", async () => {
145145
assert.deepEqual(states, [true, false]);
146146
});
147147

148+
test("saveCoalescer_flush_waits_for_the_latest_pending_save", async () => {
149+
const d = deferred();
150+
const persisted = [];
151+
152+
const coalescer = createSaveCoalescer(
153+
async (v) => {
154+
if (v.n === 0) await d.promise;
155+
persisted.push(v.n);
156+
return v;
157+
},
158+
() => {},
159+
() => {},
160+
);
161+
162+
coalescer.enqueue({ n: 0 });
163+
coalescer.enqueue({ n: 1 });
164+
let flushed = false;
165+
const flush = coalescer.flush().then(() => {
166+
flushed = true;
167+
});
168+
await tick();
169+
assert.equal(flushed, false);
170+
171+
d.resolve();
172+
await flush;
173+
assert.deepEqual(persisted, [0, 1]);
174+
});
175+
176+
test("saveCoalescer_flush_rejects_when_the_final_save_fails", async () => {
177+
const coalescer = createSaveCoalescer(
178+
async () => {
179+
throw new Error("save failed");
180+
},
181+
() => {},
182+
() => {},
183+
);
184+
185+
coalescer.enqueue({ n: 0 });
186+
await assert.rejects(coalescer.flush(), /save failed/);
187+
});
188+
148189
test("saveCoalescer_cancel_prevents_onSaved_and_onSaving_false", async () => {
149190
const d = deferred();
150191
const states = [];

‎desktop/src/features/onboarding/ui/saveCoalescer.ts‎

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,36 @@
77
* recent local change.
88
*
99
* Lifecycle: call cancel() on unmount so in-flight saves do not invoke
10-
* the onSaving / onSaved callbacks after the owning component is gone.
10+
* callbacks after the owning component is gone. Call flush() before leaving
11+
* a surface that must guarantee its latest optimistic value was persisted.
1112
*/
1213
export function createSaveCoalescer<T>(
1314
save: (value: T) => Promise<T>,
1415
onSaving: (isSaving: boolean) => void,
1516
onSaved: (value: T) => void,
16-
): { enqueue: (value: T) => void; cancel: () => void } {
17+
): {
18+
enqueue: (value: T) => void;
19+
flush: () => Promise<void>;
20+
cancel: () => void;
21+
} {
1722
let pending: T | undefined;
1823
let hasPending = false;
1924
let running = false;
2025
let cancelled = false;
26+
let finalError: unknown;
27+
let flushWaiters: Array<{
28+
resolve: () => void;
29+
reject: (error: unknown) => void;
30+
}> = [];
31+
32+
function settleFlushWaiters() {
33+
const waiters = flushWaiters;
34+
flushWaiters = [];
35+
for (const waiter of waiters) {
36+
if (finalError === undefined) waiter.resolve();
37+
else waiter.reject(finalError);
38+
}
39+
}
2140

2241
async function drain() {
2342
while (hasPending) {
@@ -26,17 +45,21 @@ export function createSaveCoalescer<T>(
2645
pending = undefined;
2746
try {
2847
const saved = await save(toSave);
48+
finalError = undefined;
2949
// Apply backend response only when no newer local edit is pending —
3050
// a stale response must never overwrite fresher optimistic state.
3151
if (!cancelled && !hasPending) {
3252
onSaved(saved);
3353
}
34-
} catch {
35-
// Non-fatal — optimistic local state is retained; user can retry.
54+
} catch (error) {
55+
finalError = error;
3656
}
3757
}
3858
running = false;
39-
if (!cancelled) onSaving(false);
59+
if (!cancelled) {
60+
onSaving(false);
61+
settleFlushWaiters();
62+
}
4063
}
4164

4265
return {
@@ -45,13 +68,29 @@ export function createSaveCoalescer<T>(
4568
hasPending = true;
4669
if (running) return;
4770
running = true;
71+
finalError = undefined;
4872
onSaving(true);
4973
void drain();
5074
},
75+
flush() {
76+
if (!running) {
77+
return finalError === undefined
78+
? Promise.resolve()
79+
: Promise.reject(finalError);
80+
}
81+
return new Promise<void>((resolve, reject) => {
82+
flushWaiters.push({ resolve, reject });
83+
});
84+
},
5185
cancel() {
5286
cancelled = true;
5387
hasPending = false;
5488
pending = undefined;
89+
const waiters = flushWaiters;
90+
flushWaiters = [];
91+
for (const waiter of waiters) {
92+
waiter.reject(new Error("Save cancelled"));
93+
}
5594
},
5695
};
5796
}

0 commit comments

Comments
 (0)