Skip to content

Automate browser based workflows with AI

SKY-11118: opt-in headless turn-drain gate for copilot live browser (#6670)

Andrew Neilsonad858e93daf2
diff --git a/skyvern-frontend/src/routes/workflows/copilot/browserReadiness.test.ts b/skyvern-frontend/src/routes/workflows/copilot/browserReadiness.test.ts
index e05428ef0..1c7b48c32 100644
--- a/skyvern-frontend/src/routes/workflows/copilot/browserReadiness.test.ts
+++ b/skyvern-frontend/src/routes/workflows/copilot/browserReadiness.test.ts
@@ -1,6 +1,7 @@
import { describe, expect, it } from "vitest";
import {
+ resolveCopilotLiveBrowserReady,
shouldQueuePromptForLiveBrowser,
shouldWaitForLiveBrowser,
} from "./browserReadiness";
@@ -65,3 +66,57 @@ describe("shouldQueuePromptForLiveBrowser", () => {
).toBe(false);
});
});
+
+describe("resolveCopilotLiveBrowserReady", () => {
+ describe("with the headless drain affordance off", () => {
+ it.each([
+ [false, false],
+ [false, true],
+ [true, false],
+ [true, true],
+ ])(
+ "returns displayReady unchanged (display=%s, backend=%s)",
+ (displayReady, hasBackendSession) => {
+ expect(
+ resolveCopilotLiveBrowserReady({
+ displayReady,
+ hasBackendSession,
+ headlessTurnDrainEnabled: false,
+ }),
+ ).toBe(displayReady);
+ },
+ );
+ });
+
+ describe("with the headless drain affordance on", () => {
+ it("becomes ready on a backend session even without a painted display", () => {
+ expect(
+ resolveCopilotLiveBrowserReady({
+ displayReady: false,
+ hasBackendSession: true,
+ headlessTurnDrainEnabled: true,
+ }),
+ ).toBe(true);
+ });
+
+ it("stays not-ready without a backend session id", () => {
+ expect(
+ resolveCopilotLiveBrowserReady({
+ displayReady: false,
+ hasBackendSession: false,
+ headlessTurnDrainEnabled: true,
+ }),
+ ).toBe(false);
+ });
+
+ it("stays ready when the display is ready regardless of the backend session", () => {
+ expect(
+ resolveCopilotLiveBrowserReady({
+ displayReady: true,
+ hasBackendSession: false,
+ headlessTurnDrainEnabled: true,
+ }),
+ ).toBe(true);
+ });
+ });
+});
diff --git a/skyvern-frontend/src/routes/workflows/copilot/browserReadiness.ts b/skyvern-frontend/src/routes/workflows/copilot/browserReadiness.ts
index dfcabe441..006f5fa95 100644
--- a/skyvern-frontend/src/routes/workflows/copilot/browserReadiness.ts
+++ b/skyvern-frontend/src/routes/workflows/copilot/browserReadiness.ts
@@ -3,6 +3,25 @@ type BrowserReadinessInput = {
isLiveBrowserReady?: boolean;
};
+type CopilotLiveBrowserReadyInput = {
+ displayReady: boolean;
+ hasBackendSession: boolean;
+ headlessTurnDrainEnabled: boolean;
+};
+
+// The headless drain path posts a turn on the backend session id alone,
+// decoupling turn-readiness from the VNC/canvas paint signal.
+export function resolveCopilotLiveBrowserReady({
+ displayReady,
+ hasBackendSession,
+ headlessTurnDrainEnabled,
+}: CopilotLiveBrowserReadyInput): boolean {
+ if (!headlessTurnDrainEnabled) {
+ return displayReady;
+ }
+ return displayReady || hasBackendSession;
+}
+
type BrowserPromptQueueInput = BrowserReadinessInput & {
message?: string;
};
diff --git a/skyvern-frontend/src/routes/workflows/copilot/sendQueue.test.ts b/skyvern-frontend/src/routes/workflows/copilot/sendQueue.test.ts
index 122813984..613417cc2 100644
--- a/skyvern-frontend/src/routes/workflows/copilot/sendQueue.test.ts
+++ b/skyvern-frontend/src/routes/workflows/copilot/sendQueue.test.ts
@@ -1,5 +1,6 @@
import { describe, expect, it } from "vitest";
+import { resolveCopilotLiveBrowserReady } from "./browserReadiness";
import { resolveDrainAction, resolveSendAction } from "./sendQueue";
const sendInput = (
@@ -60,6 +61,19 @@ describe("resolveSendAction", () => {
).toBe("send");
});
+ it("sends when readiness is resolved from a headless backend session with no display paint", () => {
+ const isLiveBrowserReady = resolveCopilotLiveBrowserReady({
+ displayReady: false,
+ hasBackendSession: true,
+ headlessTurnDrainEnabled: true,
+ });
+ expect(
+ resolveSendAction(
+ sendInput({ requiresLiveBrowser: true, isLiveBrowserReady }),
+ ),
+ ).toBe("send");
+ });
+
it("sends when no live browser is required", () => {
expect(resolveSendAction(sendInput())).toBe("send");
});
@@ -139,6 +153,19 @@ describe("resolveDrainAction", () => {
).toBe("drain_skip_queue");
});
+ it("drains a parked live_browser prompt once a backend session is present", () => {
+ expect(
+ resolveDrainAction(
+ drainInput({
+ queuedReason: "live_browser",
+ hasLiveBrowserSession: true,
+ inFlight: false,
+ hasWorkflowPermanentId: true,
+ }),
+ ),
+ ).toBe("drain_skip_queue");
+ });
+
it("waits for the session before draining a live_browser prompt", () => {
expect(
resolveDrainAction(
diff --git a/skyvern-frontend/src/routes/workflows/editor/Workspace.tsx b/skyvern-frontend/src/routes/workflows/editor/Workspace.tsx
index 6bcb9e6eb..8a4fa1b8a 100644
--- a/skyvern-frontend/src/routes/workflows/editor/Workspace.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/Workspace.tsx
@@ -143,6 +143,7 @@ import { shouldKeepExistingEdgeForInsertion } from "./workflowInsertion";
import { constructCacheKeyValue, getInitialParameters } from "./utils";
import { WorkflowCopilotChat } from "../copilot/WorkflowCopilotChat";
import { WorkflowCopilotButton } from "../copilot/WorkflowCopilotButton";
+import { resolveCopilotLiveBrowserReady } from "../copilot/browserReadiness";
import type { WorkflowYAMLConversionResponse } from "../copilot/workflowCopilotTypes";
import "./workspace-styles.css";
@@ -312,6 +313,9 @@ function Workspace({
}, [initialCopilotMessage, location.pathname, location.search, navigate]);
const [searchParams] = useSearchParams();
const cacheKeyValueParam = searchParams.get("cache-key-value");
+ const headlessTurnDrainEnabled = ["1", "true"].includes(
+ (searchParams.get("copilotHeadlessTurnDrain") ?? "").toLowerCase(),
+ );
const [timelineMode, setTimelineMode] = useState("wide");
const [page, setPage] = useState(1);
const [nudge, setNudge] = useState(false);
@@ -650,9 +654,13 @@ function Workspace({
// readyBrowserSessionId is keyed to the browser session id rather than a
// bare boolean: when activeDebugSession's id changes, stale ready state
// from the previous session cannot leak into the next render.
- const copilotLiveBrowserReady = Boolean(
- readyBrowserSessionId && readyBrowserSessionId === liveBrowserSessionId,
- );
+ const copilotLiveBrowserReady = resolveCopilotLiveBrowserReady({
+ displayReady: Boolean(
+ readyBrowserSessionId && readyBrowserSessionId === liveBrowserSessionId,
+ ),
+ hasBackendSession: Boolean(liveBrowserSessionId),
+ headlessTurnDrainEnabled,
+ });
const handleLiveBrowserReadyChange = useCallback(
(ready: boolean, sessionId: string | null) => {