Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

fix(agent): keep composer reads free of draft mutations (#42427)

zyssyz123d21518f8feaa
diff --git a/api/controllers/console/agent/composer.py b/api/controllers/console/agent/composer.py
index 2ee9933309e..68a0e942571 100644
--- a/api/controllers/console/agent/composer.py
+++ b/api/controllers/console/agent/composer.py
@@ -508,7 +508,7 @@ class AgentComposerApi(Resource):
@account_initialization_required
@rbac_permission_required(RBACCheck(RBACPermission.AGENT_PREVIEW, AgentId()))
@with_current_tenant_id
- @with_session
+ @with_session(write=False)
def get(self, session: Session, tenant_id: str, agent_id: UUID):
return dump_response(
AgentAppComposerResponse,
@@ -550,7 +550,7 @@ class AgentComposerValidateApi(Resource):
@account_initialization_required
@rbac_permission_required(RBACCheck(RBACPermission.AGENT_PREVIEW, AgentId()))
@with_current_tenant_id
- @with_session
+ @with_session(write=False)
@model_validate(ComposerSavePayload)
def post(self, req_data: ComposerSavePayload, session: Session, tenant_id: str, agent_id: UUID):
AgentComposerService.load_agent_composer(session=session, tenant_id=tenant_id, agent_id=str(agent_id))
diff --git a/api/controllers/console/app/agent_config_inspector.py b/api/controllers/console/app/agent_config_inspector.py
index 33503512907..215c9eb1beb 100644
--- a/api/controllers/console/app/agent_config_inspector.py
+++ b/api/controllers/console/app/agent_config_inspector.py
@@ -285,6 +285,7 @@ def _resolve_console_version(
account_id: str,
version_id: str | None,
draft_type: str | None,
+ for_write: bool = False,
) -> tuple[str, AgentConfigVersionKind]:
if version_id:
return version_id, AgentConfigVersionKind.SNAPSHOT
@@ -301,15 +302,27 @@ def _resolve_console_version(
if isinstance(draft_id, str) and draft_id:
return draft_id, AgentConfigVersionKind.BUILD_DRAFT
else:
+ if for_write:
+ prepared_draft = AgentComposerService.prepare_agent_composer_draft(
+ session=session, tenant_id=tenant_id, agent_id=agent_id, account_id=account_id
+ )
+ # Asset services open an independent session for the mutation.
+ draft_id = prepared_draft.id
+ session.commit()
+ return draft_id, AgentConfigVersionKind.DRAFT
state = AgentComposerService.load_agent_composer(session=session, tenant_id=tenant_id, agent_id=agent_id)
draft = state.get("draft") or {}
draft_id = draft.get("id")
- if isinstance(draft_id, str) and draft_id:
- # load_agent_composer creates the normal draft on first access.
- # Config asset services use their own SQLAlchemy session, so the
- # draft must be visible before we hand its id across that boundary.
- session.commit()
+ snapshot_id = (state.get("active_config_snapshot") or {}).get("id")
+ stale_inline_draft = (
+ (state.get("agent") or {}).get("scope") == "workflow_only"
+ and isinstance(snapshot_id, str)
+ and draft.get("base_snapshot_id") != snapshot_id
+ )
+ if isinstance(draft_id, str) and draft_id and not stale_inline_draft:
return draft_id, AgentConfigVersionKind.DRAFT
+ if isinstance(snapshot_id, str) and snapshot_id:
+ return snapshot_id, AgentConfigVersionKind.SNAPSHOT
except AgentVersionNotFoundError as exc:
raise AgentConfigServiceError(
"config_version_not_found",
@@ -339,6 +352,7 @@ def _resolve_target(
account_id=account_id,
version_id=version_id,
draft_type=draft_type,
+ for_write=request.method in {"POST", "PUT", "PATCH", "DELETE"},
)
return _ResolvedConsoleTarget(
tenant_id=tenant_id,
diff --git a/api/services/agent/composer_service.py b/api/services/agent/composer_service.py
index ed66bff8339..7f2a130516d 100644
--- a/api/services/agent/composer_service.py
+++ b/api/services/agent/composer_service.py
@@ -388,6 +388,16 @@ class AgentComposerService:
agent = cls._require_agent(session=session, tenant_id=tenant_id, agent_id=agent_id)
return cls._load_agent_composer_for_agent(session=session, tenant_id=tenant_id, agent=agent)
+ @classmethod
+ def prepare_agent_composer_draft(
+ cls, *, session: Session, tenant_id: str, agent_id: str, account_id: str
+ ) -> AgentConfigDraft:
+ """Prepare a persisted normal draft for an explicit configuration write."""
+ agent = cls._require_agent(session=session, tenant_id=tenant_id, agent_id=agent_id)
+ return cls.get_or_create_normal_agent_draft(
+ session=session, tenant_id=tenant_id, agent=agent, created_by=account_id
+ )
+
@classmethod
def load_agent_soul_for_debug(
cls,
@@ -416,22 +426,38 @@ class AgentComposerService:
@classmethod
def _load_agent_composer_for_agent(cls, *, session: Session, tenant_id: str, agent: Agent) -> dict[str, Any]:
- draft = cls.get_or_create_normal_agent_draft(
+ """Read effective configuration without creating or rebasing persisted drafts.
+
+ Stale workflow-only drafts read from the current snapshot. Their draft
+ metadata still describes the persisted row; write paths own rebasing.
+ """
+ draft = cls._get_agent_draft(
session=session,
tenant_id=tenant_id,
- agent=agent,
- created_by=agent.updated_by or agent.created_by,
+ agent_id=agent.id,
+ draft_type=AgentConfigDraftType.DRAFT,
+ account_id=None,
)
version = cls._get_version_if_present(
session=session, tenant_id=tenant_id, agent_id=agent.id, version_id=agent.active_config_snapshot_id
)
+ if draft is None or (
+ agent.scope == AgentScope.WORKFLOW_ONLY
+ and agent.active_config_snapshot_id
+ and draft.base_snapshot_id != agent.active_config_snapshot_id
+ ):
+ if version is None:
+ raise AgentVersionNotFoundError()
+ agent_soul = version.config_snapshot_dict
+ else:
+ agent_soul = draft.config_snapshot_dict
return {
"variant": ComposerVariant.AGENT_APP.value,
"agent": cls._serialize_agent(agent),
"active_config_snapshot": cls._serialize_version(version),
"active_config_is_published": bool(agent.active_config_snapshot_id and agent.active_config_is_published),
"draft": cls._serialize_draft(draft),
- "agent_soul": draft.config_snapshot_dict,
+ "agent_soul": agent_soul,
"save_options": [ComposerSaveStrategy.SAVE_TO_CURRENT_VERSION.value],
"app_id": agent.app_id,
"backing_app_id": agent.backing_app_id or agent.app_id,
@@ -1982,6 +2008,9 @@ class AgentComposerService:
account_id: str | None,
created_by: str | None,
) -> AgentConfigDraft:
+ # All draft writers lock the parent before checking for an absent draft.
+ # Locking a draft query alone cannot serialize concurrent first writes.
+ session.scalar(select(Agent.id).where(Agent.tenant_id == tenant_id, Agent.id == agent.id).with_for_update())
draft = cls._get_agent_draft(
session=session,
tenant_id=tenant_id,
diff --git a/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.py b/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.py
index f6c832957fb..ee10c5dc19f 100644
--- a/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.py
+++ b/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.py
@@ -1648,6 +1648,21 @@ def test_agent_composer_routes_resolve_app_from_agent_id(
assert cast(dict[str, object], captured["candidates"])["agent_id"] == agent_id
+def test_agent_composer_get_uses_read_only_session() -> None:
+ assert "@with_session(write=False)\n def get" in getsource(AgentComposerApi)
+
+
+def test_agent_composer_get_accepts_missing_draft(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:
+ payload = _agent_app_composer_response()
+ payload["draft"] = None
+ payload["agent_soul"] = {"prompt": {"system_prompt": "read-only snapshot"}}
+ monkeypatch.setattr(composer_controller.AgentComposerService, "load_agent_composer", lambda **_kwargs: payload)
+ with app.test_request_context():
+ result = unwrap(AgentComposerApi.get)(AgentComposerApi(), MagicMock(), "tenant-1", "agent-1")
+ assert result["draft"] is None
+ assert result["agent_soul"]["prompt"]["system_prompt"] == "read-only snapshot"
+
+
def test_agent_chat_generate_and_stop_routes_resolve_app_from_agent_id(
app: Flask, monkeypatch: pytest.MonkeyPatch, account_id: str, unbound_session: Session
) -> None:
diff --git a/api/tests/unit_tests/controllers/console/app/test_agent_config_inspector.py b/api/tests/unit_tests/controllers/console/app/test_agent_config_inspector.py
index 5f56a408ff1..94e6458edf8 100644
--- a/api/tests/unit_tests/controllers/console/app/test_agent_config_inspector.py
+++ b/api/tests/unit_tests/controllers/console/app/test_agent_config_inspector.py
@@ -7,6 +7,7 @@ workflow-node agent binding, and service delegation for the new config surface.
from __future__ import annotations
from inspect import unwrap
+from types import SimpleNamespace
from unittest.mock import MagicMock, patch
from flask import Flask
@@ -119,7 +120,7 @@ def test_manifest_resolves_workflow_node_agent_and_normal_draft(unbound_session:
assert config_service.return_value.manifest.call_args.kwargs["config_version_kind"].value == "draft"
-def test_normal_draft_resolution_commits_created_draft_before_service_session(sqlite_session: Session) -> None:
+def test_normal_draft_read_resolution_does_not_commit(sqlite_session: Session) -> None:
session = sqlite_session
commits: list[str] = []
event.listen(session, "after_commit", lambda _session: commits.append("commit"))
@@ -135,6 +136,64 @@ def test_normal_draft_resolution_commits_created_draft_before_service_session(sq
)
assert version_id == "draft-1"
assert version_kind.value == "draft"
+ assert commits == []
+
+
+def test_normal_config_reads_fall_back_to_snapshot_without_creating_draft(unbound_session: Session) -> None:
+ with patch(f"{_MOD}.AgentComposerService") as composer:
+ composer.load_agent_composer.return_value = {"draft": None, "active_config_snapshot": {"id": "snapshot-1"}}
+ version_id, version_kind = inspector._resolve_console_version(
+ session=unbound_session,
+ tenant_id="tenant-1",
+ agent_id="agent-1",
+ account_id="acct-1",
+ version_id=None,
+ draft_type="draft",
+ )
+ composer.prepare_agent_composer_draft.assert_not_called()
+ assert version_id == "snapshot-1"
+ assert version_kind.value == "snapshot"
+
+
+def test_stale_inline_config_reads_use_effective_snapshot(unbound_session: Session) -> None:
+ with patch(f"{_MOD}.AgentComposerService") as composer:
+ composer.load_agent_composer.return_value = {
+ "agent": {"scope": "workflow_only"},
+ "draft": {"id": "draft-1", "base_snapshot_id": "snapshot-1"},
+ "active_config_snapshot": {"id": "snapshot-2"},
+ }
+ version_id, version_kind = inspector._resolve_console_version(
+ session=unbound_session,
+ tenant_id="tenant-1",
+ agent_id="agent-1",
+ account_id="acct-1",
+ version_id=None,
+ draft_type="draft",
+ )
+ composer.prepare_agent_composer_draft.assert_not_called()
+ assert version_id == "snapshot-2"
+ assert version_kind.value == "snapshot"
+
+
+def test_config_write_prepares_draft_before_independent_service_session(sqlite_session: Session) -> None:
+ commits: list[str] = []
+ event.listen(sqlite_session, "after_commit", lambda _session: commits.append("commit"))
+ with app.test_request_context("/", method="POST"), patch(f"{_MOD}.AgentComposerService") as composer:
+ composer.prepare_agent_composer_draft.return_value = SimpleNamespace(id="draft-1")
+ target = inspector._resolve_target(
+ session=sqlite_session,
+ tenant_id="tenant-1",
+ agent_id="agent-1",
+ account_id="acct-1",
+ version_id=None,
+ draft_type="draft",
+ )
+ composer.prepare_agent_composer_draft.assert_called_once_with(
+ session=sqlite_session, tenant_id="tenant-1", agent_id="agent-1", account_id="acct-1"
+ )
+ composer.load_agent_composer.assert_not_called()
+ assert target.version_id == "draft-1"
+ assert target.version_kind.value == "draft"
assert commits == ["commit"]
diff --git a/api/tests/unit_tests/services/agent/test_agent_services.py b/api/tests/unit_tests/services/agent/test_agent_services.py
index 43ed0043d64..7b1558e7999 100644
--- a/api/tests/unit_tests/services/agent/test_agent_services.py
+++ b/api/tests/unit_tests/services/agent/test_agent_services.py
@@ -706,7 +706,7 @@ def test_load_agent_app_composer_exposes_draft_save_only(monkeypatch: pytest.Mon
draft = AgentConfigDraft(config_snapshot=AgentSoulConfig.model_validate({"prompt": {"system_prompt": "x"}}))
monkeypatch.setattr(AgentComposerService, "_require_agent_app_agent", lambda **kwargs: agent)
- monkeypatch.setattr(AgentComposerService, "_get_or_create_agent_draft", lambda **kwargs: draft)
+ monkeypatch.setattr(AgentComposerService, "_get_agent_draft", lambda **kwargs: draft)
monkeypatch.setattr(AgentComposerService, "_get_version_if_present", lambda **kwargs: None)
monkeypatch.setattr(AgentComposerService, "_serialize_agent", lambda _agent: {"id": _agent.id})
monkeypatch.setattr(AgentComposerService, "_serialize_version", lambda _version: None)
@@ -718,6 +718,133 @@ def test_load_agent_app_composer_exposes_draft_save_only(monkeypatch: pytest.Mon
assert result["active_config_is_published"] is True
[email protected]("scope", [AgentScope.ROSTER, AgentScope.WORKFLOW_ONLY])
[email protected]("draft_state", ["missing", "current", "stale"])
+def test_load_agent_composer_never_persists_draft_changes(
+ sqlite_session: Session, scope: AgentScope, draft_state: str
+) -> None:
+ session = sqlite_session
+ agent = _agent(scope=scope)
+ agent.active_config_snapshot_id = "snapshot-2"
+ agent.active_config_is_published = True
+ snapshot = _snapshot(
+ snapshot_id="snapshot-2",
+ version=2,
+ agent_soul=AgentSoulConfig.model_validate({"prompt": {"system_prompt": "snapshot"}}),
+ )
+ draft = None
+ session.add_all([agent, snapshot])
+ if draft_state != "missing":
+ draft = AgentConfigDraft(
+ tenant_id=agent.tenant_id,
+ agent_id=agent.id,
+ draft_type=AgentConfigDraftType.DRAFT,
+ account_id=None,
+ draft_owner_key="",
+ base_snapshot_id="snapshot-1" if draft_state == "stale" else snapshot.id,
+ config_snapshot=AgentSoulConfig.model_validate({"prompt": {"system_prompt": "draft edit"}}),
+ created_by="account-1",
+ updated_by="account-1",
+ )
+ session.add(draft)
+ session.commit()
+ original_draft = AgentComposerService._serialize_draft(draft)
+ original_agent = AgentComposerService._serialize_agent(agent)
+ original_config = draft.config_snapshot_dict if draft is not None else None
+ flushes: list[str] = []
+ event.listen(session, "before_flush", lambda *_args: flushes.append("flush"))
+
+ for _ in range(3):
+ result = AgentComposerService.load_agent_composer(session=session, tenant_id=agent.tenant_id, agent_id=agent.id)
+ expected_prompt = (
+ "snapshot"
+ if draft_state == "missing" or (scope == AgentScope.WORKFLOW_ONLY and draft_state == "stale")
+ else "draft edit"
+ )
+ assert result["agent_soul"]["prompt"]["system_prompt"] == expected_prompt
+ assert result["draft"] == original_draft
+ assert result["agent"] == original_agent
+ assert result["active_config_is_published"] is True
+ assert not session.new
+ assert not session.dirty
+ session.commit()
+ assert flushes == []
+ persisted = session.scalars(select(AgentConfigDraft).where(AgentConfigDraft.agent_id == agent.id)).all()
+ assert len(persisted) == (0 if draft is None else 1)
+ if draft is not None:
+ session.refresh(draft)
+ assert AgentComposerService._serialize_draft(draft) == original_draft
+ assert draft.config_snapshot_dict == original_config
+
+
[email protected]("snapshot_state", ["no_pointer", "missing", "wrong_tenant", "wrong_agent"])
+def test_load_agent_composer_requires_owned_snapshot_without_draft(
+ sqlite_session: Session, snapshot_state: str
+) -> None:
+ agent = _agent()
+ agent.active_config_snapshot_id = None if snapshot_state == "no_pointer" else "snapshot-1"
+ sqlite_session.add(agent)
+ if snapshot_state in {"wrong_tenant", "wrong_agent"}:
+ sqlite_session.add(
+ _snapshot(
+ tenant_id="other-tenant" if snapshot_state == "wrong_tenant" else agent.tenant_id,
+ agent_id="other-agent" if snapshot_state == "wrong_agent" else agent.id,
+ )
+ )
+ sqlite_session.commit()
+ with pytest.raises(AgentVersionNotFoundError):
+ AgentComposerService.load_agent_composer(session=sqlite_session, tenant_id=agent.tenant_id, agent_id=agent.id)
+ assert not sqlite_session.new
+ assert not sqlite_session.dirty
+
+
+def test_load_agent_composer_does_not_select_personal_build_draft(sqlite_session: Session) -> None:
+ agent = _agent()
+ snapshot = _snapshot()
+ agent.active_config_snapshot_id = snapshot.id
+ build_draft = AgentConfigDraft(
+ tenant_id=agent.tenant_id,
+ agent_id=agent.id,
+ draft_type=AgentConfigDraftType.DEBUG_BUILD,
+ account_id="account-1",
+ draft_owner_key="account-1",
+ config_snapshot=AgentSoulConfig.model_validate({"prompt": {"system_prompt": "private build"}}),
+ )
+ sqlite_session.add_all([agent, snapshot, build_draft])
+ sqlite_session.commit()
+ result = AgentComposerService.load_agent_composer(
+ session=sqlite_session, tenant_id=agent.tenant_id, agent_id=agent.id
+ )
+ assert result["draft"] is None
+ assert result["agent_soul"] == snapshot.config_snapshot_dict
+ assert not sqlite_session.new
+ assert not sqlite_session.dirty
+
+
+def test_prepare_agent_composer_draft_creates_only_for_explicit_write(sqlite_session: Session) -> None:
+ agent = _agent()
+ snapshot = _snapshot()
+ agent.active_config_snapshot_id = snapshot.id
+ sqlite_session.add_all([agent, snapshot])
+ sqlite_session.commit()
+ result = AgentComposerService.load_agent_composer(
+ session=sqlite_session, tenant_id=agent.tenant_id, agent_id=agent.id
+ )
+ assert result["draft"] is None
+ draft = AgentComposerService.prepare_agent_composer_draft(
+ session=sqlite_session, tenant_id=agent.tenant_id, agent_id=agent.id, account_id="account-2"
+ )
+ sqlite_session.commit()
+ assert draft.config_snapshot_dict == snapshot.config_snapshot_dict
+ assert draft.created_by == "account-2"
+ assert (
+ AgentComposerService.prepare_agent_composer_draft(
+ session=sqlite_session, tenant_id=agent.tenant_id, agent_id=agent.id, account_id="account-2"
+ ).id
+ == draft.id
+ )
+
+
def test_save_agent_app_composer_rejects_version_save_strategy(sqlite_session: Session):
session = sqlite_session
payload = ComposerSavePayload.model_validate(