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 core app entity and app config tests (#43879)

Eddy ZHANG5fe7f018764e
diff --git a/api/tests/unit_tests/core/app/app_config/test_base_app_config_manager.py b/api/tests/unit_tests/core/app/app_config/test_base_app_config_manager.py
index e2ab3e2192b..f5ddfaf40ec 100644
--- a/api/tests/unit_tests/core/app/app_config/test_base_app_config_manager.py
+++ b/api/tests/unit_tests/core/app/app_config/test_base_app_config_manager.py
@@ -5,15 +5,16 @@ import pytest
from pytest_mock import MockerFixture
from core.app.app_config.base_app_config_manager import BaseAppConfigManager
+from models.model import AppMode
class TestBaseAppConfigManager:
@pytest.fixture
- def mock_config_dict(self):
+ def mock_config_dict(self) -> dict[str, object]:
return {"key": "value", "another": 123}
@pytest.fixture
- def mock_app_additional_features(self, mocker: MockerFixture):
+ def mock_app_additional_features(self, mocker: MockerFixture) -> MagicMock:
mock_instance = MagicMock()
mocker.patch(
"core.app.app_config.base_app_config_manager.AppAdditionalFeatures",
@@ -22,7 +23,7 @@ class TestBaseAppConfigManager:
return mock_instance
@pytest.fixture
- def mock_managers(self, mocker: MockerFixture):
+ def mock_managers(self, mocker: MockerFixture) -> dict[str, MagicMock]:
retrieval = mocker.patch(
"core.app.app_config.base_app_config_manager.RetrievalResourceConfigManager.convert",
return_value="retrieval_result",
@@ -65,32 +66,20 @@ class TestBaseAppConfigManager:
@pytest.mark.parametrize(
("app_mode", "expected_is_vision"),
[
- ("CHAT", True),
- ("COMPLETION", True),
- ("AGENT_CHAT", True),
- ("OTHER", False),
+ (AppMode.CHAT, True),
+ (AppMode.COMPLETION, True),
+ (AppMode.AGENT_CHAT, True),
+ (AppMode.WORKFLOW, False),
],
)
def test_convert_features_all_modes(
self,
- mocker: MockerFixture,
- mock_config_dict,
- mock_app_additional_features,
- mock_managers,
- app_mode,
- expected_is_vision,
- ):
- # Arrange
- mock_app_mode = MagicMock()
- mock_app_mode.CHAT = "CHAT"
- mock_app_mode.COMPLETION = "COMPLETION"
- mock_app_mode.AGENT_CHAT = "AGENT_CHAT"
-
- mocker.patch(
- "core.app.app_config.base_app_config_manager.AppMode",
- mock_app_mode,
- )
-
+ mock_config_dict: dict[str, object],
+ mock_app_additional_features: MagicMock,
+ mock_managers: dict[str, MagicMock],
+ app_mode: AppMode,
+ expected_is_vision: bool,
+ ) -> None:
# Act
result = BaseAppConfigManager.convert_features(mock_config_dict, app_mode)
@@ -108,21 +97,14 @@ class TestBaseAppConfigManager:
mock_managers["speech_to_text"].assert_called_once_with(config=dict(mock_config_dict.items()))
mock_managers["text_to_speech"].assert_called_once_with(config=dict(mock_config_dict.items()))
- def test_convert_features_empty_config(self, mocker: MockerFixture, mock_app_additional_features, mock_managers):
+ def test_convert_features_empty_config(
+ self, mock_app_additional_features: MagicMock, mock_managers: dict[str, MagicMock]
+ ) -> None:
# Arrange
empty_config = {}
- mock_app_mode = MagicMock()
- mock_app_mode.CHAT = "CHAT"
- mock_app_mode.COMPLETION = "COMPLETION"
- mock_app_mode.AGENT_CHAT = "AGENT_CHAT"
-
- mocker.patch(
- "core.app.app_config.base_app_config_manager.AppMode",
- mock_app_mode,
- )
# Act
- result = BaseAppConfigManager.convert_features(empty_config, "CHAT")
+ result = BaseAppConfigManager.convert_features(empty_config, AppMode.CHAT)
# Assert
assert result == mock_app_additional_features
@@ -139,12 +121,14 @@ class TestBaseAppConfigManager:
[],
],
)
- def test_convert_features_invalid_config_raises(self, invalid_config):
+ def test_convert_features_invalid_config_raises(self, invalid_config: object) -> None:
# Act & Assert
with pytest.raises((TypeError, AttributeError)):
- BaseAppConfigManager.convert_features(invalid_config, "CHAT")
+ BaseAppConfigManager.convert_features(invalid_config, AppMode.CHAT) # pyrefly: ignore[bad-argument-type]
- def test_convert_features_manager_exception_propagates(self, mocker: MockerFixture, mock_config_dict):
+ def test_convert_features_manager_exception_propagates(
+ self, mocker: MockerFixture, mock_config_dict: dict[str, object]
+ ) -> None:
# Arrange
mocker.patch(
"core.app.app_config.base_app_config_manager.RetrievalResourceConfigManager.convert",
@@ -153,29 +137,19 @@ class TestBaseAppConfigManager:
# Act & Assert
with pytest.raises(RuntimeError):
- BaseAppConfigManager.convert_features(mock_config_dict, "CHAT")
+ BaseAppConfigManager.convert_features(mock_config_dict, AppMode.CHAT)
def test_convert_features_mapping_subclass(
- self, mocker: MockerFixture, mock_app_additional_features, mock_managers
- ):
+ self, mock_app_additional_features: MagicMock, mock_managers: dict[str, MagicMock]
+ ) -> None:
# Arrange
- class CustomMapping(UserDict):
+ class CustomMapping(UserDict[str, int]):
pass
custom_config = CustomMapping({"a": 1})
- mock_app_mode = MagicMock()
- mock_app_mode.CHAT = "CHAT"
- mock_app_mode.COMPLETION = "COMPLETION"
- mock_app_mode.AGENT_CHAT = "AGENT_CHAT"
-
- mocker.patch(
- "core.app.app_config.base_app_config_manager.AppMode",
- mock_app_mode,
- )
-
# Act
- result = BaseAppConfigManager.convert_features(custom_config, "CHAT")
+ result = BaseAppConfigManager.convert_features(custom_config, AppMode.CHAT)
# Assert
assert result == mock_app_additional_features
diff --git a/api/tests/unit_tests/core/app/app_config/test_entities.py b/api/tests/unit_tests/core/app/app_config/test_entities.py
index f2bc3076dac..b63fe414ee0 100644
--- a/api/tests/unit_tests/core/app/app_config/test_entities.py
+++ b/api/tests/unit_tests/core/app/app_config/test_entities.py
@@ -8,7 +8,7 @@ from graphon.variables.input_entities import VariableEntity, VariableEntityType
class TestAppConfigEntities:
- def test_variable_entity_coerces_none_description_and_options(self):
+ def test_variable_entity_coerces_none_description_and_options(self) -> None:
entity = VariableEntity(
variable="query",
label="Query",
@@ -20,7 +20,7 @@ class TestAppConfigEntities:
assert entity.description == ""
assert entity.options == []
- def test_variable_entity_rejects_invalid_json_schema(self):
+ def test_variable_entity_rejects_invalid_json_schema(self) -> None:
with pytest.raises(ValueError):
VariableEntity(
variable="query",
@@ -29,12 +29,12 @@ class TestAppConfigEntities:
json_schema={"type": "string", "minLength": "bad"},
)
- def test_prompt_template_value_of(self):
+ def test_prompt_template_value_of(self) -> None:
assert PromptTemplateEntity.PromptType.value_of("simple") == PromptTemplateEntity.PromptType.SIMPLE
with pytest.raises(ValueError):
PromptTemplateEntity.PromptType.value_of("missing")
- def test_dataset_retrieve_strategy_value_of(self):
+ def test_dataset_retrieve_strategy_value_of(self) -> None:
assert (
DatasetRetrieveConfigEntity.RetrieveStrategy.value_of("single")
== DatasetRetrieveConfigEntity.RetrieveStrategy.SINGLE
diff --git a/api/tests/unit_tests/core/app/entities/test_queue_entities.py b/api/tests/unit_tests/core/app/entities/test_queue_entities.py
index 43d69023e70..981e3d6d69f 100644
--- a/api/tests/unit_tests/core/app/entities/test_queue_entities.py
+++ b/api/tests/unit_tests/core/app/entities/test_queue_entities.py
@@ -2,23 +2,23 @@ from core.app.entities.queue_entities import QueueEvent, QueueReasoningChunkEven
class TestQueueEntities:
- def test_get_stop_reason_for_known_stop_by(self):
+ def test_get_stop_reason_for_known_stop_by(self) -> None:
event = QueueStopEvent(stopped_by=QueueStopEvent.StopBy.USER_MANUAL)
assert event.get_stop_reason() == "Stopped by user."
- def test_get_stop_reason_prefers_explicit_reason(self):
+ def test_get_stop_reason_prefers_explicit_reason(self) -> None:
event = QueueStopEvent(
stopped_by=QueueStopEvent.StopBy.USER_MANUAL,
reason="Workflow execution timed out",
)
assert event.get_stop_reason() == "Workflow execution timed out"
- def test_get_stop_reason_for_unknown_stop_by(self):
+ def test_get_stop_reason_for_unknown_stop_by(self) -> None:
event = QueueStopEvent(stopped_by=QueueStopEvent.StopBy.USER_MANUAL)
- event.stopped_by = "unknown"
+ event.stopped_by = "unknown" # pyrefly: ignore[bad-assignment]
assert event.get_stop_reason() == "Stopped by unknown reason."
- def test_reasoning_chunk_event_defaults(self):
+ def test_reasoning_chunk_event_defaults(self) -> None:
event = QueueReasoningChunkEvent(reasoning="thinking", from_node_id="llm")
assert event.event == QueueEvent.REASONING_CHUNK
assert event.reasoning == "thinking"
@@ -27,7 +27,7 @@ class TestQueueEntities:
assert event.in_iteration_id is None
assert event.in_loop_id is None
- def test_reasoning_chunk_event_terminal_marker_allows_empty_reasoning(self):
+ def test_reasoning_chunk_event_terminal_marker_allows_empty_reasoning(self) -> None:
event = QueueReasoningChunkEvent(reasoning="", from_node_id="llm", is_final=True)
assert event.reasoning == ""
assert event.is_final is True
diff --git a/api/tests/unit_tests/core/app/entities/test_rag_pipeline_invoke_entities.py b/api/tests/unit_tests/core/app/entities/test_rag_pipeline_invoke_entities.py
index 1e0ef6d6d68..dfe39a2acd6 100644
--- a/api/tests/unit_tests/core/app/entities/test_rag_pipeline_invoke_entities.py
+++ b/api/tests/unit_tests/core/app/entities/test_rag_pipeline_invoke_entities.py
@@ -2,7 +2,7 @@ from core.app.entities.rag_pipeline_invoke_entities import RagPipelineInvokeEnti
class TestRagPipelineInvokeEntity:
- def test_defaults_and_fields(self):
+ def test_defaults_and_fields(self) -> None:
entity = RagPipelineInvokeEntity(
pipeline_id="pipe-1",
application_generate_entity={"foo": "bar"},
diff --git a/api/tests/unit_tests/core/app/entities/test_task_entities.py b/api/tests/unit_tests/core/app/entities/test_task_entities.py
index 19d49a28877..35408087e49 100644
--- a/api/tests/unit_tests/core/app/entities/test_task_entities.py
+++ b/api/tests/unit_tests/core/app/entities/test_task_entities.py
@@ -13,7 +13,7 @@ from graphon.model_runtime.utils.encoders import jsonable_encoder
class TestTaskEntities:
- def test_node_start_to_ignore_detail_dict(self):
+ def test_node_start_to_ignore_detail_dict(self) -> None:
data = NodeStartStreamResponse.Data(
id="exec-1",
node_id="node-1",
@@ -29,10 +29,12 @@ class TestTaskEntities:
payload = response.to_ignore_detail_dict()
assert payload["event"] == StreamEvent.NODE_STARTED.value
- assert payload["data"]["inputs"] is None
- assert payload["data"]["extras"] == {}
+ detail = payload["data"]
+ assert isinstance(detail, dict)
+ assert detail["inputs"] is None
+ assert detail["extras"] == {}
- def test_node_finish_to_ignore_detail_dict(self):
+ def test_node_finish_to_ignore_detail_dict(self) -> None:
data = NodeFinishStreamResponse.Data(
id="exec-1",
node_id="node-1",
@@ -53,11 +55,13 @@ class TestTaskEntities:
payload = response.to_ignore_detail_dict()
assert payload["event"] == StreamEvent.NODE_FINISHED.value
- assert payload["data"]["inputs"] is None
- assert payload["data"]["outputs"] is None
- assert payload["data"]["files"] == []
+ detail = payload["data"]
+ assert isinstance(detail, dict)
+ assert detail["inputs"] is None
+ assert detail["outputs"] is None
+ assert detail["files"] == []
- def test_node_retry_to_ignore_detail_dict(self):
+ def test_node_retry_to_ignore_detail_dict(self) -> None:
data = NodeRetryStreamResponse.Data(
id="exec-1",
node_id="node-1",
@@ -82,7 +86,7 @@ class TestTaskEntities:
assert payload["data"]["retry_index"] == 2
assert payload["data"]["outputs"] is None
- def test_reasoning_chunk_stream_response_shape(self):
+ def test_reasoning_chunk_stream_response_shape(self) -> None:
response = ReasoningChunkStreamResponse(
task_id="task-1",
data=ReasoningChunkStreamResponse.Data(
@@ -102,7 +106,7 @@ class TestTaskEntities:
assert payload["data"]["node_id"] == "llm"
assert payload["data"]["is_final"] is False
- def test_task_state_metadata_reasoning_round_trips(self):
+ def test_task_state_metadata_reasoning_round_trips(self) -> None:
# The persistence path serializes the whole metadata to message_metadata via
# model_dump -> jsonable_encoder -> json.dumps, then reads back with json.loads.
metadata = TaskStateMetadata()
@@ -114,7 +118,7 @@ class TestTaskEntities:
assert restored["reasoning"] == {"llm": "first", "llm2": "second"}
- def test_task_state_metadata_reasoning_defaults_empty(self):
+ def test_task_state_metadata_reasoning_defaults_empty(self) -> None:
# Old rows / runs without reasoning serialize to an empty dict, never null.
metadata = TaskStateMetadata()
restored = json.loads(json.dumps(jsonable_encoder(metadata.model_dump())))
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 35fbcb5dda7..35ce836c0b2 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -225,8 +225,6 @@ project-excludes = [
"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",
- "core/app/app_config/test_base_app_config_manager.py",
- "core/app/app_config/test_entities.py",
"core/app/app_config/workflow_ui_based_app/test_workflow_ui_based_app_manager.py",
"core/app/apps/advanced_chat/test_app_config_manager.py",
"core/app/apps/advanced_chat/test_app_generator.py",
@@ -291,9 +289,6 @@ project-excludes = [
"core/app/apps/workflow/test_generate_task_pipeline.py",
"core/app/apps/workflow/test_generate_task_pipeline_core.py",
"core/app/entities/test_app_invoke_entities.py",
- "core/app/entities/test_queue_entities.py",
- "core/app/entities/test_rag_pipeline_invoke_entities.py",
- "core/app/entities/test_task_entities.py",
"core/app/features/rate_limiting/conftest.py",
"core/app/features/rate_limiting/test_rate_limit.py",
"core/app/features/test_annotation_reply.py",