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.
Python agentagentic-aiagentic-frameworkagentic-workflowaiautomationclaudedeepseekgenaigptllmlow-codemcpnextjsno-codeopenaipythonskillsworkflow
test(api): strictly type service API fixtures and conversation tests (#45180)
Eddy ZHANG5336037aa91f
diff --git a/api/tests/unit_tests/controllers/service_api/app/test_conversation.py b/api/tests/unit_tests/controllers/service_api/app/test_conversation.pyindex 191e934f9ff..a5a623ad180 100644--- a/api/tests/unit_tests/controllers/service_api/app/test_conversation.py+++ b/api/tests/unit_tests/controllers/service_api/app/test_conversation.py@@ -1,6 +1,6 @@import uuidfrom datetime import UTC, datetime-from types import SimpleNamespace+from typing import Literalimport pytestfrom pydantic import ValidationError@@ -42,20 +42,20 @@ class TestConversationCases:class TestConversationListQuery:"""Test suite for ConversationListQuery Pydantic model."""- def test_query_with_defaults(self):+ def test_query_with_defaults(self) -> None:"""Test query with default values."""query = ConversationListQuery()assert query.last_id is Noneassert query.limit == 20assert query.sort_by == "-updated_at"- def test_query_with_last_id(self):+ def test_query_with_last_id(self) -> None:"""Test query with pagination last_id."""last_id = str(uuid.uuid4())query = ConversationListQuery(last_id=last_id)assert str(query.last_id) == last_id- def test_query_limit_boundaries(self):+ def test_query_limit_boundaries(self) -> None:"""Test query respects limit boundaries."""query_min = ConversationListQuery(limit=1)assert query_min.limit == 1@@ -63,16 +63,6 @@ class TestConversationCases:query_max = ConversationListQuery(limit=100)assert query_max.limit == 100- def test_query_rejects_limit_below_minimum(self):- """Test query rejects limit < 1."""- with pytest.raises(ValueError, match="1 validation error for ConversationListQuery\\\nlimit"):- ConversationListQuery(limit=0)-- def test_query_rejects_limit_above_maximum(self):- """Test query rejects limit > 100."""- with pytest.raises(ValueError, match="1 validation error for ConversationListQuery\\\nlimit"):- ConversationListQuery(limit=101)-@pytest.mark.parametrize("sort_by",[@@ -82,7 +72,9 @@ class TestConversationCases:"-updated_at",],)- def test_query_valid_sort_options(self, sort_by):+ def test_query_valid_sort_options(+ self, sort_by: Literal["created_at", "-created_at", "updated_at", "-updated_at"]+ ) -> None:"""Test all valid sort_by options."""query = ConversationListQuery(sort_by=sort_by)assert query.sort_by == sort_by@@ -90,19 +82,19 @@ class TestConversationCases:class TestConversationRenamePayload:"""Test suite for ConversationRenamePayload Pydantic model."""- def test_payload_with_name(self):+ def test_payload_with_name(self) -> None:"""Test payload with explicit name."""payload = ConversationRenamePayload(name="My New Chat", auto_generate=False)assert payload.name == "My New Chat"assert payload.auto_generate is False- def test_payload_with_auto_generate(self):+ def test_payload_with_auto_generate(self) -> None:"""Test payload with auto_generate enabled."""payload = ConversationRenamePayload(auto_generate=True)assert payload.auto_generate is Trueassert payload.name is None- def test_payload_requires_name_when_auto_generate_false(self):+ def test_payload_requires_name_when_auto_generate_false(self) -> None:"""Test that name is required when auto_generate is False."""with pytest.raises(ValueError,@@ -114,7 +106,7 @@ class TestConversationCases:ConversationRenamePayload(auto_generate=False)assert "name is required when auto_generate is false" in str(exc_info.value)- def test_payload_requires_non_empty_name_when_auto_generate_false(self):+ def test_payload_requires_non_empty_name_when_auto_generate_false(self) -> None:"""Test that empty string name is rejected."""with pytest.raises(ValueError,@@ -125,7 +117,7 @@ class TestConversationCases:):ConversationRenamePayload(name="", auto_generate=False)- def test_payload_requires_non_whitespace_name_when_auto_generate_false(self):+ def test_payload_requires_non_whitespace_name_when_auto_generate_false(self) -> None:"""Test that whitespace-only name is rejected."""with pytest.raises(ValueError,@@ -136,12 +128,12 @@ class TestConversationCases:):ConversationRenamePayload(name=" ", auto_generate=False)- def test_payload_name_with_special_characters(self):+ def test_payload_name_with_special_characters(self) -> None:"""Test payload with name containing special characters."""payload = ConversationRenamePayload(name="Chat #1 - (Test) & More!", auto_generate=False)assert payload.name == "Chat #1 - (Test) & More!"- def test_payload_name_with_unicode(self):+ def test_payload_name_with_unicode(self) -> None:"""Test payload with Unicode characters in name."""payload = ConversationRenamePayload(name="对话 📝 Чат", auto_generate=False)assert payload.name == "对话 📝 Чат"@@ -149,34 +141,34 @@ class TestConversationCases:class TestConversationVariablesQuery:"""Test suite for ConversationVariablesQuery Pydantic model."""- def test_query_with_defaults(self):+ def test_query_with_defaults(self) -> None:"""Test query with default values."""query = ConversationVariablesQuery()assert query.last_id is Noneassert query.limit == 20assert query.variable_name is None- def test_query_with_variable_name(self):+ def test_query_with_variable_name(self) -> None:"""Test query with valid variable_name filter."""query = ConversationVariablesQuery(variable_name="user_preference")assert query.variable_name == "user_preference"- def test_query_allows_hyphen_in_variable_name(self):+ def test_query_allows_hyphen_in_variable_name(self) -> None:"""Test that hyphens are allowed in variable names."""query = ConversationVariablesQuery(variable_name="my-variable")assert query.variable_name == "my-variable"- def test_query_allows_underscore_in_variable_name(self):+ def test_query_allows_underscore_in_variable_name(self) -> None:"""Test that underscores are allowed in variable names."""query = ConversationVariablesQuery(variable_name="my_variable")assert query.variable_name == "my_variable"- def test_query_allows_period_in_variable_name(self):+ def test_query_allows_period_in_variable_name(self) -> None:"""Test that periods are allowed in variable names."""query = ConversationVariablesQuery(variable_name="config.setting")assert query.variable_name == "config.setting"- def test_query_rejects_sql_injection_single_quote(self):+ def test_query_rejects_sql_injection_single_quote(self) -> None:"""Test that single quotes are rejected (SQL injection prevention)."""with pytest.raises(ValueError, match="1 validation error for ConversationVariablesQuery\\\nvariable_name"@@ -184,7 +176,7 @@ class TestConversationCases:ConversationVariablesQuery(variable_name="'; DROP TABLE users;--")assert "can only contain" in str(exc_info.value)- def test_query_rejects_sql_injection_double_quote(self):+ def test_query_rejects_sql_injection_double_quote(self) -> None:"""Test that double quotes are rejected."""with pytest.raises(ValueError, match="1 validation error for ConversationVariablesQuery\\\nvariable_name"@@ -192,7 +184,7 @@ class TestConversationCases:ConversationVariablesQuery(variable_name='name"test')assert "can only contain" in str(exc_info.value)- def test_query_rejects_sql_injection_semicolon(self):+ def test_query_rejects_sql_injection_semicolon(self) -> None:"""Test that semicolons are rejected."""with pytest.raises(ValueError, match="1 validation error for ConversationVariablesQuery\\\nvariable_name"@@ -200,7 +192,7 @@ class TestConversationCases:ConversationVariablesQuery(variable_name="name;malicious")assert "can only contain" in str(exc_info.value)- def test_query_rejects_sql_injection_comment(self):+ def test_query_rejects_sql_injection_comment(self) -> None:"""Test that SQL comments are rejected."""with pytest.raises(ValueError, match="1 validation error for ConversationVariablesQuery\\\nvariable_name"@@ -208,7 +200,7 @@ class TestConversationCases:ConversationVariablesQuery(variable_name="name--comment")assert "invalid characters" in str(exc_info.value)- def test_query_rejects_special_characters(self):+ def test_query_rejects_special_characters(self) -> None:"""Test that special characters are rejected."""with pytest.raises(ValueError, match="1 validation error for ConversationVariablesQuery\\\nvariable_name"@@ -216,7 +208,7 @@ class TestConversationCases:ConversationVariablesQuery(variable_name="name@domain")assert "can only contain" in str(exc_info.value)- def test_query_rejects_backticks(self):+ def test_query_rejects_backticks(self) -> None:"""Test that backticks are rejected (SQL injection prevention)."""with pytest.raises(ValueError, match="1 validation error for ConversationVariablesQuery\\\nvariable_name"@@ -224,7 +216,7 @@ class TestConversationCases:ConversationVariablesQuery(variable_name="`table`")assert "can only contain" in str(exc_info.value)- def test_query_pagination_limits(self):+ def test_query_pagination_limits(self) -> None:"""Test query pagination limit boundaries."""query_min = ConversationVariablesQuery(limit=1)assert query_min.limit == 1@@ -235,49 +227,50 @@ class TestConversationCases:class TestConversationVariableUpdatePayload:"""Test suite for ConversationVariableUpdatePayload Pydantic model."""- def test_payload_with_string_value(self):+ def test_payload_with_string_value(self) -> None:"""Test payload with string value."""payload = ConversationVariableUpdatePayload(value="hello")assert payload.value == "hello"- def test_payload_with_number_value(self):+ def test_payload_with_number_value(self) -> None:"""Test payload with number value."""payload = ConversationVariableUpdatePayload(value=42)assert payload.value == 42- def test_payload_with_float_value(self):+ def test_payload_with_float_value(self) -> None:"""Test payload with float value."""payload = ConversationVariableUpdatePayload(value=float("3.14159"))assert payload.value == float("3.14159")- def test_payload_with_list_value(self):+ def test_payload_with_list_value(self) -> None:"""Test payload with list value."""payload = ConversationVariableUpdatePayload(value=["a", "b", "c"])assert payload.value == ["a", "b", "c"]- def test_payload_with_dict_value(self):+ def test_payload_with_dict_value(self) -> None:"""Test payload with dictionary value."""payload = ConversationVariableUpdatePayload(value={"key": "value"})assert payload.value == {"key": "value"}- def test_payload_with_none_value(self):+ def test_payload_with_none_value(self) -> None:"""Test payload with None value."""payload = ConversationVariableUpdatePayload(value=None)assert payload.value is None- def test_payload_with_boolean_value(self):+ def test_payload_with_boolean_value(self) -> None:"""Test payload with boolean value."""payload = ConversationVariableUpdatePayload(value=True)assert payload.value is True- def test_payload_with_nested_structure(self):+ def test_payload_with_nested_structure(self) -> None:"""Test payload with deeply nested structure."""nested = {"level1": {"level2": {"level3": ["a", "b", {"c": 123}]}}}payload = ConversationVariableUpdatePayload(value=nested)assert payload.value == nestedclass TestConversationVariableResponseModels:- def test_variable_response_normalizes_value_type_and_timestamps(self):+ def test_variable_response_normalizes_value_type_and_timestamps(self) -> None:+ """Given an integer segment type and UTC timestamps, expose a number and epoch seconds."""created_at = datetime(2026, 1, 2, 3, 4, 5, tzinfo=UTC)response = ConversationVariableResponse.model_validate({@@ -295,7 +288,8 @@ class TestConversationCases:assert response.created_at == int(created_at.timestamp())assert response.updated_at == int(created_at.timestamp())- def test_variable_response_normalizes_string_value_type_alias(self):+ def test_variable_response_normalizes_string_value_type_alias(self) -> None:+ """Given the integer type alias, expose the canonical number type."""response = ConversationVariableResponse.model_validate({"id": "550e8400-e29b-41d4-a716-446655440000",@@ -306,22 +300,25 @@ class TestConversationCases:assert response.value_type == "number"- def test_variable_response_normalizes_callable_exposed_type(self):+ def test_variable_response_normalizes_callable_exposed_type(self) -> None:+ """Given a segment type with an exposed_type method, use its string result."""response = ConversationVariableResponse.model_validate({"id": "550e8400-e29b-41d4-a716-446655440000","name": "foo",- "value_type": SimpleNamespace(exposed_type=lambda: SegmentType.STRING.exposed_type()),+ "value_type": SegmentType.STRING,})assert response.value_type == "string"- def test_serialize_value_type_supports_segments_and_mappings(self):+ def test_serialize_value_type_supports_segments_and_mappings(self) -> None:+ """Given a segment or value_type mapping, return its exposed type."""assert serialize_value_type(StringSegment(value="hello")) == "string"assert serialize_value_type({"value_type": SegmentType.INTEGER}) == "number"- def test_variable_pagination_response(self):+ def test_variable_pagination_response(self) -> None:+ """Given a valid pagination payload, preserve its limit, cursor state, and variable."""response = ConversationVariableInfiniteScrollPaginationResponse.model_validate({"limit": 1,@@ -353,21 +350,21 @@ class TestConversationCases:AppMode.ADVANCED_CHAT.value,],)- def test_chat_modes_are_valid_for_conversation_endpoints(self, mode):+ def test_chat_modes_are_valid_for_conversation_endpoints(self, mode: str) -> None:"""Test that all chat modes are valid for conversation endpoints.Verifies that CHAT, AGENT_CHAT, AGENT, and ADVANCED_CHAT modes passvalidation without raising NotChatAppError."""app = App(- mode=mode,+ mode=AppMode(mode),)# Validation should pass without raising for chat modesapp_mode = AppMode.value_of(app.mode)assert app_mode in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT, AppMode.AGENT}- def test_completion_mode_is_invalid_for_conversation_endpoints(self):+ def test_completion_mode_is_invalid_for_conversation_endpoints(self) -> None:"""Test that COMPLETION mode is invalid for conversation endpoints.Verifies that calling a conversation endpoint with a COMPLETION mode@@ -382,7 +379,7 @@ class TestConversationCases:with pytest.raises(NotChatAppError):raise NotChatAppError()- def test_workflow_mode_is_invalid_for_conversation_endpoints(self):+ def test_workflow_mode_is_invalid_for_conversation_endpoints(self) -> None:"""Test that WORKFLOW mode is invalid for conversation endpoints.Verifies that calling a conversation endpoint with a WORKFLOW mode@@ -400,27 +397,27 @@ class TestConversationCases:class TestConversationErrorTypes:"""Test conversation-related error types."""- def test_conversation_not_exists_error(self):+ def test_conversation_not_exists_error(self) -> None:"""Test ConversationNotExistsError exists and can be raised."""error = services.errors.conversation.ConversationNotExistsError()assert isinstance(error, services.errors.conversation.ConversationNotExistsError)- def test_conversation_completed_error(self):+ def test_conversation_completed_error(self) -> None:"""Test ConversationCompletedError exists."""error = services.errors.conversation.ConversationCompletedError()assert isinstance(error, services.errors.conversation.ConversationCompletedError)- def test_last_conversation_not_exists_error(self):+ def test_last_conversation_not_exists_error(self) -> None:"""Test LastConversationNotExistsError exists."""error = services.errors.conversation.LastConversationNotExistsError()assert isinstance(error, services.errors.conversation.LastConversationNotExistsError)- def test_conversation_variable_not_exists_error(self):+ def test_conversation_variable_not_exists_error(self) -> None:"""Test ConversationVariableNotExistsError exists."""error = services.errors.conversation.ConversationVariableNotExistsError()assert isinstance(error, services.errors.conversation.ConversationVariableNotExistsError)- def test_conversation_variable_type_mismatch_error(self):+ def test_conversation_variable_type_mismatch_error(self) -> None:"""Test ConversationVariableTypeMismatchError exists."""error = services.errors.conversation.ConversationVariableTypeMismatchError("Type mismatch")assert isinstance(error, services.errors.conversation.ConversationVariableTypeMismatchError)@@ -448,7 +445,8 @@ class TestConversationRenamePayloadCases:@staticmethod@pytest.mark.parametrize("payload_cls", [ConsolePayload, ServicePayload])- def test_payload_allows_auto_generate_without_name(payload_cls):+ def test_payload_allows_auto_generate_without_name(payload_cls: type[ConversationRenamePayload]) -> None:+ """Given either endpoint payload model, accept automatic naming without a name."""payload = payload_cls.model_validate({"auto_generate": True})assert payload.auto_generate is True@@ -457,6 +455,9 @@ class TestConversationRenamePayloadCases:@staticmethod@pytest.mark.parametrize("payload_cls", [ConsolePayload, ServicePayload])@pytest.mark.parametrize("value", [None, "", " "])- def test_payload_requires_name_when_not_auto_generate(payload_cls, value):+ def test_payload_requires_name_when_not_auto_generate(+ payload_cls: type[ConversationRenamePayload], value: str | None+ ) -> None:+ """Given either endpoint model and a blank name, reject manual naming with ValidationError."""with pytest.raises(ValidationError):payload_cls.model_validate({"name": value, "auto_generate": False})diff --git a/api/tests/unit_tests/controllers/service_api/conftest.py b/api/tests/unit_tests/controllers/service_api/conftest.pyindex 38bae518d56..f9b99a77fa1 100644--- a/api/tests/unit_tests/controllers/service_api/conftest.py+++ b/api/tests/unit_tests/controllers/service_api/conftest.py@@ -6,9 +6,12 @@ database interactions, and common test data patterns used acrossService API controller tests."""+from __future__ import annotations+import uuidfrom collections.abc import Iteratorfrom dataclasses import dataclass+from typing import TYPE_CHECKINGimport pytestfrom flask import Flask@@ -18,8 +21,12 @@ from sqlalchemy.orm import Sessionfrom core.rag.index_processor.constant.index_type import IndexStructureTypefrom models.account import Account, Tenant, TenantAccountJoin, TenantAccountRole, TenantStatusfrom models.base import TypeBase+from models.enums import ApiTokenType, AppStatus, DataSourceType, DocumentCreatedFrom, IndexingStatus, SegmentStatusfrom models.model import ApiToken, App, AppMode, EndUser, EndUserType+if TYPE_CHECKING:+ from models.dataset import ChildChunk, Dataset, Document, DocumentSegment+@dataclass(frozen=True)class ServiceApiIdentity:@@ -33,10 +40,10 @@ class ServiceApiIdentity:@pytest.fixturedef service_api_identity(sqlite_engine: Engine) -> Iterator[ServiceApiIdentity]:- """Yield an isolated SQLite session with a real active tenant owner."""+ """Given an isolated SQLite engine, yield a persisted tenant owner and close its session afterward."""TypeBase.metadata.create_all(sqlite_engine,- tables=[Account.__table__, Tenant.__table__, TenantAccountJoin.__table__],+ tables=[TypeBase.metadata.tables[model.__tablename__] for model in (Account, Tenant, TenantAccountJoin)],)with Session(sqlite_engine, expire_on_commit=False) as session:tenant = Tenant(name="Service API Workspace")@@ -60,7 +67,7 @@ def service_api_identity(sqlite_engine: Engine) -> Iterator[ServiceApiIdentity]:@pytest.fixture-def app():+def app() -> Flask:"""Create Flask test application with proper configuration."""flask_app = Flask(__name__)flask_app.config["TESTING"] = True@@ -68,19 +75,19 @@ def app():@pytest.fixture-def mock_tenant_id():- """Generate a consistent tenant ID for test sessions."""+def mock_tenant_id() -> str:+ """Return a fresh UUID string for an isolated test tenant."""return str(uuid.uuid4())@pytest.fixture-def mock_app_id():- """Generate a consistent app ID for test sessions."""+def mock_app_id() -> str:+ """Return a fresh UUID string for an isolated test app."""return str(uuid.uuid4())@pytest.fixture-def mock_end_user(mock_tenant_id):+def mock_end_user(mock_tenant_id: str) -> EndUser:"""Create a real EndUser model with required attributes."""user = EndUser(id=str(uuid.uuid4()),@@ -95,7 +102,7 @@ def mock_end_user(mock_tenant_id):@pytest.fixture-def mock_app_model(mock_app_id, mock_tenant_id):+def mock_app_model(mock_app_id: str, mock_tenant_id: str) -> App:"""Create an App model with all required attributes for API testing."""app = App(id=mock_app_id,@@ -103,14 +110,14 @@ def mock_app_model(mock_app_id, mock_tenant_id):name="Test App",description="A test application",mode=AppMode.CHAT,- status="normal",+ status=AppStatus.NORMAL,enable_api=True,)return app@pytest.fixture-def mock_tenant(mock_tenant_id):+def mock_tenant(mock_tenant_id: str) -> Tenant:"""Create a Tenant model."""tenant = Tenant(name="Service API Tenant", status=TenantStatus.NORMAL)tenant.id = mock_tenant_id@@ -118,7 +125,7 @@ def mock_tenant(mock_tenant_id):@pytest.fixture-def mock_account():+def mock_account() -> Account:"""Create an Account model."""account = Account(name="Service API Account", email=f"service-{uuid.uuid4()}@example.com")account.id = str(uuid.uuid4())@@ -126,28 +133,28 @@ def mock_account():@pytest.fixture-def mock_api_token(mock_app_id, mock_tenant_id):+def mock_api_token(mock_app_id: str, mock_tenant_id: str) -> ApiToken:"""Create a real API token for authentication tests."""return ApiToken(app_id=mock_app_id,tenant_id=mock_tenant_id,token=f"test_token_{uuid.uuid4().hex[:8]}",- type="app",+ type=ApiTokenType.APP,)@pytest.fixture-def mock_dataset_api_token(mock_tenant_id):+def mock_dataset_api_token(mock_tenant_id: str) -> ApiToken:"""Create a real API token for dataset endpoints."""return ApiToken(tenant_id=mock_tenant_id,token=f"dataset_token_{uuid.uuid4().hex[:8]}",- type="dataset",+ type=ApiTokenType.DATASET,)@pytest.fixture-def mock_dataset():+def mock_dataset() -> Dataset:"""Create a Dataset model."""from models.dataset import Dataset@@ -163,8 +170,8 @@ def mock_dataset():@pytest.fixture-def mock_document():- """Create a Document model."""+def mock_document() -> Document:+ """Return an unpersisted completed Document with its required source and creator fields."""from models.dataset import Documentdocument = Document(@@ -172,7 +179,12 @@ def mock_document():dataset_id=str(uuid.uuid4()),tenant_id=str(uuid.uuid4()),name="test_document.txt",- indexing_status="completed",+ position=1,+ data_source_type=DataSourceType.UPLOAD_FILE,+ batch="test-batch",+ created_from=DocumentCreatedFrom.API,+ created_by=str(uuid.uuid4()),+ indexing_status=IndexingStatus.COMPLETED,enabled=True,doc_form=IndexStructureType.PARAGRAPH_INDEX,)@@ -180,7 +192,7 @@ def mock_document():@pytest.fixture-def mock_segment():+def mock_segment() -> DocumentSegment:"""Create a DocumentSegment model."""from models.dataset import DocumentSegment@@ -194,15 +206,15 @@ def mock_segment():tokens=0,created_by="account-id",enabled=True,- status="completed",+ status=SegmentStatus.COMPLETED,)segment.id = str(uuid.uuid4())return segment@pytest.fixture-def mock_child_chunk():- """Create a mock ChildChunk model."""+def mock_child_chunk() -> ChildChunk:+ """Return an unpersisted ChildChunk with valid required fields."""from models.dataset import ChildChunkchild_chunk = ChildChunk(diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.tomlindex bdf577fc598..1d4e97eb67b 100644--- a/api/tests/unit_tests/pyrefly.toml+++ b/api/tests/unit_tests/pyrefly.toml@@ -76,12 +76,10 @@ project-excludes = ["controllers/service_api/app/test_app.py","controllers/service_api/app/test_audio.py","controllers/service_api/app/test_completion.py",- "controllers/service_api/app/test_conversation.py","controllers/service_api/app/test_file.py","controllers/service_api/app/test_workflow_events.py","controllers/service_api/app/test_message.py","controllers/service_api/app/test_workflow.py",- "controllers/service_api/conftest.py","controllers/service_api/dataset/rag_pipeline/test_rag_pipeline_workflow.py","controllers/service_api/dataset/test_segment.py","controllers/service_api/dataset/test_document.py",