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 trigger manager tests (#43896)

Eddy ZHANG4f41e05a50b1
diff --git a/api/tests/unit_tests/core/trigger/conftest.py b/api/tests/unit_tests/core/trigger/conftest.py
index d9da80a8b70..bf246c00ef8 100644
--- a/api/tests/unit_tests/core/trigger/conftest.py
+++ b/api/tests/unit_tests/core/trigger/conftest.py
@@ -73,7 +73,12 @@ def make_controller(
def make_subscription(**overrides: Any) -> Subscription:
- defaults = {"expires_at": 9999999999, "endpoint": "https://hook.test", "properties": {"k": "v"}, "parameters": {}}
+ defaults = {
+ "expires_at": 9999999999,
+ "endpoint": "https://hook.test",
+ "properties": {"k": "v"},
+ "parameters": dict[str, object](),
+ }
defaults.update(overrides)
return Subscription(**defaults)
diff --git a/api/tests/unit_tests/core/trigger/test_trigger_manager.py b/api/tests/unit_tests/core/trigger/test_trigger_manager.py
index e1999d92caa..fbe8f09edbf 100644
--- a/api/tests/unit_tests/core/trigger/test_trigger_manager.py
+++ b/api/tests/unit_tests/core/trigger/test_trigger_manager.py
@@ -8,15 +8,20 @@ and delegation to provider controller.
from __future__ import annotations
+from collections.abc import Callable
from threading import Lock
from unittest.mock import MagicMock, patch
import pytest
+from flask import Request
+from typing_extensions import TypedDict
from core.plugin.entities.plugin_daemon import CredentialType
from core.plugin.entities.request import TriggerInvokeEventResponse
from core.plugin.impl.exc import PluginDaemonError, PluginNotFoundError
+from core.trigger.entities.entities import Subscription
from core.trigger.errors import EventIgnoreError
+from core.trigger.provider import PluginTriggerProviderController
from core.trigger.trigger_manager import TriggerManager
from models.provider_ids import TriggerProviderID
from tests.unit_tests.core.trigger.conftest import (
@@ -30,9 +35,22 @@ PID = TriggerProviderID(VALID_PROVIDER_ID)
PID_STR = str(PID)
+class _InvokeTriggerEventArgs(TypedDict, closed=True):
+ tenant_id: str
+ user_id: str
+ provider_id: TriggerProviderID
+ event_name: str
+ parameters: dict[str, object]
+ credentials: dict[str, str]
+ credential_type: CredentialType
+ subscription: Subscription
+ request: Request
+ payload: dict[str, object]
+
+
class TestGetTriggerPluginIcon:
@patch("core.trigger.trigger_manager.PluginTriggerClient")
- def test_builds_correct_url(self, mock_client, config_overrides):
+ def test_builds_correct_url(self, mock_client: MagicMock, config_overrides: Callable[..., None]) -> None:
config_overrides(CONSOLE_API_URL="https://console.example.com")
provider = MagicMock()
provider.declaration.identity.icon = "my-icon.svg"
@@ -47,7 +65,7 @@ class TestGetTriggerPluginIcon:
class TestListPluginTriggerProviders:
@patch("core.trigger.trigger_manager.PluginTriggerClient")
- def test_wraps_entities_into_controllers(self, mock_client):
+ def test_wraps_entities_into_controllers(self, mock_client: MagicMock) -> None:
entity = MagicMock()
entity.declaration = make_provider_entity("p1")
entity.plugin_id = "plugin-1"
@@ -61,7 +79,7 @@ class TestListPluginTriggerProviders:
assert controllers[0].plugin_id == "plugin-1"
@patch("core.trigger.trigger_manager.PluginTriggerClient")
- def test_skips_failing_providers(self, mock_client):
+ def test_skips_failing_providers(self, mock_client: MagicMock) -> None:
good = MagicMock()
good.declaration = make_provider_entity("good")
good.plugin_id = "good-plugin"
@@ -85,9 +103,9 @@ class TestListPluginTriggerProviders:
class TestGetTriggerProvider:
@patch("core.trigger.trigger_manager.PluginTriggerClient")
@patch("core.trigger.trigger_manager.contexts")
- def test_initializes_context_on_first_call(self, mock_ctx, mock_client):
+ def test_initializes_context_on_first_call(self, mock_ctx: MagicMock, mock_client: MagicMock) -> None:
# get() called 3 times: (1) try block, (2) after set, (3) under lock
- mock_ctx.plugin_trigger_providers.get.side_effect = [LookupError, {}, {}]
+ mock_ctx.plugin_trigger_providers.get.side_effect = [LookupError, dict[str, object](), dict[str, object]()]
mock_ctx.plugin_trigger_providers_lock.get.return_value = Lock()
provider = MagicMock()
provider.declaration = make_provider_entity()
@@ -103,7 +121,7 @@ class TestGetTriggerProvider:
@patch("core.trigger.trigger_manager.PluginTriggerClient")
@patch("core.trigger.trigger_manager.contexts")
- def test_returns_cached_without_fetch(self, mock_ctx, mock_client):
+ def test_returns_cached_without_fetch(self, mock_ctx: MagicMock, mock_client: MagicMock) -> None:
cached = make_controller()
mock_ctx.plugin_trigger_providers.get.return_value = {PID_STR: cached}
@@ -114,10 +132,10 @@ class TestGetTriggerProvider:
@patch("core.trigger.trigger_manager.PluginTriggerClient")
@patch("core.trigger.trigger_manager.contexts")
- def test_double_check_lock_uses_cached_from_other_thread(self, mock_ctx, mock_client):
+ def test_double_check_lock_uses_cached_from_other_thread(self, mock_ctx: MagicMock, mock_client: MagicMock) -> None:
cached = make_controller()
mock_ctx.plugin_trigger_providers.get.side_effect = [
- {}, # first check misses
+ dict[str, object](), # first check misses
{PID_STR: cached}, # under-lock check hits
]
mock_ctx.plugin_trigger_providers_lock.get.return_value = Lock()
@@ -129,8 +147,8 @@ class TestGetTriggerProvider:
@patch("core.trigger.trigger_manager.PluginTriggerClient")
@patch("core.trigger.trigger_manager.contexts")
- def test_fetches_and_caches_on_miss(self, mock_ctx, mock_client):
- cache: dict = {}
+ def test_fetches_and_caches_on_miss(self, mock_ctx: MagicMock, mock_client: MagicMock) -> None:
+ cache: dict[str, PluginTriggerProviderController] = {}
mock_ctx.plugin_trigger_providers.get.return_value = cache
mock_ctx.plugin_trigger_providers_lock.get.return_value = Lock()
provider = MagicMock()
@@ -146,8 +164,8 @@ class TestGetTriggerProvider:
@patch("core.trigger.trigger_manager.PluginTriggerClient")
@patch("core.trigger.trigger_manager.contexts")
- def test_none_fetch_raises_value_error(self, mock_ctx, mock_client):
- mock_ctx.plugin_trigger_providers.get.return_value = {}
+ def test_none_fetch_raises_value_error(self, mock_ctx: MagicMock, mock_client: MagicMock) -> None:
+ mock_ctx.plugin_trigger_providers.get.return_value = dict[str, object]()
mock_ctx.plugin_trigger_providers_lock.get.return_value = Lock()
mock_client.return_value.fetch_trigger_provider.return_value = None
@@ -156,8 +174,8 @@ class TestGetTriggerProvider:
@patch("core.trigger.trigger_manager.PluginTriggerClient")
@patch("core.trigger.trigger_manager.contexts")
- def test_plugin_not_found_becomes_value_error(self, mock_ctx, mock_client):
- mock_ctx.plugin_trigger_providers.get.return_value = {}
+ def test_plugin_not_found_becomes_value_error(self, mock_ctx: MagicMock, mock_client: MagicMock) -> None:
+ mock_ctx.plugin_trigger_providers.get.return_value = dict[str, object]()
mock_ctx.plugin_trigger_providers_lock.get.return_value = Lock()
mock_client.return_value.fetch_trigger_provider.side_effect = PluginNotFoundError("gone")
@@ -166,8 +184,8 @@ class TestGetTriggerProvider:
@patch("core.trigger.trigger_manager.PluginTriggerClient")
@patch("core.trigger.trigger_manager.contexts")
- def test_plugin_daemon_error_propagates(self, mock_ctx, mock_client):
- mock_ctx.plugin_trigger_providers.get.return_value = {}
+ def test_plugin_daemon_error_propagates(self, mock_ctx: MagicMock, mock_client: MagicMock) -> None:
+ mock_ctx.plugin_trigger_providers.get.return_value = dict[str, object]()
mock_ctx.plugin_trigger_providers_lock.get.return_value = Lock()
mock_client.return_value.fetch_trigger_provider.side_effect = PluginDaemonError("test error")
@@ -177,7 +195,7 @@ class TestGetTriggerProvider:
class TestListAllTriggerProviders:
@patch.object(TriggerManager, "list_plugin_trigger_providers")
- def test_delegates_to_list_plugin(self, mock_list):
+ def test_delegates_to_list_plugin(self, mock_list: MagicMock) -> None:
expected = [make_controller()]
mock_list.return_value = expected
@@ -187,7 +205,7 @@ class TestListAllTriggerProviders:
class TestListTriggersByProvider:
@patch.object(TriggerManager, "get_trigger_provider")
- def test_returns_provider_events(self, mock_get):
+ def test_returns_provider_events(self, mock_get: MagicMock) -> None:
ctrl = make_controller()
mock_get.return_value = ctrl
@@ -197,7 +215,7 @@ class TestListTriggersByProvider:
class TestInvokeTriggerEvent:
- def _args(self):
+ def _args(self) -> _InvokeTriggerEventArgs:
return {
"tenant_id": "t1",
"user_id": "u1",
@@ -212,7 +230,7 @@ class TestInvokeTriggerEvent:
}
@patch.object(TriggerManager, "get_trigger_provider")
- def test_returns_invoke_response(self, mock_get):
+ def test_returns_invoke_response(self, mock_get: MagicMock) -> None:
ctrl = MagicMock()
expected = TriggerInvokeEventResponse(variables={"v": "1"}, cancelled=False)
ctrl.invoke_trigger_event.return_value = expected
@@ -224,7 +242,7 @@ class TestInvokeTriggerEvent:
assert result.cancelled is False
@patch.object(TriggerManager, "get_trigger_provider")
- def test_event_ignore_returns_cancelled(self, mock_get):
+ def test_event_ignore_returns_cancelled(self, mock_get: MagicMock) -> None:
ctrl = MagicMock()
ctrl.invoke_trigger_event.side_effect = EventIgnoreError("skip")
mock_get.return_value = ctrl
@@ -235,7 +253,7 @@ class TestInvokeTriggerEvent:
assert result.variables == {}
@patch.object(TriggerManager, "get_trigger_provider")
- def test_other_errors_propagate(self, mock_get):
+ def test_other_errors_propagate(self, mock_get: MagicMock) -> None:
ctrl = MagicMock()
ctrl.invoke_trigger_event.side_effect = RuntimeError("boom")
mock_get.return_value = ctrl
@@ -246,7 +264,7 @@ class TestInvokeTriggerEvent:
class TestSubscribeTrigger:
@patch.object(TriggerManager, "get_trigger_provider")
- def test_delegates_with_correct_args(self, mock_get):
+ def test_delegates_with_correct_args(self, mock_get: MagicMock) -> None:
ctrl = MagicMock()
expected = make_subscription()
ctrl.subscribe_trigger.return_value = expected
@@ -268,7 +286,7 @@ class TestSubscribeTrigger:
class TestUnsubscribeTrigger:
@patch.object(TriggerManager, "get_trigger_provider")
- def test_delegates_with_correct_args(self, mock_get):
+ def test_delegates_with_correct_args(self, mock_get: MagicMock) -> None:
ctrl = MagicMock()
expected = MagicMock()
ctrl.unsubscribe_trigger.return_value = expected
@@ -289,7 +307,7 @@ class TestUnsubscribeTrigger:
class TestRefreshTrigger:
@patch.object(TriggerManager, "get_trigger_provider")
- def test_delegates_with_correct_args(self, mock_get):
+ def test_delegates_with_correct_args(self, mock_get: MagicMock) -> None:
ctrl = MagicMock()
expected = make_subscription()
ctrl.refresh_trigger.return_value = expected
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 0f5ec443f6d..aec94de0e96 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -469,10 +469,8 @@ project-excludes = [
"core/tools/utils/test_workflow_configuration_sync.py",
"core/tools/workflow_as_tool/test_provider.py",
"core/tools/workflow_as_tool/test_tool.py",
- "core/trigger/conftest.py",
"core/trigger/debug/test_debug_event_bus.py",
"core/trigger/debug/test_debug_event_selectors.py",
- "core/trigger/test_trigger_manager.py",
"core/trigger/utils/test_utils_encryption.py",
"core/trigger/utils/test_utils_endpoint.py",
"core/trigger/utils/test_utils_locks.py",