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 services agent composer tests (#43933)

Eddy ZHANGc433d3260f08
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index ccd28799d73..6c81589dbae 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -598,16 +598,11 @@ project-excludes = [
"oss/tencent_cos/test_tencent_cos.py",
"oss/volcengine_tos/test_volcengine_tos.py",
"repositories/test_sqlalchemy_api_workflow_run_repository.py",
- "services/agent/test_agent_composer_entities.py",
"services/agent/test_agent_dsl_service.py",
"services/agent/test_agent_observability_service.py",
"services/agent/test_agent_services.py",
- "services/agent/test_composer_candidates.py",
- "services/agent/test_composer_mention_validation.py",
"services/agent/test_prompt_mentions.py",
"services/agent/test_skill_package_service.py",
- "services/agent/test_skill_standardize_service.py",
- "services/agent/test_skill_tool_inference_service.py",
"services/agent/test_workflow_publish_service.py",
"services/auth/test_api_key_auth_base.py",
"services/auth/test_api_key_auth_factory.py",
diff --git a/api/tests/unit_tests/services/agent/test_agent_composer_entities.py b/api/tests/unit_tests/services/agent/test_agent_composer_entities.py
index f18d58e3032..66309de5b59 100644
--- a/api/tests/unit_tests/services/agent/test_agent_composer_entities.py
+++ b/api/tests/unit_tests/services/agent/test_agent_composer_entities.py
@@ -14,7 +14,7 @@ from services.entities.agent_entities import (
)
-def test_default_agent_soul_enables_file_upload_feature():
+def test_default_agent_soul_enables_file_upload_feature() -> None:
agent_soul = AgentSoulConfig()
file_upload = agent_soul.model_dump(mode="json")["app_features"]["file_upload"]
@@ -31,7 +31,7 @@ def test_default_agent_soul_enables_file_upload_feature():
assert bool(agent_soul.app_features) is False
-def test_workflow_variant_rejects_agent_app_only_fields():
+def test_workflow_variant_rejects_agent_app_only_fields() -> None:
with pytest.raises(ValueError):
ComposerSavePayload.model_validate(
{
@@ -44,7 +44,7 @@ def test_workflow_variant_rejects_agent_app_only_fields():
)
-def test_agent_app_variant_rejects_workflow_node_job():
+def test_agent_app_variant_rejects_workflow_node_job() -> None:
with pytest.raises(ValueError):
ComposerSavePayload.model_validate(
{
@@ -55,7 +55,7 @@ def test_agent_app_variant_rejects_workflow_node_job():
)
-def test_locked_workflow_soul_rejects_soul_changes():
+def test_locked_workflow_soul_rejects_soul_changes() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": ComposerVariant.WORKFLOW,
@@ -69,7 +69,7 @@ def test_locked_workflow_soul_rejects_soul_changes():
ComposerConfigValidator.validate_save_payload(payload)
-def test_locked_workflow_node_job_only_allows_inline_soul_payload():
+def test_locked_workflow_node_job_only_allows_inline_soul_payload() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": ComposerVariant.WORKFLOW,
@@ -82,7 +82,7 @@ def test_locked_workflow_node_job_only_allows_inline_soul_payload():
ComposerConfigValidator.validate_save_payload(payload)
-def test_draft_save_payload_skips_publish_only_agent_soul_validation():
+def test_draft_save_payload_skips_publish_only_agent_soul_validation() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": ComposerVariant.AGENT_APP,
@@ -100,7 +100,7 @@ def test_draft_save_payload_skips_publish_only_agent_soul_validation():
ComposerConfigValidator.validate_publish_payload(payload)
-def test_agent_app_soul_allows_app_features_and_variables():
+def test_agent_app_soul_allows_app_features_and_variables() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": ComposerVariant.AGENT_APP,
@@ -123,7 +123,7 @@ def test_agent_app_soul_allows_app_features_and_variables():
assert payload.agent_soul.app_variables[0].name == "company_name"
-def test_agent_app_soul_accepts_legacy_follow_up_model_config():
+def test_agent_app_soul_accepts_legacy_follow_up_model_config() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": ComposerVariant.AGENT_APP,
@@ -155,7 +155,7 @@ def test_agent_app_soul_accepts_legacy_follow_up_model_config():
assert follow_up.model.completion_params == {"temperature": 0.7, "max_tokens": 128}
-def test_composer_save_payload_accepts_new_roster_metadata():
+def test_composer_save_payload_accepts_new_roster_metadata() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": ComposerVariant.WORKFLOW,
@@ -177,7 +177,7 @@ def test_composer_save_payload_accepts_new_roster_metadata():
assert payload.icon_background == "#E0F2FE"
-def test_knowledge_query_mode_uses_stable_backend_enums():
+def test_knowledge_query_mode_uses_stable_backend_enums() -> None:
config = AgentSoulConfig.model_validate(
{
"knowledge": {
@@ -258,7 +258,7 @@ def test_knowledge_query_mode_uses_stable_backend_enums():
),
],
)
-def test_knowledge_sets_contract_rejects_invalid_configs(knowledge_payload, match: str):
+def test_knowledge_sets_contract_rejects_invalid_configs(knowledge_payload: object, match: str) -> None:
with pytest.raises(ValidationError, match=match):
AgentSoulConfig.model_validate({"knowledge": knowledge_payload})
@@ -326,7 +326,7 @@ def test_knowledge_sets_contract_rejects_invalid_configs(knowledge_payload, matc
),
],
)
-def test_knowledge_runtime_requirements_block_publish_but_not_draft_save(knowledge_payload, match: str):
+def test_knowledge_runtime_requirements_block_publish_but_not_draft_save(knowledge_payload: object, match: str) -> None:
draft_payload = ComposerSavePayload.model_validate(
{
"variant": ComposerVariant.AGENT_APP,
@@ -347,7 +347,7 @@ def test_knowledge_runtime_requirements_block_publish_but_not_draft_save(knowled
ComposerConfigValidator.validate_publish_payload(publish_payload)
-def test_manual_metadata_filtering_condition_accepts_composer_ui_identifiers():
+def test_manual_metadata_filtering_condition_accepts_composer_ui_identifiers() -> None:
"""The composer's condition editor always sends ``id`` (list row key) and
``metadata_id`` (selected metadata field reference) alongside every
condition. Rejecting them as unknown fields broke every save of a manual
@@ -387,12 +387,15 @@ def test_manual_metadata_filtering_condition_accepts_composer_ui_identifiers():
}
)
- condition = payload.agent_soul.knowledge.sets[0].metadata_filtering.conditions.conditions[0]
+ assert payload.agent_soul is not None
+ conditions = payload.agent_soul.knowledge.sets[0].metadata_filtering.conditions
+ assert conditions is not None
+ condition = conditions.conditions[0]
assert condition.id == "b149eceb-191a-40a2-9f11-61cf21ebd147"
assert condition.metadata_id == "ad6cf326-eadf-46e8-a2d5-9cb892d2cc84"
-def test_agent_soul_model_config_is_first_class_without_credentials():
+def test_agent_soul_model_config_is_first_class_without_credentials() -> None:
config = AgentSoulConfig(
model=AgentSoulModelConfig(
plugin_id="langgenius/openai",
@@ -408,7 +411,7 @@ def test_agent_soul_model_config_is_first_class_without_credentials():
assert dumped["model"]["credential_ref"] == {"type": "provider", "id": "credential-1", "provider": None}
-def test_declared_outputs_support_file_check_and_failure_strategy():
+def test_declared_outputs_support_file_check_and_failure_strategy() -> None:
"""Stage 4 §4.3 + §4.4: file output may carry a single ``check`` plus a
full LLM-node-parity ``failure_strategy``."""
node_job = WorkflowNodeJobConfig.model_validate(
@@ -444,14 +447,14 @@ def test_declared_outputs_support_file_check_and_failure_strategy():
assert output.failure_strategy.on_failure.value == "fail_branch"
-def test_plaintext_secrets_are_rejected():
+def test_plaintext_secrets_are_rejected() -> None:
config = AgentSoulConfig.model_validate({"env": {"variables": [{"name": "OPENAI_API_KEY", "api_key": "secret"}]}})
with pytest.raises(PlaintextSecretNotAllowedError):
ComposerConfigValidator.validate_agent_soul(config)
-def test_workflow_agent_soul_config_strips_agent_app_only_fields():
+def test_workflow_agent_soul_config_strips_agent_app_only_fields() -> None:
config = AgentComposerService._workflow_agent_soul_config(
{
"prompt": {"system_prompt": "answer carefully"},
diff --git a/api/tests/unit_tests/services/agent/test_composer_candidates.py b/api/tests/unit_tests/services/agent/test_composer_candidates.py
index 990302e9f91..ac91b5ce404 100644
--- a/api/tests/unit_tests/services/agent/test_composer_candidates.py
+++ b/api/tests/unit_tests/services/agent/test_composer_candidates.py
@@ -2,6 +2,7 @@
from __future__ import annotations
+from collections.abc import Iterable
from unittest.mock import Mock
from fields.agent_fields import AgentComposerCandidatesResponse
@@ -65,7 +66,7 @@ def _draft_vars(nid: str) -> list[tuple[str, str | None]]:
return []
-def _collect(node_id: str, *, system_vars=()):
+def _collect(node_id: str, *, system_vars: Iterable[tuple[str, str]] = ()) -> tuple[list[dict[str, object]], bool]:
entries, truncated = previous_node_output_candidates(
graph=_GRAPH,
node_id=node_id,
@@ -76,7 +77,7 @@ def _collect(node_id: str, *, system_vars=()):
return entries, truncated
-def test_upstream_outputs_follow_inspector_semantics():
+def test_upstream_outputs_follow_inspector_semantics() -> None:
entries, truncated = _collect("agent-target", system_vars=[("query", "string")])
assert truncated is False
@@ -107,7 +108,7 @@ def test_upstream_outputs_follow_inspector_semantics():
assert "end" not in by_node
-def test_results_differ_per_node_id():
+def test_results_differ_per_node_id() -> None:
entries_target, _ = _collect("agent-target")
entries_llm, _ = _collect("llm-1")
@@ -140,9 +141,9 @@ def test_historical_agent_version_two_uses_inferred_outputs() -> None:
declared_loader.assert_not_called()
-def test_previous_outputs_capped_and_flagged():
+def test_previous_outputs_capped_and_flagged() -> None:
graph = {
- "nodes": [{"id": "start-1", "data": {"type": "start", "title": "S", "variables": []}}, {"id": "t"}],
+ "nodes": [{"id": "start-1", "data": {"type": "start", "title": "S", "variables": list[object]()}}, {"id": "t"}],
"edges": [{"source": "start-1", "target": "t"}],
}
many: list[tuple[str, str | None]] = [(f"v{i}", "string") for i in range(MAX_CANDIDATES_PER_LIST + 5)]
@@ -183,7 +184,7 @@ def _soul() -> AgentSoulConfig:
)
-def test_soul_candidates_lists_configured_items_only():
+def test_soul_candidates_lists_configured_items_only() -> None:
dataset = Dataset(
id="ds-1",
tenant_id="tenant-1",
@@ -217,7 +218,7 @@ def test_soul_candidates_lists_configured_items_only():
assert lists["dify_tools"][0]["id"] == "tavily/tavily_search"
-def test_candidates_response_omits_legacy_skill_file_candidates():
+def test_candidates_response_omits_legacy_skill_file_candidates() -> None:
response = AgentComposerCandidatesResponse.model_validate(
{
"variant": "agent_app",
@@ -232,7 +233,7 @@ def test_candidates_response_omits_legacy_skill_file_candidates():
assert "skills_files" not in response["allowed_soul_candidates"]
-def test_soul_candidates_empty_config_yields_empty_lists():
+def test_soul_candidates_empty_config_yields_empty_lists() -> None:
lists, truncated = soul_candidates(
agent_soul=None,
dataset_lookup=lambda ids: {},
@@ -242,7 +243,7 @@ def test_soul_candidates_empty_config_yields_empty_lists():
assert all(value == [] for value in lists.values())
-def test_soul_candidates_caps_lists():
+def test_soul_candidates_caps_lists() -> None:
lists, truncated = soul_candidates(
agent_soul=None,
dataset_lookup=lambda ids: {},
diff --git a/api/tests/unit_tests/services/agent/test_composer_mention_validation.py b/api/tests/unit_tests/services/agent/test_composer_mention_validation.py
index 3d28f577137..5095afbbc28 100644
--- a/api/tests/unit_tests/services/agent/test_composer_mention_validation.py
+++ b/api/tests/unit_tests/services/agent/test_composer_mention_validation.py
@@ -29,39 +29,39 @@ def _node_job_payload(workflow_prompt: str) -> ComposerSavePayload:
)
-def test_soul_prompt_accepts_soul_kinds():
+def test_soul_prompt_accepts_soul_kinds() -> None:
payload = _soul_payload("Use [§skill:s1§] [§file:f1§] [§tool:p/t§] [§cli_tool:c§] [§knowledge:k1§] [§human:h1§]")
ComposerConfigValidator.validate_save_payload(payload)
-def test_soul_prompt_rejects_node_output_mention():
+def test_soul_prompt_rejects_node_output_mention() -> None:
with pytest.raises(InvalidComposerConfigError, match="mention_kind_not_allowed"):
ComposerConfigValidator.validate_save_payload(_soul_payload("Read [§node_output:n1.text§]"))
-def test_soul_prompt_rejects_declared_output_mention():
+def test_soul_prompt_rejects_declared_output_mention() -> None:
with pytest.raises(InvalidComposerConfigError, match="mention_kind_not_allowed"):
ComposerConfigValidator.validate_save_payload(_soul_payload("Produce [§output:report§]"))
-def test_node_job_prompt_accepts_job_kinds():
+def test_node_job_prompt_accepts_job_kinds() -> None:
payload = _node_job_payload("Read [§node_output:n1.text:START/text§], produce [§output:report§], ask [§human:h1§]")
ComposerConfigValidator.validate_save_payload(payload)
@pytest.mark.parametrize("token", ["[§skill:s1§]", "[§tool:p/t§]", "[§cli_tool:c§]", "[§knowledge:k1§]"])
-def test_node_job_prompt_rejects_soul_only_kinds(token: str):
+def test_node_job_prompt_rejects_soul_only_kinds(token: str) -> None:
with pytest.raises(InvalidComposerConfigError, match="mention_kind_not_allowed"):
ComposerConfigValidator.validate_save_payload(_node_job_payload(f"Use {token}"))
-def test_mention_limit_enforced():
+def test_mention_limit_enforced() -> None:
prompt = " ".join(f"[§human:h{i}§]" for i in range(201))
with pytest.raises(InvalidComposerConfigError, match="mention_limit_exceeded"):
ComposerConfigValidator.validate_save_payload(_soul_payload(prompt))
-def test_prompt_without_mentions_still_passes():
+def test_prompt_without_mentions_still_passes() -> None:
ComposerConfigValidator.validate_save_payload(_soul_payload("plain prompt, {{var}} and {{#context#}} untouched"))
@@ -83,20 +83,20 @@ def _soul_payload_with_human(system_prompt: str) -> ComposerSavePayload:
)
-def test_configured_human_without_mention_is_rejected():
+def test_configured_human_without_mention_is_rejected() -> None:
with pytest.raises(InvalidComposerConfigError, match="human_involvement_not_referenced"):
ComposerConfigValidator.validate_save_payload(_soul_payload_with_human("no human reference here"))
-def test_configured_human_referenced_by_id_passes():
+def test_configured_human_referenced_by_id_passes() -> None:
ComposerConfigValidator.validate_save_payload(_soul_payload_with_human("ask [§human:c-1§] when unsure"))
-def test_configured_human_referenced_by_email_alias_passes():
+def test_configured_human_referenced_by_email_alias_passes() -> None:
ComposerConfigValidator.validate_save_payload(_soul_payload_with_human("ask [§human:[email protected]§]"))
-def test_node_job_human_must_be_referenced_too():
+def test_node_job_human_must_be_referenced_too() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": "workflow",
@@ -110,11 +110,12 @@ def test_node_job_human_must_be_referenced_too():
with pytest.raises(InvalidComposerConfigError, match="human_involvement_not_referenced"):
ComposerConfigValidator.validate_save_payload(payload)
+ assert payload.node_job is not None
payload.node_job.workflow_prompt = "escalate to [§human:c-2§]"
ComposerConfigValidator.validate_save_payload(payload)
-def test_identity_less_human_contact_is_skipped():
+def test_identity_less_human_contact_is_skipped() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": "agent_app",
@@ -131,25 +132,25 @@ def test_identity_less_human_contact_is_skipped():
# ── ENG-617: soft findings ───────────────────────────────────────────────────
-def _findings(payload: ComposerSavePayload, **kwargs):
+def _findings(payload: ComposerSavePayload, **kwargs: set[str] | None) -> dict[str, list[dict[str, object]]]:
return ComposerConfigValidator.collect_soft_findings(payload, **kwargs)
-def test_dangling_knowledge_mention_becomes_placeholder_with_label():
+def test_dangling_knowledge_mention_becomes_placeholder_with_label() -> None:
payload = _soul_payload("ground in [§knowledge:gone-1:旧产品手册§]")
findings = _findings(payload)
assert findings["knowledge_retrieval_placeholder"] == [{"id": "gone-1", "placeholder_name": "旧产品手册"}]
assert findings["warnings"] == []
-def test_dangling_knowledge_without_label_gets_fallback_name():
+def test_dangling_knowledge_without_label_gets_fallback_name() -> None:
findings = _findings(_soul_payload("see [§knowledge:deadbeef-cafe§]"))
assert findings["knowledge_retrieval_placeholder"] == [
{"id": "deadbeef-cafe", "placeholder_name": "Knowledge deadbeef"}
]
-def test_configured_but_deleted_knowledge_set_surfaces_as_placeholder():
+def test_configured_but_deleted_knowledge_set_surfaces_as_placeholder() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": "agent_app",
@@ -178,14 +179,14 @@ def test_configured_but_deleted_knowledge_set_surfaces_as_placeholder():
]
-def test_unresolved_non_knowledge_mentions_warn_target_missing():
+def test_unresolved_non_knowledge_mentions_warn_target_missing() -> None:
findings = _findings(_soul_payload("use [§skill:nope:Ghost Skill§] and [§human:missing§]"))
codes = [(w["code"], w["kind"]) for w in findings["warnings"]]
assert ("mention_target_missing", "human") in codes
assert findings["knowledge_retrieval_placeholder"] == []
-def test_provider_all_tools_mention_resolves_against_provider_level_entry():
+def test_provider_all_tools_mention_resolves_against_provider_level_entry() -> None:
# `[§tool:<provider>/*§]` = all tools of that provider; it points at a
# provider-level config entry (tool_name omitted), so with the entry present
# it must produce neither hard error nor warning…
@@ -216,7 +217,7 @@ def test_provider_all_tools_mention_resolves_against_provider_level_entry():
assert [(w["code"], w["kind"]) for w in dangling["warnings"]] == [("mention_target_missing", "tool")]
-def test_duplicate_cli_tool_ids_rejected():
+def test_duplicate_cli_tool_ids_rejected() -> None:
payload = ComposerSavePayload.model_validate(
{
"variant": "agent_app",
@@ -237,7 +238,7 @@ def test_duplicate_cli_tool_ids_rejected():
ComposerConfigValidator.validate_save_payload(payload)
-def test_save_backfills_missing_cli_tool_ids_and_keeps_existing():
+def test_save_backfills_missing_cli_tool_ids_and_keeps_existing() -> None:
from services.agent.composer_service import _backfill_cli_tool_ids
payload = ComposerSavePayload.model_validate(
@@ -261,13 +262,13 @@ def test_save_backfills_missing_cli_tool_ids_and_keeps_existing():
assert minted.id != "ct-1"
-def test_malformed_marker_warns_but_does_not_block():
+def test_malformed_marker_warns_but_does_not_block() -> None:
payload = _soul_payload("hello [§wat:x:y§] world")
ComposerConfigValidator.validate_save_payload(payload) # no hard error
findings = _findings(payload)
assert [w["code"] for w in findings["warnings"]] == ["mention_malformed"]
-def test_clean_prompt_yields_empty_findings():
+def test_clean_prompt_yields_empty_findings() -> None:
findings = _findings(_soul_payload("plain prompt with {{#context#}} legacy form"))
assert findings == {"warnings": [], "knowledge_retrieval_placeholder": []}