Skip to content

Automate browser based workflows with AI

Segment workflow browser profiles with templated keys (#6805)

Suchintan48091df93eed
diff --git a/alembic/versions/2026_06_25_0017-45128d67bc1a_add_browser_profile_key_to_workflows.py b/alembic/versions/2026_06_25_0017-45128d67bc1a_add_browser_profile_key_to_workflows.py
new file mode 100644
index 000000000..f0db01467
--- /dev/null
+++ b/alembic/versions/2026_06_25_0017-45128d67bc1a_add_browser_profile_key_to_workflows.py
@@ -0,0 +1,27 @@
+"""add browser_profile_key to workflows
+
+Revision ID: 45128d67bc1a
+Revises: 2c76348b4e7a
+Create Date: 2026-06-25T00:17:17.827852+00:00
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "45128d67bc1a"
+down_revision: Union[str, None] = "2c76348b4e7a"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+ op.add_column("workflows", sa.Column("browser_profile_key", sa.String(), nullable=True))
+
+
+def downgrade() -> None:
+ op.drop_column("workflows", "browser_profile_key")
diff --git a/skyvern-frontend/src/routes/workflows/components/WorkflowVisualComparisonDrawer.tsx b/skyvern-frontend/src/routes/workflows/components/WorkflowVisualComparisonDrawer.tsx
index e709034cc..cf0a4ff63 100644
--- a/skyvern-frontend/src/routes/workflows/components/WorkflowVisualComparisonDrawer.tsx
+++ b/skyvern-frontend/src/routes/workflows/components/WorkflowVisualComparisonDrawer.tsx
@@ -104,6 +104,7 @@ function getWorkflowElements(version: WorkflowVersion) {
webhookCallbackUrl: version.webhook_callback_url || "",
persistBrowserSession: version.persist_browser_session,
browserProfileId: version.browser_profile_id ?? null,
+ browserProfileKey: version.browser_profile_key ?? null,
model: version.model,
maxScreenshotScrolls: version.max_screenshot_scrolls || 3,
maxElapsedTimeMinutes: version.max_elapsed_time_minutes ?? null,
diff --git a/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.test.tsx b/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.test.tsx
index fb1dc4844..0f289fdd4 100644
--- a/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.test.tsx
+++ b/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.test.tsx
@@ -22,7 +22,6 @@ const tagKeys: Array<TagKey> = [
];
function renderControl(props: {
- exactValuesOnly?: boolean;
value?: Array<TagFilterTerm>;
onChange?: (terms: Array<TagFilterTerm>) => void;
}) {
@@ -33,7 +32,6 @@ function renderControl(props: {
value={props.value ?? []}
onChange={props.onChange ?? (() => {})}
labelSuggestions={["adhoc"]}
- exactValuesOnly={props.exactValuesOnly}
/>
</MemoryRouter>,
);
@@ -45,32 +43,37 @@ function openAndType(query: string) {
fireEvent.change(input, { target: { value: query } });
}
-describe("TagFilterControl exactValuesOnly", () => {
- it("does not offer a bare label as an addable filter", () => {
- renderControl({ exactValuesOnly: true });
+// All surfaces (workflows list + analytics dashboard) accept the same three
+// term shapes: bare label, group:* (group-any), and exact group:value.
+describe("TagFilterControl", () => {
+ it("offers a bare label as an addable filter", () => {
+ renderControl({});
openAndType("prod");
- expect(screen.queryByText(/^Filter by/)).toBeNull();
+ expect(screen.getByText(/Filter by label/)).toBeTruthy();
});
- it("offers an exact group:value as an addable filter", () => {
- renderControl({ exactValuesOnly: true });
- openAndType("env:prod");
- expect(screen.getByText(/env: prod/)).toBeTruthy();
+ it("adds a bare label on selection", () => {
+ const onChange = vi.fn();
+ renderControl({ onChange });
+ openAndType("prod");
+ fireEvent.click(screen.getByText(/Filter by/));
+ expect(onChange).toHaveBeenCalledWith([{ key: null, value: "prod" }]);
});
- it("adds an exact term on selection", () => {
+ it("offers and adds an exact group:value", () => {
const onChange = vi.fn();
- renderControl({ exactValuesOnly: true, onChange });
+ renderControl({ onChange });
openAndType("env:prod");
+ expect(screen.getByText(/env: prod/)).toBeTruthy();
fireEvent.click(screen.getByText(/Filter by/));
expect(onChange).toHaveBeenCalledWith([{ key: "env", value: "prod" }]);
});
-});
-describe("TagFilterControl default mode", () => {
- it("still offers a bare label as an addable filter (workflows list parity)", () => {
- renderControl({ exactValuesOnly: false });
- openAndType("prod");
- expect(screen.getByText(/Filter by label/)).toBeTruthy();
+ it("adds a group-any term from a group suggestion", () => {
+ const onChange = vi.fn();
+ renderControl({ onChange });
+ openAndType("env");
+ fireEvent.click(screen.getByText(/: any/));
+ expect(onChange).toHaveBeenCalledWith([{ key: "env", value: null }]);
});
});
diff --git a/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.tsx b/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.tsx
index 74ffc7dc8..968bc67d1 100644
--- a/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.tsx
+++ b/skyvern-frontend/src/routes/workflows/components/tagging/TagFilterControl.tsx
@@ -51,11 +51,6 @@ type Props = {
// to this callback. Omit it for read-only surfaces (e.g. the analytics
// dashboard filter) that must not expose destructive tag-key management.
onDeleteKey?: (tagKey: TagKey) => void;
- // Restrict filtering to exact `group:value` terms only — no bare labels and
- // no group-any (`key:*`). Use on surfaces whose backend matches values
- // literally (the analytics summary endpoint), where those broader forms
- // would silently return unfiltered/empty data.
- exactValuesOnly?: boolean;
// (key, value) -> palette color; only exact group:value chips are colored.
// Omit on surfaces that don't load colors (chips stay neutral).
colors?: TagColorMap;
@@ -88,7 +83,6 @@ function TagFilterControl({
valueSuggestionsByKey,
triggerLabel = "Tags",
onDeleteKey,
- exactValuesOnly = false,
colors,
}: Props) {
const [open, setOpen] = React.useState(false);
@@ -143,12 +137,7 @@ function TagFilterControl({
const trimmedQuery = query.trim();
const normalizedQuery = trimmedQuery.toLowerCase();
const candidate = parseTagFilterTerm(query);
- // In exact mode only fully-specified group:value terms are addable; bare
- // labels and group-any (key:null) are rejected because the backend can't
- // honor them.
- const candidateAddable =
- candidate !== null &&
- (!exactValuesOnly || (candidate.key !== null && candidate.value !== null));
+ const candidateAddable = candidate !== null;
const candidateExists =
candidate !== null && value.some((term) => sameTerm(term, candidate));
const showAdd = candidateAddable && !candidateExists;
@@ -166,7 +155,7 @@ function TagFilterControl({
.slice(0, MAX_AUTOCOMPLETE_SUGGESTIONS)
: [];
const labelMatches =
- typedKey === null && !exactValuesOnly
+ typedKey === null
? labelSuggestions
.filter((label) => label.toLowerCase().includes(normalizedQuery))
.filter(
@@ -307,11 +296,7 @@ function TagFilterControl({
) : null}
<Command shouldFilter={false}>
<CommandInput
- placeholder={
- exactValuesOnly
- ? "Filter by group:value…"
- : "Filter by label or group:label…"
- }
+ placeholder="Filter by label, group:*, or group:label…"
value={query}
onValueChange={setQuery}
onKeyDown={(event) => {
@@ -322,11 +307,7 @@ function TagFilterControl({
}}
/>
<CommandList>
- <CommandEmpty>
- {exactValuesOnly
- ? "Type group:value to filter."
- : "Type a label, group:*, or group:label."}
- </CommandEmpty>
+ <CommandEmpty>Type a label, group:*, or group:label.</CommandEmpty>
{showAdd && candidate ? (
<CommandGroup>
<CommandItem
@@ -345,21 +326,13 @@ function TagFilterControl({
key={tagKey.key}
value={`__group__,${tagKey.key}`}
className="justify-between gap-2"
- // Default: filter by group (any value in it). In exact mode
- // group-any isn't supported, so prefill `key:` and make the
- // user pick a concrete value instead.
- onSelect={() =>
- exactValuesOnly
- ? setQuery(`${tagKey.key}:`)
- : addTerm({ key: tagKey.key, value: null })
- }
+ // Filter by group (any value in it).
+ onSelect={() => addTerm({ key: tagKey.key, value: null })}
>
<div className="flex min-w-0 flex-col">
<span className="truncate">
<span className="font-medium">{tagKey.key}</span>
- <span className="text-muted-foreground">
- {exactValuesOnly ? ": …" : ": any"}
- </span>
+ <span className="text-muted-foreground">: any</span>
</span>
{tagKey.description ? (
<span className="truncate text-xs text-muted-foreground">
diff --git a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.composerMode.test.tsx b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.composerMode.test.tsx
index b1622ed04..071f2aeb6 100644
--- a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.composerMode.test.tsx
+++ b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.composerMode.test.tsx
@@ -99,6 +99,7 @@ const saveData = {
webhookCallbackUrl: null,
persistBrowserSession: false,
browserProfileId: null,
+ browserProfileKey: null,
model: null,
maxScreenshotScrolls: null,
extraHttpHeaders: null,
diff --git a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.queue.test.tsx b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.queue.test.tsx
index 1db6db441..8f38e4dd2 100644
--- a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.queue.test.tsx
+++ b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.queue.test.tsx
@@ -112,6 +112,7 @@ const saveData = {
webhookCallbackUrl: null,
persistBrowserSession: false,
browserProfileId: null,
+ browserProfileKey: null,
model: null,
maxScreenshotScrolls: null,
extraHttpHeaders: null,
diff --git a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.tsx b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.tsx
index f6347340e..9f2563d18 100644
--- a/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.tsx
+++ b/skyvern-frontend/src/routes/workflows/copilot/WorkflowCopilotChat.tsx
@@ -1293,6 +1293,7 @@ export function WorkflowCopilotChat({
webhook_callback_url: saveData.settings.webhookCallbackUrl,
persist_browser_session: saveData.settings.persistBrowserSession,
browser_profile_id: saveData.settings.browserProfileId,
+ browser_profile_key: saveData.settings.browserProfileKey,
model: saveData.settings.model,
max_screenshot_scrolls: saveData.settings.maxScreenshotScrolls,
max_elapsed_time_minutes:
@@ -1326,6 +1327,12 @@ export function WorkflowCopilotChat({
pendingSubmitSnapshot.current = {
...saveData.workflow,
title: saveData.title,
+ proxy_location: saveData.settings.proxyLocation,
+ webhook_callback_url: saveData.settings.webhookCallbackUrl,
+ persist_browser_session: saveData.settings.persistBrowserSession,
+ browser_profile_id: saveData.settings.browserProfileId,
+ browser_profile_key: saveData.settings.browserProfileKey,
+ model: saveData.settings.model,
workflow_definition: {
...saveData.workflow.workflow_definition,
parameters: saveData.parameters,
diff --git a/skyvern-frontend/src/routes/workflows/debugger/Debugger.tsx b/skyvern-frontend/src/routes/workflows/debugger/Debugger.tsx
index 0ce890efe..e499f94a1 100644
--- a/skyvern-frontend/src/routes/workflows/debugger/Debugger.tsx
+++ b/skyvern-frontend/src/routes/workflows/debugger/Debugger.tsx
@@ -69,6 +69,7 @@ function Debugger() {
const settings: WorkflowSettings = {
persistBrowserSession: workflow.persist_browser_session,
browserProfileId: workflow.browser_profile_id ?? null,
+ browserProfileKey: workflow.browser_profile_key ?? null,
proxyLocation: workflow.proxy_location,
webhookCallbackUrl: workflow.webhook_callback_url,
model: workflow.model,
diff --git a/skyvern-frontend/src/routes/workflows/editor/WorkflowEditor.tsx b/skyvern-frontend/src/routes/workflows/editor/WorkflowEditor.tsx
index 1eeb6263c..8260dd4e2 100644
--- a/skyvern-frontend/src/routes/workflows/editor/WorkflowEditor.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/WorkflowEditor.tsx
@@ -78,6 +78,7 @@ function WorkflowEditor() {
const settings: WorkflowSettings = {
persistBrowserSession: workflow.persist_browser_session,
browserProfileId: workflow.browser_profile_id ?? null,
+ browserProfileKey: workflow.browser_profile_key ?? null,
proxyLocation: workflow.proxy_location,
webhookCallbackUrl: workflow.webhook_callback_url,
model: workflow.model,
diff --git a/skyvern-frontend/src/routes/workflows/editor/Workspace.tsx b/skyvern-frontend/src/routes/workflows/editor/Workspace.tsx
index edc4fc784..eea94486e 100644
--- a/skyvern-frontend/src/routes/workflows/editor/Workspace.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/Workspace.tsx
@@ -1344,6 +1344,7 @@ function Workspace({
webhookCallbackUrl: workflowData.webhook_callback_url || "",
persistBrowserSession: workflowData.persist_browser_session ?? false,
browserProfileId: workflowData.browser_profile_id ?? null,
+ browserProfileKey: workflowData.browser_profile_key ?? null,
model: workflowData.model ?? null,
maxScreenshotScrolls: workflowData.max_screenshot_scrolls || 3,
maxElapsedTimeMinutes: workflowData.max_elapsed_time_minutes ?? null,
@@ -1419,6 +1420,7 @@ function Workspace({
webhookCallbackUrl: selectedVersion.webhook_callback_url || "",
persistBrowserSession: selectedVersion.persist_browser_session,
browserProfileId: selectedVersion.browser_profile_id ?? null,
+ browserProfileKey: selectedVersion.browser_profile_key ?? null,
model: selectedVersion.model,
maxScreenshotScrolls: selectedVersion.max_screenshot_scrolls || 3,
maxElapsedTimeMinutes: selectedVersion.max_elapsed_time_minutes ?? null,
@@ -2365,6 +2367,8 @@ function Workspace({
extra_http_headers: extraHttpHeaders,
cdp_connect_headers: cdpConnectHeaders,
persist_browser_session: saveData.settings.persistBrowserSession,
+ browser_profile_id: saveData.settings.browserProfileId,
+ browser_profile_key: saveData.settings.browserProfileKey,
model: saveData.settings.model,
totp_verification_url: saveData.workflow.totp_verification_url,
totp_identifier: null,
diff --git a/skyvern-frontend/src/routes/workflows/editor/nestedConditionalSave.test.ts b/skyvern-frontend/src/routes/workflows/editor/nestedConditionalSave.test.ts
index 5a7b8bf35..18f153532 100644
--- a/skyvern-frontend/src/routes/workflows/editor/nestedConditionalSave.test.ts
+++ b/skyvern-frontend/src/routes/workflows/editor/nestedConditionalSave.test.ts
@@ -21,6 +21,7 @@ const DEFAULT_SETTINGS: WorkflowSettings = {
webhookCallbackUrl: null,
persistBrowserSession: false,
browserProfileId: null,
+ browserProfileKey: null,
model: null,
maxScreenshotScrolls: null,
maxElapsedTimeMinutes: null,
diff --git a/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/StartNode.tsx b/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/StartNode.tsx
index 8b7515bb0..2f7b21067 100644
--- a/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/StartNode.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/StartNode.tsx
@@ -31,6 +31,7 @@ interface StartSettings {
proxyLocation: ProxyLocation;
persistBrowserSession: boolean;
browserProfileId: string | null;
+ browserProfileKey: string | null;
model: WorkflowModel | null;
maxScreenshotScrollingTimes: number | null;
extraHttpHeaders: string | Record<string, unknown> | null;
@@ -67,6 +68,9 @@ function StartNode({ id, data, parentId }: NodeProps<StartNode>) {
browserProfileId: data.withWorkflowSettings
? data.browserProfileId
: null,
+ browserProfileKey: data.withWorkflowSettings
+ ? data.browserProfileKey
+ : null,
model: data.withWorkflowSettings ? data.model : null,
maxScreenshotScrollingTimes: data.withWorkflowSettings
? data.maxScreenshotScrolls
diff --git a/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/WorkflowSettingsEditor.test.tsx b/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/WorkflowSettingsEditor.test.tsx
new file mode 100644
index 000000000..5cb4c04c2
--- /dev/null
+++ b/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/WorkflowSettingsEditor.test.tsx
@@ -0,0 +1,223 @@
+// @vitest-environment jsdom
+
+import { cleanup, fireEvent, render, screen } from "@testing-library/react";
+import type { ReactNode } from "react";
+import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+
+import type { WorkflowStartNodeData } from "./types";
+
+const mockUpdateNodeData = vi.fn();
+const startNodeData: WorkflowStartNodeData = {
+ withWorkflowSettings: true,
+ webhookCallbackUrl: "",
+ proxyLocation: null,
+ persistBrowserSession: true,
+ browserProfileId: null,
+ browserProfileKey: null,
+ model: null,
+ maxScreenshotScrolls: null,
+ maxElapsedTimeMinutes: null,
+ extraHttpHeaders: null,
+ cdpConnectHeaders: null,
+ editable: true,
+ runWith: "agent",
+ codeVersion: null,
+ scriptCacheKey: null,
+ aiFallback: true,
+ runSequentially: false,
+ sequentialKey: null,
+ finallyBlockLabel: null,
+ workflowSystemPrompt: null,
+ label: "__start_block__",
+ showCode: false,
+};
+
+let nodeData = startNodeData;
+
+vi.mock("@xyflow/react", async () => {
+ const actual =
+ await vi.importActual<typeof import("@xyflow/react")>("@xyflow/react");
+ return {
+ ...actual,
+ useNodesData: (id: string) =>
+ id === "start"
+ ? {
+ id,
+ type: "start",
+ data: nodeData,
+ }
+ : null,
+ useNodes: () => [],
+ useEdges: () => [],
+ useReactFlow: () => ({
+ updateNodeData: mockUpdateNodeData,
+ }),
+ };
+});
+
+vi.mock("@/components/WorkflowBlockInputTextarea", () => ({
+ WorkflowBlockInputTextarea: ({
+ value,
+ onChange,
+ placeholder,
+ "data-testid": dataTestId,
+ }: {
+ value: string;
+ onChange: (value: string) => void;
+ placeholder?: string;
+ "data-testid"?: string;
+ }) => (
+ <textarea
+ data-testid={dataTestId}
+ placeholder={placeholder}
+ value={value}
+ onChange={(event) => onChange(event.target.value)}
+ />
+ ),
+}));
+
+vi.mock("@/components/ModelSelector", () => ({
+ ModelSelector: () => <div data-testid="model-selector" />,
+}));
+
+vi.mock("@/components/ProxySelector", () => ({
+ ProxySelector: () => <div data-testid="proxy-selector" />,
+}));
+
+vi.mock("@/routes/workflows/components/BrowserProfileSelector", () => ({
+ BrowserProfileSelector: () => <div data-testid="browser-profile-selector" />,
+}));
+
+vi.mock("@/components/KeyValueInput", () => ({
+ KeyValueInput: () => <div data-testid="key-value-input" />,
+}));
+
+vi.mock("@/components/TestWebhookDialog", () => ({
+ TestWebhookDialog: () => <div data-testid="test-webhook-dialog" />,
+}));
+
+vi.mock("@/routes/workflows/hooks/useResetProfileMutation", () => ({
+ useResetProfileMutation: () => ({
+ mutate: vi.fn(),
+ isPending: false,
+ }),
+}));
+
+vi.mock("@/components/ui/select", () => ({
+ Select: ({
+ children,
+ onValueChange,
+ value,
+ }: {
+ children: ReactNode;
+ onValueChange: (value: string) => void;
+ value: string;
+ }) => (
+ <div data-select-value={value}>
+ {children}
+ <button
+ type="button"
+ data-testid="select-credential_id"
+ onClick={() => onValueChange("credential_id")}
+ >
+ credential_id
+ </button>
+ </div>
+ ),
+ SelectContent: ({ children }: { children: ReactNode }) => (
+ <div>{children}</div>
+ ),
+ SelectItem: ({ children, value }: { children: ReactNode; value: string }) => (
+ <div data-value={value}>{children}</div>
+ ),
+ SelectTrigger: ({
+ children,
+ "data-testid": dataTestId,
+ }: {
+ children: ReactNode;
+ "data-testid"?: string;
+ }) => <button data-testid={dataTestId}>{children}</button>,
+ SelectValue: ({ placeholder }: { placeholder: string }) => (
+ <span>{placeholder}</span>
+ ),
+}));
+
+import { WorkflowSettingsEditor } from "./WorkflowSettingsEditor";
+
+function renderSettings(overrides: Partial<WorkflowStartNodeData> = {}) {
+ nodeData = {
+ ...startNodeData,
+ ...overrides,
+ };
+ return render(<WorkflowSettingsEditor blockId="start" />);
+}
+
+beforeEach(() => {
+ nodeData = startNodeData;
+ mockUpdateNodeData.mockClear();
+});
+
+afterEach(() => {
+ cleanup();
+});
+
+describe("WorkflowSettingsEditor browser profile key field", () => {
+ test("uses a templated key textarea without a dropdown or code toggle", () => {
+ renderSettings();
+
+ expect(screen.getByTestId("browser-profile-key-template")).toBeDefined();
+ expect(screen.queryByTestId("browser-profile-key-input-select")).toBeNull();
+ expect(
+ screen.queryByRole("button", { name: "Enter a custom value" }),
+ ).toBeNull();
+ expect(screen.getByText(/Use \+ to insert an input/)).toBeDefined();
+ });
+
+ test("updates browserProfileKey from the textarea", () => {
+ renderSettings();
+
+ fireEvent.change(screen.getByTestId("browser-profile-key-template"), {
+ target: { value: "{{ credential_id }}" },
+ });
+
+ expect(mockUpdateNodeData).toHaveBeenCalledWith("start", {
+ browserProfileKey: "{{ credential_id }}",
+ });
+ });
+
+ test("clears browserProfileKey when the textarea is emptied", () => {
+ renderSettings({ browserProfileKey: "{{ credential_id }}" });
+
+ fireEvent.change(screen.getByTestId("browser-profile-key-template"), {
+ target: { value: "" },
+ });
+
+ expect(mockUpdateNodeData).toHaveBeenCalledWith("start", {
+ browserProfileKey: null,
+ });
+ });
+
+ test("shows stored raw keys in the textarea", () => {
+ renderSettings({ browserProfileKey: "tenant-a" });
+
+ expect(
+ (
+ screen.getByTestId(
+ "browser-profile-key-template",
+ ) as HTMLTextAreaElement
+ ).value,
+ ).toBe("tenant-a");
+ });
+
+ test("shows stored templated keys in the textarea", () => {
+ renderSettings({ browserProfileKey: "{{ credential_id }}" });
+
+ expect(
+ (
+ screen.getByTestId(
+ "browser-profile-key-template",
+ ) as HTMLTextAreaElement
+ ).value,
+ ).toBe("{{ credential_id }}");
+ });
+});
diff --git a/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/WorkflowSettingsEditor.tsx b/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/WorkflowSettingsEditor.tsx
index d9afd366c..80787eca0 100644
--- a/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/WorkflowSettingsEditor.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/WorkflowSettingsEditor.tsx
@@ -51,6 +51,9 @@ const PREVENT_OVERLAPPING_RUNS_TOOLTIP =
const SEQUENTIAL_KEY_TOOLTIP =
"Scope the run queue. Runs with the same key are queued together; runs with different keys can still execute in parallel. Templated against agent inputs, for example {{ account_id }} to serialize per account.";
+const BROWSER_PROFILE_KEY_TOOLTIP =
+ "Template for separating saved browser profiles. Use + to insert an agent input, or type a static key. Runs with the same rendered value reuse the same saved profile.";
+
const WORKFLOW_RUN_DEFAULT_MAX_ELAPSED_TIME_MINUTES = 4 * 60;
const WORKFLOW_RUN_MAX_ELAPSED_TIME_MINUTES = 8 * 60;
@@ -114,7 +117,6 @@ function WorkflowSettingsEditorBody({
() => new Set(terminalBlockLabels),
[terminalBlockLabels],
);
-
useEffect(() => {
if (
data.finallyBlockLabel &&
@@ -292,10 +294,53 @@ function WorkflowSettingsEditorBody({
className="ml-auto"
checked={data.persistBrowserSession}
onCheckedChange={(value) =>
- update({ persistBrowserSession: value })
+ update({
+ persistBrowserSession: value,
+ browserProfileKey: value ? data.browserProfileKey : null,
+ })
}
/>
</div>
+ {data.persistBrowserSession && (
+ <div className="flex flex-col gap-3 rounded-md bg-slate-elevation4 p-4 pl-4">
+ <div className="space-y-2">
+ <div className="flex items-center gap-2">
+ <Label>Browser Profile Key (optional)</Label>
+ <HelpTooltip content={BROWSER_PROFILE_KEY_TOOLTIP} />
+ </div>
+ <div className="flex flex-col gap-2">
+ <WorkflowBlockInputTextarea
+ nodeId={blockId}
+ onChange={(value) => {
+ update({
+ browserProfileKey: value.length ? value : null,
+ });
+ }}
+ value={data.browserProfileKey ?? ""}
+ placeholder="{{ credential_id }}"
+ className="nopan text-xs"
+ data-testid="browser-profile-key-template"
+ />
+ <p className="text-xs text-slate-400">
+ Use + to insert an input like {"{{ credential_id }}"}. Leave
+ empty to use one saved profile for this agent.
+ </p>
+ {!data.runSequentially && data.browserProfileKey && (
+ <p className="text-xs text-amber-300">
+ Overlapping runs with the same rendered key can overwrite
+ the same saved profile.
+ </p>
+ )}
+ {data.browserProfileId && (
+ <p className="text-xs text-amber-300">
+ Starting Browser Profile bypasses saved-session loading and
+ write-back. Leave it empty when separating saved profiles.
+ </p>
+ )}
+ </div>
+ </div>
+ </div>
+ )}
{data.persistBrowserSession && workflowPermanentId && (
<Dialog
open={isResetProfileDialogOpen}
@@ -309,16 +354,16 @@ function WorkflowSettingsEditorBody({
className="nopan"
>
<ReloadIcon className="mr-2 h-3 w-3" />
- Reset Profile
+ Reset Saved Profile
</Button>
</DialogTrigger>
<DialogContent>
<DialogHeader>
<DialogTitle>Reset saved profile?</DialogTitle>
<DialogDescription>
- Clears the saved browser profile for this agent. The next run
- will start from a fresh browser state. Use this if the saved
- profile is stuck or producing errors.
+ Clears the default saved browser profile for this agent. The
+ next unsegmented run starts from a fresh browser state.
+ Segmented saved profiles are kept.
</DialogDescription>
</DialogHeader>
<DialogFooter>
@@ -333,7 +378,7 @@ function WorkflowSettingsEditorBody({
{resetProfileMutation.isPending && (
<ReloadIcon className="mr-2 h-4 w-4 animate-spin" />
)}
- Reset Profile
+ Reset Saved Profile
</Button>
</DialogFooter>
</DialogContent>
@@ -342,8 +387,8 @@ function WorkflowSettingsEditorBody({
</div>
<div className="space-y-2">
<div className="flex items-center gap-2">
- <Label>Default Browser Profile</Label>
- <HelpTooltip content="The default browser profile used when running this agent. Can be overridden per run." />
+ <Label>Starting Browser Profile</Label>
+ <HelpTooltip content="Optional browser profile to load at run start. Leave this empty when you want saved-session persistence to decide the browser state." />
</div>
<BrowserProfileSelector
value={data.browserProfileId}
diff --git a/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/types.ts b/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/types.ts
index 742e2e799..4bd769a35 100644
--- a/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/types.ts
+++ b/skyvern-frontend/src/routes/workflows/editor/nodes/StartNode/types.ts
@@ -9,6 +9,7 @@ export type WorkflowStartNodeData = {
proxyLocation: ProxyLocation;
persistBrowserSession: boolean;
browserProfileId: string | null;
+ browserProfileKey: string | null;
model: WorkflowModel | null;
maxScreenshotScrolls: number | null;
maxElapsedTimeMinutes: number | null;
diff --git a/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowComparisonPanel.tsx b/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowComparisonPanel.tsx
index 6ab566a14..f6199d3ca 100644
--- a/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowComparisonPanel.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowComparisonPanel.tsx
@@ -140,6 +140,7 @@ function getWorkflowElements(version: WorkflowVersion) {
webhookCallbackUrl: version.webhook_callback_url || "",
persistBrowserSession: version.persist_browser_session,
browserProfileId: version.browser_profile_id ?? null,
+ browserProfileKey: version.browser_profile_key ?? null,
model: version.model,
maxScreenshotScrolls: version.max_screenshot_scrolls || 3,
maxElapsedTimeMinutes: version.max_elapsed_time_minutes ?? null,
diff --git a/skyvern-frontend/src/routes/workflows/editor/sortable/perf.test.ts b/skyvern-frontend/src/routes/workflows/editor/sortable/perf.test.ts
index eea5cbe66..246e3fa89 100644
--- a/skyvern-frontend/src/routes/workflows/editor/sortable/perf.test.ts
+++ b/skyvern-frontend/src/routes/workflows/editor/sortable/perf.test.ts
@@ -50,6 +50,7 @@ const DEFAULT_SETTINGS: WorkflowSettings = {
webhookCallbackUrl: null,
persistBrowserSession: false,
browserProfileId: null,
+ browserProfileKey: null,
model: null,
maxScreenshotScrolls: null,
maxElapsedTimeMinutes: null,
diff --git a/skyvern-frontend/src/routes/workflows/editor/sortable/roundTrip.test.ts b/skyvern-frontend/src/routes/workflows/editor/sortable/roundTrip.test.ts
index cb8e028ce..138619013 100644
--- a/skyvern-frontend/src/routes/workflows/editor/sortable/roundTrip.test.ts
+++ b/skyvern-frontend/src/routes/workflows/editor/sortable/roundTrip.test.ts
@@ -40,6 +40,7 @@ const DEFAULT_SETTINGS: WorkflowSettings = {
webhookCallbackUrl: null,
persistBrowserSession: false,
browserProfileId: null,
+ browserProfileKey: null,
model: null,
maxScreenshotScrolls: null,
maxElapsedTimeMinutes: null,
diff --git a/skyvern-frontend/src/routes/workflows/editor/types.ts b/skyvern-frontend/src/routes/workflows/editor/types.ts
index 018fe2b8e..bfef05db5 100644
--- a/skyvern-frontend/src/routes/workflows/editor/types.ts
+++ b/skyvern-frontend/src/routes/workflows/editor/types.ts
@@ -20,6 +20,7 @@ export type SkyvernCredential = {
description?: string | null;
parameterType: "credential";
credentialId: string;
+ dataType?: typeof WorkflowParameterValueType.CredentialId;
};
export type OnePasswordCredential = {
diff --git a/skyvern-frontend/src/routes/workflows/editor/utils.test.ts b/skyvern-frontend/src/routes/workflows/editor/utils.test.ts
new file mode 100644
index 000000000..6a6f4f8a7
--- /dev/null
+++ b/skyvern-frontend/src/routes/workflows/editor/utils.test.ts
@@ -0,0 +1,98 @@
+import { describe, expect, test } from "vitest";
+
+import {
+ type WorkflowApiResponse,
+ WorkflowParameterValueType,
+} from "../types/workflowTypes";
+import { getInitialParameters } from "./utils";
+
+const baseWorkflow = {
+ workflow_id: "w_test",
+ organization_id: "o_test",
+ is_saved_task: false,
+ is_template: false,
+ title: "Test workflow",
+ workflow_permanent_id: "wpid_test",
+ version: 1,
+ description: "Test workflow",
+ workflow_definition: {
+ version: 2,
+ blocks: [],
+ parameters: [],
+ finally_block_label: null,
+ workflow_system_prompt: null,
+ },
+ proxy_location: null,
+ webhook_callback_url: null,
+ extra_http_headers: null,
+ cdp_connect_headers: null,
+ persist_browser_session: false,
+ browser_profile_id: null,
+ browser_profile_key: null,
+ model: null,
+ totp_verification_url: null,
+ totp_identifier: null,
+ max_screenshot_scrolls: null,
+ max_elapsed_time_minutes: null,
+ status: null,
+ created_at: "2026-06-23T00:00:00Z",
+ modified_at: "2026-06-23T00:00:00Z",
+ deleted_at: null,
+ run_with: "agent",
+ cache_key: null,
+ ai_fallback: true,
+ adaptive_caching: null,
+ code_version: null,
+ run_sequentially: false,
+ sequential_key: null,
+ folder_id: null,
+ import_error: null,
+} satisfies WorkflowApiResponse;
+
+describe("getInitialParameters", () => {
+ test("marks workflow credential_id parameters without marking static credential parameters", () => {
+ const workflow: WorkflowApiResponse = {
+ ...baseWorkflow,
+ workflow_definition: {
+ ...baseWorkflow.workflow_definition,
+ parameters: [
+ {
+ parameter_type: "workflow",
+ workflow_id: "w_test",
+ workflow_parameter_id: "wp_credential_input",
+ key: "credential_id",
+ description: null,
+ workflow_parameter_type: WorkflowParameterValueType.CredentialId,
+ default_value: "cred_default",
+ created_at: "2026-06-23T00:00:00Z",
+ modified_at: "2026-06-23T00:00:00Z",
+ deleted_at: null,
+ },
+ {
+ parameter_type: "credential",
+ workflow_id: "w_test",
+ credential_parameter_id: "cp_static",
+ key: "static_credential",
+ description: null,
+ credential_id: "cred_static",
+ created_at: "2026-06-23T00:00:00Z",
+ modified_at: "2026-06-23T00:00:00Z",
+ deleted_at: null,
+ },
+ ],
+ },
+ };
+
+ expect(getInitialParameters(workflow)).toEqual([
+ expect.objectContaining({
+ key: "credential_id",
+ parameterType: "credential",
+ dataType: WorkflowParameterValueType.CredentialId,
+ }),
+ expect.not.objectContaining({
+ key: "static_credential",
+ dataType: WorkflowParameterValueType.CredentialId,
+ }),
+ ]);
+ });
+});
diff --git a/skyvern-frontend/src/routes/workflows/editor/utils.ts b/skyvern-frontend/src/routes/workflows/editor/utils.ts
index 1ff34d180..a85a9b3a5 100644
--- a/skyvern-frontend/src/routes/workflows/editor/utils.ts
+++ b/skyvern-frontend/src/routes/workflows/editor/utils.ts
@@ -21,6 +21,7 @@ const getInitialParameters = (workflow: WorkflowApiResponse) => {
key: parameter.key,
parameterType: WorkflowEditorParameterTypes.Credential,
credentialId: parameter.default_value as string,
+ dataType: WorkflowParameterValueType.CredentialId,
description: parameter.description,
};
}
diff --git a/skyvern-frontend/src/routes/workflows/editor/workflowEditorUtils.ts b/skyvern-frontend/src/routes/workflows/editor/workflowEditorUtils.ts
index 684cb68ec..b43db86ab 100644
--- a/skyvern-frontend/src/routes/workflows/editor/workflowEditorUtils.ts
+++ b/skyvern-frontend/src/routes/workflows/editor/workflowEditorUtils.ts
@@ -1982,6 +1982,7 @@ function getElements(
withWorkflowSettings: true,
persistBrowserSession: settings.persistBrowserSession,
browserProfileId: settings.browserProfileId,
+ browserProfileKey: settings.browserProfileKey,
proxyLocation: settings.proxyLocation ?? ProxyLocation.Residential,
webhookCallbackUrl: settings.webhookCallbackUrl ?? "",
model: settings.model,
@@ -3396,6 +3397,7 @@ function getWorkflowSettings(nodes: Array<AppNode>): WorkflowSettings {
const defaultSettings = {
persistBrowserSession: false,
browserProfileId: null,
+ browserProfileKey: null,
proxyLocation: ProxyLocation.Residential,
webhookCallbackUrl: null,
model: null,
@@ -3424,6 +3426,7 @@ function getWorkflowSettings(nodes: Array<AppNode>): WorkflowSettings {
return {
persistBrowserSession: data.persistBrowserSession,
browserProfileId: data.browserProfileId,
+ browserProfileKey: data.browserProfileKey,
proxyLocation: data.proxyLocation,
webhookCallbackUrl: data.webhookCallbackUrl,
model: data.model,
@@ -4509,6 +4512,7 @@ function convert(workflow: WorkflowApiResponse): WorkflowCreateYAMLRequest {
webhook_callback_url: workflow.webhook_callback_url,
persist_browser_session: workflow.persist_browser_session,
browser_profile_id: workflow.browser_profile_id ?? null,
+ browser_profile_key: workflow.browser_profile_key ?? null,
model: workflow.model,
totp_verification_url: workflow.totp_verification_url,
max_screenshot_scrolls: workflow.max_screenshot_scrolls,
diff --git a/skyvern-frontend/src/routes/workflows/types/workflowTypes.ts b/skyvern-frontend/src/routes/workflows/types/workflowTypes.ts
index 505f89c1b..822f02ed5 100644
--- a/skyvern-frontend/src/routes/workflows/types/workflowTypes.ts
+++ b/skyvern-frontend/src/routes/workflows/types/workflowTypes.ts
@@ -659,6 +659,7 @@ export type WorkflowApiResponse = {
cdp_connect_headers: Record<string, string> | null;
persist_browser_session: boolean;
browser_profile_id?: string | null;
+ browser_profile_key?: string | null;
model: WorkflowModel | null;
totp_verification_url: string | null;
totp_identifier: string | null;
@@ -684,6 +685,7 @@ export type WorkflowSettings = {
webhookCallbackUrl: string | null;
persistBrowserSession: boolean;
browserProfileId: string | null;
+ browserProfileKey: string | null;
model: WorkflowModel | null;
maxScreenshotScrolls: number | null;
maxElapsedTimeMinutes: number | null;
diff --git a/skyvern-frontend/src/routes/workflows/types/workflowYamlTypes.ts b/skyvern-frontend/src/routes/workflows/types/workflowYamlTypes.ts
index c50c4be00..18abe9160 100644
--- a/skyvern-frontend/src/routes/workflows/types/workflowYamlTypes.ts
+++ b/skyvern-frontend/src/routes/workflows/types/workflowYamlTypes.ts
@@ -12,6 +12,7 @@ export type WorkflowCreateYAMLRequest = {
webhook_callback_url?: string | null;
persist_browser_session?: boolean;
browser_profile_id?: string | null;
+ browser_profile_key?: string | null;
model?: WorkflowModel | null;
totp_verification_url?: string | null;
workflow_definition: WorkflowDefinitionYAML;
diff --git a/skyvern-frontend/src/store/WorkflowHasChangesStore.ts b/skyvern-frontend/src/store/WorkflowHasChangesStore.ts
index 5890504e2..bdcef7a87 100644
--- a/skyvern-frontend/src/store/WorkflowHasChangesStore.ts
+++ b/skyvern-frontend/src/store/WorkflowHasChangesStore.ts
@@ -181,6 +181,7 @@ const useWorkflowSave = (opts?: WorkflowSaveOpts) => {
webhook_callback_url: saveData.settings.webhookCallbackUrl,
persist_browser_session: saveData.settings.persistBrowserSession,
browser_profile_id: saveData.settings.browserProfileId,
+ browser_profile_key: saveData.settings.browserProfileKey,
model: saveData.settings.model,
max_screenshot_scrolls: saveData.settings.maxScreenshotScrolls,
max_elapsed_time_minutes:
diff --git a/skyvern-frontend/src/store/WorkflowSettingsStore.ts b/skyvern-frontend/src/store/WorkflowSettingsStore.ts
index 6fe443b07..45fe44cd9 100644
--- a/skyvern-frontend/src/store/WorkflowSettingsStore.ts
+++ b/skyvern-frontend/src/store/WorkflowSettingsStore.ts
@@ -9,6 +9,7 @@ export interface WorkflowSettingsState {
webhookCallbackUrl: string;
proxyLocation: ProxyLocation;
persistBrowserSession: boolean;
+ browserProfileKey: string | null;
model: WorkflowModel | null;
maxScreenshotScrollingTimes: number | null;
extraHttpHeaders: string | Record<string, unknown> | null;
@@ -31,6 +32,7 @@ const defaultState: Omit<
webhookCallbackUrl: "",
proxyLocation: ProxyLocation.Residential,
persistBrowserSession: false,
+ browserProfileKey: null,
model: null,
maxScreenshotScrollingTimes: null,
extraHttpHeaders: null,
diff --git a/skyvern-frontend/src/store/onboarding/OnboardingProvider.test.tsx b/skyvern-frontend/src/store/onboarding/OnboardingProvider.test.tsx
index cfb6fcfea..79acb664a 100644
--- a/skyvern-frontend/src/store/onboarding/OnboardingProvider.test.tsx
+++ b/skyvern-frontend/src/store/onboarding/OnboardingProvider.test.tsx
@@ -36,25 +36,30 @@ vi.mock("@/util/onboarding/OnboardingTelemetry", () => ({
}));
import { OnboardingProvider } from "./OnboardingProvider";
-import type { OnboardingStateResponse } from "./types";
+import type { OnboardingState, OnboardingStateResponse } from "./types";
import { useOnboardingState } from "./useOnboardingState";
+import { OnboardingTelemetry } from "@/util/onboarding/OnboardingTelemetry";
const DISMISSED_AT = "2026-01-01T00:00:00.000Z";
+function freshOnboardingState(): OnboardingState {
+ return {
+ tour_completed_at: null,
+ modal_dismissed_at: null,
+ first_save_at: null,
+ first_run_at: null,
+ ab_variant: null,
+ user_intent: null,
+ seen_canvas: null,
+ seen_node_adder: null,
+ seen_sidebar: null,
+ seen_save_run: null,
+ };
+}
+
function freshResponse(): OnboardingStateResponse {
return {
- onboarding_state: {
- tour_completed_at: null,
- modal_dismissed_at: null,
- first_save_at: null,
- first_run_at: null,
- ab_variant: null,
- user_intent: null,
- seen_canvas: null,
- seen_node_adder: null,
- seen_sidebar: null,
- seen_save_run: null,
- },
+ onboarding_state: freshOnboardingState(),
launch_date_at_signup: "2025-01-01T00:00:00Z",
};
}
@@ -120,7 +125,7 @@ describe("OnboardingProvider write resilience", () => {
const dismissedResponse: OnboardingStateResponse = {
...freshResponse(),
onboarding_state: {
- ...freshResponse().onboarding_state,
+ ...freshOnboardingState(),
modal_dismissed_at: DISMISSED_AT,
},
};
@@ -142,3 +147,25 @@ describe("OnboardingProvider write resilience", () => {
expect(screen.getByTestId("dismissed").textContent).toBe(DISMISSED_AT);
});
});
+
+describe("OnboardingProvider missing onboarding_state", () => {
+ it("renders without throwing when the response omits onboarding_state", async () => {
+ // A signed-out / transitional /users/me/onboarding body can lack
+ // onboarding_state; the provider must not dereference it (SKY-11430).
+ // The key is absent (not explicitly undefined) to mirror the real JSON.
+ const responseWithoutState: OnboardingStateResponse = {
+ launch_date_at_signup: null,
+ };
+ mockGet.mockResolvedValue({ data: responseWithoutState });
+
+ renderProvider();
+
+ await waitFor(() => expect(mockGet).toHaveBeenCalledTimes(1));
+ // state resolves to null, so the consumer reads an undefined field rather
+ // than crashing on a missing onboarding_state.
+ await waitFor(() =>
+ expect(screen.getByTestId("dismissed").textContent).toBe("undefined"),
+ );
+ expect(OnboardingTelemetry.registerVariant).not.toHaveBeenCalled();
+ });
+});
diff --git a/skyvern-frontend/src/store/onboarding/OnboardingProvider.tsx b/skyvern-frontend/src/store/onboarding/OnboardingProvider.tsx
index 69fb16cd6..395cb5e51 100644
--- a/skyvern-frontend/src/store/onboarding/OnboardingProvider.tsx
+++ b/skyvern-frontend/src/store/onboarding/OnboardingProvider.tsx
@@ -49,7 +49,7 @@ function OnboardingProvider({ children }: Readonly<Props>) {
await queryClient.cancelQueries({ queryKey: QUERY_KEY });
const previous =
queryClient.getQueryData<OnboardingStateResponse>(QUERY_KEY);
- if (previous) {
+ if (previous?.onboarding_state) {
queryClient.setQueryData<OnboardingStateResponse>(QUERY_KEY, {
...previous,
onboarding_state: { ...previous.onboarding_state, ...patch },
@@ -70,7 +70,7 @@ function OnboardingProvider({ children }: Readonly<Props>) {
data?.launch_date_at_signup != null &&
new Date(data.launch_date_at_signup) >= new Date(PRODUCT_LAUNCH_DATE);
- const abVariant = data?.onboarding_state.ab_variant ?? null;
+ const abVariant = data?.onboarding_state?.ab_variant ?? null;
useEffect(() => {
if (abVariant) {
diff --git a/skyvern-frontend/src/store/onboarding/types.ts b/skyvern-frontend/src/store/onboarding/types.ts
index 11912d185..67798c1f9 100644
--- a/skyvern-frontend/src/store/onboarding/types.ts
+++ b/skyvern-frontend/src/store/onboarding/types.ts
@@ -15,7 +15,7 @@ export type OnboardingState = {
};
export type OnboardingStateResponse = {
- onboarding_state: OnboardingState;
+ onboarding_state?: OnboardingState;
launch_date_at_signup: string | null;
};
diff --git a/skyvern/client/types/workflow.py b/skyvern/client/types/workflow.py
index 99bec408d..648c0059d 100644
--- a/skyvern/client/types/workflow.py
+++ b/skyvern/client/types/workflow.py
@@ -28,6 +28,7 @@ class Workflow(UniversalBaseModel):
totp_identifier: typing.Optional[str] = None
persist_browser_session: typing.Optional[bool] = None
browser_profile_id: typing.Optional[str] = None
+ browser_profile_key: typing.Optional[str] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
status: typing.Optional[WorkflowStatus] = None
max_screenshot_scrolls: typing.Optional[int] = None
diff --git a/skyvern/client/types/workflow_create_yaml_request.py b/skyvern/client/types/workflow_create_yaml_request.py
index d97f912a1..dd266183e 100644
--- a/skyvern/client/types/workflow_create_yaml_request.py
+++ b/skyvern/client/types/workflow_create_yaml_request.py
@@ -20,6 +20,7 @@ class WorkflowCreateYamlRequest(UniversalBaseModel):
totp_identifier: typing.Optional[str] = None
persist_browser_session: typing.Optional[bool] = None
browser_profile_id: typing.Optional[str] = None
+ browser_profile_key: typing.Optional[str] = None
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
workflow_definition: WorkflowDefinitionYaml
is_saved_task: typing.Optional[bool] = None
diff --git a/skyvern/forge/sdk/copilot/tools/frontier.py b/skyvern/forge/sdk/copilot/tools/frontier.py
index d4a5d4057..1f0433d48 100644
--- a/skyvern/forge/sdk/copilot/tools/frontier.py
+++ b/skyvern/forge/sdk/copilot/tools/frontier.py
@@ -616,6 +616,7 @@ _CANONICAL_WORKFLOW_SETTING_FIELDS: tuple[str, ...] = (
"totp_identifier",
"persist_browser_session",
"browser_profile_id",
+ "browser_profile_key",
"model",
"max_screenshot_scrolls",
"extra_http_headers",
diff --git a/skyvern/forge/sdk/copilot/tools/workflow_update.py b/skyvern/forge/sdk/copilot/tools/workflow_update.py
index 8c2e62778..cb451d015 100644
--- a/skyvern/forge/sdk/copilot/tools/workflow_update.py
+++ b/skyvern/forge/sdk/copilot/tools/workflow_update.py
@@ -3771,6 +3771,7 @@ async def _update_workflow(
totp_identifier=workflow.totp_identifier,
persist_browser_session=workflow.persist_browser_session,
browser_profile_id=workflow.browser_profile_id,
+ browser_profile_key=workflow.browser_profile_key,
model=workflow.model,
max_screenshot_scrolling_times=workflow.max_screenshot_scrolls,
extra_http_headers=workflow.extra_http_headers,
diff --git a/skyvern/forge/sdk/db/models.py b/skyvern/forge/sdk/db/models.py
index 447beb47f..cce3db4ef 100644
--- a/skyvern/forge/sdk/db/models.py
+++ b/skyvern/forge/sdk/db/models.py
@@ -514,6 +514,7 @@ class WorkflowModel(SoftDeleteMixin, Base):
totp_identifier = Column(String)
persist_browser_session = Column(Boolean, default=False, nullable=False)
browser_profile_id = Column(String, nullable=True)
+ browser_profile_key = Column(String, nullable=True)
model = Column(JSON, nullable=True)
status = Column(String, nullable=False, default="published")
generate_script = Column(Boolean, default=False, nullable=False)
diff --git a/skyvern/forge/sdk/db/repositories/workflows.py b/skyvern/forge/sdk/db/repositories/workflows.py
index e061290ca..da6447422 100644
--- a/skyvern/forge/sdk/db/repositories/workflows.py
+++ b/skyvern/forge/sdk/db/repositories/workflows.py
@@ -103,6 +103,7 @@ class WorkflowsRepository(BaseRepository):
totp_identifier: str | None = None,
persist_browser_session: bool = False,
browser_profile_id: str | None = None,
+ browser_profile_key: str | None = None,
model: dict[str, Any] | None = None,
workflow_permanent_id: str | None = None,
version: int | None = None,
@@ -136,6 +137,7 @@ class WorkflowsRepository(BaseRepository):
cdp_connect_headers=cdp_connect_headers,
persist_browser_session=persist_browser_session,
browser_profile_id=browser_profile_id,
+ browser_profile_key=browser_profile_key,
model=model,
is_saved_task=is_saved_task,
status=status,
@@ -653,6 +655,7 @@ class WorkflowsRepository(BaseRepository):
totp_identifier: str | None | object = _UNSET,
persist_browser_session: bool | None = None,
browser_profile_id: str | None | object = _UNSET,
+ browser_profile_key: str | None | object = _UNSET,
model: dict[str, Any] | None | object = _UNSET,
max_screenshot_scrolling_times: int | None | object = _UNSET,
max_elapsed_time_minutes: int | None | object = _UNSET,
@@ -702,6 +705,8 @@ class WorkflowsRepository(BaseRepository):
workflow.persist_browser_session = persist_browser_session
if browser_profile_id is not _UNSET:
workflow.browser_profile_id = cast(str | None, browser_profile_id)
+ if browser_profile_key is not _UNSET:
+ workflow.browser_profile_key = cast(str | None, browser_profile_key)
if model is not _UNSET:
workflow.model = model
if max_screenshot_scrolling_times is not _UNSET:
@@ -963,6 +968,7 @@ class WorkflowsRepository(BaseRepository):
totp_identifier: str | None | object = _UNSET,
persist_browser_session: bool | None = None,
browser_profile_id: str | None | object = _UNSET,
+ browser_profile_key: str | None | object = _UNSET,
model: dict[str, Any] | None | object = _UNSET,
max_screenshot_scrolling_times: int | None | object = _UNSET,
max_elapsed_time_minutes: int | None | object = _UNSET,
@@ -1048,6 +1054,8 @@ class WorkflowsRepository(BaseRepository):
workflow.persist_browser_session = persist_browser_session
if browser_profile_id is not _UNSET:
workflow.browser_profile_id = cast(str | None, browser_profile_id)
+ if browser_profile_key is not _UNSET:
+ workflow.browser_profile_key = cast(str | None, browser_profile_key)
if model is not _UNSET:
workflow.model = model
if max_screenshot_scrolling_times is not _UNSET:
diff --git a/skyvern/forge/sdk/db/utils.py b/skyvern/forge/sdk/db/utils.py
index bdb4262ba..254156985 100644
--- a/skyvern/forge/sdk/db/utils.py
+++ b/skyvern/forge/sdk/db/utils.py
@@ -555,6 +555,7 @@ def convert_to_workflow(
totp_identifier=workflow_model.totp_identifier,
persist_browser_session=workflow_model.persist_browser_session,
browser_profile_id=workflow_model.browser_profile_id,
+ browser_profile_key=workflow_model.browser_profile_key,
model=workflow_model.model,
proxy_location=deserialize_proxy_location(workflow_model.proxy_location),
max_screenshot_scrolls=workflow_model.max_screenshot_scrolling_times,
diff --git a/skyvern/forge/sdk/routes/browser_profiles.py b/skyvern/forge/sdk/routes/browser_profiles.py
index 34928ed14..6c06cda79 100644
--- a/skyvern/forge/sdk/routes/browser_profiles.py
+++ b/skyvern/forge/sdk/routes/browser_profiles.py
@@ -572,11 +572,15 @@ async def _create_profile_from_workflow_run(
# Poll for a short grace period so that immediate profile-creation requests
# succeed without forcing clients to implement retry loops.
poll_attempts = 30 # ~30 s max wait
+ browser_session_storage_key = await app.WORKFLOW_SERVICE.get_workflow_browser_session_storage_key(
+ workflow=workflow,
+ workflow_run=workflow_run,
+ )
session_dir: str | None = None
for attempt in range(poll_attempts):
session_dir = await app.STORAGE.retrieve_browser_session(
organization_id=organization_id,
- workflow_permanent_id=workflow.workflow_permanent_id,
+ workflow_permanent_id=browser_session_storage_key,
)
if session_dir:
break # session found
diff --git a/skyvern/forge/sdk/routes/credentials.py b/skyvern/forge/sdk/routes/credentials.py
index 8e43b7813..32f8d0cd5 100644
--- a/skyvern/forge/sdk/routes/credentials.py
+++ b/skyvern/forge/sdk/routes/credentials.py
@@ -1349,12 +1349,28 @@ async def _create_browser_profile_after_workflow(
# Session persistence lags the run reaching completed (see clean_up_workflow),
# so retrieval retries on a budget sized to that lag.
+ workflow = await app.DATABASE.workflows.get_workflow(
+ workflow_id=workflow_id,
+ organization_id=organization_id,
+ )
+ if not workflow:
+ LOG.warning(
+ "Workflow not found during browser profile creation",
+ credential_id=credential_id,
+ workflow_id=workflow_id,
+ workflow_permanent_id=workflow_permanent_id,
+ )
+ return
+ browser_session_storage_key = await app.WORKFLOW_SERVICE.get_workflow_browser_session_storage_key(
+ workflow=workflow,
+ workflow_run=workflow_run,
+ )
session_dir = None
max_retries = _SESSION_PERSIST_MAX_RETRIES
for attempt in range(max_retries):
session_dir = await app.STORAGE.retrieve_browser_session(
organization_id=organization_id,
- workflow_permanent_id=workflow_permanent_id,
+ workflow_permanent_id=browser_session_storage_key,
)
if session_dir:
break
diff --git a/skyvern/forge/sdk/routes/workflow_copilot.py b/skyvern/forge/sdk/routes/workflow_copilot.py
index 3755fa805..03fcea93f 100644
--- a/skyvern/forge/sdk/routes/workflow_copilot.py
+++ b/skyvern/forge/sdk/routes/workflow_copilot.py
@@ -923,6 +923,7 @@ async def _commit_staged_workflow(
totp_identifier=staged_workflow.totp_identifier,
persist_browser_session=staged_workflow.persist_browser_session,
browser_profile_id=staged_workflow.browser_profile_id,
+ browser_profile_key=staged_workflow.browser_profile_key,
model=staged_workflow.model,
max_screenshot_scrolling_times=staged_workflow.max_screenshot_scrolls,
extra_http_headers=staged_workflow.extra_http_headers,
@@ -959,6 +960,7 @@ async def _restore_workflow_definition(original_workflow: Workflow | None, organ
totp_identifier=original_workflow.totp_identifier,
persist_browser_session=original_workflow.persist_browser_session,
browser_profile_id=original_workflow.browser_profile_id,
+ browser_profile_key=original_workflow.browser_profile_key,
model=original_workflow.model,
max_screenshot_scrolling_times=original_workflow.max_screenshot_scrolls,
extra_http_headers=original_workflow.extra_http_headers,
@@ -1579,6 +1581,7 @@ def _process_workflow_yaml(
totp_identifier=workflow_yaml_request.totp_identifier,
persist_browser_session=workflow_yaml_request.persist_browser_session or False,
browser_profile_id=workflow_yaml_request.browser_profile_id,
+ browser_profile_key=workflow_yaml_request.browser_profile_key,
model=workflow_yaml_request.model,
max_screenshot_scrolls=workflow_yaml_request.max_screenshot_scrolls,
extra_http_headers=workflow_yaml_request.extra_http_headers,
diff --git a/skyvern/forge/sdk/workflow/browser_profile_key.py b/skyvern/forge/sdk/workflow/browser_profile_key.py
new file mode 100644
index 000000000..9fdde9a44
--- /dev/null
+++ b/skyvern/forge/sdk/workflow/browser_profile_key.py
@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+from hashlib import sha256
+from typing import Any
+
+from jinja2.sandbox import SandboxedEnvironment
+
+_JINJA_ENV = SandboxedEnvironment()
+_PROFILE_SEGMENT_PATH = "profile_segments"
+_PROFILE_SEGMENT_DIGEST_LENGTH = 24
+
+
+def normalize_browser_profile_key(browser_profile_key: str | None) -> str | None:
+ if browser_profile_key is None:
+ return None
+ stripped = browser_profile_key.strip()
+ return stripped or None
+
+
+def validate_browser_profile_key(browser_profile_key: str | None) -> str | None:
+ normalized = normalize_browser_profile_key(browser_profile_key)
+ if normalized is None:
+ return None
+ _JINJA_ENV.parse(normalized)
+ return normalized
+
+
+def render_browser_profile_key(browser_profile_key: str | None, parameters: dict[str, Any]) -> str | None:
+ normalized = normalize_browser_profile_key(browser_profile_key)
+ if normalized is None:
+ return None
+ rendered = _JINJA_ENV.from_string(normalized).render(parameters)
+ return rendered.strip() or None
+
+
+def build_workflow_browser_session_storage_key(
+ workflow_permanent_id: str,
+ rendered_browser_profile_key: str | None,
+) -> str:
+ rendered = rendered_browser_profile_key.strip() if rendered_browser_profile_key else ""
+ if not rendered:
+ return workflow_permanent_id
+ digest = sha256(rendered.encode("utf-8")).hexdigest()[:_PROFILE_SEGMENT_DIGEST_LENGTH]
+ return f"{workflow_permanent_id}/{_PROFILE_SEGMENT_PATH}/{digest}"
diff --git a/skyvern/forge/sdk/workflow/models/workflow.py b/skyvern/forge/sdk/workflow/models/workflow.py
index 59862aa49..d53e63170 100644
--- a/skyvern/forge/sdk/workflow/models/workflow.py
+++ b/skyvern/forge/sdk/workflow/models/workflow.py
@@ -138,6 +138,7 @@ class Workflow(BaseModel):
totp_identifier: str | None = None
persist_browser_session: bool = False
browser_profile_id: str | None = None
+ browser_profile_key: str | None = None
model: dict[str, Any] | None = None
status: WorkflowStatus = WorkflowStatus.published
max_screenshot_scrolls: int | None = None
diff --git a/skyvern/forge/sdk/workflow/service.py b/skyvern/forge/sdk/workflow/service.py
index 63e958481..2c4839186 100644
--- a/skyvern/forge/sdk/workflow/service.py
+++ b/skyvern/forge/sdk/workflow/service.py
@@ -71,6 +71,10 @@ from skyvern.forge.sdk.schemas.persistent_browser_sessions import PersistentBrow
from skyvern.forge.sdk.schemas.tasks import Task, TaskStatus
from skyvern.forge.sdk.schemas.workflow_runs import WorkflowRunBlock, WorkflowRunTimeline, WorkflowRunTimelineType
from skyvern.forge.sdk.trace import traced
+from skyvern.forge.sdk.workflow.browser_profile_key import (
+ build_workflow_browser_session_storage_key,
+ render_browser_profile_key,
+)
from skyvern.forge.sdk.workflow.exceptions import (
InvalidWorkflowDefinition,
WorkflowVersionConflict,
@@ -1233,6 +1237,14 @@ class WorkflowService:
workflow_run_id=workflow_run.workflow_run_id,
)
+ browser_profile_key = getattr(workflow, "browser_profile_key", None)
+ if getattr(workflow, "persist_browser_session", False) and browser_profile_key:
+ await self.get_workflow_browser_session_storage_key(
+ workflow=workflow,
+ workflow_run=workflow_run,
+ parameter_values={param.key: value for param, value in workflow_parameter_values},
+ )
+
await self._validate_credential_ids(
[
value
@@ -1301,6 +1313,51 @@ class WorkflowService:
return "value cannot be null"
return "database error while saving parameter value"
+ async def get_workflow_browser_session_storage_key(
+ self,
+ *,
+ workflow: Workflow,
+ workflow_run: WorkflowRun,
+ parameter_values: dict[str, Any] | None = None,
+ ) -> str:
+ if not workflow.browser_profile_key:
+ return workflow.workflow_permanent_id
+
+ if parameter_values is None:
+ try:
+ parameter_tuples = await app.DATABASE.workflow_runs.get_workflow_run_parameters(
+ workflow_run_id=workflow_run.workflow_run_id,
+ )
+ parameter_values = {wf_param.key: run_param.value for wf_param, run_param in parameter_tuples}
+ except Exception as exc:
+ raise SkyvernHTTPException(
+ message=("Failed to read workflow run parameters while resolving the browser profile segment key")
+ ) from exc
+
+ try:
+ rendered_key = render_browser_profile_key(workflow.browser_profile_key, parameter_values)
+ except Exception as exc:
+ raise SkyvernHTTPException(
+ message=f"Failed to render browser profile segment key: {get_user_facing_exception_message(exc)}"
+ ) from exc
+
+ if not rendered_key:
+ raise MissingValueForParameter(
+ parameter_key=workflow.browser_profile_key,
+ workflow_id=workflow.workflow_permanent_id,
+ workflow_run_id=workflow_run.workflow_run_id,
+ )
+
+ storage_key = build_workflow_browser_session_storage_key(workflow.workflow_permanent_id, rendered_key)
+ LOG.info(
+ "Resolved workflow browser session storage key",
+ workflow_run_id=workflow_run.workflow_run_id,
+ workflow_permanent_id=workflow.workflow_permanent_id,
+ browser_profile_key=workflow.browser_profile_key,
+ storage_key=storage_key,
+ )
+ return storage_key
+
@staticmethod
def _is_schedule_input_parameter(workflow_parameter: Any) -> bool:
"""Check whether a parameter is user-configurable input for scheduled runs.
@@ -3924,6 +3981,7 @@ class WorkflowService:
totp_identifier: str | None = None,
persist_browser_session: bool = False,
browser_profile_id: str | None = None,
+ browser_profile_key: str | None = None,
model: dict[str, Any] | None = None,
workflow_permanent_id: str | None = None,
version: int | None = None,
@@ -3957,6 +4015,7 @@ class WorkflowService:
totp_identifier=totp_identifier,
persist_browser_session=persist_browser_session,
browser_profile_id=browser_profile_id,
+ browser_profile_key=browser_profile_key,
model=model,
workflow_permanent_id=workflow_permanent_id,
version=version,
@@ -4348,6 +4407,7 @@ class WorkflowService:
totp_identifier: str | None | object = _UNSET,
persist_browser_session: bool | None = None,
browser_profile_id: str | None | object = _UNSET,
+ browser_profile_key: str | None | object = _UNSET,
model: dict[str, Any] | None | object = _UNSET,
max_screenshot_scrolling_times: int | None | object = _UNSET,
max_elapsed_time_minutes: int | None | object = _UNSET,
@@ -4376,6 +4436,7 @@ class WorkflowService:
totp_identifier=totp_identifier,
persist_browser_session=persist_browser_session,
browser_profile_id=browser_profile_id,
+ browser_profile_key=browser_profile_key,
model=model,
max_screenshot_scrolling_times=max_screenshot_scrolling_times,
max_elapsed_time_minutes=max_elapsed_time_minutes,
@@ -4404,6 +4465,7 @@ class WorkflowService:
totp_identifier=totp_identifier,
persist_browser_session=persist_browser_session,
browser_profile_id=browser_profile_id,
+ browser_profile_key=browser_profile_key,
model=model,
max_screenshot_scrolling_times=max_screenshot_scrolling_times,
max_elapsed_time_minutes=max_elapsed_time_minutes,
@@ -5870,6 +5932,10 @@ class WorkflowService:
and not workflow_run.browser_profile_id
):
if workflow_run.status == WorkflowRunStatus.completed:
+ browser_session_storage_key = await self.get_workflow_browser_session_storage_key(
+ workflow=workflow,
+ workflow_run=workflow_run,
+ )
if not close_browser_on_completion:
# Browser stays alive here, so close()'s cookie snapshot never ran; capture
# session cookies now or they're missing from the archived profile on reuse.
@@ -5879,12 +5945,13 @@ class WorkflowService:
)
await app.STORAGE.store_browser_session(
workflow_run.organization_id,
- workflow.workflow_permanent_id,
+ browser_session_storage_key,
browser_state.browser_artifacts.browser_session_dir,
)
LOG.info(
"Persisted browser session for workflow run",
workflow_run_id=workflow_run.workflow_run_id,
+ browser_session_storage_key=browser_session_storage_key,
)
else:
LOG.info(
@@ -6391,6 +6458,7 @@ class WorkflowService:
totp_identifier=request.totp_identifier,
persist_browser_session=request.persist_browser_session,
browser_profile_id=request.browser_profile_id,
+ browser_profile_key=request.browser_profile_key,
model=request.model,
max_screenshot_scrolling_times=request.max_screenshot_scrolls,
max_elapsed_time_minutes=effective_max_elapsed_time_minutes,
@@ -6431,6 +6499,7 @@ class WorkflowService:
totp_identifier=request.totp_identifier,
persist_browser_session=request.persist_browser_session,
browser_profile_id=request.browser_profile_id,
+ browser_profile_key=request.browser_profile_key,
model=request.model,
max_screenshot_scrolling_times=request.max_screenshot_scrolls,
max_elapsed_time_minutes=request.max_elapsed_time_minutes,
diff --git a/skyvern/schemas/workflows.py b/skyvern/schemas/workflows.py
index 94030b7df..53b72dd1d 100644
--- a/skyvern/schemas/workflows.py
+++ b/skyvern/schemas/workflows.py
@@ -10,6 +10,7 @@ from pydantic import BaseModel, Field, field_serializer, field_validator, model_
from skyvern.config import settings
from skyvern.forge.sdk.api.llm.config_registry import LLMConfigRegistry
from skyvern.forge.sdk.settings_manager import SettingsManager
+from skyvern.forge.sdk.workflow.browser_profile_key import validate_browser_profile_key
from skyvern.forge.sdk.workflow.models.parameter import OutputParameter, ParameterType, WorkflowParameterType
from skyvern.forge.sdk.workflow.models.run_limits import (
WORKFLOW_RUN_MAX_ELAPSED_TIME_MINUTES,
@@ -1299,6 +1300,7 @@ class WorkflowCreateYAMLRequest(BaseModel):
totp_identifier: str | None = None
persist_browser_session: bool = False
browser_profile_id: str | None = None
+ browser_profile_key: str | None = None
model: dict[str, Any] | None = None
workflow_definition: WorkflowDefinitionYAML
is_saved_task: bool = False
@@ -1327,6 +1329,11 @@ class WorkflowCreateYAMLRequest(BaseModel):
def _normalize_run_with(cls, v: str | None) -> str:
return normalize_run_with(v)
+ @field_validator("browser_profile_key", mode="before")
+ @classmethod
+ def _normalize_browser_profile_key(cls, v: str | None) -> str | None:
+ return validate_browser_profile_key(v)
+
@field_serializer("cdp_connect_headers")
def _mask_cdp_connect_headers(self, headers: dict[str, str] | None) -> dict[str, str] | None:
return mask_header_values(headers)
diff --git a/tests/unit/forge/sdk/db/test_update_workflow_definition_fields.py b/tests/unit/forge/sdk/db/test_update_workflow_definition_fields.py
index a9b7a13f2..3c8e91171 100644
--- a/tests/unit/forge/sdk/db/test_update_workflow_definition_fields.py
+++ b/tests/unit/forge/sdk/db/test_update_workflow_definition_fields.py
@@ -1,14 +1,14 @@
"""Regression tests for ``WorkflowsRepository.update_workflow_and_reconcile_definition_params``.
-Covers the 16 workflow-level fields that were newly threaded through
+Covers the 17 workflow-level fields that were newly threaded through
``WorkflowService.update_workflow_definition`` in the copilot-v2 stack:
-- ``_UNSET``-guarded (11): ``proxy_location``, ``webhook_callback_url``,
+- ``_UNSET``-guarded (12): ``proxy_location``, ``webhook_callback_url``,
``model``, ``max_screenshot_scrolling_times``, ``extra_http_headers``,
``sequential_key``, ``browser_profile_id``, ``totp_verification_url``,
- ``totp_identifier``, ``adaptive_caching``, ``code_version``. Omitting the kwarg must
- leave the persisted value unchanged; passing explicit ``None`` clears
- nullable columns.
+ ``browser_profile_key``, ``totp_identifier``, ``adaptive_caching``,
+ ``code_version``. Omitting the kwarg must leave the persisted value
+ unchanged; passing explicit ``None`` clears nullable columns.
- bare-``None`` (5): ``persist_browser_session``, ``run_with``,
``ai_fallback``, ``cache_key``, ``run_sequentially``. Both omitting
the kwarg and passing ``None`` must leave the persisted value
@@ -74,6 +74,7 @@ async def seeded_workflow(agent_db: AgentDB) -> dict[str, str]:
extra_http_headers={"X-Seed": "yes"},
persist_browser_session=True,
browser_profile_id="bp_seed_profile",
+ browser_profile_key="{{ credential_id }}",
model={"model_name": "seed-model"},
run_with="agent",
ai_fallback=False,
@@ -228,6 +229,7 @@ async def test_omitting_all_workflow_level_fields_preserves_seed(
assert workflow.extra_http_headers == {"X-Seed": "yes"}
assert workflow.persist_browser_session is True
assert workflow.browser_profile_id == "bp_seed_profile"
+ assert workflow.browser_profile_key == "{{ credential_id }}"
assert workflow.model == {"model_name": "seed-model"}
assert workflow.run_with == "agent"
assert workflow.ai_fallback is False
@@ -284,6 +286,7 @@ async def test_passing_none_to_unset_guarded_fields_clears_them(
extra_http_headers=None,
sequential_key=None,
browser_profile_id=None,
+ browser_profile_key=None,
code_version=None,
)
workflow = await _get(agent_db, seeded_workflow)
@@ -297,6 +300,7 @@ async def test_passing_none_to_unset_guarded_fields_clears_them(
assert workflow.extra_http_headers is None
assert workflow.sequential_key is None
assert workflow.browser_profile_id is None
+ assert workflow.browser_profile_key is None
assert workflow.code_version is None
@@ -315,6 +319,7 @@ async def test_setting_new_values_persists_across_all_fields(
extra_http_headers={"X-Updated": "yes"},
persist_browser_session=False,
browser_profile_id="bp_new_profile",
+ browser_profile_key="{{ account_id }}",
model={"model_name": "new-model"},
run_with="code",
ai_fallback=True,
@@ -334,6 +339,7 @@ async def test_setting_new_values_persists_across_all_fields(
assert workflow.extra_http_headers == {"X-Updated": "yes"}
assert workflow.persist_browser_session is False
assert workflow.browser_profile_id == "bp_new_profile"
+ assert workflow.browser_profile_key == "{{ account_id }}"
assert workflow.model == {"model_name": "new-model"}
assert workflow.run_with == "code"
assert workflow.ai_fallback is True
diff --git a/tests/unit/test_browser_profile_key.py b/tests/unit/test_browser_profile_key.py
new file mode 100644
index 000000000..fe988a2a2
--- /dev/null
+++ b/tests/unit/test_browser_profile_key.py
@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+from hashlib import sha256
+
+import pytest
+from jinja2 import TemplateSyntaxError
+
+from skyvern.forge.sdk.workflow.browser_profile_key import (
+ build_workflow_browser_session_storage_key,
+ render_browser_profile_key,
+ validate_browser_profile_key,
+)
+
+
+def test_template_browser_profile_key_reads_parameter_value() -> None:
+ assert render_browser_profile_key("{{ credential_id }}", {"credential_id": "cred_123"}) == "cred_123"
+
+
+def test_plain_browser_profile_key_is_literal_text() -> None:
+ assert render_browser_profile_key("credential_id", {"credential_id": "cred_123"}) == "credential_id"
+
+
+def test_template_browser_profile_key_returns_none_when_missing_or_empty() -> None:
+ assert render_browser_profile_key("{{ credential_id }}", {}) is None
+ assert render_browser_profile_key("{{ credential_id }}", {"credential_id": " "}) is None
+
+
+def test_jinja_browser_profile_key_renders_from_parameters() -> None:
+ assert (
+ render_browser_profile_key("{{ region }}:{{ credential_id }}", {"region": "us", "credential_id": "cred_123"})
+ == "us:cred_123"
+ )
+
+
+def test_validate_browser_profile_key_rejects_invalid_jinja() -> None:
+ with pytest.raises(TemplateSyntaxError):
+ validate_browser_profile_key("{{ credential_id")
+
+
+def test_segmented_storage_key_uses_stable_hashed_suffix() -> None:
+ digest = sha256(b"cred_123").hexdigest()[:24]
+ assert build_workflow_browser_session_storage_key("wpid_test", "cred_123") == f"wpid_test/profile_segments/{digest}"
+
+
+def test_empty_storage_key_keeps_legacy_workflow_key() -> None:
+ assert build_workflow_browser_session_storage_key("wpid_test", None) == "wpid_test"
diff --git a/tests/unit/test_workflow_service_profile_writeback.py b/tests/unit/test_workflow_service_profile_writeback.py
index e25edef3b..b9e84937d 100644
--- a/tests/unit/test_workflow_service_profile_writeback.py
+++ b/tests/unit/test_workflow_service_profile_writeback.py
@@ -7,11 +7,13 @@ overwrite the shared S3 profile with their dirty state.
from __future__ import annotations
+from types import SimpleNamespace
from unittest.mock import AsyncMock, MagicMock
import pytest
from skyvern.forge import app
+from skyvern.forge.sdk.workflow.browser_profile_key import build_workflow_browser_session_storage_key
from skyvern.forge.sdk.workflow.models.workflow import WorkflowRunStatus
@@ -19,6 +21,7 @@ def _make_workflow(persist: bool = True) -> MagicMock:
wf = MagicMock()
wf.persist_browser_session = persist
wf.workflow_permanent_id = "wpid_test"
+ wf.browser_profile_key = None
return wf
@@ -75,6 +78,39 @@ async def test_profile_persisted_on_completed_run(monkeypatch: pytest.MonkeyPatc
store_mock.assert_awaited_once_with("o_test", "wpid_test", "/tmp/fake_profile")
+async def test_profile_persisted_to_segmented_key_on_completed_run(monkeypatch: pytest.MonkeyPatch) -> None:
+ """Segmented workflows should write back to the segment-specific storage key."""
+ from skyvern.forge.sdk.workflow.service import WorkflowService
+
+ workflow = _make_workflow(persist=True)
+ workflow.browser_profile_key = "{{ credential_id }}"
+ workflow_run = _make_workflow_run(WorkflowRunStatus.completed)
+ browser_state = _make_browser_state()
+ store_mock = _patch_clean_up_deps(monkeypatch, browser_state)
+ monkeypatch.setattr(
+ app.DATABASE.workflow_runs,
+ "get_workflow_run_parameters",
+ AsyncMock(
+ return_value=[
+ (
+ SimpleNamespace(key="credential_id"),
+ SimpleNamespace(value="cred_123"),
+ )
+ ]
+ ),
+ )
+
+ svc = WorkflowService()
+ monkeypatch.setattr(svc, "persist_video_data", AsyncMock())
+ monkeypatch.setattr(svc, "get_tasks_by_workflow_run_id", AsyncMock(return_value=[]))
+
+ await svc.clean_up_workflow(workflow=workflow, workflow_run=workflow_run, need_call_webhook=False)
+
+ storage_key = build_workflow_browser_session_storage_key("wpid_test", "cred_123")
+ store_mock.assert_awaited_once_with("o_test", storage_key, "/tmp/fake_profile")
+
+
@pytest.mark.asyncio
@pytest.mark.parametrize(
"status",