Skip to content

Automate browser based workflows with AI

Show reserved parameters in workflow block parameter picker (#SKY-7548) (#4857)

Celal Zamanoğlu03085e1a69a3
diff --git a/skyvern-frontend/src/components/WorkflowBlockInput.tsx b/skyvern-frontend/src/components/WorkflowBlockInput.tsx
index 5808811ef..41ee1cf29 100644
--- a/skyvern-frontend/src/components/WorkflowBlockInput.tsx
+++ b/skyvern-frontend/src/components/WorkflowBlockInput.tsx
@@ -66,7 +66,7 @@ function WorkflowBlockInput(props: Props) {
<PlusIcon className="size-4" />
</div>
</PopoverTrigger>
- <PopoverContent className="w-[22rem]">
+ <PopoverContent className="w-[19rem]">
<WorkflowBlockParameterSelect
nodeId={nodeId}
onAdd={(parameterKey) => {
diff --git a/skyvern-frontend/src/components/WorkflowBlockInputSet.tsx b/skyvern-frontend/src/components/WorkflowBlockInputSet.tsx
index 3e417cc8d..af0894335 100644
--- a/skyvern-frontend/src/components/WorkflowBlockInputSet.tsx
+++ b/skyvern-frontend/src/components/WorkflowBlockInputSet.tsx
@@ -77,7 +77,7 @@ function WorkflowBlockInputSet(props: Props) {
<PlusIcon className="size-4" />
</div>
</PopoverTrigger>
- <PopoverContent className="w-[22rem]">
+ <PopoverContent className="w-[19rem]">
<WorkflowBlockParameterSelect
nodeId={nodeId}
onAdd={(parameterKey) => {
diff --git a/skyvern-frontend/src/components/WorkflowBlockInputTextarea.tsx b/skyvern-frontend/src/components/WorkflowBlockInputTextarea.tsx
index cd4561c61..06f8682b9 100644
--- a/skyvern-frontend/src/components/WorkflowBlockInputTextarea.tsx
+++ b/skyvern-frontend/src/components/WorkflowBlockInputTextarea.tsx
@@ -114,7 +114,7 @@ function WorkflowBlockInputTextarea(props: Props) {
<PlusIcon className="size-4" />
</div>
</PopoverTrigger>
- <PopoverContent className="w-[22rem]">
+ <PopoverContent className="w-[19rem]">
<WorkflowBlockParameterSelect
nodeId={nodeId}
onAdd={insertParameterAtCursor}
diff --git a/skyvern-frontend/src/routes/workflows/editor/nodes/WorkflowBlockParameterSelect.tsx b/skyvern-frontend/src/routes/workflows/editor/nodes/WorkflowBlockParameterSelect.tsx
index 201e7208e..3960c617b 100644
--- a/skyvern-frontend/src/routes/workflows/editor/nodes/WorkflowBlockParameterSelect.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/nodes/WorkflowBlockParameterSelect.tsx
@@ -1,13 +1,47 @@
import { useEdges, useNodes } from "@xyflow/react";
import { useWorkflowParametersStore } from "@/store/WorkflowParametersStore";
import { AppNode } from ".";
-import { getAvailableOutputParameterKeys } from "../workflowEditorUtils";
+import {
+ getAvailableOutputParameterKeys,
+ isNodeInsideForLoop,
+} from "../workflowEditorUtils";
import { PlusIcon } from "@radix-ui/react-icons";
import { SwitchBar } from "@/components/SwitchBar";
import { useState } from "react";
import { ScrollArea } from "@/components/ui/scroll-area";
import { ScrollAreaViewport } from "@radix-ui/react-scroll-area";
+// Reserved parameters that are always available
+// See: skyvern/forge/sdk/workflow/models/parameter.py RESERVED_PARAMETER_KEYS
+const GLOBAL_RESERVED_PARAMETERS = [
+ { key: "current_date", description: "Current UTC date (YYYY-MM-DD format)" },
+ {
+ key: "workflow_run_outputs",
+ description: "JSON of all block outputs collected so far",
+ },
+ {
+ key: "workflow_run_summary",
+ description: "Merged summary of all block outputs",
+ },
+ { key: "workflow_run_id", description: "Unique ID of the current run" },
+ { key: "workflow_id", description: "The workflow's ID" },
+ {
+ key: "workflow_permanent_id",
+ description: "The workflow's permanent ID",
+ },
+ { key: "workflow_title", description: "The workflow's title" },
+];
+
+// Reserved parameters only available inside loop blocks
+const LOOP_RESERVED_PARAMETERS = [
+ { key: "current_value", description: "The current item being iterated" },
+ { key: "current_item", description: "Alias for current_value" },
+ {
+ key: "current_index",
+ description: "Zero-based index of the current iteration",
+ },
+];
+
type Props = {
nodeId: string;
onAdd: (parameterKey: string) => void;
@@ -23,19 +57,13 @@ function WorkflowBlockParameterSelect({ nodeId, onAdd }: Props) {
edges,
nodeId,
);
- const credentialParameters = workflowParameters.filter(
- (parameter) => parameter.parameterType === "credential",
- );
- const credentialParameterKeys = credentialParameters.map(
- (parameter) => parameter.key,
- );
+ const allParameterKeys = workflowParameters.map((parameter) => parameter.key);
- const nonCredentialParameters = workflowParameters.filter(
- (parameter) => parameter.parameterType !== "credential",
- );
- const nonCredentialParameterKeys = nonCredentialParameters.map(
- (parameter) => parameter.key,
- );
+ const insideLoop = isNodeInsideForLoop(nodes, nodeId);
+ const reservedParameters = [
+ ...GLOBAL_RESERVED_PARAMETERS,
+ ...(insideLoop ? LOOP_RESERVED_PARAMETERS : []),
+ ];
return (
<div className="cursor-auto space-y-3">
@@ -43,6 +71,7 @@ function WorkflowBlockParameterSelect({ nodeId, onAdd }: Props) {
<h1>Add Parameter</h1>
</header>
<SwitchBar
+ className="w-full"
onChange={(value) => setContent(value)}
value={content}
options={[
@@ -50,42 +79,21 @@ function WorkflowBlockParameterSelect({ nodeId, onAdd }: Props) {
label: "Parameters",
value: "parameters",
},
- {
- label: "Credentials",
- value: "credentials",
- },
{
label: "Block Outputs",
value: "outputs",
},
+ {
+ label: "System",
+ value: "system",
+ },
]}
/>
<ScrollArea>
<ScrollAreaViewport className="max-h-96">
- {content === "credentials" && (
- <div className="space-y-2">
- {credentialParameterKeys.map((parameterKey) => {
- return (
- <div
- key={parameterKey}
- className="flex cursor-pointer justify-between rounded-md bg-slate-elevation1 px-3 py-2 text-xs hover:bg-slate-elevation2"
- onClick={() => {
- onAdd(parameterKey);
- }}
- >
- {parameterKey}
- <PlusIcon />
- </div>
- );
- })}
- {credentialParameterKeys.length === 0 && (
- <div className="text-xs">No credentials</div>
- )}
- </div>
- )}
{content === "parameters" && (
<div className="space-y-2">
- {nonCredentialParameterKeys.map((parameterKey) => {
+ {allParameterKeys.map((parameterKey) => {
return (
<div
key={parameterKey}
@@ -99,8 +107,8 @@ function WorkflowBlockParameterSelect({ nodeId, onAdd }: Props) {
</div>
);
})}
- {nonCredentialParameterKeys.length === 0 && (
- <div className="text-xs">No workflow parameters</div>
+ {allParameterKeys.length === 0 && (
+ <div className="text-xs">No parameters</div>
)}
</div>
)}
@@ -125,6 +133,30 @@ function WorkflowBlockParameterSelect({ nodeId, onAdd }: Props) {
)}
</div>
)}
+ {content === "system" && (
+ <div className="space-y-2">
+ {reservedParameters.map(({ key, description }) => (
+ <div
+ key={key}
+ className="flex cursor-pointer items-center justify-between rounded-md bg-slate-elevation1 px-3 py-2 text-xs hover:bg-slate-elevation2"
+ onClick={() => {
+ onAdd(key);
+ }}
+ >
+ <div>
+ <div>{key}</div>
+ <div className="text-[0.625rem] text-muted-foreground">
+ {description}
+ </div>
+ </div>
+ <PlusIcon className="shrink-0" />
+ </div>
+ ))}
+ {reservedParameters.length === 0 && (
+ <div className="text-xs">No reserved parameters</div>
+ )}
+ </div>
+ )}
</ScrollAreaViewport>
</ScrollArea>
</div>
diff --git a/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterEditPanel.tsx b/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterEditPanel.tsx
index 2ed948d7b..c94f426fe 100644
--- a/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterEditPanel.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterEditPanel.tsx
@@ -186,6 +186,7 @@ function WorkflowParameterEditPanel({
"workflow_permanent_id",
"workflow_run_id",
"workflow_run_outputs",
+ "workflow_run_summary",
];
const isCloud = useContext(CloudContext);
const isEditMode = !!initialValues;
diff --git a/skyvern-frontend/src/routes/workflows/editor/workflowEditorUtils.ts b/skyvern-frontend/src/routes/workflows/editor/workflowEditorUtils.ts
index 614d2f5eb..11c2bfa93 100644
--- a/skyvern-frontend/src/routes/workflows/editor/workflowEditorUtils.ts
+++ b/skyvern-frontend/src/routes/workflows/editor/workflowEditorUtils.ts
@@ -4112,10 +4112,13 @@ function isNodeInsideForLoop(nodes: Array<AppNode>, nodeId: string): boolean {
if (!currentNode) {
return false;
}
- const parentNode = currentNode.parentId
- ? nodes.find((n) => n.id === currentNode.parentId)
- : null;
- return parentNode?.type === "loop";
+ let current: AppNode | undefined = currentNode;
+ while (current?.parentId) {
+ const parent = nodes.find((n) => n.id === current!.parentId);
+ if (parent?.type === "loop") return true;
+ current = parent;
+ }
+ return false;
}
export {
diff --git a/skyvern/forge/sdk/workflow/models/parameter.py b/skyvern/forge/sdk/workflow/models/parameter.py
index 51c7a094d..e12e650ab 100644
--- a/skyvern/forge/sdk/workflow/models/parameter.py
+++ b/skyvern/forge/sdk/workflow/models/parameter.py
@@ -17,6 +17,8 @@ RESERVED_PARAMETER_KEYS = [
"workflow_id",
"workflow_permanent_id",
"workflow_run_id",
+ "workflow_run_outputs",
+ "workflow_run_summary",
]