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.
Python agentagentic-aiagentic-frameworkagentic-workflowaiautomationclaudedeepseekgenaigptllmlow-codemcpnextjsno-codeopenaipythonskillsworkflow
fix(agent): reject incompatible session snapshots (#41447)
zyssyz123ad86351cc1d1
diff --git a/api/controllers/console/app/completion.py b/api/controllers/console/app/completion.pyindex cfa18235cd0..5f3982a65dc 100644--- a/api/controllers/console/app/completion.py+++ b/api/controllers/console/app/completion.py@@ -16,6 +16,7 @@ from controllers.common.schema import register_response_schema_models, register_from controllers.console import console_nsfrom controllers.console.agent.app_helpers import resolve_agent_runtime_app_modelfrom controllers.console.app.error import (+ AgentSessionConfigurationChangedError,AppUnavailableError,CompletionRequestError,ConversationCompletedError,@@ -620,6 +621,10 @@ def _raise_agent_stream_error_before_response(response):if isinstance(response, _ClosableStream):response.close()message = error_payload.get("message")+ if error_payload.get("code") == AgentSessionConfigurationChangedError.error_code:+ raise AgentSessionConfigurationChangedError(+ str(message or AgentSessionConfigurationChangedError.description)+ )raise CompletionRequestError(str(message or "Agent App chat failed."))return _prepend_stream_chunks(buffered, chunk, iterator)diff --git a/api/controllers/console/app/error.py b/api/controllers/console/app/error.pyindex 1bb6fafb224..2a84336596e 100644--- a/api/controllers/console/app/error.py+++ b/api/controllers/console/app/error.py@@ -1,3 +1,7 @@+from core.app.apps.agent_app.errors import (+ AGENT_SESSION_CONFIGURATION_CHANGED_ERROR_CODE,+ AGENT_SESSION_CONFIGURATION_CHANGED_MESSAGE,+)from libs.exception import BaseHTTPException@@ -49,6 +53,12 @@ class CompletionRequestError(BaseHTTPException):code = 400+class AgentSessionConfigurationChangedError(BaseHTTPException):+ error_code = AGENT_SESSION_CONFIGURATION_CHANGED_ERROR_CODE+ description = AGENT_SESSION_CONFIGURATION_CHANGED_MESSAGE+ code = 409++class AppMoreLikeThisDisabledError(BaseHTTPException):error_code = "app_more_like_this_disabled"description = "The 'More like this' feature is disabled. Please refresh your page."diff --git a/api/core/app/apps/agent_app/app_generator.py b/api/core/app/apps/agent_app/app_generator.pyindex b2457a44a04..5381cd4b1c3 100644--- a/api/core/app/apps/agent_app/app_generator.py+++ b/api/core/app/apps/agent_app/app_generator.py@@ -31,7 +31,11 @@ from core.agent.publish_visibility import agent_has_workflow_callable_active_snafrom core.app.app_config.easy_ui_based_app.model_config.converter import ModelConfigConverterfrom core.app.apps.agent_app.app_config_manager import AgentAppConfigManagerfrom core.app.apps.agent_app.app_runner import AgentAppRunner-from core.app.apps.agent_app.errors import AgentAppGeneratorError, AgentAppNotPublishedError+from core.app.apps.agent_app.errors import (+ AgentAppGeneratorError,+ AgentAppNotPublishedError,+ AgentSessionSnapshotIncompatibleError,+)from core.app.apps.agent_app.generate_response_converter import AgentAppGenerateResponseConverterfrom core.app.apps.agent_app.runtime_request_builder import AgentAppRuntimeRequestBuilderfrom core.app.apps.agent_app.session_store import AgentAppWorkspaceStore@@ -531,6 +535,15 @@ class AgentAppGenerator(MessageBasedAppGenerator):)except GenerateTaskStoppedError:pass+ except AgentSessionSnapshotIncompatibleError as error:+ logger.info(+ "Agent App session snapshot no longer matches the current composition",+ extra={+ "agent_id": application_generate_entity.agent_id,+ "conversation_id": conversation_id,+ },+ )+ queue_manager.publish_error(error, PublishFrom.APPLICATION_MANAGER)except Exception as e:logger.exception("Unknown Error in Agent App generate worker")queue_manager.publish_error(e, PublishFrom.APPLICATION_MANAGER)diff --git a/api/core/app/apps/agent_app/errors.py b/api/core/app/apps/agent_app/errors.pyindex 51b4e77116a..bdcd38abfdf 100644--- a/api/core/app/apps/agent_app/errors.py+++ b/api/core/app/apps/agent_app/errors.py@@ -1,6 +1,24 @@+from core.app.apps.exc import AppGenerateError++AGENT_SESSION_CONFIGURATION_CHANGED_ERROR_CODE = "agent_session_configuration_changed"+AGENT_SESSION_CONFIGURATION_CHANGED_MESSAGE = (+ "The Agent configuration changed after this conversation started. Start a new conversation to continue."+)++class AgentAppGeneratorError(ValueError):"""Raised when an Agent App turn cannot be set up."""class AgentAppNotPublishedError(AgentAppGeneratorError):"""Raised when a public Agent App runtime is requested before publish."""+++class AgentSessionSnapshotIncompatibleError(AppGenerateError):+ """Raised when a retained session snapshot no longer matches the current composition."""++ error_code = AGENT_SESSION_CONFIGURATION_CHANGED_ERROR_CODE+ status_code = 409++ def __init__(self) -> None:+ super().__init__(AGENT_SESSION_CONFIGURATION_CHANGED_MESSAGE)diff --git a/api/core/app/apps/agent_app/runtime_request_builder.py b/api/core/app/apps/agent_app/runtime_request_builder.pyindex 23b93d2f9bb..70c813d0fd5 100644--- a/api/core/app/apps/agent_app/runtime_request_builder.py+++ b/api/core/app/apps/agent_app/runtime_request_builder.py@@ -50,6 +50,8 @@ from models.agent_config_entities import AgentSoulConfig, AgentSoulToolsConfigfrom models.provider_ids import ModelProviderIDfrom services.agent.prompt_mentions import expand_prompt_mentions+from .errors import AgentSessionSnapshotIncompatibleError+class AgentAppRuntimeRequestBuildError(ValueError):"""Raised when Agent App state cannot be mapped to a valid run request."""@@ -191,6 +193,7 @@ class AgentAppRuntimeRequestBuilder:metadata=metadata,))+ self._validate_session_snapshot_layers(request)redacted = cast(dict[str, Any], redact_for_agent_backend_log(request))return AgentAppRuntimeRequest(request=request,@@ -199,6 +202,24 @@ class AgentAppRuntimeRequestBuilder:binding_id=context.binding_id,)+ @staticmethod+ def _validate_session_snapshot_layers(request: CreateRunRequest) -> None:+ """Reject stale snapshots before they reach the Agent backend.++ Draft rows are updated in place, so their IDs cannot prove that a+ retained snapshot still belongs to the current composition. Agenton+ requires the ordered layer names to match exactly; enforce the same+ invariant at the API boundary and return a product-level error.+ """++ snapshot = request.session_snapshot+ if snapshot is None:+ return+ snapshot_layer_names = tuple(layer.name for layer in snapshot.layers)+ composition_layer_names = tuple(layer.name for layer in request.composition.layers)+ if snapshot_layer_names != composition_layer_names:+ raise AgentSessionSnapshotIncompatibleError()+def _build_tool_layers(self,*,diff --git a/api/core/app/apps/base_app_generate_response_converter.py b/api/core/app/apps/base_app_generate_response_converter.pyindex aef54cc049e..0576bd48318 100644--- a/api/core/app/apps/base_app_generate_response_converter.py+++ b/api/core/app/apps/base_app_generate_response_converter.py@@ -7,6 +7,7 @@ from dify_agent.protocol import RunFailureTypefrom pydantic import JsonValuefrom clients.agent_backend.errors import AgentBackendError, AgentBackendRunFailedError+from core.app.apps.exc import AppGenerateErrorfrom core.app.entities.app_invoke_entities import InvokeFromfrom core.app.entities.task_entities import AppBlockingResponse, AppStreamResponsefrom core.errors.error import ModelCurrentlyNotSupportError, ProviderTokenNotInitError, QuotaExceededError@@ -125,6 +126,13 @@ class AppGenerateResponseConverter[TBlockingResponse: AppBlockingResponse](ABC):"message": str(e),}+ if isinstance(e, AppGenerateError):+ return {+ "code": e.error_code,+ "status": e.status_code,+ "message": str(e),+ }+error_responses: dict[type[Exception], dict[str, JsonValue]] = {ValueError: {"code": "invalid_param", "status": 400},ProviderTokenNotInitError: {"code": "provider_not_initialize", "status": 400},diff --git a/api/core/app/apps/exc.py b/api/core/app/apps/exc.pyindex 4187118b9bc..e5cb5d31b9a 100644--- a/api/core/app/apps/exc.py+++ b/api/core/app/apps/exc.py@@ -1,2 +1,9 @@+class AppGenerateError(ValueError):+ """Base class for application-generation errors with a stable response contract."""++ error_code: str+ status_code: int++class GenerateTaskStoppedError(Exception):passdiff --git a/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.py b/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.pyindex c2251709838..c2b43d8cb22 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@@ -55,7 +55,7 @@ from controllers.console.agent.roster import (from controllers.console.app import completion as completion_controllerfrom controllers.console.app import message as message_controllerfrom controllers.console.app.completion import AgentBuildChatFinalizeApi, AgentChatMessageApi, AgentChatMessageStopApi-from controllers.console.app.error import CompletionRequestError+from controllers.console.app.error import AgentSessionConfigurationChangedError, CompletionRequestErrorfrom controllers.console.app.message import (AgentChatMessageListApi,AgentMessageApi,@@ -1633,6 +1633,38 @@ def test_agent_chat_stream_preflight_raises_first_error_event() -> None:assert stream.closed is True+def test_agent_chat_stream_preflight_preserves_session_configuration_error() -> None:+ class ClosableStream:+ def __init__(self) -> None:+ self.closed = False+ self._chunks = iter(+ [+ "event: ping\n\n",+ (+ 'data: {"event":"error","message":"Start a new conversation to continue.",'+ '"code":"agent_session_configuration_changed","status":409}\n\n'+ ),+ ]+ )++ def __iter__(self):+ return self++ def __next__(self) -> str:+ return next(self._chunks)++ def close(self) -> None:+ self.closed = True++ stream = ClosableStream()+ with pytest.raises(AgentSessionConfigurationChangedError) as exc_info:+ completion_controller._raise_agent_stream_error_before_response(stream)+ assert exc_info.value.code == 409+ assert exc_info.value.error_code == "agent_session_configuration_changed"+ assert "Start a new conversation" in exc_info.value.description+ assert stream.closed is True++def test_agent_chat_stream_preflight_preserves_first_normal_event() -> None:stream = iter(["event: ping\n\n", 'data: {"event":"message","answer":"hello"}\n\n', 'data: {"event":"message_end"}\n\n']diff --git a/api/tests/unit_tests/core/app/apps/agent_app/test_app_generator.py b/api/tests/unit_tests/core/app/apps/agent_app/test_app_generator.pyindex ca0e989d9d1..f4a0c4e90f3 100644--- a/api/tests/unit_tests/core/app/apps/agent_app/test_app_generator.py+++ b/api/tests/unit_tests/core/app/apps/agent_app/test_app_generator.py@@ -21,6 +21,7 @@ from core.app.apps.agent_app.app_generator import (AgentAppGenerator,AgentAppGeneratorError,)+from core.app.apps.agent_app.errors import AgentSessionSnapshotIncompatibleErrorfrom core.app.apps.exc import GenerateTaskStoppedErrorfrom core.app.entities.app_invoke_entities import InvokeFrom, UserFromfrom core.app.entities.queue_entities import QueueAnnotationReplyEvent@@ -427,6 +428,23 @@ class TestGenerateWorker:self._call(generator, mocker, queue_manager)assert queue_manager.publish_error.called+ def test_session_configuration_change_is_published_without_unknown_error_log(+ self,+ generator: AgentAppGenerator,+ mocker: MockerFixture,+ ) -> None:+ error = AgentSessionSnapshotIncompatibleError()+ self._wire(generator, mocker, run_side_effect=error)+ queue_manager = mocker.MagicMock()+ info_log = mocker.patch(f"{MODULE}.logger.info")+ exception_log = mocker.patch(f"{MODULE}.logger.exception")++ self._call(generator, mocker, queue_manager)++ queue_manager.publish_error.assert_called_once_with(error, module.PublishFrom.APPLICATION_MANAGER)+ info_log.assert_called_once()+ exception_log.assert_not_called()+class TestResumeAfterFormSubmission:"""ENG-638: a resume turn re-sends the paused turn's original query so thediff --git a/api/tests/unit_tests/core/app/apps/agent_app/test_app_runner.py b/api/tests/unit_tests/core/app/apps/agent_app/test_app_runner.pyindex a9c27c61d47..1099a252dea 100644--- a/api/tests/unit_tests/core/app/apps/agent_app/test_app_runner.py+++ b/api/tests/unit_tests/core/app/apps/agent_app/test_app_runner.py@@ -12,7 +12,8 @@ from typing import Any, overridefrom unittest.mock import MagicMockimport pytest-from agenton.compositor import CompositorSessionSnapshot+from agenton.compositor import CompositorSessionSnapshot, LayerSessionSnapshot+from agenton.layers import LifecycleStatefrom dify_agent.layers.ask_human import AskHumanToolResultfrom dify_agent.protocol import (AgentRunUsage,@@ -52,7 +53,8 @@ from clients.agent_backend import ()from core.app.apps.agent_app import app_runner as app_runner_modulefrom core.app.apps.agent_app.app_runner import AgentAppRunner-from core.app.apps.agent_app.runtime_request_builder import AgentAppRuntimeRequestBuilder+from core.app.apps.agent_app.errors import AgentSessionSnapshotIncompatibleError+from core.app.apps.agent_app.runtime_request_builder import AgentAppRuntimeBuildContext, AgentAppRuntimeRequestBuilderfrom core.app.apps.agent_app.session_store import AgentAppSessionScope, StoredAgentAppSessionfrom core.app.apps.exc import GenerateTaskStoppedErrorfrom core.app.entities.app_invoke_entities import DifyRunContext, InvokeFrom, UserFrom@@ -628,6 +630,34 @@ def _dify_ctx() -> DifyRunContext:)+def _compatible_session_snapshot() -> CompositorSessionSnapshot:+ request = (+ AgentAppRuntimeRequestBuilder(+ dify_tools_builder=_NoToolsBuilder(), # type: ignore[arg-type]+ )+ .build(+ AgentAppRuntimeBuildContext(+ dify_context=_dify_ctx(),+ agent_id="agent-1",+ agent_config_snapshot_id="snap-1",+ agent_soul=_soul(),+ conversation_id="conv-1",+ user_query="hello",+ idempotency_key="msg-1",+ binding_id="binding-1",+ backend_binding_ref="backend-binding-1",+ )+ )+ .request+ )+ return CompositorSessionSnapshot(+ layers=[+ LayerSessionSnapshot(name=layer.name, lifecycle_state=LifecycleState.SUSPENDED, runtime_state={})+ for layer in request.composition.layers+ ]+ )++def _runner(client: FakeAgentBackendRunClient,store: _FakeSessionStore,@@ -1314,7 +1344,7 @@ def test_repeated_tool_calls_with_placeholder_call_id_and_reused_index_create_didef test_prior_session_snapshot_is_threaded_into_request() -> None:- prior = CompositorSessionSnapshot(layers=[])+ prior = _compatible_session_snapshot()client = FakeAgentBackendRunClient()store = _FakeSessionStore(loaded=prior)qm = _FakeQueueManager()@@ -1325,8 +1355,23 @@ def test_prior_session_snapshot_is_threaded_into_request() -> None:assert client.request.session_snapshot is prior+def test_incompatible_session_snapshot_is_rejected_before_backend_invocation() -> None:+ compatible = _compatible_session_snapshot()+ stale = CompositorSessionSnapshot(+ layers=[layer for layer in compatible.layers if layer.name != "agent_soul_prompt"]+ )+ client = FakeAgentBackendRunClient()+ store = _FakeSessionStore(loaded=stale)++ with pytest.raises(AgentSessionSnapshotIncompatibleError, match="Start a new conversation"):+ _run(_runner(client, store), _FakeQueueManager())++ assert client.request is None+ assert store.saved == []++def test_debug_session_scope_can_reuse_conversation_across_config_snapshots() -> None:- prior = CompositorSessionSnapshot(layers=[])+ prior = _compatible_session_snapshot()client = FakeAgentBackendRunClient()store = _FakeSessionStore(loaded=prior)qm = _FakeQueueManager()@@ -1599,7 +1644,7 @@ def test_ask_human_pauses_turn_creates_form_and_persists_correlation() -> None:def test_submitted_form_resumes_turn_with_deferred_tool_results(monkeypatch: pytest.MonkeyPatch) -> None:# ENG-638: a turn that runs while a pending form is answered threads the# human's reply into the request as deferred_tool_results.- snapshot = CompositorSessionSnapshot(layers=[])+ snapshot = _compatible_session_snapshot()stored = StoredAgentAppSession(scope=AgentAppSessionScope(tenant_id="tenant-1",diff --git a/api/tests/unit_tests/core/app/apps/agent_app/test_runtime_request_builder.py b/api/tests/unit_tests/core/app/apps/agent_app/test_runtime_request_builder.pyindex 987c15d7a39..db33a1ad03b 100644--- a/api/tests/unit_tests/core/app/apps/agent_app/test_runtime_request_builder.py+++ b/api/tests/unit_tests/core/app/apps/agent_app/test_runtime_request_builder.py@@ -6,6 +6,8 @@ from __future__ import annotationsfrom types import SimpleNamespaceimport pytest+from agenton.compositor import CompositorSessionSnapshot, LayerSessionSnapshot+from agenton.layers import LifecycleStatefrom dify_agent.layers.config import DifyConfigSkillConfigfrom dify_agent.layers.dify_core_tools import DifyCoreToolConfig, DifyCoreToolsLayerConfigfrom dify_agent.layers.dify_plugin import DifyPluginToolConfig, DifyPluginToolsLayerConfig@@ -20,6 +22,7 @@ from clients.agent_backend import (AgentBackendRunRequestBuilder,)from clients.agent_backend.request_builder import DIFY_SHELL_LAYER_ID+from core.app.apps.agent_app.errors import AgentSessionSnapshotIncompatibleErrorfrom core.app.apps.agent_app.runtime_request_builder import (AgentAppRuntimeBuildContext,AgentAppRuntimeRequestBuilder,@@ -164,6 +167,7 @@ def _ctx(*,query: str = "hello",agent_config_version_kind: str = "snapshot",+ session_snapshot: CompositorSessionSnapshot | None = None,) -> AgentAppRuntimeBuildContext:dify_context = SimpleNamespace(tenant_id="tenant-1",@@ -183,6 +187,7 @@ def _ctx(binding_id="binding-1",backend_binding_ref="binding-ref-1",agent_config_version_kind=agent_config_version_kind, # type: ignore[arg-type]+ session_snapshot=session_snapshot,)@@ -199,6 +204,15 @@ def _soul_with_model() -> AgentSoulConfig:)+def _snapshot_for_layer_names(layer_names: list[str]) -> CompositorSessionSnapshot:+ return CompositorSessionSnapshot(+ layers=[+ LayerSessionSnapshot(name=name, lifecycle_state=LifecycleState.SUSPENDED, runtime_state={})+ for name in layer_names+ ]+ )++class TestAgentAppRuntimeRequestBuilder:def test_build_maps_soul_to_run_request(self, model_context_window_calls: list[tuple[object, str, str]]):builder = AgentAppRuntimeRequestBuilder(@@ -237,6 +251,57 @@ class TestAgentAppRuntimeRequestBuilder:assert "credentials" not in result.redacted_request["composition"]["layers"][-1]["config"]assert result.metadata["conversation_id"] == "conv-1"+ @pytest.mark.parametrize(+ ("previous_prompt", "current_prompt"),+ [("", "You are Iris."), ("You are Iris.", "")],+ )+ def test_build_rejects_session_snapshot_after_layer_topology_changes(+ self,+ previous_prompt: str,+ current_prompt: str,+ ) -> None:+ builder = AgentAppRuntimeRequestBuilder(+ dify_tools_builder=_NoToolsBuilder(), # type: ignore[arg-type]+ )+ previous_soul = _soul_with_model()+ previous_soul.prompt.system_prompt = previous_prompt+ previous_request = builder.build(_ctx(previous_soul, agent_config_version_kind="draft")).request+ snapshot = _snapshot_for_layer_names([layer.name for layer in previous_request.composition.layers])+ current_soul = _soul_with_model()+ current_soul.prompt.system_prompt = current_prompt++ with pytest.raises(AgentSessionSnapshotIncompatibleError) as exc_info:+ builder.build(+ _ctx(+ current_soul,+ agent_config_version_kind="draft",+ session_snapshot=snapshot,+ )+ )++ assert exc_info.value.error_code == "agent_session_configuration_changed"+ assert exc_info.value.status_code == 409+ assert "Start a new conversation" in str(exc_info.value)++ def test_build_reuses_session_snapshot_when_config_changes_without_changing_layers(self) -> None:+ builder = AgentAppRuntimeRequestBuilder(+ dify_tools_builder=_NoToolsBuilder(), # type: ignore[arg-type]+ )+ previous_request = builder.build(_ctx(_soul_with_model(), agent_config_version_kind="draft")).request+ snapshot = _snapshot_for_layer_names([layer.name for layer in previous_request.composition.layers])+ current_soul = _soul_with_model()+ current_soul.prompt.system_prompt = "You are Ada."++ result = builder.build(+ _ctx(+ current_soul,+ agent_config_version_kind="draft",+ session_snapshot=snapshot,+ )+ )++ assert result.request.session_snapshot is snapshot+def test_build_wraps_agent_soul_prompt_for_build_draft(self):builder = AgentAppRuntimeRequestBuilder(dify_tools_builder=_NoToolsBuilder(), # type: ignore[arg-type]diff --git a/api/tests/unit_tests/core/app/task_pipeline/test_based_generate_task_pipeline.py b/api/tests/unit_tests/core/app/task_pipeline/test_based_generate_task_pipeline.pyindex 18c2fdd97a2..26b3f521a3e 100644--- a/api/tests/unit_tests/core/app/task_pipeline/test_based_generate_task_pipeline.py+++ b/api/tests/unit_tests/core/app/task_pipeline/test_based_generate_task_pipeline.py@@ -7,6 +7,7 @@ from dify_agent.protocol import RunFailureTypefrom sqlalchemy.orm import Sessionfrom clients.agent_backend.errors import AgentBackendRunFailedError+from core.app.apps.agent_app.errors import AgentSessionSnapshotIncompatibleErrorfrom core.app.apps.base_app_generate_response_converter import AppGenerateResponseConverterfrom core.app.entities.app_invoke_entities import InvokeFromfrom core.app.entities.queue_entities import QueueErrorEvent@@ -168,6 +169,17 @@ class TestBasedGenerateTaskPipeline:"message": "run limit reached (agent_run_id=run-1)",}+ def test_stream_converter_preserves_agent_session_configuration_error(self):+ data = AppGenerateResponseConverter._error_to_stream_response(AgentSessionSnapshotIncompatibleError())++ assert data == {+ "code": "agent_session_configuration_changed",+ "status": 409,+ "message": (+ "The Agent configuration changed after this conversation started. Start a new conversation to continue."+ ),+ }+def test_handle_output_moderation_when_flagged(self, pipeline):handler = Mock()handler.moderation_completion.return_value = ("filtered", True)