Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
Disable Save while an authoring action or Copilot change holds the editor (SKY-17997) (#8961)
Cindy Li2b9edf9c47dc
diff --git a/skyvern-frontend/src/routes/workflows/editor/WorkflowHeader.tsx b/skyvern-frontend/src/routes/workflows/editor/WorkflowHeader.tsxindex 739768de1..421f6feb6 100644--- a/skyvern-frontend/src/routes/workflows/editor/WorkflowHeader.tsx+++ b/skyvern-frontend/src/routes/workflows/editor/WorkflowHeader.tsx@@ -39,6 +39,11 @@ import {import { useWorkflowPanelStore } from "@/store/WorkflowPanelStore";import { useWorkflowParametersStore } from "@/store/WorkflowParametersStore";import { useWorkflowTitleStore } from "@/store/WorkflowTitleStore";+import { ControlTooltip } from "../studio/ControlTooltip";+import {+ selectSaveLockReason,+ useWorkflowYamlEditorStore,+} from "@/store/WorkflowYamlEditorStore";import { cn } from "@/util/utils";import { EditableNodeTitle } from "./nodes/components/EditableNodeTitle";import { EditorOverflowMenu } from "./header/EditorOverflowMenu";@@ -110,6 +115,7 @@ function BrowserModeButton() {function SaveButton() {const saving = useWorkflowHasChangesStore((s) => s.saveIsPending);const isRecording = useRecordingStore().isRecording;+ const saveLockReason = useWorkflowYamlEditorStore(selectSaveLockReason);const isGlobalWorkflow = useIsGlobalWorkflow();const onSave = useSaveWorkflow();const pendingGoalChangeCount = useCopilotActionStore(@@ -131,30 +137,31 @@ function SaveButton() {return (<TooltipProvider>- <Tooltip>- <TooltipTrigger asChild>- <Button- size="icon"- variant="tertiary"- className="size-10 min-w-[2.5rem]"- disabled={isGlobalWorkflow || isRecording}- onClick={() => {- if (pendingGoalChangeCount > 0) {- setGoalDialogOpen(true);- return;- }- save();- }}- >- {saving ? (- <ReloadIcon className="size-6 animate-spin" />- ) : (- <SaveIcon className="size-6" />- )}- </Button>- </TooltipTrigger>- <TooltipContent>Save</TooltipContent>- </Tooltip>+ <ControlTooltip+ content="Save"+ reason={saveLockReason}+ blocked={saveLockReason !== null}+ >+ <Button+ size="icon"+ variant="tertiary"+ className="size-10 min-w-[2.5rem] disabled:pointer-events-none"+ disabled={isGlobalWorkflow || isRecording || saveLockReason !== null}+ onClick={() => {+ if (pendingGoalChangeCount > 0) {+ setGoalDialogOpen(true);+ return;+ }+ save();+ }}+ >+ {saving ? (+ <ReloadIcon className="size-6 animate-spin" />+ ) : (+ <SaveIcon className="size-6" />+ )}+ </Button>+ </ControlTooltip><PendingGoalChangesDialogopen={goalDialogOpen}onOpenChange={setGoalDialogOpen}diff --git a/skyvern-frontend/src/routes/workflows/editor/header/EditorOverflowMenu.tsx b/skyvern-frontend/src/routes/workflows/editor/header/EditorOverflowMenu.tsxindex c15d51da4..7c6808d89 100644--- a/skyvern-frontend/src/routes/workflows/editor/header/EditorOverflowMenu.tsx+++ b/skyvern-frontend/src/routes/workflows/editor/header/EditorOverflowMenu.tsx@@ -36,7 +36,10 @@ import {SaveStaleError,useWorkflowHasChangesStore,} from "@/store/WorkflowHasChangesStore";-import { useWorkflowYamlEditorStore } from "@/store/WorkflowYamlEditorStore";+import {+ selectSaveLockReason,+ useWorkflowYamlEditorStore,+} from "@/store/WorkflowYamlEditorStore";import { cn } from "@/util/utils";import { SaveFailedError, useSaveWorkflow } from "../hooks/useSaveWorkflow";@@ -64,6 +67,8 @@ export function EditorOverflowMenu({const saveBlockedReason = useWorkflowHasChangesStore((s) => s.saveBlockedReason,);+ const saveLockReason = useWorkflowYamlEditorStore(selectSaveLockReason);+ const templateSaveReason = saveBlockedReason ?? saveLockReason;const templateReasonId = useId();const isRecording = useRecordingStore((s) => s.isRecording);const requestTour = useProductTourStore((s) => s.requestTour);@@ -112,7 +117,7 @@ export function EditorOverflowMenu({const disabled = isRecording || templateMutation.isPending || saving;// Only adding a template saves first. Radix skips a `disabled` item in keyboard navigation,// so the held item stays focusable and carries aria-disabled to keep its reason reachable.- const templateSaveHeld = !isTemplate && Boolean(saveBlockedReason);+ const templateSaveHeld = !isTemplate && Boolean(templateSaveReason);const handleTemplateToggle = async () => {const newIsTemplate = !isTemplate;@@ -204,7 +209,7 @@ export function EditorOverflowMenu({id={templateReasonId}className="max-w-xs whitespace-normal text-xs text-muted-foreground">- {saveBlockedReason}+ {templateSaveReason}</span></>) : (diff --git a/skyvern-frontend/src/routes/workflows/editor/workflowYamlDocument.test.ts b/skyvern-frontend/src/routes/workflows/editor/workflowYamlDocument.test.tsindex a703a58d0..c00be0c6a 100644--- a/skyvern-frontend/src/routes/workflows/editor/workflowYamlDocument.test.ts+++ b/skyvern-frontend/src/routes/workflows/editor/workflowYamlDocument.test.ts@@ -2549,7 +2549,7 @@ describe("regular save transactions", () => {});return { owner, view, client };}- test("legacy save refuses a Copilot lock without an unhandled rejection", async () => {+ test("legacy save is disabled under a Copilot lock without an unhandled rejection", async () => {const { view, client } = mountSave();client.setDefaultOptions({queries: { staleTime: Infinity, retry: false },@@ -2575,13 +2575,9 @@ describe("regular save transactions", () => {),);try {- fireEvent.click(control.getByRole("button"));- await waitFor(() =>- expect(toast).toHaveBeenCalledWith({- title: "Wait for the Copilot change to finish",- variant: "destructive",- }),- );+ const save = control.getByRole("button");+ expect(save.matches(":disabled")).toBe(true);+ fireEvent.click(save);await act(async () => {await new Promise((resolve) => setTimeout(resolve, 0));});diff --git a/skyvern-frontend/src/routes/workflows/studio/StudioTopBar.test.tsx b/skyvern-frontend/src/routes/workflows/studio/StudioTopBar.test.tsxindex 40117d2fd..dec1b2990 100644--- a/skyvern-frontend/src/routes/workflows/studio/StudioTopBar.test.tsx+++ b/skyvern-frontend/src/routes/workflows/studio/StudioTopBar.test.tsx@@ -402,10 +402,49 @@ describe("SaveButton confirmation gating", () => {active: false,draft: "",entrySnapshot: "",+ authoringInProgress: false,+ copilotAcceptance: null,});useRecordingStore.setState({ isRecording: false });});+ test.each([+ {+ lock: { authoringInProgress: true },+ reason: "Finish the current authoring action before saving",+ },+ {+ lock: { copilotAcceptance: Symbol("acceptance") },+ reason: "Wait for the Copilot change to finish",+ },+ ])(+ "disables Save while the editor is locked: $reason",+ ({ lock, reason }) => {+ const clean = saveData([block("a", { url: "x" })]);+ useWorkflowHasChangesStore.setState({+ getSaveData: () => clean,+ hasChanges: true,+ saveIsPending: false,+ });+ useWorkflowYamlEditorStore.setState(lock);++ renderSaveButton();+ const save = screen.getByRole("button", {+ name: "Save workflow",+ description: reason,+ });+ expect(save.matches(":disabled")).toBe(true);++ act(() =>+ useWorkflowYamlEditorStore.setState({+ authoringInProgress: false,+ copilotAcceptance: null,+ }),+ );+ expect(save.matches(":disabled")).toBe(false);+ },+ );+test("confirms a dirty draft even when contentDirty is stale-false", () => {const clean = saveData([block("a", { url: "x" })]);const dirty = saveData([block("a", { url: "y" })]);diff --git a/skyvern-frontend/src/routes/workflows/studio/StudioTopBar.tsx b/skyvern-frontend/src/routes/workflows/studio/StudioTopBar.tsxindex 796e1eec1..819463427 100644--- a/skyvern-frontend/src/routes/workflows/studio/StudioTopBar.tsx+++ b/skyvern-frontend/src/routes/workflows/studio/StudioTopBar.tsx@@ -46,6 +46,10 @@ import { useWorkflowPanelStore } from "@/store/WorkflowPanelStore";import { useWorkflowParametersStore } from "@/store/WorkflowParametersStore";import { useWorkflowSnapshotStore } from "@/store/WorkflowSnapshotStore";import { useWorkflowTitleStore } from "@/store/WorkflowTitleStore";+import {+ selectSaveLockReason,+ useWorkflowYamlEditorStore,+} from "@/store/WorkflowYamlEditorStore";import { basicLocalTimeFormat, basicTimeFormat } from "@/util/timeFormat";import { cn } from "@/util/utils";@@ -138,6 +142,8 @@ export function SaveButton() {const contentDirty = useWorkflowSnapshotStore((s) => s.contentDirty);const snapshot = useWorkflowSnapshotStore((s) => s.snapshot);const isRecording = useRecordingStore((s) => s.isRecording);+ const saveLockReason = useWorkflowYamlEditorStore(selectSaveLockReason);+ const saveUnavailable = isRecording || saveLockReason !== null;const onSave = useSaveWorkflow();const [confirmOpen, setConfirmOpen] = useState(false);const pendingGoalChangeCount = useCopilotActionStore(@@ -197,14 +203,14 @@ export function SaveButton() {<><ControlTooltipcontent="Save workflow"- reason={saveBlockedReason}- blocked={isRecording}+ reason={saveBlockedReason ?? saveLockReason}+ blocked={saveUnavailable}><Buttonvariant="ghost"size="icon"- className="relative h-8 w-8 text-muted-foreground"- disabled={isRecording}+ className="relative h-8 w-8 text-muted-foreground disabled:pointer-events-none"+ disabled={saveUnavailable}onClick={() => {if (pendingGoalChangeCount > 0) {setGoalDialogOpen(true);@@ -259,7 +265,7 @@ export function SaveButton() {</Button>) : (<Button- disabled={saving}+ disabled={saving || saveLockReason !== null}onClick={() => {// Close only on success; a failed save (already toasted by// onSave's onError) keeps the list open for retry, so swallowdiff --git a/skyvern-frontend/src/store/WorkflowHasChangesStore.recording.test.tsx b/skyvern-frontend/src/store/WorkflowHasChangesStore.recording.test.tsxindex fa8cccad6..fcbd6bc58 100644--- a/skyvern-frontend/src/store/WorkflowHasChangesStore.recording.test.tsx+++ b/skyvern-frontend/src/store/WorkflowHasChangesStore.recording.test.tsx@@ -31,6 +31,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";import {reflectYamlDraftDirtiness,+ SaveRefusedError,useWorkflowHasChangesStore,useWorkflowSave,usePendingWorkflowSaveRecovery,@@ -1642,9 +1643,11 @@ describe("workflow recording attachment", () => {}const { result } = renderHook(() => useWorkflowSave(), { wrapper });- await expect(- act(async () => result.current.mutateAsync(undefined)),- ).rejects.toThrow("Finish the current authoring action before saving");+ const refused = act(async () => result.current.mutateAsync(undefined));+ await expect(refused).rejects.toBeInstanceOf(SaveRefusedError);+ await expect(refused).rejects.toThrow(+ "Finish the current authoring action before saving",+ );expect(mocks.put).not.toHaveBeenCalled();expect(mocks.delete).not.toHaveBeenCalled();expect(useWorkflowHasChangesStore.getState()).toMatchObject({diff --git a/skyvern-frontend/src/store/WorkflowHasChangesStore.ts b/skyvern-frontend/src/store/WorkflowHasChangesStore.tsindex 4a59c2c03..77e9d06d3 100644--- a/skyvern-frontend/src/store/WorkflowHasChangesStore.ts+++ b/skyvern-frontend/src/store/WorkflowHasChangesStore.ts@@ -5,6 +5,7 @@ import { useWorkflowParametersStore } from "./WorkflowParametersStore";import { getInitialParameters } from "@/routes/workflows/editor/utils";import {selectEditorMutationLocked,+ AUTHORING_SAVE_MESSAGE,SAVE_STALE_MESSAGE,beginSaveTransaction,canInitializeWorkflow,@@ -125,10 +126,7 @@ function assertWorkflowSaveAllowed(}const state = useWorkflowYamlEditorStore.getState();if (state.authoringInProgress) {- throw new YamlCommitError(- "workflow",- "Finish the current authoring action before saving",- );+ throw new SaveRefusedError(AUTHORING_SAVE_MESSAGE);}const owner = state.lockKind === "save" ? saveOwner : yamlCommit?.owner;if (diff --git a/skyvern-frontend/src/store/WorkflowYamlEditorStore.ts b/skyvern-frontend/src/store/WorkflowYamlEditorStore.tsindex 651aa9073..e2089f59a 100644--- a/skyvern-frontend/src/store/WorkflowYamlEditorStore.ts+++ b/skyvern-frontend/src/store/WorkflowYamlEditorStore.ts@@ -90,6 +90,19 @@ export function selectEditorMutationLocked(return state.commitInProgress || state.copilotAcceptance !== null;}+export const AUTHORING_SAVE_MESSAGE =+ "Finish the current authoring action before saving";++// Our own in-flight save shows a spinner, not a reason.+export function selectSaveLockReason(+ state: WorkflowYamlEditorState,+): string | null {+ if (state.authoringInProgress) return AUTHORING_SAVE_MESSAGE;+ if (state.lockKind === "save" || !selectEditorMutationLocked(state))+ return null;+ return getWorkflowLockMessage(state);+}+export function isEditorMutationLocked(): boolean {return selectEditorMutationLocked(useWorkflowYamlEditorStore.getState());}@@ -637,8 +650,9 @@ export function withCopilotAcceptance(}}-export function getWorkflowLockMessage(): string {- const state = useWorkflowYamlEditorStore.getState();+export function getWorkflowLockMessage(+ state: WorkflowYamlEditorState = useWorkflowYamlEditorStore.getState(),+): string {if (state.lockKind === "save") return "A save is in progress";if (state.lockKind === "copilot" ||