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 agent/ops/tools test files (#44817)

Felix Shi671840f805d9
diff --git a/api/tests/unit_tests/core/app/apps/advanced_chat/test_app_config_manager.py b/api/tests/unit_tests/core/app/apps/advanced_chat/test_app_config_manager.py
index 16cb9a949d7..f9785d98933 100644
--- a/api/tests/unit_tests/core/app/apps/advanced_chat/test_app_config_manager.py
+++ b/api/tests/unit_tests/core/app/apps/advanced_chat/test_app_config_manager.py
@@ -1,3 +1,4 @@
+from collections.abc import Callable
from unittest.mock import patch
from core.app.apps.advanced_chat.app_config_manager import AdvancedChatAppConfigManager
@@ -15,7 +16,7 @@ def _workflow() -> Workflow:
class TestAdvancedChatAppConfigManager:
- def test_get_app_config(self):
+ def test_get_app_config(self) -> None:
app_model = _app()
workflow = _workflow()
@@ -34,12 +35,10 @@ class TestAdvancedChatAppConfigManager:
assert app_config.workflow_id == "wf-1"
assert app_config.app_mode == AppMode.ADVANCED_CHAT
- def test_config_validate_filters_keys(self):
- def _add_key(key, value):
- def _inner[**P](*args: P.args, **kwargs: P.kwargs):
- config = kwargs.get("config") if kwargs else args[-1]
- config = {**config, key: value}
- return config, [key]
+ def test_config_validate_filters_keys(self) -> None:
+ def _add_key(key: str, value: object) -> Callable[..., tuple[dict[str, object], list[str]]]:
+ def _inner(config: dict[str, object], **_: object) -> tuple[dict[str, object], list[str]]:
+ return {**config, key: value}, [key]
return _inner
diff --git a/api/tests/unit_tests/core/app/apps/test_message_generator.py b/api/tests/unit_tests/core/app/apps/test_message_generator.py
index a7ecf79b1e0..b3195fb6afa 100644
--- a/api/tests/unit_tests/core/app/apps/test_message_generator.py
+++ b/api/tests/unit_tests/core/app/apps/test_message_generator.py
@@ -1,21 +1,39 @@
+from collections.abc import Iterator
from unittest.mock import Mock, patch
from core.app.apps.message_generator import MessageGenerator
from core.app.entities.task_entities import StreamEvent
-from libs.broadcast_channel.channel import SupportsPreparedSubscription
+from libs.broadcast_channel.channel import Subscription, SupportsPreparedSubscription
from models.model import AppMode
+class _StubSubscription(Subscription):
+ """A subscription that never yields messages; the generator only forwards it."""
+
+ def __iter__(self) -> Iterator[bytes]:
+ return iter(())
+
+ def receive(self, timeout: float | None = 0.1) -> bytes | None:
+ # No message is ever buffered, so any timeout expires immediately.
+ del timeout
+ return None
+
+ def close(self) -> None:
+ return None
+
+
class _PreparedSubscriber(SupportsPreparedSubscription):
def __init__(self) -> None:
self.prepare_calls = 0
+ self.prepared_subscription = _StubSubscription()
+ self.ordinary_subscription = _StubSubscription()
- def prepare_subscription(self):
+ def prepare_subscription(self) -> Subscription:
self.prepare_calls += 1
- return "prepared-subscription"
+ return self.prepared_subscription
- def subscribe(self):
- return "ordinary-subscription"
+ def subscribe(self) -> Subscription:
+ return self.ordinary_subscription
class _TopicWithSeparateSubscriberView:
@@ -25,12 +43,12 @@ class _TopicWithSeparateSubscriberView:
def as_subscriber(self) -> _PreparedSubscriber:
return self.subscriber
- def subscribe(self):
+ def subscribe(self) -> Subscription:
raise AssertionError("event retrieval must use the topic's subscriber view")
class TestMessageGenerator:
- def test_get_response_topic(self):
+ def test_get_response_topic(self) -> None:
channel = Mock()
channel.topic.return_value = "topic"
@@ -41,7 +59,7 @@ class TestMessageGenerator:
expected_key = MessageGenerator._make_channel_key(AppMode.WORKFLOW, "run-1")
channel.topic.assert_called_once_with(expected_key)
- def test_retrieve_events_passes_arguments(self):
+ def test_retrieve_events_passes_arguments(self) -> None:
topic = Mock()
topic.as_subscriber.return_value = topic
topic.subscribe.return_value = "subscription"
@@ -72,7 +90,7 @@ class TestMessageGenerator:
terminal_events=[StreamEvent.WORKFLOW_FINISHED.value],
)
- def test_retrieve_events_uses_prepared_subscription_capability(self):
+ def test_retrieve_events_uses_prepared_subscription_capability(self) -> None:
topic = _TopicWithSeparateSubscriberView()
with (
patch("core.app.apps.message_generator.MessageGenerator.get_response_topic", return_value=topic),
@@ -82,7 +100,7 @@ class TestMessageGenerator:
assert topic.subscriber.prepare_calls == 1
mock_stream.assert_called_once_with(
- subscription="prepared-subscription",
+ subscription=topic.subscriber.prepared_subscription,
idle_timeout=300,
ping_interval=10.0,
on_subscribe=None,
diff --git a/api/tests/unit_tests/core/plugin/impl/test_agent.py b/api/tests/unit_tests/core/plugin/impl/test_agent.py
index d8843f0eebf..c50738219ea 100644
--- a/api/tests/unit_tests/core/plugin/impl/test_agent.py
+++ b/api/tests/unit_tests/core/plugin/impl/test_agent.py
@@ -1,3 +1,4 @@
+from collections.abc import Callable
from types import SimpleNamespace
from pytest_mock import MockerFixture
@@ -5,6 +6,8 @@ from pytest_mock import MockerFixture
from core.plugin.entities.request import PluginInvokeContext
from core.plugin.impl.agent import PluginAgentClient
+_Transformer = Callable[[dict[str, object]], dict[str, object]]
+
def _agent_provider(name: str = "agent") -> SimpleNamespace:
return SimpleNamespace(
@@ -17,13 +20,14 @@ def _agent_provider(name: str = "agent") -> SimpleNamespace:
class TestPluginAgentClient:
- def test_fetch_agent_strategy_providers(self, mocker: MockerFixture):
+ def test_fetch_agent_strategy_providers(self, mocker: MockerFixture) -> None:
client = PluginAgentClient()
provider = _agent_provider("remote")
- def fake_request(method, path, type_, **kwargs):
- transformer = kwargs["transformer"]
- payload = {
+ def fake_request(
+ method: str, path: str, type_: object, *, transformer: _Transformer, **kwargs: object
+ ) -> list[SimpleNamespace]:
+ payload: dict[str, object] = {
"data": [
{
"declaration": {
@@ -33,8 +37,16 @@ class TestPluginAgentClient:
}
]
}
- transformed = transformer(payload)
- assert transformed["data"][0]["declaration"]["strategies"][0]["identity"]["provider"] == "remote"
+ assert transformer(payload) == {
+ "data": [
+ {
+ "declaration": {
+ "identity": {"name": "remote"},
+ "strategies": [{"identity": {"provider": "remote"}}],
+ }
+ }
+ ]
+ }
return [provider]
request_mock = mocker.patch.object(client, "_request_with_plugin_daemon_response", side_effect=fake_request)
@@ -45,16 +57,19 @@ class TestPluginAgentClient:
assert result[0].declaration.identity.name == "org/plugin/remote"
assert result[0].declaration.strategies[0].identity.provider == "org/plugin/remote"
- def test_fetch_agent_strategy_provider(self, mocker: MockerFixture):
+ def test_fetch_agent_strategy_provider(self, mocker: MockerFixture) -> None:
client = PluginAgentClient()
provider = _agent_provider("provider")
- def fake_request(method, path, type_, **kwargs):
- transformer = kwargs["transformer"]
- assert transformer({"data": None}) == {"data": None}
- payload = {"data": {"declaration": {"strategies": [{"identity": {"provider": "old"}}]}}}
- transformed = transformer(payload)
- assert transformed["data"]["declaration"]["strategies"][0]["identity"]["provider"] == "provider"
+ def fake_request(
+ method: str, path: str, type_: object, *, transformer: _Transformer, **kwargs: object
+ ) -> SimpleNamespace:
+ skipped: dict[str, object] = {"data": None}
+ assert transformer(skipped) == skipped
+ payload: dict[str, object] = {"data": {"declaration": {"strategies": [{"identity": {"provider": "old"}}]}}}
+ assert transformer(payload) == {
+ "data": {"declaration": {"strategies": [{"identity": {"provider": "provider"}}]}}
+ }
return provider
request_mock = mocker.patch.object(client, "_request_with_plugin_daemon_response", side_effect=fake_request)
@@ -65,7 +80,7 @@ class TestPluginAgentClient:
assert result.declaration.identity.name == "org/plugin/provider"
assert result.declaration.strategies[0].identity.provider == "org/plugin/provider"
- def test_invoke_merges_chunks_and_passes_context(self, mocker: MockerFixture):
+ def test_invoke_merges_chunks_and_passes_context(self, mocker: MockerFixture) -> None:
client = PluginAgentClient()
stream_mock = mocker.patch.object(
client, "_request_with_plugin_daemon_response_stream", return_value=iter(["raw"])
diff --git a/api/tests/unit_tests/core/rag/extractor/blob/test_blob.py b/api/tests/unit_tests/core/rag/extractor/blob/test_blob.py
index 2ce0ed14454..97926b8adcf 100644
--- a/api/tests/unit_tests/core/rag/extractor/blob/test_blob.py
+++ b/api/tests/unit_tests/core/rag/extractor/blob/test_blob.py
@@ -7,11 +7,11 @@ from core.rag.extractor.blob.blob import Blob
class TestBlob:
- def test_requires_data_or_path(self):
+ def test_requires_data_or_path(self) -> None:
with pytest.raises(ValueError, match="Either data or path must be provided"):
Blob()
- def test_source_property_and_repr_include_path(self, tmp_path: Path):
+ def test_source_property_and_repr_include_path(self, tmp_path: Path) -> None:
file_path = tmp_path / "sample.txt"
file_path.write_text("hello", encoding="utf-8")
@@ -20,11 +20,11 @@ class TestBlob:
assert blob.source == str(file_path)
assert str(file_path) in repr(blob)
- def test_as_string_from_bytes_and_str(self):
+ def test_as_string_from_bytes_and_str(self) -> None:
assert Blob.from_data(b"abc").as_string() == "abc"
assert Blob.from_data("plain-text").as_string() == "plain-text"
- def test_as_string_from_path(self, tmp_path: Path):
+ def test_as_string_from_path(self, tmp_path: Path) -> None:
file_path = tmp_path / "sample.txt"
file_path.write_text("from-file", encoding="utf-8")
@@ -32,13 +32,13 @@ class TestBlob:
assert blob.as_string() == "from-file"
- def test_as_string_raises_for_invalid_state(self):
+ def test_as_string_raises_for_invalid_state(self) -> None:
blob = Blob.model_construct(data=None, path=None, mimetype=None, encoding="utf-8")
with pytest.raises(ValueError, match="Unable to get string for blob"):
blob.as_string()
- def test_as_bytes_from_bytes_str_and_path(self, tmp_path: Path):
+ def test_as_bytes_from_bytes_str_and_path(self, tmp_path: Path) -> None:
from_bytes = Blob.from_data(b"abc")
from_str = Blob.from_data("abc", encoding="utf-8")
@@ -50,13 +50,13 @@ class TestBlob:
assert from_str.as_bytes() == b"abc"
assert from_path.as_bytes() == b"from-path"
- def test_as_bytes_raises_for_invalid_state(self):
+ def test_as_bytes_raises_for_invalid_state(self) -> None:
blob = Blob.model_construct(data=None, path=None, mimetype=None, encoding="utf-8")
with pytest.raises(ValueError, match="Unable to get bytes for blob"):
blob.as_bytes()
- def test_as_bytes_io_for_bytes_and_path(self, tmp_path: Path):
+ def test_as_bytes_io_for_bytes_and_path(self, tmp_path: Path) -> None:
data_blob = Blob.from_data(b"bytes-io")
with data_blob.as_bytes_io() as stream:
assert isinstance(stream, BytesIO)
@@ -68,14 +68,14 @@ class TestBlob:
with path_blob.as_bytes_io() as stream:
assert stream.read() == b"path-stream"
- def test_as_bytes_io_raises_for_unsupported_data_type(self):
+ def test_as_bytes_io_raises_for_unsupported_data_type(self) -> None:
blob = Blob.from_data("text-value")
with pytest.raises(NotImplementedError, match="Unable to convert blob"):
with blob.as_bytes_io():
pass
- def test_from_path_respects_guessing_and_explicit_mime(self, tmp_path: Path):
+ def test_from_path_respects_guessing_and_explicit_mime(self, tmp_path: Path) -> None:
file_path = tmp_path / "example.txt"
file_path.write_text("x", encoding="utf-8")
diff --git a/api/tests/unit_tests/core/workflow/test_system_variables.py b/api/tests/unit_tests/core/workflow/test_system_variables.py
index 8ee11e4894e..1d19dc792ce 100644
--- a/api/tests/unit_tests/core/workflow/test_system_variables.py
+++ b/api/tests/unit_tests/core/workflow/test_system_variables.py
@@ -10,7 +10,7 @@ from graphon.file import File, FileTransferMethod, FileType
from graphon.nodes import BuiltinNodeTypes
-def test_build_system_variables_normalizes_workflow_execution_id():
+def test_build_system_variables_normalizes_workflow_execution_id() -> None:
system_variables = build_system_variables(
user_id="user-id",
workflow_execution_id="run-id",
@@ -27,7 +27,7 @@ def test_build_system_variables_normalizes_workflow_execution_id():
}
-def test_build_system_variables_preserves_explicit_workflow_run_id():
+def test_build_system_variables_preserves_explicit_workflow_run_id() -> None:
system_variables = build_system_variables(
workflow_run_id="explicit-run-id",
workflow_execution_id="ignored-run-id",
@@ -38,7 +38,7 @@ def test_build_system_variables_preserves_explicit_workflow_run_id():
assert system_values["files"] == []
-def test_build_system_variables_preserves_file_values():
+def test_build_system_variables_preserves_file_values() -> None:
file = File(
file_type=FileType.DOCUMENT,
transfer_method=FileTransferMethod.LOCAL_FILE,
@@ -56,7 +56,7 @@ def test_build_system_variables_preserves_file_values():
assert system_values["files"] == [file]
-def test_default_system_variables_generates_workflow_run_id():
+def test_default_system_variables_generates_workflow_run_id() -> None:
system_variables = default_system_variables()
system_values = system_variables_to_mapping(system_variables)
@@ -65,7 +65,7 @@ def test_default_system_variables_generates_workflow_run_id():
assert system_values["files"] == []
-def test_get_node_creation_preload_selectors_requires_conversation_for_memory_nodes():
+def test_get_node_creation_preload_selectors_requires_conversation_for_memory_nodes() -> None:
selectors = get_node_creation_preload_selectors(
node_type=BuiltinNodeTypes.QUESTION_CLASSIFIER,
node_data=SimpleNamespace(memory=object()),
@@ -74,7 +74,7 @@ def test_get_node_creation_preload_selectors_requires_conversation_for_memory_no
assert selectors == (("sys", "conversation_id"),)
-def test_get_node_creation_preload_selectors_skips_non_memory_nodes():
+def test_get_node_creation_preload_selectors_skips_non_memory_nodes() -> None:
selectors = get_node_creation_preload_selectors(
node_type=BuiltinNodeTypes.START,
node_data=SimpleNamespace(memory=None),
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 9459bacaf73..a40ef62033a 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -90,7 +90,6 @@ project-excludes = [
"core/app/app_config/easy_ui_based_app/model_config/test_converter.py",
"core/app/app_config/easy_ui_based_app/variables/test_manager.py",
"core/app/app_config/features/suggested_questions_after_answer/test_manager.py",
- "core/app/apps/advanced_chat/test_app_config_manager.py",
"core/app/apps/advanced_chat/test_app_generator.py",
"core/app/apps/advanced_chat/test_app_runner.py",
"core/app/apps/advanced_chat/test_generate_response_converter.py",
@@ -113,7 +112,6 @@ project-excludes = [
"core/app/apps/test_base_app_generator.py",
"core/app/apps/test_base_app_queue_manager.py",
"core/app/apps/test_message_based_app_generator.py",
- "core/app/apps/test_message_generator.py",
"core/app/apps/test_streaming_utils.py",
"core/helper/test_trace_id_helper.py",
"core/app/apps/workflow/test_app_generator.py",
@@ -155,7 +153,6 @@ project-excludes = [
"core/memory/test_token_buffer_memory.py",
"core/plugin/impl/test_model_runtime_factory.py",
"core/moderation/test_input_moderation.py",
- "core/plugin/impl/test_agent.py",
"core/plugin/impl/test_base.py",
"core/plugin/impl/test_datasource.py",
"core/plugin/impl/test_endpoint.py",
@@ -173,7 +170,6 @@ project-excludes = [
"core/rag/datasource/keyword/jieba/test_jieba_keyword_table_handler.py",
"core/rag/datasource/test_retrieval_service.py",
"core/rag/datasource/vdb/test_vector_factory.py",
- "core/rag/extractor/blob/test_blob.py",
"core/rag/extractor/test_excel_extractor.py",
"core/rag/extractor/test_extract_processor.py",
"core/rag/extractor/test_helpers.py",
@@ -266,7 +262,6 @@ project-excludes = [
"core/workflow/nodes/human_input/test_callback.py",
"core/workflow/test_human_input_forms.py",
"../e2e_tests/contracts/core/workflow/test_node_mapping_bootstrap.py",
- "core/workflow/test_system_variables.py",
"core/workflow/test_workflow_entry.py",
"dev/test_generate_knowledge_fs_contract.py",
"enterprise/telemetry/test_contracts.py",
@@ -353,12 +348,10 @@ project-excludes = [
"services/test_workflow_run_service.py",
"services/test_workflow_service.py",
"services/tools/test_tools_transform_service.py",
- "services/tools/test_tools_manage_service.py",
"services/test_workflow_draft_variable_service.py",
"services/workflow/test_node_output_inspector_service.py",
"services/workflow/test_workflow_converter.py",
"services/test_workflow_event_snapshot_service.py",
- "services/test_workflow_restore.py",
"tasks/test_clean_dataset_task.py",
"tasks/test_clean_document_task.py",
"tasks/test_document_indexing_task.py",
diff --git a/api/tests/unit_tests/services/test_workflow_restore.py b/api/tests/unit_tests/services/test_workflow_restore.py
index da09783f4ee..29b0662e84d 100644
--- a/api/tests/unit_tests/services/test_workflow_restore.py
+++ b/api/tests/unit_tests/services/test_workflow_restore.py
@@ -5,7 +5,7 @@ from models.workflow import Workflow
from models.workflow import WorkflowType as ModelWorkflowType
from services.workflow_restore import apply_published_workflow_snapshot_to_draft
-LEGACY_FEATURES = {
+LEGACY_FEATURES: dict[str, object] = {
"file_upload": {
"image": {
"enabled": True,
@@ -17,16 +17,16 @@ LEGACY_FEATURES = {
"retriever_resource": {"enabled": True},
"sensitive_word_avoidance": {"enabled": False},
"speech_to_text": {"enabled": False},
- "suggested_questions": [],
+ "suggested_questions": list[str](),
"suggested_questions_after_answer": {"enabled": False},
"text_to_speech": {"enabled": False, "language": "", "voice": ""},
}
-NORMALIZED_FEATURES = {
+NORMALIZED_FEATURES: dict[str, object] = {
"file_upload": {
"enabled": True,
"allowed_file_types": ["image"],
- "allowed_file_extensions": [],
+ "allowed_file_extensions": list[str](),
"allowed_file_upload_methods": ["remote_url", "local_file"],
"number_limits": 6,
},
@@ -34,7 +34,7 @@ NORMALIZED_FEATURES = {
"retriever_resource": {"enabled": True},
"sensitive_word_avoidance": {"enabled": False},
"speech_to_text": {"enabled": False},
- "suggested_questions": [],
+ "suggested_questions": list[str](),
"suggested_questions_after_answer": {"enabled": False},
"text_to_speech": {"enabled": False, "language": "", "voice": ""},
}
diff --git a/api/tests/unit_tests/services/tools/test_tools_manage_service.py b/api/tests/unit_tests/services/tools/test_tools_manage_service.py
index 73ac9a10c63..afff7e096bd 100644
--- a/api/tests/unit_tests/services/tools/test_tools_manage_service.py
+++ b/api/tests/unit_tests/services/tools/test_tools_manage_service.py
@@ -6,7 +6,9 @@ from services.tools.tools_manage_service import ToolCommonService
class TestToolCommonService:
@patch("services.tools.tools_manage_service.ToolTransformService")
@patch("services.tools.tools_manage_service.ToolManager")
- def test_list_tool_providers_transforms_and_returns(self, mock_manager, mock_transform):
+ def test_list_tool_providers_transforms_and_returns(
+ self, mock_manager: MagicMock, mock_transform: MagicMock
+ ) -> None:
mock_provider1 = MagicMock()
mock_provider1.to_dict.return_value = {"name": "provider1"}
mock_provider2 = MagicMock()
@@ -21,8 +23,9 @@ class TestToolCommonService:
@patch("services.tools.tools_manage_service.ToolTransformService")
@patch("services.tools.tools_manage_service.ToolManager")
- def test_list_tool_providers_with_type_filter(self, mock_manager, mock_transform):
- mock_manager.list_providers_from_api.return_value = []
+ def test_list_tool_providers_with_type_filter(self, mock_manager: MagicMock, mock_transform: MagicMock) -> None:
+ providers: list[object] = []
+ mock_manager.list_providers_from_api.return_value = providers
result = ToolCommonService.list_tool_providers("user-1", "tenant-1", typ="builtin")
@@ -31,8 +34,9 @@ class TestToolCommonService:
@patch("services.tools.tools_manage_service.ToolTransformService")
@patch("services.tools.tools_manage_service.ToolManager")
- def test_list_tool_providers_empty(self, mock_manager, mock_transform):
- mock_manager.list_providers_from_api.return_value = []
+ def test_list_tool_providers_empty(self, mock_manager: MagicMock, mock_transform: MagicMock) -> None:
+ providers: list[object] = []
+ mock_manager.list_providers_from_api.return_value = providers
result = ToolCommonService.list_tool_providers("u", "t")