import json from datetime import datetime from enum import StrEnum from typing import Any import sqlalchemy as sa from sqlalchemy import DateTime, Index, String, UniqueConstraint, func from sqlalchemy.orm import Mapped, mapped_column from libs.datetime_utils import naive_utc_now from libs.uuid_utils import uuidv7 from .agent_config_entities import AgentSoulConfig, WorkflowNodeJobConfig from .base import Base, DefaultFieldsMixin from .types import EnumText, JSONModelColumn, LongText, StringUUID class AgentKind(StrEnum): """Agent implementation family. This leaves room for future non-Dify agent implementations while keeping the current roster/workflow APIs scoped to Dify Agent. """ # Native Agent backed by the Dify Agent runtime/protocol. DIFY_AGENT = "dify_agent" class AgentScope(StrEnum): """Visibility and lifecycle scope of an Agent record.""" # Workspace-visible Agent that can be reused from Agent Roster. ROSTER = "roster" # Temporary workflow-local Agent created inside one draft workflow node. WORKFLOW_ONLY = "workflow_only" class AgentSource(StrEnum): """Origin that created or imported the Agent.""" # Created from an Agent App composer. AGENT_APP = "agent_app" # Created from a Workflow Agent Composer flow. WORKFLOW = "workflow" # Imported from an external artifact or future CLI/export flow. IMPORTED = "imported" # Created by system bootstrap or managed templates. SYSTEM = "system" class AgentIconType(StrEnum): """Supported icon storage formats for Agent roster entries.""" # ``icon`` stores an uploaded image reference. IMAGE = "image" # ``icon`` stores an emoji character. EMOJI = "emoji" # ``icon`` stores an external image URL. LINK = "link" class AgentStatus(StrEnum): """Soft lifecycle state for Agent records.""" # Available for roster lookup, composer use, and workflow binding. ACTIVE = "active" # Hidden from active roster queries while preserving historical bindings. ARCHIVED = "archived" class AgentConfigRevisionOperation(StrEnum): """Audit operation recorded for Agent Soul version/revision changes.""" # Initial version creation for a new Agent. CREATE_VERSION = "create_version" # Saves over the user-facing current version by creating a replacement snapshot. SAVE_CURRENT_VERSION = "save_current_version" # Creates a new semantic version for the same Agent. SAVE_NEW_VERSION = "save_new_version" # Saves composer content into a brand-new roster Agent. SAVE_NEW_AGENT = "save_new_agent" # Promotes a workflow-only Agent into the reusable Agent Roster. SAVE_TO_ROSTER = "save_to_roster" class WorkflowAgentBindingType(StrEnum): """How a workflow node is bound to an Agent.""" # Node uses a reusable Agent from the workspace roster. ROSTER_AGENT = "roster_agent" # Node owns a workflow-only Agent that is not visible in the roster. INLINE_AGENT = "inline_agent" class Agent(DefaultFieldsMixin, Base): """Workspace-scoped Agent identity used by Agent Roster and workflow-only agents.""" __tablename__ = "agents" __table_args__ = ( sa.PrimaryKeyConstraint("id", name="agent_pkey"), UniqueConstraint("tenant_id", "roster_unique_name"), Index("agent_tenant_updated_at_idx", "tenant_id", "updated_at"), Index("agent_tenant_scope_idx", "tenant_id", "scope"), Index("agent_tenant_workflow_id_idx", "tenant_id", "workflow_id"), Index("agent_tenant_app_id_idx", "tenant_id", "app_id"), Index("agent_active_config_snapshot_id_idx", "active_config_snapshot_id"), ) tenant_id: Mapped[str] = mapped_column(StringUUID, nullable=False) name: Mapped[str] = mapped_column(String(255), nullable=False) description: Mapped[str] = mapped_column(LongText, nullable=False, default="") icon_type: Mapped[AgentIconType | None] = mapped_column(EnumText(AgentIconType, length=32), nullable=True) icon: Mapped[str | None] = mapped_column( String(255), nullable=True, comment="Icon payload interpreted by icon_type: emoji character, image file id, or external URL.", ) icon_background: Mapped[str | None] = mapped_column(String(255), nullable=True) agent_kind: Mapped[AgentKind] = mapped_column( EnumText(AgentKind, length=32), nullable=False, default=AgentKind.DIFY_AGENT ) scope: Mapped[AgentScope] = mapped_column(EnumText(AgentScope, length=32), nullable=False) source: Mapped[AgentSource] = mapped_column(EnumText(AgentSource, length=32), nullable=False) app_id: Mapped[str | None] = mapped_column(StringUUID, nullable=True) workflow_id: Mapped[str | None] = mapped_column(StringUUID, nullable=True) workflow_node_id: Mapped[str | None] = mapped_column(String(255), nullable=True) active_config_snapshot_id: Mapped[str | None] = mapped_column(StringUUID, nullable=True) status: Mapped[AgentStatus] = mapped_column( EnumText(AgentStatus, length=32), nullable=False, default=AgentStatus.ACTIVE ) roster_unique_name: Mapped[str | None] = mapped_column( String(255), sa.Computed("CASE WHEN scope = 'roster' AND status = 'active' THEN name ELSE NULL END"), nullable=True, ) created_by: Mapped[str | None] = mapped_column(StringUUID, nullable=True) updated_by: Mapped[str | None] = mapped_column(StringUUID, nullable=True) archived_by: Mapped[str | None] = mapped_column(StringUUID, nullable=True) archived_at: Mapped[datetime | None] = mapped_column(DateTime, nullable=True) class AgentConfigSnapshot(DefaultFieldsMixin, Base): """Immutable Agent Soul snapshot. ``config_snapshot`` stores ``AgentSoulConfig`` as JSON-backed ``LongText``. It may contain credential or secret references, but must never contain plaintext secrets. """ __tablename__ = "agent_config_snapshots" __table_args__ = ( sa.PrimaryKeyConstraint("id", name="agent_config_snapshot_pkey"), UniqueConstraint("agent_id", "version", name="agent_config_snapshot_agent_version_unique"), Index("agent_config_snapshot_tenant_agent_created_at_idx", "tenant_id", "agent_id", "created_at"), Index("agent_config_snapshot_tenant_created_at_idx", "tenant_id", "created_at"), ) tenant_id: Mapped[str] = mapped_column(StringUUID, nullable=False) agent_id: Mapped[str] = mapped_column(StringUUID, nullable=False) version: Mapped[int] = mapped_column(sa.Integer, nullable=False) config_snapshot: Mapped[Any] = mapped_column(JSONModelColumn(AgentSoulConfig), nullable=False) summary: Mapped[str | None] = mapped_column(LongText, nullable=True) version_note: Mapped[str | None] = mapped_column(LongText, nullable=True) created_by: Mapped[str | None] = mapped_column(StringUUID, nullable=True) @property def config_snapshot_dict(self) -> dict[str, Any]: if not self.config_snapshot: return {} if hasattr(self.config_snapshot, "model_dump"): return self.config_snapshot.model_dump(mode="json") if isinstance(self.config_snapshot, str): return json.loads(self.config_snapshot) return dict(self.config_snapshot) class AgentConfigRevision(Base): """Audit edge for every Agent Soul save operation. Revisions link immutable Agent Soul snapshots instead of duplicating the serialized configuration JSON. """ __tablename__ = "agent_config_revisions" __table_args__ = ( sa.PrimaryKeyConstraint("id", name="agent_config_revision_pkey"), UniqueConstraint( "agent_id", "revision", name="agent_config_revision_agent_revision_unique", ), Index("agent_config_revision_tenant_agent_created_at_idx", "tenant_id", "agent_id", "created_at"), Index( "agent_config_revision_tenant_current_snapshot_created_at_idx", "tenant_id", "current_snapshot_id", "created_at", ), ) id: Mapped[str] = mapped_column(StringUUID, primary_key=True, default=lambda: str(uuidv7())) tenant_id: Mapped[str] = mapped_column(StringUUID, nullable=False) agent_id: Mapped[str] = mapped_column(StringUUID, nullable=False) previous_snapshot_id: Mapped[str | None] = mapped_column(StringUUID, nullable=True) current_snapshot_id: Mapped[str] = mapped_column(StringUUID, nullable=False) revision: Mapped[int] = mapped_column(sa.Integer, nullable=False) operation: Mapped[AgentConfigRevisionOperation] = mapped_column( EnumText(AgentConfigRevisionOperation, length=64), nullable=False ) summary: Mapped[str | None] = mapped_column(LongText, nullable=True) version_note: Mapped[str | None] = mapped_column(LongText, nullable=True) created_by: Mapped[str | None] = mapped_column(StringUUID, nullable=True) created_at: Mapped[datetime] = mapped_column( DateTime, nullable=False, default=naive_utc_now, server_default=func.current_timestamp(), ) class WorkflowAgentNodeBinding(DefaultFieldsMixin, Base): """Binding between one workflow node and one Agent config snapshot. ``node_job_config`` stores Workflow Node Job JSON only. Agent Soul belongs to ``AgentConfigSnapshot.config_snapshot`` and must not be duplicated here. """ __tablename__ = "workflow_agent_node_bindings" __table_args__ = ( sa.PrimaryKeyConstraint("id", name="workflow_agent_node_binding_pkey"), UniqueConstraint( "tenant_id", "workflow_id", "node_id", name="workflow_agent_node_binding_node_unique", ), Index("workflow_agent_node_binding_agent_idx", "tenant_id", "agent_id"), Index("workflow_agent_node_binding_current_snapshot_idx", "tenant_id", "current_snapshot_id"), Index("workflow_agent_node_binding_app_idx", "tenant_id", "app_id"), ) tenant_id: Mapped[str] = mapped_column(StringUUID, nullable=False) app_id: Mapped[str] = mapped_column(StringUUID, nullable=False) workflow_id: Mapped[str] = mapped_column(StringUUID, nullable=False) node_id: Mapped[str] = mapped_column(String(255), nullable=False) binding_type: Mapped[WorkflowAgentBindingType] = mapped_column( EnumText(WorkflowAgentBindingType, length=32), nullable=False ) agent_id: Mapped[str | None] = mapped_column(StringUUID, nullable=True) current_snapshot_id: Mapped[str | None] = mapped_column(StringUUID, nullable=True) node_job_config: Mapped[Any] = mapped_column(JSONModelColumn(WorkflowNodeJobConfig), nullable=False) created_by: Mapped[str | None] = mapped_column(StringUUID, nullable=True) updated_by: Mapped[str | None] = mapped_column(StringUUID, nullable=True) @property def node_job_config_dict(self) -> dict[str, Any]: if not self.node_job_config: return {} if hasattr(self.node_job_config, "model_dump"): return self.node_job_config.model_dump(mode="json") if isinstance(self.node_job_config, str): return json.loads(self.node_job_config) return dict(self.node_job_config)