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.

refactor(models): remove implicit-session AppModelConfig.annotation_reply_dict (#43024)

Keith855842410aaf
diff --git a/api/controllers/mcp/mcp.py b/api/controllers/mcp/mcp.py
index 65e240827eb..98ac0acce18 100644
--- a/api/controllers/mcp/mcp.py
+++ b/api/controllers/mcp/mcp.py
@@ -195,8 +195,7 @@ class MCPAppApi(Resource):
app_model_config = app.app_model_config_with_session(session=session)
if not app_model_config:
raise MCPRequestError(mcp_types.INVALID_REQUEST, "App is unavailable")
- features_dict = app_model_config.to_dict()
- raw_user_input_form = features_dict.get("user_input_form", [])
+ raw_user_input_form = app_model_config.user_input_form_list
# Convert to VariableEntity objects
try:
diff --git a/api/core/app/apps/agent_chat/app_config_manager.py b/api/core/app/apps/agent_chat/app_config_manager.py
index 80e6e5a322b..8cd0da34c4a 100644
--- a/api/core/app/apps/agent_chat/app_config_manager.py
+++ b/api/core/app/apps/agent_chat/app_config_manager.py
@@ -62,6 +62,8 @@ class AgentChatAppConfigManager(BaseAppConfigManager):
config_from = EasyUIBasedAppModelConfigFrom.APP_LATEST_CONFIG
if config_from != EasyUIBasedAppModelConfigFrom.ARGS:
+ if annotation_reply is None:
+ raise ValueError("Annotation reply config is required")
app_model_config_dict = app_model_config.to_dict(annotation_reply=annotation_reply)
config_dict = app_model_config_dict.copy()
else:
diff --git a/api/core/app/apps/agent_chat/app_generator.py b/api/core/app/apps/agent_chat/app_generator.py
index 1c639758519..fc22015151d 100644
--- a/api/core/app/apps/agent_chat/app_generator.py
+++ b/api/core/app/apps/agent_chat/app_generator.py
@@ -138,9 +138,12 @@ class AgentChatAppGenerator(MessageBasedAppGenerator):
# always enable retriever resource in debugger mode
override_model_config_dict["retriever_resource"] = {"enabled": True}
- annotation_reply = (
- None if override_model_config_dict else load_annotation_reply_config(session, app_model_config.app_id)
- )
+ if override_model_config_dict:
+ annotation_reply = None
+ effective_model_config_dict = override_model_config_dict
+ else:
+ annotation_reply = load_annotation_reply_config(session, app_model_config.app_id)
+ effective_model_config_dict = app_model_config.to_dict(annotation_reply=annotation_reply)
# parse files
# TODO(QuantumGhost): Move file parsing logic to the API controller layer
@@ -150,9 +153,7 @@ class AgentChatAppGenerator(MessageBasedAppGenerator):
# `DraftWorkflowNodeRunApi` class which handle this properly.
with self._bind_file_access_scope(tenant_id=app_model.tenant_id, user=user, invoke_from=invoke_from):
files = args.get("files") or []
- file_extra_config = FileUploadConfigManager.convert(
- override_model_config_dict or app_model_config.to_dict(annotation_reply=annotation_reply)
- )
+ file_extra_config = FileUploadConfigManager.convert(effective_model_config_dict)
if file_extra_config:
file_objs = file_factory.build_from_mappings(
mappings=files,
diff --git a/api/core/app/apps/chat/app_config_manager.py b/api/core/app/apps/chat/app_config_manager.py
index 56c17b4b591..9bbb673fc86 100644
--- a/api/core/app/apps/chat/app_config_manager.py
+++ b/api/core/app/apps/chat/app_config_manager.py
@@ -55,6 +55,8 @@ class ChatAppConfigManager(BaseAppConfigManager):
config_from = EasyUIBasedAppModelConfigFrom.APP_LATEST_CONFIG
if config_from != EasyUIBasedAppModelConfigFrom.ARGS:
+ if annotation_reply is None:
+ raise ValueError("Annotation reply config is required")
app_model_config_dict = app_model_config.to_dict(annotation_reply=annotation_reply)
config_dict = app_model_config_dict.copy()
else:
diff --git a/api/core/app/apps/chat/app_generator.py b/api/core/app/apps/chat/app_generator.py
index a67b246233f..c9509f62ed0 100644
--- a/api/core/app/apps/chat/app_generator.py
+++ b/api/core/app/apps/chat/app_generator.py
@@ -133,9 +133,12 @@ class ChatAppGenerator(MessageBasedAppGenerator):
# always enable retriever resource in debugger mode
override_model_config_dict["retriever_resource"] = {"enabled": True}
- annotation_reply = (
- None if override_model_config_dict else load_annotation_reply_config(session, app_model_config.app_id)
- )
+ if override_model_config_dict:
+ annotation_reply = None
+ effective_model_config_dict = override_model_config_dict
+ else:
+ annotation_reply = load_annotation_reply_config(session, app_model_config.app_id)
+ effective_model_config_dict = app_model_config.to_dict(annotation_reply=annotation_reply)
# parse files
# TODO(QuantumGhost): Move file parsing logic to the API controller layer
@@ -145,9 +148,7 @@ class ChatAppGenerator(MessageBasedAppGenerator):
# `DraftWorkflowNodeRunApi` class which handle this properly.
with self._bind_file_access_scope(tenant_id=app_model.tenant_id, user=user, invoke_from=invoke_from):
files = args["files"] if args.get("files") else []
- file_extra_config = FileUploadConfigManager.convert(
- override_model_config_dict or app_model_config.to_dict(annotation_reply=annotation_reply)
- )
+ file_extra_config = FileUploadConfigManager.convert(effective_model_config_dict)
if file_extra_config:
file_objs = file_factory.build_from_mappings(
mappings=files,
diff --git a/api/core/app/apps/completion/app_config_manager.py b/api/core/app/apps/completion/app_config_manager.py
index 9f9b8702c4f..18d49c6edc4 100644
--- a/api/core/app/apps/completion/app_config_manager.py
+++ b/api/core/app/apps/completion/app_config_manager.py
@@ -46,6 +46,8 @@ class CompletionAppConfigManager(BaseAppConfigManager):
config_from = EasyUIBasedAppModelConfigFrom.APP_LATEST_CONFIG
if config_from != EasyUIBasedAppModelConfigFrom.ARGS:
+ if annotation_reply is None:
+ raise ValueError("Annotation reply config is required")
app_model_config_dict = app_model_config.to_dict(annotation_reply=annotation_reply)
config_dict = app_model_config_dict.copy()
else:
diff --git a/api/core/app/apps/completion/app_generator.py b/api/core/app/apps/completion/app_generator.py
index 3d1338a8bf6..3413a0480c9 100644
--- a/api/core/app/apps/completion/app_generator.py
+++ b/api/core/app/apps/completion/app_generator.py
@@ -119,9 +119,12 @@ class CompletionAppGenerator(MessageBasedAppGenerator):
tenant_id=app_model.tenant_id, config=args.get("model_config", {}), session=session
)
- annotation_reply = (
- None if override_model_config_dict else load_annotation_reply_config(session, app_model_config.app_id)
- )
+ if override_model_config_dict:
+ annotation_reply = None
+ effective_model_config_dict = override_model_config_dict
+ else:
+ annotation_reply = load_annotation_reply_config(session, app_model_config.app_id)
+ effective_model_config_dict = app_model_config.to_dict(annotation_reply=annotation_reply)
# parse files
# TODO(QuantumGhost): Move file parsing logic to the API controller layer
@@ -131,9 +134,7 @@ class CompletionAppGenerator(MessageBasedAppGenerator):
# `DraftWorkflowNodeRunApi` class which handle this properly.
with self._bind_file_access_scope(tenant_id=app_model.tenant_id, user=user, invoke_from=invoke_from):
files = args["files"] if args.get("files") else []
- file_extra_config = FileUploadConfigManager.convert(
- override_model_config_dict or app_model_config.to_dict(annotation_reply=annotation_reply)
- )
+ file_extra_config = FileUploadConfigManager.convert(effective_model_config_dict)
if file_extra_config:
file_objs = file_factory.build_from_mappings(
mappings=files,
diff --git a/api/models/model.py b/api/models/model.py
index c4482b15d0a..bf8c3d14347 100644
--- a/api/models/model.py
+++ b/api/models/model.py
@@ -806,10 +806,6 @@ class AppModelConfig(TypeBase):
def retriever_resource_dict(self) -> EnabledConfig:
return self._get_enabled_config(self.retriever_resource, default_enabled=True)
- @property
- def annotation_reply_dict(self) -> AnnotationReplyConfig:
- return load_annotation_reply_config(db.session(), self.app_id)
-
@property
def more_like_this_dict(self) -> EnabledConfig:
return self._get_enabled_config(self.more_like_this)
@@ -879,7 +875,7 @@ class AppModelConfig(TypeBase):
},
)
- def to_dict(self, *, annotation_reply: AnnotationReplyConfig | None = None) -> AppModelConfigDict:
+ def to_dict(self, *, annotation_reply: AnnotationReplyConfig) -> AppModelConfigDict:
return {
"opening_statement": self.opening_statement,
"suggested_questions": self.suggested_questions_list,
@@ -887,7 +883,7 @@ class AppModelConfig(TypeBase):
"speech_to_text": self.speech_to_text_dict,
"text_to_speech": self.text_to_speech_dict,
"retriever_resource": self.retriever_resource_dict,
- "annotation_reply": annotation_reply if annotation_reply is not None else self.annotation_reply_dict,
+ "annotation_reply": annotation_reply,
"more_like_this": self.more_like_this_dict,
"sensitive_word_avoidance": self.sensitive_word_avoidance_dict,
"external_data_tools": self.external_data_tools_list,
diff --git a/api/tests/test_containers_integration_tests/models/test_app_model_config.py b/api/tests/test_containers_integration_tests/models/test_app_model_config.py
index e8b36097e14..b093861e888 100644
--- a/api/tests/test_containers_integration_tests/models/test_app_model_config.py
+++ b/api/tests/test_containers_integration_tests/models/test_app_model_config.py
@@ -8,21 +8,21 @@ from uuid import uuid4
from sqlalchemy.orm import Session
-from models.model import AppModelConfig
+from models.model import AppModelConfig, load_annotation_reply_config
class TestAppModelConfig:
"""Integration tests for AppModelConfig."""
- def test_annotation_reply_dict_disabled_without_setting(self, db_session_with_containers: Session) -> None:
- """Return disabled annotation reply dict when no AppAnnotationSetting exists."""
+ def test_load_annotation_reply_config_disabled_without_setting(self, db_session_with_containers: Session) -> None:
+ """Return disabled annotation reply config when no AppAnnotationSetting exists."""
# Arrange
config = AppModelConfig(app_id=str(uuid4()))
db_session_with_containers.add(config)
db_session_with_containers.commit()
# Act
- result = config.annotation_reply_dict
+ result = load_annotation_reply_config(db_session_with_containers, config.app_id)
# Assert
assert result == {"enabled": False}
diff --git a/api/tests/unit_tests/core/app/apps/agent_chat/test_agent_chat_app_config_manager.py b/api/tests/unit_tests/core/app/apps/agent_chat/test_agent_chat_app_config_manager.py
index 273764e1eba..d015294b737 100644
--- a/api/tests/unit_tests/core/app/apps/agent_chat/test_agent_chat_app_config_manager.py
+++ b/api/tests/unit_tests/core/app/apps/agent_chat/test_agent_chat_app_config_manager.py
@@ -166,6 +166,15 @@ class TestAgentChatAppConfigManagerGetAppConfig:
assert result.app_model_config_from.value == "app-latest-config"
to_dict.assert_called_once_with(annotation_reply=annotation_reply)
+ def test_get_app_config_requires_annotation_reply_without_override(self):
+ with pytest.raises(ValueError, match="Annotation reply config is required"):
+ AgentChatAppConfigManager.get_app_config(
+ app_model=_app(),
+ app_model_config=_config(),
+ conversation=None,
+ annotation_reply=None,
+ )
+
class TestAgentChatAppConfigManagerConfigValidate:
def test_config_validate_filters_related_keys(self, mocker: MockerFixture):
diff --git a/api/tests/unit_tests/core/app/apps/chat/test_app_config_manager.py b/api/tests/unit_tests/core/app/apps/chat/test_app_config_manager.py
index 4f43e5fe045..2acd2137278 100644
--- a/api/tests/unit_tests/core/app/apps/chat/test_app_config_manager.py
+++ b/api/tests/unit_tests/core/app/apps/chat/test_app_config_manager.py
@@ -1,6 +1,7 @@
import json
from unittest.mock import patch
+import pytest
from sqlalchemy.orm import Session
from core.app.app_config.entities import EasyUIBasedAppModelConfigFrom, ModelConfigEntity, PromptTemplateEntity
@@ -87,6 +88,14 @@ class TestChatAppConfigManager:
to_dict.assert_called_once_with(annotation_reply=annotation_reply)
+ def test_get_app_config_requires_annotation_reply_without_override(self):
+ with pytest.raises(ValueError, match="Annotation reply config is required"):
+ ChatAppConfigManager.get_app_config(
+ app_model=_app(),
+ app_model_config=_app_model_config(),
+ annotation_reply=None,
+ )
+
def test_config_validate_filters_related_keys(self, unbound_session: Session):
config = {"extra": 1}
diff --git a/api/tests/unit_tests/core/app/apps/completion/test_completion_app_config_manager.py b/api/tests/unit_tests/core/app/apps/completion/test_completion_app_config_manager.py
index 96cd3796c9f..ef524d64059 100644
--- a/api/tests/unit_tests/core/app/apps/completion/test_completion_app_config_manager.py
+++ b/api/tests/unit_tests/core/app/apps/completion/test_completion_app_config_manager.py
@@ -1,5 +1,6 @@
from types import SimpleNamespace
+import pytest
from pytest_mock import MockerFixture
from sqlalchemy.orm import Session
@@ -81,6 +82,14 @@ class TestCompletionAppConfigManager:
assert result.app_model_config_dict == {"model": {"provider": "x"}}
to_dict.assert_called_once_with(annotation_reply=annotation_reply)
+ def test_get_app_config_requires_annotation_reply_without_override(self):
+ with pytest.raises(ValueError, match="Annotation reply config is required"):
+ CompletionAppConfigManager.get_app_config(
+ app_model=_app(),
+ app_model_config=_config(),
+ annotation_reply=None,
+ )
+
def test_config_validate_filters_related_keys(self, mocker: MockerFixture, unbound_session: Session):
config = {
"model": {"provider": "x"},
diff --git a/api/tests/unit_tests/models/test_app_models.py b/api/tests/unit_tests/models/test_app_models.py
index 41770a55d9b..f1a1e8280df 100644
--- a/api/tests/unit_tests/models/test_app_models.py
+++ b/api/tests/unit_tests/models/test_app_models.py
@@ -11,7 +11,7 @@ This test suite covers:
import json
from datetime import UTC, datetime
from decimal import Decimal
-from unittest.mock import PropertyMock, patch
+from unittest.mock import patch
from uuid import UUID, uuid4
import pytest
@@ -21,6 +21,7 @@ from sqlalchemy.orm import Session
from models.dataset import DatasetCollectionBinding
from models.enums import CollectionBindingType, ConversationFromSource, CustomizeTokenStrategy
from models.model import (
+ AnnotationReplyConfig,
App,
AppAnnotationHitHistory,
AppAnnotationSetting,
@@ -531,15 +532,9 @@ class TestAppModelConfig:
def test_to_dict_uses_injected_annotation_reply(self):
config = AppModelConfig(app_id=str(uuid4()))
- annotation_reply = {"enabled": False}
+ annotation_reply: AnnotationReplyConfig = {"enabled": False}
- with patch.object(
- AppModelConfig,
- "annotation_reply_dict",
- new_callable=PropertyMock,
- side_effect=AssertionError("annotation_reply_dict should not be accessed"),
- ):
- result = config.to_dict(annotation_reply=annotation_reply)
+ result = config.to_dict(annotation_reply=annotation_reply)
assert result["annotation_reply"] == annotation_reply