Skip to content

Automate browser based workflows with AI

fix(SKY-11886): stop URL sync from reverting focus on repeat block adds (#7107)

Celal Zamanoğlua05083365300
diff --git a/skyvern-frontend/src/routes/workflows/editor/hooks/useSelectedBlockUrlSync.test.tsx b/skyvern-frontend/src/routes/workflows/editor/hooks/useSelectedBlockUrlSync.test.tsx
index 8f5c2c7fd..1b9557396 100644
--- a/skyvern-frontend/src/routes/workflows/editor/hooks/useSelectedBlockUrlSync.test.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/hooks/useSelectedBlockUrlSync.test.tsx
@@ -1,9 +1,24 @@
// @vitest-environment jsdom
import type { ReactNode } from "react";
-import { act, renderHook, waitFor } from "@testing-library/react";
+import {
+ act,
+ fireEvent,
+ render,
+ renderHook,
+ screen,
+ waitFor,
+} from "@testing-library/react";
import { MemoryRouter, useLocation, useNavigate } from "react-router-dom";
-import { beforeEach, describe, expect, test } from "vitest";
+import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import {
+ ReactFlow,
+ ReactFlowProvider,
+ useEdgesState,
+ useNodesState,
+ useReactFlow,
+ type Edge,
+} from "@xyflow/react";
import { useWorkflowPanelStore } from "@/store/WorkflowPanelStore";
@@ -17,18 +32,21 @@ import {
const startNode = {
id: "start-node",
type: "start",
+ position: { x: 0, y: 0 },
data: { label: "__start_block__" },
} as AppNode;
const loginNode = {
id: "login-node",
type: "task",
+ position: { x: 0, y: 100 },
data: { label: "Login" },
} as AppNode;
const checkoutNode = {
id: "checkout-node",
type: "codeBlock",
+ position: { x: 0, y: 200 },
data: { label: "Checkout step" },
} as AppNode;
@@ -50,10 +68,74 @@ function useTestHarnessWithNavigate(enabled = true) {
return { location: useLocation(), navigate: useNavigate() };
}
+// jsdom has no ResizeObserver; React Flow's resize handler needs one to mount.
+class ResizeObserverStub {
+ observe() {}
+ unobserve() {}
+ disconnect() {}
+}
+
+type PendingAdd = { nodes: Array<AppNode>; id: string } | null;
+
+// Mirrors the real add-a-block path end to end: WorkflowNodeLibraryPanel's
+// onClick calls addNode() (doLayout's setNodes, then setSelectedBlockId) and
+// closeWorkflowPanel(), all inside one React synthetic event. That matters:
+// an imperative act(() => ...) call doesn't reproduce the same batching, so
+// this drives it through a real <button onClick> and fireEvent.click.
+function AddViaRealFlow({
+ initialNodes,
+ pendingAddRef,
+}: {
+ initialNodes: Array<AppNode>;
+ pendingAddRef: { current: PendingAdd };
+}) {
+ const [nodes, setNodes, onNodesChange] = useNodesState<AppNode>(initialNodes);
+ const [edges, , onEdgesChange] = useEdgesState<Edge>([]);
+ const { getNodes } = useReactFlow();
+ useSelectedBlockUrlSync({
+ enabled: true,
+ nodes,
+ getNodes: getNodes as () => Array<AppNode>,
+ });
+ const location = useLocation();
+
+ return (
+ <div>
+ <div data-testid="search">{location.search}</div>
+ <div data-testid="store">
+ {useWorkflowPanelStore((s) => s.selectedBlockId)}
+ </div>
+ <button
+ data-testid="add-button"
+ onClick={() => {
+ const pendingAdd = pendingAddRef.current;
+ if (!pendingAdd) return;
+ setNodes(pendingAdd.nodes);
+ useWorkflowPanelStore.getState().setSelectedBlockId(pendingAdd.id);
+ useWorkflowPanelStore.getState().closeWorkflowPanel();
+ }}
+ >
+ add
+ </button>
+ <ReactFlow
+ nodes={nodes}
+ edges={edges}
+ onNodesChange={onNodesChange}
+ onEdgesChange={onEdgesChange}
+ />
+ </div>
+ );
+}
+
beforeEach(() => {
+ vi.stubGlobal("ResizeObserver", ResizeObserverStub);
useWorkflowPanelStore.getState().setSelectedBlockId(null);
});
+afterEach(() => {
+ vi.unstubAllGlobals();
+});
+
describe("getInitialSelectedBlockId", () => {
test("restores the matching workflow block in studio", () => {
const searchParams = new URLSearchParams();
@@ -197,4 +279,40 @@ describe("useSelectedBlockUrlSync", () => {
expect(result.current.search).toBe("");
});
});
+
+ test("keeps focus on the newest block across consecutive adds", async () => {
+ const pendingAddRef: { current: PendingAdd } = { current: null };
+ render(
+ <MemoryRouter initialEntries={["/workflows/wpid_abc/studio"]}>
+ <ReactFlowProvider>
+ <AddViaRealFlow
+ initialNodes={[startNode]}
+ pendingAddRef={pendingAddRef}
+ />
+ </ReactFlowProvider>
+ </MemoryRouter>,
+ );
+
+ pendingAddRef.current = { nodes: [startNode, loginNode], id: "login-node" };
+ fireEvent.click(screen.getByTestId("add-button"));
+ await waitFor(() => {
+ expect(screen.getByTestId("search").textContent).toBe(
+ "?selected-block=Login",
+ );
+ });
+ expect(screen.getByTestId("store").textContent).toBe("login-node");
+
+ pendingAddRef.current = {
+ nodes: [startNode, loginNode, checkoutNode],
+ id: "checkout-node",
+ };
+ fireEvent.click(screen.getByTestId("add-button"));
+
+ await waitFor(() => {
+ expect(screen.getByTestId("store").textContent).toBe("checkout-node");
+ });
+ expect(screen.getByTestId("search").textContent).toBe(
+ "?selected-block=Checkout+step",
+ );
+ });
});
diff --git a/skyvern-frontend/src/routes/workflows/editor/hooks/useSelectedBlockUrlSync.ts b/skyvern-frontend/src/routes/workflows/editor/hooks/useSelectedBlockUrlSync.ts
index 79d6f6cad..aecce6287 100644
--- a/skyvern-frontend/src/routes/workflows/editor/hooks/useSelectedBlockUrlSync.ts
+++ b/skyvern-frontend/src/routes/workflows/editor/hooks/useSelectedBlockUrlSync.ts
@@ -85,6 +85,10 @@ export function useSelectedBlockUrlSync({
const selectedBlockLabelParam = searchParams.get(SELECTED_BLOCK_SEARCH_PARAM);
const searchParamsRef = useRef(searchParams);
searchParamsRef.current = searchParams;
+ // Skip reconciling from the URL when its value hasn't changed: a
+ // `nodes`-only re-run of the effect below would otherwise revert a
+ // same-commit fresher store selection back to the stale URL target.
+ const lastAppliedLabelParamRef = useRef<string | null>(null);
const getCurrentNodes = useCallback(() => {
const latestNodes = getNodes?.();
@@ -105,9 +109,17 @@ export function useSelectedBlockUrlSync({
);
useEffect(() => {
- if (!enabled || !selectedBlockLabelParam) {
+ if (!enabled) {
+ return;
+ }
+ if (!selectedBlockLabelParam) {
+ lastAppliedLabelParamRef.current = null;
+ return;
+ }
+ if (selectedBlockLabelParam === lastAppliedLabelParamRef.current) {
return;
}
+ lastAppliedLabelParamRef.current = selectedBlockLabelParam;
const currentNodes = getCurrentNodes();
const matchedNodeId = getWorkflowBlockNodeIdByLabel(