Skip to content

Commit

Permalink
Add secret parameter to workflow (#1150)
Browse files Browse the repository at this point in the history
  • Loading branch information
@wintonzheng
wintonzheng authored Nov 6, 2024
1 parent b62c2ca commit b73602d
Show file tree
Hide file tree
Showing 6 changed files with 170 additions and 36 deletions.
32 changes: 26 additions & 6 deletions skyvern-frontend/src/routes/workflows/editor/FlowRenderer.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import { nanoid } from "nanoid";
import { useEffect, useState } from "react";
import {
AWSSecretParameter,
BitwardenSensitiveInformationParameter,
WorkflowApiResponse,
WorkflowParameterValueType,
} from "../types/workflowTypes";
import {
BitwardenLoginCredentialParameterYAML,
BitwardenSensitiveInformationParameterYAML,
BlockYAML,
ContextParameterYAML,
ParameterYAML,
Expand Down Expand Up @@ -74,6 +74,7 @@ function convertToParametersYAML(
| WorkflowParameterYAML
| BitwardenLoginCredentialParameterYAML
| ContextParameterYAML
| BitwardenSensitiveInformationParameterYAML
> {
return parameters.map((parameter) => {
if (parameter.parameterType === "workflow") {
Expand All @@ -93,6 +94,20 @@ function convertToParametersYAML(
description: parameter.description || null,
source_parameter_key: parameter.sourceParameterKey,
};
} else if (parameter.parameterType === "secret") {
return {
parameter_type: "bitwarden_sensitive_information",
key: parameter.key,
bitwarden_identity_key: parameter.identityKey,
bitwarden_identity_fields: parameter.identityFields,
description: parameter.description || null,
bitwarden_collection_id: parameter.collectionId,
bitwarden_client_id_aws_secret_key: "SKYVERN_BITWARDEN_CLIENT_ID",
bitwarden_client_secret_aws_secret_key:
"SKYVERN_BITWARDEN_CLIENT_SECRET",
bitwarden_master_password_aws_secret_key:
"SKYVERN_BITWARDEN_MASTER_PASSWORD",
};
} else {
return {
parameter_type: "bitwarden_login_credential",
Expand Down Expand Up @@ -131,6 +146,14 @@ export type ParametersState = Array<
sourceParameterKey: string;
description?: string | null;
}
| {
key: string;
parameterType: "secret";
identityKey: string;
identityFields: Array<string>;
collectionId: string;
description?: string | null;
}
>;

type Props = {
Expand Down Expand Up @@ -246,12 +269,9 @@ function FlowRenderer({
const parametersInYAMLConvertibleJSON = convertToParametersYAML(parameters);
const filteredParameters = workflow.workflow_definition.parameters.filter(
(parameter) => {
return (
parameter.parameter_type === "aws_secret" ||
parameter.parameter_type === "bitwarden_sensitive_information"
);
return parameter.parameter_type === "aws_secret";
},
) as Array<AWSSecretParameter | BitwardenSensitiveInformationParameter>;
) as Array<AWSSecretParameter>;

const echoParameters = convertEchoParameters(filteredParameters);

Expand Down
14 changes: 13 additions & 1 deletion skyvern-frontend/src/routes/workflows/editor/WorkflowEditor.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ function WorkflowEditor() {
(parameter) =>
parameter.parameter_type === "workflow" ||
parameter.parameter_type === "bitwarden_login_credential" ||
parameter.parameter_type === "context",
parameter.parameter_type === "context" ||
parameter.parameter_type === "bitwarden_sensitive_information",
)
.map((parameter) => {
if (parameter.parameter_type === "workflow") {
Expand All @@ -71,6 +72,17 @@ function WorkflowEditor() {
sourceParameterKey: parameter.source.key,
description: parameter.description,
};
} else if (
parameter.parameter_type === "bitwarden_sensitive_information"
) {
return {
key: parameter.key,
parameterType: "secret",
collectionId: parameter.bitwarden_collection_id,
identityKey: parameter.bitwarden_identity_key,
identityFields: parameter.bitwarden_identity_fields,
description: parameter.description,
};
} else {
return {
key: parameter.key,
Expand Down
56 changes: 54 additions & 2 deletions skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterAddPanel.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { toast } from "@/components/ui/use-toast";
import { SourceParameterKeySelector } from "../../components/SourceParameterKeySelector";

type Props = {
type: "workflow" | "credential" | "context";
type: "workflow" | "credential" | "context" | "secret";
onClose: () => void;
onSave: (value: ParametersState[number]) => void;
};
Expand All @@ -34,13 +34,16 @@ const workflowParameterTypeOptions = [
{ label: "JSON", value: WorkflowParameterValueType.JSON },
];

function header(type: "workflow" | "credential" | "context") {
function header(type: "workflow" | "credential" | "context" | "secret") {
if (type === "workflow") {
return "Add Input Parameter";
}
if (type === "credential") {
return "Add Credential Parameter";
}
if (type === "secret") {
return "Add Secret Parameter";
}
return "Add Context Parameter";
}

Expand All @@ -62,6 +65,9 @@ function WorkflowParameterAddPanel({ type, onClose, onSave }: Props) {
string | undefined
>(undefined);

const [identityKey, setIdentityKey] = useState("");
const [identityFields, setIdentityFields] = useState("");

return (
<div className="space-y-4">
<header className="flex items-center justify-between">
Expand Down Expand Up @@ -192,6 +198,31 @@ function WorkflowParameterAddPanel({ type, onClose, onSave }: Props) {
/>
</div>
)}
{type === "secret" && (
<>
<div className="space-y-1">
<Label className="text-xs text-slate-300">Identity Key</Label>
<Input
value={identityKey}
onChange={(e) => setIdentityKey(e.target.value)}
/>
</div>
<div className="space-y-1">
<Label className="text-xs text-slate-300">Identity Fields</Label>
<Input
value={identityFields}
onChange={(e) => setIdentityFields(e.target.value)}
/>
</div>
<div className="space-y-1">
<Label className="text-xs text-slate-300">Collection ID</Label>
<Input
value={collectionId}
onChange={(e) => setCollectionId(e.target.value)}
/>
</div>
</>
)}
<div className="flex justify-end">
<Button
onClick={() => {
Expand Down Expand Up @@ -243,6 +274,27 @@ function WorkflowParameterAddPanel({ type, onClose, onSave }: Props) {
description,
});
}
if (type === "secret") {
if (!collectionId) {
toast({
variant: "destructive",
title: "Failed to add parameter",
description: "Collection ID is required",
});
return;
}
onSave({
key,
parameterType: "secret",
collectionId,
identityFields: identityFields
.split(",")
.filter((s) => s.length > 0)
.map((field) => field.trim()),
identityKey,
description,
});
}
if (type === "context") {
if (!sourceParameterKey) {
toast({
Expand Down
66 changes: 63 additions & 3 deletions skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterEditPanel.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { toast } from "@/components/ui/use-toast";
import { SourceParameterKeySelector } from "../../components/SourceParameterKeySelector";

type Props = {
type: "workflow" | "credential" | "context";
type: "workflow" | "credential" | "context" | "secret";
onClose: () => void;
onSave: (value: ParametersState[number]) => void;
initialValues: ParametersState[number];
Expand All @@ -35,13 +35,16 @@ const workflowParameterTypeOptions = [
{ label: "JSON", value: WorkflowParameterValueType.JSON },
];

function header(type: "workflow" | "credential" | "context") {
function header(type: "workflow" | "credential" | "context" | "secret") {
if (type === "workflow") {
return "Edit Input Parameter";
}
if (type === "credential") {
return "Edit Credential Parameter";
}
if (type === "secret") {
return "Edit Secret Parameter";
}
return "Edit Context Parameter";
}

Expand All @@ -61,7 +64,8 @@ function WorkflowParameterEditPanel({
initialValues.description ?? "",
);
const [collectionId, setCollectionId] = useState(
initialValues.parameterType === "credential"
initialValues.parameterType === "credential" ||
initialValues.parameterType === "secret"
? initialValues.collectionId
: "",
);
Expand Down Expand Up @@ -95,6 +99,16 @@ function WorkflowParameterEditPanel({
: undefined,
);

const [identityKey, setIdentityKey] = useState(
initialValues.parameterType === "secret" ? initialValues.identityKey : "",
);

const [identityFields, setIdentityFields] = useState(
initialValues.parameterType === "secret"
? initialValues.identityFields.join(", ")
: "",
);

return (
<div className="space-y-4">
<header className="flex items-center justify-between">
Expand Down Expand Up @@ -225,6 +239,31 @@ function WorkflowParameterEditPanel({
/>
</div>
)}
{type === "secret" && (
<>
<div className="space-y-1">
<Label className="text-xs text-slate-300">Identity Key</Label>
<Input
value={identityKey}
onChange={(e) => setIdentityKey(e.target.value)}
/>
</div>
<div className="space-y-1">
<Label className="text-xs text-slate-300">Identity Fields</Label>
<Input
value={identityFields}
onChange={(e) => setIdentityFields(e.target.value)}
/>
</div>
<div className="space-y-1">
<Label className="text-xs text-slate-300">Collection ID</Label>
<Input
value={collectionId}
onChange={(e) => setCollectionId(e.target.value)}
/>
</div>
</>
)}
<div className="flex justify-end">
<Button
onClick={() => {
Expand Down Expand Up @@ -276,6 +315,27 @@ function WorkflowParameterEditPanel({
description,
});
}
if (type === "secret") {
if (!collectionId) {
toast({
variant: "destructive",
title: "Failed to add parameter",
description: "Collection ID is required",
});
return;
}
onSave({
key,
parameterType: "secret",
collectionId,
identityFields: identityFields
.split(",")
.filter((s) => s.length > 0)
.map((field) => field.trim()),
identityKey,
description,
});
}
if (type === "context") {
if (!sourceParameterKey) {
toast({
Expand Down
13 changes: 12 additions & 1 deletion skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParametersPanel.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ function WorkflowParametersPanel() {
active: boolean;
operation: "add" | "edit";
parameter?: ParametersState[number] | null;
type: "workflow" | "credential" | "context";
type: "workflow" | "credential" | "context" | "secret";
}>({
active: false,
operation: "add",
Expand Down Expand Up @@ -103,6 +103,17 @@ function WorkflowParametersPanel() {
>
Context Parameter
</DropdownMenuItem>
<DropdownMenuItem
onClick={() => {
setOperationPanelState({
active: true,
operation: "add",
type: "secret",
});
}}
>
Secret Parameter
</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>

Expand Down
25 changes: 2 additions & 23 deletions skyvern-frontend/src/routes/workflows/editor/workflowEditorUtils.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ import { Edge } from "@xyflow/react";
import { nanoid } from "nanoid";
import type {
AWSSecretParameter,
BitwardenSensitiveInformationParameter,
ContextParameter,
OutputParameter,
Parameter,
WorkflowApiResponse,
Expand Down Expand Up @@ -45,11 +43,11 @@ import { fileParserNodeDefaultData } from "./nodes/FileParserNode/types";
import { LoopNode, loopNodeDefaultData } from "./nodes/LoopNode/types";
import { NodeAdderNode } from "./nodes/NodeAdderNode/types";
import { sendEmailNodeDefaultData } from "./nodes/SendEmailNode/types";
import { StartNode } from "./nodes/StartNode/types";
import { taskNodeDefaultData } from "./nodes/TaskNode/types";
import { textPromptNodeDefaultData } from "./nodes/TextPromptNode/types";
import { NodeBaseData } from "./nodes/types";
import { uploadNodeDefaultData } from "./nodes/UploadNode/types";
import { StartNode } from "./nodes/StartNode/types";

export const NEW_NODE_LABEL_PREFIX = "block_";

Expand Down Expand Up @@ -685,11 +683,7 @@ function generateNodeLabel(existingLabels: Array<string>) {
* If a parameter is not displayed in the editor, we should echo its value back when saved.
*/
function convertEchoParameters(
parameters: Array<
| ContextParameter
| BitwardenSensitiveInformationParameter
| AWSSecretParameter
>,
parameters: Array<AWSSecretParameter>,
): Array<ParameterYAML> {
return parameters.map((parameter) => {
if (parameter.parameter_type === "aws_secret") {
Expand All @@ -699,21 +693,6 @@ function convertEchoParameters(
aws_key: parameter.aws_key,
};
}
if (parameter.parameter_type === "bitwarden_sensitive_information") {
return {
key: parameter.key,
parameter_type: "bitwarden_sensitive_information",
bitwarden_collection_id: parameter.bitwarden_collection_id,
bitwarden_identity_key: parameter.bitwarden_identity_key,
bitwarden_identity_fields: parameter.bitwarden_identity_fields,
bitwarden_client_id_aws_secret_key:
parameter.bitwarden_client_id_aws_secret_key,
bitwarden_client_secret_aws_secret_key:
parameter.bitwarden_client_secret_aws_secret_key,
bitwarden_master_password_aws_secret_key:
parameter.bitwarden_master_password_aws_secret_key,
};
}
throw new Error("Unknown parameter type");
});
}
Expand Down

0 comments on commit b73602d

Please sign in to comment.