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 moderation tests (#43914)

Eddy ZHANGea45f2d59440
diff --git a/api/tests/unit_tests/core/moderation/api/test_api.py b/api/tests/unit_tests/core/moderation/api/test_api.py
index 99eded2a5c4..97a4ba25af3 100644
--- a/api/tests/unit_tests/core/moderation/api/test_api.py
+++ b/api/tests/unit_tests/core/moderation/api/test_api.py
@@ -13,7 +13,7 @@ from models.api_based_extension import APIBasedExtension
class TestApiModeration:
@pytest.fixture
- def api_config(self):
+ def api_config(self) -> dict[str, object]:
return {
"inputs_config": {
"enabled": True,
@@ -25,10 +25,10 @@ class TestApiModeration:
}
@pytest.fixture
- def api_moderation(self, api_config):
+ def api_moderation(self, api_config: dict[str, object]) -> ApiModeration:
return ApiModeration(app_id="test-app-id", tenant_id="test-tenant-id", config=api_config)
- def test_moderation_input_params(self):
+ def test_moderation_input_params(self) -> None:
params = ModerationInputParams(app_id="app-1", inputs={"key": "val"}, query="test query")
assert params.app_id == "app-1"
assert params.inputs == {"key": "val"}
@@ -40,23 +40,23 @@ class TestApiModeration:
assert params_default.inputs == {}
assert params_default.query == ""
- def test_moderation_output_params(self):
+ def test_moderation_output_params(self) -> None:
params = ModerationOutputParams(app_id="app-1", text="test text")
assert params.app_id == "app-1"
assert params.text == "test text"
with pytest.raises(ValidationError):
- ModerationOutputParams()
+ ModerationOutputParams() # pyrefly: ignore[missing-argument]
@patch("core.moderation.api.api.ApiModeration._get_api_based_extension")
- def test_validate_config_success(self, mock_get_extension, api_config):
+ def test_validate_config_success(self, mock_get_extension: MagicMock, api_config: dict[str, object]) -> None:
mock_get_extension.return_value = APIBasedExtension(
tenant_id="tenant-id", name="Test Extension", api_endpoint="https://example.com", api_key="test-key"
)
ApiModeration.validate_config("test-tenant-id", api_config)
mock_get_extension.assert_called_once_with("test-tenant-id", "test-extension-id", db.session)
- def test_validate_config_missing_extension_id(self):
+ def test_validate_config_missing_extension_id(self) -> None:
config = {
"inputs_config": {"enabled": True},
"outputs_config": {"enabled": True},
@@ -65,13 +65,15 @@ class TestApiModeration:
ApiModeration.validate_config("test-tenant-id", config)
@patch("core.moderation.api.api.ApiModeration._get_api_based_extension")
- def test_validate_config_extension_not_found(self, mock_get_extension, api_config):
+ def test_validate_config_extension_not_found(
+ self, mock_get_extension: MagicMock, api_config: dict[str, object]
+ ) -> None:
mock_get_extension.return_value = None
with pytest.raises(ValueError, match="API-based Extension not found"):
ApiModeration.validate_config("test-tenant-id", api_config)
@patch("core.moderation.api.api.ApiModeration._get_config_by_requestor")
- def test_moderation_for_inputs_enabled(self, mock_get_config, api_moderation):
+ def test_moderation_for_inputs_enabled(self, mock_get_config: MagicMock, api_moderation: ApiModeration) -> None:
mock_get_config.return_value = {"flagged": True, "action": "direct_output", "preset_response": "Blocked by API"}
result = api_moderation.moderation_for_inputs(inputs={"q": "a"}, query="hello")
@@ -86,7 +88,7 @@ class TestApiModeration:
{"app_id": "test-app-id", "inputs": {"q": "a"}, "query": "hello"},
)
- def test_moderation_for_inputs_disabled(self):
+ def test_moderation_for_inputs_disabled(self) -> None:
config = {
"inputs_config": {"enabled": False},
"outputs_config": {"enabled": True},
@@ -99,13 +101,13 @@ class TestApiModeration:
assert result.action == ModerationAction.DIRECT_OUTPUT
assert result.preset_response == ""
- def test_moderation_for_inputs_no_config(self):
+ def test_moderation_for_inputs_no_config(self) -> None:
moderation = ApiModeration("app-id", "tenant-id", None)
with pytest.raises(ValueError, match="The config is not set"):
moderation.moderation_for_inputs({}, "")
@patch("core.moderation.api.api.ApiModeration._get_config_by_requestor")
- def test_moderation_for_outputs_enabled(self, mock_get_config, api_moderation):
+ def test_moderation_for_outputs_enabled(self, mock_get_config: MagicMock, api_moderation: ApiModeration) -> None:
mock_get_config.return_value = {"flagged": False, "action": "direct_output", "preset_response": ""}
result = api_moderation.moderation_for_outputs(text="hello world")
@@ -117,7 +119,7 @@ class TestApiModeration:
APIBasedExtensionPoint.APP_MODERATION_OUTPUT, {"app_id": "test-app-id", "text": "hello world"}
)
- def test_moderation_for_outputs_disabled(self):
+ def test_moderation_for_outputs_disabled(self) -> None:
config = {
"inputs_config": {"enabled": True},
"outputs_config": {"enabled": False},
@@ -129,7 +131,7 @@ class TestApiModeration:
assert result.flagged is False
assert result.action == ModerationAction.DIRECT_OUTPUT
- def test_moderation_for_outputs_no_config(self):
+ def test_moderation_for_outputs_no_config(self) -> None:
moderation = ApiModeration("app-id", "tenant-id", None)
with pytest.raises(ValueError, match="The config is not set"):
moderation.moderation_for_outputs("test")
@@ -137,7 +139,13 @@ class TestApiModeration:
@patch("core.moderation.api.api.ApiModeration._get_api_based_extension")
@patch("core.moderation.api.api.decrypt_token")
@patch("core.moderation.api.api.APIBasedExtensionRequestor")
- def test_get_config_by_requestor_success(self, mock_requestor_cls, mock_decrypt, mock_get_ext, api_moderation):
+ def test_get_config_by_requestor_success(
+ self,
+ mock_requestor_cls: MagicMock,
+ mock_decrypt: MagicMock,
+ mock_get_ext: MagicMock,
+ api_moderation: ApiModeration,
+ ) -> None:
mock_ext = APIBasedExtension(
tenant_id="tenant-id",
name="Test Extension",
@@ -161,13 +169,15 @@ class TestApiModeration:
mock_requestor_cls.assert_called_once_with("http://api.test", "decrypted-key")
mock_requestor.request.assert_called_once_with(APIBasedExtensionPoint.APP_MODERATION_INPUT, params)
- def test_get_config_by_requestor_no_config(self):
+ def test_get_config_by_requestor_no_config(self) -> None:
moderation = ApiModeration("app-id", "tenant-id", None)
with pytest.raises(ValueError, match="The config is not set"):
moderation._get_config_by_requestor(APIBasedExtensionPoint.APP_MODERATION_INPUT, {})
@patch("core.moderation.api.api.ApiModeration._get_api_based_extension")
- def test_get_config_by_requestor_extension_not_found(self, mock_get_ext, api_moderation):
+ def test_get_config_by_requestor_extension_not_found(
+ self, mock_get_ext: MagicMock, api_moderation: ApiModeration
+ ) -> None:
mock_get_ext.return_value = None
with pytest.raises(ValueError, match="API-based Extension not found"):
api_moderation._get_config_by_requestor(APIBasedExtensionPoint.APP_MODERATION_INPUT, {})
@@ -190,7 +200,10 @@ class TestApiModeration:
sqlite_session.add_all((target, other_tenant))
sqlite_session.commit()
- result = ApiModeration._get_api_based_extension("tenant-1", "ext-1", sqlite_session)
+ result = ApiModeration._get_api_based_extension("tenant-1", "ext-1", sqlite_session) # pyrefly: ignore[bad-argument-type]
assert result is target
- assert ApiModeration._get_api_based_extension("tenant-1", "ext-2", sqlite_session) is None
+ assert (
+ ApiModeration._get_api_based_extension("tenant-1", "ext-2", sqlite_session) # pyrefly: ignore[bad-argument-type]
+ is None
+ )
diff --git a/api/tests/unit_tests/core/moderation/test_output_moderation.py b/api/tests/unit_tests/core/moderation/test_output_moderation.py
index ceafd9f04d3..cfc5e5139e1 100644
--- a/api/tests/unit_tests/core/moderation/test_output_moderation.py
+++ b/api/tests/unit_tests/core/moderation/test_output_moderation.py
@@ -11,9 +11,14 @@ from core.moderation.base import ModerationAction, ModerationOutputsResult
from core.moderation.output_moderation import ModerationRule, OutputModeration
+def _publish_mock(manager: MessageBasedAppQueueManager) -> MagicMock:
+ assert isinstance(manager.publish, MagicMock)
+ return manager.publish
+
+
class TestOutputModeration:
@pytest.fixture
- def queue_manager(self):
+ def queue_manager(self) -> MessageBasedAppQueueManager:
with patch("core.app.apps.base_app_queue_manager.redis_client.setex"):
manager = MessageBasedAppQueueManager(
task_id="test-task",
@@ -27,26 +32,28 @@ class TestOutputModeration:
return manager
@pytest.fixture
- def moderation_rule(self):
+ def moderation_rule(self) -> ModerationRule:
return ModerationRule(type="keywords", config={"keywords": "badword"})
@pytest.fixture
- def output_moderation(self, queue_manager, moderation_rule: ModerationRule):
+ def output_moderation(
+ self, queue_manager: MessageBasedAppQueueManager, moderation_rule: ModerationRule
+ ) -> OutputModeration:
return OutputModeration(
tenant_id="test_tenant", app_id="test_app", rule=moderation_rule, queue_manager=queue_manager
)
- def test_should_direct_output(self, output_moderation: OutputModeration):
+ def test_should_direct_output(self, output_moderation: OutputModeration) -> None:
assert output_moderation.should_direct_output() is False
output_moderation.final_output = "blocked"
assert output_moderation.should_direct_output() is True
- def test_get_final_output(self, output_moderation: OutputModeration):
+ def test_get_final_output(self, output_moderation: OutputModeration) -> None:
assert output_moderation.get_final_output() == ""
output_moderation.final_output = "blocked"
assert output_moderation.get_final_output() == "blocked"
- def test_append_new_token(self, output_moderation: OutputModeration):
+ def test_append_new_token(self, output_moderation: OutputModeration) -> None:
with patch.object(OutputModeration, "start_thread") as mock_start:
output_moderation.append_new_token("hello")
assert output_moderation.buffer == "hello"
@@ -57,7 +64,7 @@ class TestOutputModeration:
assert output_moderation.buffer == "hello world"
assert mock_start.call_count == 1
- def test_moderation_completion_no_flag(self, output_moderation: OutputModeration):
+ def test_moderation_completion_no_flag(self, output_moderation: OutputModeration) -> None:
with patch.object(OutputModeration, "moderation") as mock_moderation:
mock_moderation.return_value = ModerationOutputsResult(flagged=False, action=ModerationAction.DIRECT_OUTPUT)
@@ -67,7 +74,9 @@ class TestOutputModeration:
assert flagged is False
assert output_moderation.is_final_chunk is True
- def test_moderation_completion_flagged_direct_output(self, output_moderation: OutputModeration, queue_manager):
+ def test_moderation_completion_flagged_direct_output(
+ self, output_moderation: OutputModeration, queue_manager: MessageBasedAppQueueManager
+ ) -> None:
with patch.object(OutputModeration, "moderation") as mock_moderation:
mock_moderation.return_value = ModerationOutputsResult(
flagged=True, action=ModerationAction.DIRECT_OUTPUT, preset_response="preset"
@@ -77,13 +86,15 @@ class TestOutputModeration:
assert output == "preset"
assert flagged is True
- queue_manager.publish.assert_called_once()
- args, _ = queue_manager.publish.call_args
+ _publish_mock(queue_manager).assert_called_once()
+ args, _ = _publish_mock(queue_manager).call_args
assert isinstance(args[0], QueueMessageReplaceEvent)
assert args[0].text == "preset"
assert args[1] == PublishFrom.TASK_PIPELINE
- def test_moderation_completion_flagged_overridden(self, output_moderation: OutputModeration, queue_manager):
+ def test_moderation_completion_flagged_overridden(
+ self, output_moderation: OutputModeration, queue_manager: MessageBasedAppQueueManager
+ ) -> None:
with patch.object(OutputModeration, "moderation") as mock_moderation:
mock_moderation.return_value = ModerationOutputsResult(
flagged=True, action=ModerationAction.OVERRIDDEN, text="masked content"
@@ -93,11 +104,11 @@ class TestOutputModeration:
assert output == "masked content"
assert flagged is True
- queue_manager.publish.assert_called_once()
- args, _ = queue_manager.publish.call_args
+ _publish_mock(queue_manager).assert_called_once()
+ args, _ = _publish_mock(queue_manager).call_args
assert args[0].text == "masked content"
- def test_start_thread(self, output_moderation: OutputModeration):
+ def test_start_thread(self, output_moderation: OutputModeration) -> None:
app = Flask(__name__)
with app.app_context():
with patch("threading.Thread") as mock_thread_class:
@@ -110,7 +121,7 @@ class TestOutputModeration:
mock_thread_class.assert_called_once()
mock_thread_instance.start.assert_called_once()
- def test_stop_thread(self, output_moderation: OutputModeration):
+ def test_stop_thread(self, output_moderation: OutputModeration) -> None:
mock_thread = MagicMock()
mock_thread.is_alive.return_value = True
output_moderation.thread = mock_thread
@@ -121,10 +132,10 @@ class TestOutputModeration:
output_moderation.thread_running = True
mock_thread.is_alive.return_value = False
output_moderation.stop_thread()
- assert output_moderation.thread_running is True
+ assert output_moderation.thread_running
@patch("core.moderation.output_moderation.ModerationFactory")
- def test_moderation_success(self, mock_factory_class, output_moderation: OutputModeration):
+ def test_moderation_success(self, mock_factory_class: MagicMock, output_moderation: OutputModeration) -> None:
mock_factory = mock_factory_class.return_value
mock_result = ModerationOutputsResult(flagged=False, action=ModerationAction.DIRECT_OUTPUT)
mock_factory.moderation_for_outputs.return_value = mock_result
@@ -137,13 +148,15 @@ class TestOutputModeration:
)
@patch("core.moderation.output_moderation.ModerationFactory")
- def test_moderation_exception(self, mock_factory_class, output_moderation: OutputModeration):
+ def test_moderation_exception(self, mock_factory_class: MagicMock, output_moderation: OutputModeration) -> None:
mock_factory_class.side_effect = Exception("error")
result = output_moderation.moderation("tenant", "app", "buffer")
assert result is None
- def test_worker_loop_and_exit(self, output_moderation: OutputModeration, queue_manager):
+ def test_worker_loop_and_exit(
+ self, output_moderation: OutputModeration, queue_manager: MessageBasedAppQueueManager
+ ) -> None:
app = Flask(__name__)
# Test exit on thread_running=False
@@ -151,7 +164,7 @@ class TestOutputModeration:
output_moderation.worker(app, 10)
# Should exit immediately
- def test_worker_no_flag(self, output_moderation: OutputModeration):
+ def test_worker_no_flag(self, output_moderation: OutputModeration) -> None:
app = Flask(__name__)
with patch.object(OutputModeration, "moderation") as mock_moderation:
@@ -161,7 +174,7 @@ class TestOutputModeration:
output_moderation.is_final_chunk = True
# To avoid infinite loop, we'll set thread_running to False after one iteration
- def side_effect[**P](*args: P.args, **kwargs: P.kwargs):
+ def side_effect[**P](*args: P.args, **kwargs: P.kwargs) -> object:
output_moderation.thread_running = False
return mock_moderation.return_value
@@ -171,7 +184,9 @@ class TestOutputModeration:
assert mock_moderation.called
- def test_worker_flagged_direct_output(self, output_moderation: OutputModeration, queue_manager):
+ def test_worker_flagged_direct_output(
+ self, output_moderation: OutputModeration, queue_manager: MessageBasedAppQueueManager
+ ) -> None:
app = Flask(__name__)
with patch.object(OutputModeration, "moderation") as mock_moderation:
@@ -185,15 +200,17 @@ class TestOutputModeration:
output_moderation.worker(app, 10)
assert output_moderation.final_output == "preset"
- queue_manager.publish.assert_called_once()
+ _publish_mock(queue_manager).assert_called_once()
# It breaks on DIRECT_OUTPUT
- def test_worker_flagged_overridden(self, output_moderation: OutputModeration, queue_manager):
+ def test_worker_flagged_overridden(
+ self, output_moderation: OutputModeration, queue_manager: MessageBasedAppQueueManager
+ ) -> None:
app = Flask(__name__)
with patch.object(OutputModeration, "moderation") as mock_moderation:
# Use side_effect to change thread_running on second call
- def side_effect[**P](*args: P.args, **kwargs: P.kwargs):
+ def side_effect[**P](*args: P.args, **kwargs: P.kwargs) -> object:
if mock_moderation.call_count > 1:
output_moderation.thread_running = False
return None
@@ -206,18 +223,18 @@ class TestOutputModeration:
output_moderation.worker(app, 10)
- queue_manager.publish.assert_called_once()
- args, _ = queue_manager.publish.call_args
+ _publish_mock(queue_manager).assert_called_once()
+ args, _ = _publish_mock(queue_manager).call_args
assert args[0].text == "masked"
- def test_worker_chunk_too_small(self, output_moderation: OutputModeration):
+ def test_worker_chunk_too_small(self, output_moderation: OutputModeration) -> None:
app = Flask(__name__)
with patch("time.sleep") as mock_sleep:
# chunk_length < buffer_size and not is_final_chunk
output_moderation.buffer = "123" # length 3
output_moderation.is_final_chunk = False
- def sleep_side_effect(seconds):
+ def sleep_side_effect(seconds: float) -> None:
output_moderation.thread_running = False
mock_sleep.side_effect = sleep_side_effect
@@ -226,13 +243,15 @@ class TestOutputModeration:
mock_sleep.assert_called_once_with(1)
- def test_worker_empty_not_flagged(self, output_moderation: OutputModeration, queue_manager):
+ def test_worker_empty_not_flagged(
+ self, output_moderation: OutputModeration, queue_manager: MessageBasedAppQueueManager
+ ) -> None:
app = Flask(__name__)
with patch.object(OutputModeration, "moderation") as mock_moderation:
# Return None (exception or no rule)
mock_moderation.return_value = None
- def side_effect[**P](*args: P.args, **kwargs: P.kwargs):
+ def side_effect[**P](*args: P.args, **kwargs: P.kwargs) -> object:
output_moderation.thread_running = False
mock_moderation.side_effect = side_effect
@@ -242,4 +261,4 @@ class TestOutputModeration:
output_moderation.worker(app, 10)
- queue_manager.publish.assert_not_called()
+ _publish_mock(queue_manager).assert_not_called()
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index d7e43c75791..25dd6c4350b 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -353,9 +353,7 @@ project-excludes = [
"core/mcp/test_utils.py",
"core/memory/test_token_buffer_memory.py",
"core/model_runtime/test_model_provider_factory.py",
- "core/moderation/api/test_api.py",
"core/moderation/test_input_moderation.py",
- "core/moderation/test_output_moderation.py",
"core/ops/test_base_trace_instance.py",
"core/ops/test_config_entity.py",
"core/ops/test_lookup_helpers.py",