AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.
fix(frontend/onboarding): keep saving after a save the server applied but never answered (#15814)
Reinier van der Leer3ec9c0fcfa27
diff --git a/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/__tests__/progress-saver.test.ts b/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/__tests__/progress-saver.test.tsindex cc3b8664f7..c5b8e2a1b4 100644--- a/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/__tests__/progress-saver.test.ts+++ b/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/__tests__/progress-saver.test.ts@@ -28,6 +28,7 @@ describe("onboarding draft outbox", () => {onConflict: vi.fn(),userID: "one",save,+ load: vi.fn(),onError: vi.fn(),});saver.enqueue(makeProgress({ role: "First" }));@@ -63,6 +64,7 @@ describe("onboarding draft outbox", () => {onConflict: vi.fn(),userID: "one",save,+ load: vi.fn(),onError,});saver.enqueue(makeProgress());@@ -88,6 +90,7 @@ describe("onboarding draft outbox", () => {onConflict: vi.fn(),userID: "one",save,+ load: vi.fn(),onError: vi.fn(),});saver.enqueue(makeProgress({ role: "Private answer" }));@@ -113,6 +116,7 @@ it("times out a hung request so checkout flush can recover", async () => {onConflict: vi.fn(),userID: "one",save,+ load: vi.fn(),onError: vi.fn(),});saver.enqueue(makeProgress());@@ -126,11 +130,16 @@ it("times out a hung request so checkout flush can recover", async () => {it("stops automatic retries when another session has updated the server revision", async () => {const save = vi.fn().mockRejectedValue({ status: 409 });+ const load = vi.fn().mockResolvedValue({+ progress: makeProgress({ role: "Other device" }),+ revision: 4,+ });const onConflict = vi.fn();const saver = createProgressSaver({initialRevision: 3,userID: "one",save,+ load,onError: vi.fn(),onConflict,});@@ -138,6 +147,7 @@ it("stops automatic retries when another session has updated the server revisionawait expect(saver.flush()).rejects.toEqual({ status: 409 });await vi.advanceTimersByTimeAsync(30_000);expect(save).toHaveBeenCalledOnce();+ expect(load).toHaveBeenCalledOnce();expect(onConflict).toHaveBeenCalledOnce();expect(readLocalProgress("one")).toMatchObject({revision: 3,diff --git a/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/__tests__/wizard-progress.test.tsx b/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/__tests__/wizard-progress.test.tsxindex c3c4ba06e2..225414a7a0 100644--- a/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/__tests__/wizard-progress.test.tsx+++ b/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/__tests__/wizard-progress.test.tsx@@ -148,6 +148,44 @@ it("acknowledges an uncertain save already present on the server without another});});+it("keeps saving after a timed-out save that the server applied", async () => {+ let server = { progress: makeProgress(), revision: 4 };+ getState.mockImplementation(async () =>+ response(server.progress, server.revision),+ );+ patchState.mockImplementation(+ ({ wizardProgress, wizardRevision, wizardUserId }) => {+ if (wizardRevision !== server.revision)+ return Promise.resolve({ status: 409, data: { detail: "Conflict" } });+ const answers = server.revision > 4;+ server = { progress: wizardProgress, revision: server.revision + 1 };+ if (!answers) return new Promise(() => {});+ return Promise.resolve({+ status: 200,+ data: { userId: wizardUserId, wizardRevision: server.revision },+ });+ },+ );+ const { result } = mountWizard();+ await settle();+ act(() => useOnboardingWizardStore.getState().setRole("Founder"));+ await act(async () => {+ await vi.advanceTimersByTimeAsync(10_250);+ });+ expect(result.current.error).toMatch(/couldn't save/i);+ act(() => useOnboardingWizardStore.getState().setOtherRole("Solo"));+ await settle();+ const latest = makeProgress({ role: "Founder", otherRole: "Solo" });+ expect(result.current.conflict).toBe(false);+ expect(result.current.error).toBeNull();+ expect(server).toEqual({ progress: latest, revision: 6 });+ expect(readLocalProgress("u1")).toEqual({+ progress: latest,+ revision: 6,+ pending: false,+ });+});+it("keeps a clean offline cache clean and saves subsequent edits", async () => {writeLocalProgress("u1", makeProgress(), false, 4);getState.mockRejectedValue(new Error("Offline"));diff --git a/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/progress-saver.ts b/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/progress-saver.tsindex 77d1fc8702..edb922b05a 100644--- a/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/progress-saver.ts+++ b/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/progress-saver.ts@@ -5,9 +5,15 @@ import {writeLocalProgress,} from "./progress";+interface ServerProgress {+ progress: OnboardingWizardProgress | null;+ revision: number;+}+export function createProgressSaver({userID,save,+ load,onError,onConflict,initialRevision,@@ -20,11 +26,14 @@ export function createProgressSaver({revision: number,signal: AbortSignal,) => Promise<number>;+ // Resolves null when the server answers for a different account.+ load: (signal: AbortSignal) => Promise<ServerProgress | null>;onError: (message: string | null) => void;}) {let revision = initialRevision;let conflicted = false;let pending: OnboardingWizardProgress | null = null;+ const sent = new Set<OnboardingWizardProgress>();let inFlight: Promise<void> | null = null;let timer: ReturnType<typeof setTimeout> | undefined;let disposed = false;@@ -47,13 +56,13 @@ export function createProgressSaver({schedule(200);}- async function saveWithTimeout(progress: OnboardingWizardProgress) {+ async function withTimeout<T>(run: (signal: AbortSignal) => Promise<T>) {const request = new AbortController();controller = request;let timeout: ReturnType<typeof setTimeout> | undefined;try {return await Promise.race([- save(progress, revision, request.signal),+ run(request.signal),new Promise<never>((_resolve, reject) => {timeout = setTimeout(() => {request.abort();@@ -70,20 +79,11 @@ export function createProgressSaver({async function drain() {while (pending && !disposed) {const progress = pending;+ sent.add(progress);try {- const previousRevision = revision;- revision = await saveWithTimeout(progress);+ const saved = await saveOrAdopt(progress);if (disposed) return;- const latest = pending ?? progress;- const local = readLocalProgress(userID);- const ownsLocal =- local?.revision === previousRevision &&- sameProgress(latest, local.progress);- if (pending === progress) pending = null;- if (ownsLocal)- writeLocalProgress(userID, latest, pending !== null, revision);- failures = 0;- onError(null);+ confirm(saved);} catch (error) {if (disposed) return;if (isProgressConflict(error)) {@@ -101,6 +101,44 @@ export function createProgressSaver({}}+ async function saveOrAdopt(progress: OnboardingWizardProgress) {+ try {+ const saved = await withTimeout((signal) =>+ save(progress, revision, signal),+ );+ return { progress, revision: saved };+ } catch (error) {+ if (!isProgressConflict(error) || disposed) throw error;+ // A save this tab timed out on may have landed and moved the revision on.+ const server = await withTimeout(load);+ if (!server || server.revision <= revision) throw error;+ const own = [...sent].find((sentProgress) =>+ sameProgress(sentProgress, server.progress),+ );+ if (!own) throw error;+ return { progress: own, revision: server.revision };+ }+ }++ function confirm(saved: {+ progress: OnboardingWizardProgress;+ revision: number;+ }) {+ const previousRevision = revision;+ revision = saved.revision;+ sent.clear();+ const latest = pending ?? saved.progress;+ const local = readLocalProgress(userID);+ const ownsLocal =+ local?.revision === previousRevision &&+ sameProgress(latest, local.progress);+ if (pending === saved.progress) pending = null;+ if (ownsLocal)+ writeLocalProgress(userID, latest, pending !== null, revision);+ failures = 0;+ onError(null);+ }+async function flush() {clearTimeout(timer);if (conflicted)diff --git a/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/useWizardProgress.ts b/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/useWizardProgress.tsindex 1ecb0de4d7..24e30d030b 100644--- a/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/useWizardProgress.ts+++ b/autogpt_platform/frontend/src/app/(no-navbar)/onboarding/useWizardProgress.ts@@ -1,7 +1,15 @@-import { patchV1UpdateOnboardingState } from "@/app/api/__generated__/endpoints/onboarding/onboarding";+import {+ getV1OnboardingState,+ patchV1UpdateOnboardingState,+} from "@/app/api/__generated__/endpoints/onboarding/onboarding";import { useRouter, useSearchParams } from "next/navigation";import { useEffect, useRef, useState } from "react";-import { clearLocalProgress, resumeStep, sameProgress } from "./progress";+import {+ clearLocalProgress,+ readProgress,+ resumeStep,+ sameProgress,+} from "./progress";import { loadWizardProgress } from "./loadWizardProgress";import { createProgressSaver } from "./progress-saver";import {@@ -124,6 +132,20 @@ export function useWizardProgress({}return result.data.wizardRevision ?? wizardRevision + 1;},+ async load(signal) {+ if (!isCurrent()) throw new Error("Your account changed.");+ const result = await getV1OnboardingState({ signal });+ if (result.status !== 200)+ throw new Error("Could not load onboarding.");+ if (result.data.userId !== userID) {+ accountChanged.current = true;+ return null;+ }+ return {+ progress: readProgress(result.data.wizardProgress),+ revision: result.data.wizardRevision ?? 0,+ };+ },onError(error) {if (isCurrent()) setStatus((state) => ({ ...state, error }));},