Skip to content

AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.

feat(platform/library): Add "Export agent to file" action (#9627)

Reinier van der Leer596b29f53afe
diff --git a/autogpt_platform/backend/backend/data/graph.py b/autogpt_platform/backend/backend/data/graph.py
index 4fcd13c964..b57d987401 100644
--- a/autogpt_platform/backend/backend/data/graph.py
+++ b/autogpt_platform/backend/backend/data/graph.py
@@ -19,9 +19,9 @@ from pydantic.fields import Field, computed_field
from backend.blocks.agent import AgentExecutorBlock
from backend.blocks.basic import AgentInputBlock, AgentOutputBlock
-from backend.util import type
+from backend.util import type as type_utils
-from .block import BlockInput, BlockType, get_block, get_blocks
+from .block import Block, BlockInput, BlockSchema, BlockType, get_block, get_blocks
from .db import BaseDbModel, transaction
from .execution import ExecutionResult, ExecutionStatus
from .includes import AGENT_GRAPH_INCLUDE, AGENT_NODE_INCLUDE
@@ -71,13 +71,20 @@ class NodeModel(Node):
webhook: Optional[Webhook] = None
+ @property
+ def block(self) -> Block[BlockSchema, BlockSchema]:
+ block = get_block(self.block_id)
+ if not block:
+ raise ValueError(f"Block #{self.block_id} does not exist")
+ return block
+
@staticmethod
- def from_db(node: AgentNode) -> "NodeModel":
+ def from_db(node: AgentNode, for_export: bool = False) -> "NodeModel":
obj = NodeModel(
id=node.id,
block_id=node.agentBlockId,
- input_default=type.convert(node.constantInput, dict[str, Any]),
- metadata=type.convert(node.metadata, dict[str, Any]),
+ input_default=type_utils.convert(node.constantInput, dict[str, Any]),
+ metadata=type_utils.convert(node.metadata, dict[str, Any]),
graph_id=node.agentGraphId,
graph_version=node.agentGraphVersion,
webhook_id=node.webhookId,
@@ -85,6 +92,8 @@ class NodeModel(Node):
)
obj.input_links = [Link.from_db(link) for link in node.Input or []]
obj.output_links = [Link.from_db(link) for link in node.Output or []]
+ if for_export:
+ return obj.stripped_for_export()
return obj
def is_triggered_by_event_type(self, event_type: str) -> bool:
@@ -103,6 +112,45 @@ class NodeModel(Node):
if event_filter[k] is True
]
+ def stripped_for_export(self) -> "NodeModel":
+ """
+ Returns a copy of the node model, stripped of any non-transferable properties
+ """
+ stripped_node = self.model_copy(deep=True)
+ # Remove credentials from node input
+ if stripped_node.input_default:
+ stripped_node.input_default = NodeModel._filter_secrets_from_node_input(
+ stripped_node.input_default, self.block.input_schema.jsonschema()
+ )
+
+ # Remove webhook info
+ stripped_node.webhook_id = None
+ stripped_node.webhook = None
+
+ return stripped_node
+
+ @staticmethod
+ def _filter_secrets_from_node_input(
+ input_data: dict[str, Any], schema: dict[str, Any] | None
+ ) -> dict[str, Any]:
+ sensitive_keys = ["credentials", "api_key", "password", "token", "secret"]
+ field_schemas = schema.get("properties", {}) if schema else {}
+ result = {}
+ for key, value in input_data.items():
+ field_schema: dict | None = field_schemas.get(key)
+ if (field_schema and field_schema.get("secret", False)) or any(
+ sensitive_key in key.lower() for sensitive_key in sensitive_keys
+ ):
+ # This is a secret value -> filter this key-value pair out
+ continue
+ elif isinstance(value, dict):
+ result[key] = NodeModel._filter_secrets_from_node_input(
+ value, field_schema
+ )
+ else:
+ result[key] = value
+ return result
+
# Fix 2-way reference Node <-> Webhook
Webhook.model_rebuild()
@@ -129,7 +177,7 @@ class GraphExecutionMeta(BaseDbModel):
total_run_time = duration
try:
- stats = type.convert(_graph_exec.stats or {}, dict[str, Any])
+ stats = type_utils.convert(_graph_exec.stats or {}, dict[str, Any])
except ValueError:
stats = {}
@@ -467,8 +515,7 @@ class GraphModel(Graph):
name=graph.name or "",
description=graph.description or "",
nodes=[
- NodeModel.from_db(GraphModel._process_node(node, for_export))
- for node in graph.AgentNodes or []
+ NodeModel.from_db(node, for_export) for node in graph.AgentNodes or []
],
links=list(
{
@@ -479,37 +526,6 @@ class GraphModel(Graph):
),
)
- @staticmethod
- def _process_node(node: AgentNode, for_export: bool) -> AgentNode:
- if for_export:
- # Remove credentials from node input
- if node.constantInput:
- constant_input = type.convert(node.constantInput, dict[str, Any])
- constant_input = GraphModel._hide_node_input_credentials(constant_input)
- node.constantInput = Json(constant_input)
-
- # Remove webhook info
- node.webhookId = None
- node.Webhook = None
-
- return node
-
- @staticmethod
- def _hide_node_input_credentials(input_data: dict[str, Any]) -> dict[str, Any]:
- sensitive_keys = ["credentials", "api_key", "password", "token", "secret"]
- result = {}
- for key, value in input_data.items():
- if isinstance(value, dict):
- result[key] = GraphModel._hide_node_input_credentials(value)
- elif isinstance(value, str) and any(
- sensitive_key in key.lower() for sensitive_key in sensitive_keys
- ):
- # Skip this key-value pair in the result
- continue
- else:
- result[key] = value
- return result
-
def clean_graph(self):
blocks = [block() for block in get_blocks().values()]
diff --git a/autogpt_platform/frontend/src/app/library/agents/[id]/page.tsx b/autogpt_platform/frontend/src/app/library/agents/[id]/page.tsx
index 551aa10903..036d9eb37d 100644
--- a/autogpt_platform/frontend/src/app/library/agents/[id]/page.tsx
+++ b/autogpt_platform/frontend/src/app/library/agents/[id]/page.tsx
@@ -2,6 +2,7 @@
import React, { useCallback, useEffect, useMemo, useState } from "react";
import { useParams, useRouter } from "next/navigation";
+import { exportAsJSONFile } from "@/lib/utils";
import { useBackendAPI } from "@/lib/autogpt-server-api/context";
import {
GraphExecution,
@@ -191,19 +192,40 @@ export default function AgentRunsPage(): React.ReactElement {
[schedules, api],
);
+ const downloadGraph = useCallback(
+ async () =>
+ agent &&
+ // Export sanitized graph from backend
+ api
+ .getGraph(agent.agent_id, agent.agent_version, true)
+ .then((graph) =>
+ exportAsJSONFile(graph, `${graph.name}_v${graph.version}.json`),
+ ),
+ [api, agent],
+ );
+
const agentActions: ButtonAction[] = useMemo(
() => [
- {
- label: "Open in builder",
- callback: () => agent && router.push(`/build?flowID=${agent.agent_id}`),
- },
+ ...(agent?.can_access_graph
+ ? [
+ {
+ label: "Open in builder",
+ callback: () =>
+ agent &&
+ router.push(
+ `/build?flowID=${agent.agent_id}&flowVersion=${agent.agent_version}`,
+ ),
+ },
+ { label: "Export agent to file", callback: downloadGraph },
+ ]
+ : []),
{
label: "Delete agent",
variant: "destructive",
callback: () => setAgentDeleteDialogOpen(true),
},
],
- [agent, router],
+ [agent, router, downloadGraph],
);
if (!agent || !graph) {