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(api): enable strict typing for easy UI dataset and prompt template tests (#44320)

Eddy ZHANG04bfd8996150
diff --git a/api/tests/unit_tests/.ruff.toml b/api/tests/unit_tests/.ruff.toml
index 7a4db424159..fa68d7611a2 100644
--- a/api/tests/unit_tests/.ruff.toml
+++ b/api/tests/unit_tests/.ruff.toml
@@ -82,7 +82,6 @@ extend-select = ["ANN401", "ARG"]
"core/agent/test_cot_agent_runner.py" = ["ARG001"]
"core/agent/test_cot_chat_agent_runner.py" = ["ARG002"]
"core/agent/test_fc_agent_runner.py" = ["TID251"]
-"core/app/app_config/easy_ui_based_app/test_dataset_manager.py" = ["ARG001", "ARG002"]
"core/app/app_config/easy_ui_based_app/test_model_config_converter.py" = ["ARG002"]
"core/app/app_config/easy_ui_based_app/test_variables_manager.py" = ["ARG002"]
"core/app/apps/advanced_chat/test_app_generator.py" = ["ARG001", "ARG002", "ARG005"]
diff --git a/api/tests/unit_tests/core/app/app_config/easy_ui_based_app/test_dataset_manager.py b/api/tests/unit_tests/core/app/app_config/easy_ui_based_app/test_dataset_manager.py
index fe42c66dc40..fd3726be4f5 100644
--- a/api/tests/unit_tests/core/app/app_config/easy_ui_based_app/test_dataset_manager.py
+++ b/api/tests/unit_tests/core/app/app_config/easy_ui_based_app/test_dataset_manager.py
@@ -1,4 +1,6 @@
import uuid
+from collections.abc import Mapping
+from typing import cast
import pytest
from pytest_mock import MockerFixture
@@ -8,7 +10,13 @@ from core.app.app_config.easy_ui_based_app.dataset.manager import DatasetConfigM
from core.app.app_config.entities import MetadataFilteringCondition, ModelConfig
from core.entities.agent_entities import PlanningStrategy
from models.dataset import Dataset
-from models.model import AppMode
+from models.model import AppMode, AppModelConfigDict
+
+
+def _app_model_config(config: Mapping[str, object]) -> AppModelConfigDict:
+ """App model configs are JSON loaded from the database; these tests build partial ones."""
+ return cast(AppModelConfigDict, config)
+
# ==============================
# Fixtures
@@ -16,50 +24,22 @@ from models.model import AppMode
@pytest.fixture
-def valid_uuid():
+def valid_uuid() -> str:
return str(uuid.uuid4())
-def base_config(valid_uuid):
- return {
- "dataset_configs": {
- "retrieval_model": "multiple",
- "datasets": {
- "strategy": "router",
- "datasets": [{"dataset": {"id": valid_uuid, "enabled": True}}],
- },
- }
- }
-
-
-def mock_dataset_service(mocker: MockerFixture, valid_uuid):
- dataset = Dataset(
- id=valid_uuid,
- tenant_id="tenant1",
- name="Test Dataset",
- created_by="account-1",
- )
-
- mocker.patch(
- "core.app.app_config.easy_ui_based_app.dataset.manager.DatasetService.get_dataset",
- return_value=dataset,
- )
-
-
# ==============================
# convert tests
# ==============================
class TestDatasetConfigManagerConvert:
- def test_convert_returns_none_when_no_datasets(self):
- config = {"dataset_configs": {"datasets": {"datasets": []}}}
- result = DatasetConfigManager.convert(config)
+ def test_convert_returns_none_when_no_datasets(self) -> None:
+ config = {"dataset_configs": {"datasets": {"datasets": list[object]()}}}
+ result = DatasetConfigManager.convert(_app_model_config(config))
assert result is None
- def test_convert_single_retrieval(self, valid_uuid):
+ def test_convert_single_retrieval(self, valid_uuid: str) -> None:
config = {
"dataset_query_variable": "query",
"dataset_configs": {
@@ -71,26 +51,26 @@ class TestDatasetConfigManagerConvert:
},
}
- result = DatasetConfigManager.convert(config)
+ result = DatasetConfigManager.convert(_app_model_config(config))
assert result is not None
assert result.dataset_ids == [valid_uuid]
assert result.retrieve_config.query_variable == "query"
- def test_convert_single_with_metadata_configs(self, valid_uuid):
+ def test_convert_single_with_metadata_configs(self, valid_uuid: str) -> None:
config = {
"dataset_query_variable": "query",
"dataset_configs": {
"retrieval_model": "single",
"metadata_filtering_mode": "manual",
"metadata_model_config": {"provider": "openai", "name": "gpt-4o", "mode": "chat"},
- "metadata_filtering_conditions": {"logical_operator": "or", "conditions": []},
+ "metadata_filtering_conditions": {"logical_operator": "or", "conditions": list[object]()},
"datasets": {
"strategy": "router",
"datasets": [{"dataset": {"id": valid_uuid, "enabled": True}}],
},
},
}
- result = DatasetConfigManager.convert(config)
+ result = DatasetConfigManager.convert(_app_model_config(config))
assert result is not None
assert result.dataset_ids == [valid_uuid]
assert result.retrieve_config.query_variable == "query"
@@ -102,7 +82,7 @@ class TestDatasetConfigManagerConvert:
logical_operator="or", conditions=[]
)
- def test_convert_multiple_defaults(self, valid_uuid):
+ def test_convert_multiple_defaults(self, valid_uuid: str) -> None:
config = {
"dataset_configs": {
"retrieval_model": "multiple",
@@ -112,38 +92,40 @@ class TestDatasetConfigManagerConvert:
},
}
}
- result = DatasetConfigManager.convert(config)
+ result = DatasetConfigManager.convert(_app_model_config(config))
+ assert result is not None
assert result.retrieve_config.top_k == 4
assert result.retrieve_config.score_threshold is None
assert result.retrieve_config.reranking_enabled is True
- def test_convert_agent_mode_disabled_tool(self, valid_uuid):
+ def test_convert_agent_mode_disabled_tool(self, valid_uuid: str) -> None:
config = {
"agent_mode": {
"enabled": True,
"tools": [{"dataset": {"id": valid_uuid, "enabled": False}}],
}
}
- result = DatasetConfigManager.convert(config)
+ result = DatasetConfigManager.convert(_app_model_config(config))
assert result is None
- def test_convert_dataset_configs_none(self):
- config = {"dataset_configs": None}
+ def test_convert_dataset_configs_none(self) -> None:
+ config: dict[str, object] = {"dataset_configs": None}
with pytest.raises(TypeError):
- DatasetConfigManager.convert(config)
+ DatasetConfigManager.convert(_app_model_config(config))
- def test_convert_agent_mode_old_style_old_format(self, valid_uuid):
+ def test_convert_agent_mode_old_style_old_format(self, valid_uuid: str) -> None:
config = {
"agent_mode": {
"enabled": True,
"tools": [{"dataset": {"id": valid_uuid, "enabled": True}}],
}
}
- result = DatasetConfigManager.convert(config)
+ result = DatasetConfigManager.convert(_app_model_config(config))
+ assert result is not None
assert result.dataset_ids == [valid_uuid]
assert result.retrieve_config.query_variable is None
- def test_convert_multiple_with_score_threshold(self, valid_uuid):
+ def test_convert_multiple_with_score_threshold(self, valid_uuid: str) -> None:
config = {
"dataset_query_variable": "query",
"dataset_configs": {
@@ -158,7 +140,8 @@ class TestDatasetConfigManagerConvert:
},
}
- result = DatasetConfigManager.convert(config)
+ result = DatasetConfigManager.convert(_app_model_config(config))
+ assert result is not None
assert result.retrieve_config.top_k == 5
assert result.retrieve_config.score_threshold == 0.8
@@ -171,24 +154,25 @@ class TestDatasetConfigManagerConvert:
{"dataset": {"id": "", "enabled": False}},
],
)
- def test_convert_ignores_invalid_dataset_entries(self, dataset_entry):
+ def test_convert_ignores_invalid_dataset_entries(self, dataset_entry: dict[str, object]) -> None:
config = {
"dataset_configs": {
"retrieval_model": "multiple",
"datasets": {"strategy": "router", "datasets": [dataset_entry]},
}
}
- result = DatasetConfigManager.convert(config)
+ result = DatasetConfigManager.convert(_app_model_config(config))
assert result is None
- def test_convert_agent_mode_old_style(self, valid_uuid):
+ def test_convert_agent_mode_old_style(self, valid_uuid: str) -> None:
config = {
"agent_mode": {
"enabled": True,
"tools": [{"dataset": {"id": valid_uuid, "enabled": True}}],
}
}
- result = DatasetConfigManager.convert(config)
+ result = DatasetConfigManager.convert(_app_model_config(config))
+ assert result is not None
assert result.dataset_ids == [valid_uuid]
@@ -198,7 +182,7 @@ class TestDatasetConfigManagerConvert:
class TestValidateAndSetDefaults:
- def test_validate_sets_defaults(self, unbound_session: Session):
+ def test_validate_sets_defaults(self, unbound_session: Session) -> None:
config = {}
updated, fields = DatasetConfigManager.validate_and_set_defaults(
"tenant1", AppMode.CHAT, config, unbound_session
@@ -207,12 +191,14 @@ class TestValidateAndSetDefaults:
assert updated["dataset_configs"]["retrieval_model"] == "single"
assert isinstance(fields, list)
- def test_validate_raises_when_dataset_configs_not_dict(self, unbound_session: Session):
+ def test_validate_raises_when_dataset_configs_not_dict(self, unbound_session: Session) -> None:
config = {"dataset_configs": "invalid"}
with pytest.raises(AttributeError):
DatasetConfigManager.validate_and_set_defaults("tenant1", AppMode.CHAT, config, unbound_session)
- def test_validate_requires_query_variable_in_completion_mode(self, valid_uuid, unbound_session: Session):
+ def test_validate_requires_query_variable_in_completion_mode(
+ self, valid_uuid: str, unbound_session: Session
+ ) -> None:
config = {
"dataset_configs": {
"datasets": {
@@ -231,7 +217,7 @@ class TestValidateAndSetDefaults:
class TestExtractDatasetConfig:
- def test_extract_sets_defaults(self, unbound_session: Session):
+ def test_extract_sets_defaults(self, unbound_session: Session) -> None:
config = {}
result = DatasetConfigManager.extract_dataset_config_for_legacy_compatibility(
"tenant1", AppMode.CHAT, config, unbound_session
@@ -240,28 +226,28 @@ class TestExtractDatasetConfig:
assert result["agent_mode"]["enabled"] is False
assert result["agent_mode"]["tools"] == []
- def test_extract_invalid_agent_mode_type(self, unbound_session: Session):
+ def test_extract_invalid_agent_mode_type(self, unbound_session: Session) -> None:
config = {"agent_mode": "invalid"}
with pytest.raises(ValueError, match="agent_mode must be of object type"):
DatasetConfigManager.extract_dataset_config_for_legacy_compatibility(
"tenant1", AppMode.CHAT, config, unbound_session
)
- def test_extract_invalid_enabled_type(self, unbound_session: Session):
+ def test_extract_invalid_enabled_type(self, unbound_session: Session) -> None:
config = {"agent_mode": {"enabled": "yes"}}
with pytest.raises(ValueError, match="enabled in agent_mode must be of boolean type"):
DatasetConfigManager.extract_dataset_config_for_legacy_compatibility(
"tenant1", AppMode.CHAT, config, unbound_session
)
- def test_extract_invalid_tools_type(self, unbound_session: Session):
+ def test_extract_invalid_tools_type(self, unbound_session: Session) -> None:
config = {"agent_mode": {"enabled": True, "tools": "invalid"}}
with pytest.raises(ValueError, match="tools in agent_mode must be a list of objects"):
DatasetConfigManager.extract_dataset_config_for_legacy_compatibility(
"tenant1", AppMode.CHAT, config, unbound_session
)
- def test_extract_invalid_uuid(self, mocker: MockerFixture, unbound_session: Session):
+ def test_extract_invalid_uuid(self, unbound_session: Session) -> None:
invalid_uuid = "not-a-uuid"
config = {
"agent_mode": {
@@ -275,7 +261,7 @@ class TestExtractDatasetConfig:
"tenant1", AppMode.CHAT, config, unbound_session
)
- def test_extract_dataset_not_exists(self, valid_uuid, mocker: MockerFixture, unbound_session: Session):
+ def test_extract_dataset_not_exists(self, valid_uuid: str, mocker: MockerFixture, unbound_session: Session) -> None:
mocker.patch(
"core.app.app_config.easy_ui_based_app.dataset.manager.DatasetService.get_dataset",
return_value=None,
@@ -299,7 +285,7 @@ class TestExtractDatasetConfig:
class TestIsDatasetExists:
- def test_dataset_exists_true(self, mocker: MockerFixture, valid_uuid, unbound_session: Session):
+ def test_dataset_exists_true(self, mocker: MockerFixture, valid_uuid: str, unbound_session: Session) -> None:
dataset = Dataset(
id=valid_uuid,
tenant_id="tenant1",
@@ -313,7 +299,9 @@ class TestIsDatasetExists:
assert DatasetConfigManager.is_dataset_exists("tenant1", valid_uuid, unbound_session)
- def test_dataset_exists_false_when_not_found(self, mocker: MockerFixture, valid_uuid, unbound_session: Session):
+ def test_dataset_exists_false_when_not_found(
+ self, mocker: MockerFixture, valid_uuid: str, unbound_session: Session
+ ) -> None:
mocker.patch(
"core.app.app_config.easy_ui_based_app.dataset.manager.DatasetService.get_dataset",
return_value=None,
@@ -321,8 +309,8 @@ class TestIsDatasetExists:
assert not DatasetConfigManager.is_dataset_exists("tenant1", valid_uuid, unbound_session)
def test_dataset_exists_false_when_tenant_mismatch(
- self, mocker: MockerFixture, valid_uuid, unbound_session: Session
- ):
+ self, mocker: MockerFixture, valid_uuid: str, unbound_session: Session
+ ) -> None:
dataset = Dataset(
id=valid_uuid,
tenant_id="other",
@@ -342,7 +330,7 @@ class TestIsDatasetExists:
class TestExtractDatasetConfigForLegacyCompatibility:
- def test_skips_empty_tool_entry(self, unbound_session: Session):
+ def test_skips_empty_tool_entry(self, unbound_session: Session) -> None:
# A malformed empty tool dict in agent_mode.tools must be skipped, not
# crash with `IndexError` on `list(tool.keys())[0]`. The sibling
# convert() already guards this with `if len(tool) == 1`.
@@ -350,7 +338,7 @@ class TestExtractDatasetConfigForLegacyCompatibility:
"agent_mode": {
"enabled": True,
"strategy": PlanningStrategy.ROUTER,
- "tools": [{}],
+ "tools": [dict[str, object]()],
}
}
diff --git a/api/tests/unit_tests/core/app/app_config/easy_ui_based_app/test_prompt_template_manager.py b/api/tests/unit_tests/core/app/app_config/easy_ui_based_app/test_prompt_template_manager.py
index 7ebc10c5d6c..1772970ac99 100644
--- a/api/tests/unit_tests/core/app/app_config/easy_ui_based_app/test_prompt_template_manager.py
+++ b/api/tests/unit_tests/core/app/app_config/easy_ui_based_app/test_prompt_template_manager.py
@@ -1,3 +1,6 @@
+from collections.abc import Mapping
+from typing import cast
+
import pytest
from core.app.app_config.easy_ui_based_app.prompt_template.manager import (
@@ -5,30 +8,35 @@ from core.app.app_config.easy_ui_based_app.prompt_template.manager import (
)
from core.app.app_config.entities import PromptTemplateEntity
from graphon.model_runtime.entities.message_entities import PromptMessageRole
-from models.model import AppMode
+from models.model import AppMode, AppModelConfigDict
+
+
+def _app_model_config(config: Mapping[str, object]) -> AppModelConfigDict:
+ """App model configs are JSON loaded from the database; these tests build partial ones."""
+ return cast(AppModelConfigDict, config)
class TestPromptTemplateConfigManagerConvert:
- def test_convert_missing_prompt_type_raises(self):
+ def test_convert_missing_prompt_type_raises(self) -> None:
with pytest.raises(ValueError, match="prompt_type is required"):
- PromptTemplateConfigManager.convert({})
+ PromptTemplateConfigManager.convert(_app_model_config({}))
- def test_convert_simple_prompt(self):
+ def test_convert_simple_prompt(self) -> None:
config = {"prompt_type": "simple", "pre_prompt": "hello"}
- result = PromptTemplateConfigManager.convert(config)
+ result = PromptTemplateConfigManager.convert(_app_model_config(config))
assert result == PromptTemplateEntity(
prompt_type=PromptTemplateEntity.PromptType.SIMPLE, simple_prompt_template="hello"
)
- def test_convert_advanced_chat_valid(self):
+ def test_convert_advanced_chat_valid(self) -> None:
config = {
"prompt_type": "advanced",
"chat_prompt_config": {"prompt": [{"text": "hi", "role": "user"}]},
}
- result = PromptTemplateConfigManager.convert(config)
+ result = PromptTemplateConfigManager.convert(_app_model_config(config))
assert result.prompt_type == PromptTemplateEntity.PromptType.ADVANCED
assert result.advanced_chat_prompt_template is not None
@@ -44,16 +52,16 @@ class TestPromptTemplateConfigManagerConvert:
{"text": "hi", "role": 123},
],
)
- def test_convert_advanced_invalid_message_fields(self, message):
+ def test_convert_advanced_invalid_message_fields(self, message: dict[str, object]) -> None:
config = {
"prompt_type": "advanced",
"chat_prompt_config": {"prompt": [message]},
}
with pytest.raises(ValueError, match="(?:message role must be a string|message text must be a string)"):
- PromptTemplateConfigManager.convert(config)
+ PromptTemplateConfigManager.convert(_app_model_config(config))
- def test_convert_advanced_completion_with_roles(self):
+ def test_convert_advanced_completion_with_roles(self) -> None:
config = {
"prompt_type": "advanced",
"completion_prompt_config": {
@@ -65,7 +73,7 @@ class TestPromptTemplateConfigManagerConvert:
},
}
- result = PromptTemplateConfigManager.convert(config)
+ result = PromptTemplateConfigManager.convert(_app_model_config(config))
assert result.prompt_type == PromptTemplateEntity.PromptType.ADVANCED
assert result.advanced_completion_prompt_template is not None
@@ -81,10 +89,10 @@ class TestPromptTemplateConfigManagerConvert:
class TestValidateAndSetDefaults:
- def setup_method(self):
+ def setup_method(self) -> None:
self.valid_model = {"mode": "chat"}
- def test_default_prompt_type_set(self):
+ def test_default_prompt_type_set(self) -> None:
config = {"model": self.valid_model}
result, keys = PromptTemplateConfigManager.validate_and_set_defaults(AppMode.CHAT, config)
@@ -92,7 +100,7 @@ class TestValidateAndSetDefaults:
assert result["prompt_type"] == "simple"
assert isinstance(keys, list)
- def test_invalid_prompt_type_raises(self):
+ def test_invalid_prompt_type_raises(self) -> None:
config = {"prompt_type": "invalid", "model": self.valid_model}
with pytest.raises(
@@ -101,7 +109,7 @@ class TestValidateAndSetDefaults:
):
PromptTemplateConfigManager.validate_and_set_defaults(AppMode.CHAT, config)
- def test_invalid_chat_prompt_config_type(self):
+ def test_invalid_chat_prompt_config_type(self) -> None:
config = {
"prompt_type": "simple",
"chat_prompt_config": "invalid",
@@ -111,7 +119,7 @@ class TestValidateAndSetDefaults:
with pytest.raises(ValueError, match="chat_prompt_config must be of object type"):
PromptTemplateConfigManager.validate_and_set_defaults(AppMode.CHAT, config)
- def test_simple_mode_invalid_pre_prompt_type(self):
+ def test_simple_mode_invalid_pre_prompt_type(self) -> None:
config = {
"prompt_type": "simple",
"pre_prompt": 123,
@@ -121,11 +129,11 @@ class TestValidateAndSetDefaults:
with pytest.raises(ValueError, match="pre_prompt must be of string type"):
PromptTemplateConfigManager.validate_and_set_defaults(AppMode.CHAT, config)
- def test_advanced_requires_one_config(self):
+ def test_advanced_requires_one_config(self) -> None:
config = {
"prompt_type": "advanced",
- "chat_prompt_config": {},
- "completion_prompt_config": {},
+ "chat_prompt_config": dict[str, object](),
+ "completion_prompt_config": dict[str, object](),
"model": {"mode": "chat"},
}
@@ -135,10 +143,10 @@ class TestValidateAndSetDefaults:
):
PromptTemplateConfigManager.validate_and_set_defaults(AppMode.CHAT, config)
- def test_advanced_invalid_model_mode(self):
+ def test_advanced_invalid_model_mode(self) -> None:
config = {
"prompt_type": "advanced",
- "chat_prompt_config": {"prompt": []},
+ "chat_prompt_config": {"prompt": list[object]()},
"model": {"mode": "invalid"},
}
@@ -147,17 +155,17 @@ class TestValidateAndSetDefaults:
):
PromptTemplateConfigManager.validate_and_set_defaults(AppMode.CHAT, config)
- def test_advanced_chat_prompt_length_exceeds(self):
+ def test_advanced_chat_prompt_length_exceeds(self) -> None:
config = {
"prompt_type": "advanced",
- "chat_prompt_config": {"prompt": [{}] * 11},
+ "chat_prompt_config": {"prompt": [dict[str, object]()] * 11},
"model": {"mode": "chat"},
}
with pytest.raises(ValueError, match="prompt messages must be less than 10"):
PromptTemplateConfigManager.validate_and_set_defaults(AppMode.CHAT, config)
- def test_completion_prefix_defaults_set_when_empty(self):
+ def test_completion_prefix_defaults_set_when_empty(self) -> None:
config = {
"prompt_type": "advanced",
"completion_prompt_config": {
@@ -184,12 +192,12 @@ class TestValidateAndSetDefaults:
class TestValidatePostPrompt:
@pytest.mark.parametrize("value", [None, ""])
- def test_post_prompt_defaults(self, value):
+ def test_post_prompt_defaults(self, value: str | None) -> None:
config = {"post_prompt": value}
result = PromptTemplateConfigManager.validate_post_prompt_and_set_defaults(config)
assert result["post_prompt"] == ""
- def test_post_prompt_invalid_type(self):
+ def test_post_prompt_invalid_type(self) -> None:
config = {"post_prompt": 123}
with pytest.raises(ValueError, match="post_prompt must be of string type"):
PromptTemplateConfigManager.validate_post_prompt_and_set_defaults(config)
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index d253ed29a8c..2d54d0b9dff 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -158,9 +158,7 @@ project-excludes = [
"core/agent/test_fc_agent_runner.py",
"core/agent/test_plugin_entities.py",
"core/app/app_config/common/test_sensitive_word_avoidance_manager.py",
- "core/app/app_config/easy_ui_based_app/test_dataset_manager.py",
"core/app/app_config/easy_ui_based_app/test_model_config_converter.py",
- "core/app/app_config/easy_ui_based_app/test_prompt_template_manager.py",
"core/app/app_config/easy_ui_based_app/test_variables_manager.py",
"core/app/app_config/features/file_upload/test_manager.py",
"core/app/app_config/features/test_additional_feature_managers.py",