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
refactor(api): enable strict typing for service API metadata tests (#43652)
Eddy ZHANG3095423cee57
diff --git a/api/tests/unit_tests/controllers/service_api/dataset/test_metadata.py b/api/tests/unit_tests/controllers/service_api/dataset/test_metadata.pyindex d6aebf3a625..8ced1d1c983 100644--- a/api/tests/unit_tests/controllers/service_api/dataset/test_metadata.py+++ b/api/tests/unit_tests/controllers/service_api/dataset/test_metadata.py@@ -19,7 +19,7 @@ Decorator strategy:import uuidfrom inspect import unwrap-from unittest.mock import ANY, Mock, create_autospec, patch+from unittest.mock import ANY, MagicMock, Mock, create_autospec, patchimport pytestfrom flask import Flask, request@@ -155,7 +155,9 @@ class _UsesSQLiteSession:@pytest.mark.parametrize("method", ["patch", "delete"])-def test_metadata_mutation_translates_missing_resource(method, sqlite_session, mock_tenant, mock_dataset):+def test_metadata_mutation_translates_missing_resource(+ method: str, sqlite_session: Session, mock_tenant: Tenant, mock_dataset: Dataset+) -> None:with (patch.object(metadata_module, "DatasetService") as datasets,patch.object(metadata_module, "application_services") as services,@@ -165,7 +167,7 @@ def test_metadata_mutation_translates_missing_resource(method, sqlite_session, moperation = metadata.update_metadata_name if method == "patch" else metadata.delete_metadataoperation.side_effect = MetadataResourceNotFoundError("Metadata not found.")resource = DatasetMetadataServiceApi()- arguments = {+ arguments: dict[str, object] = {"session": sqlite_session,"tenant_id": mock_tenant.id,"dataset_id": mock_dataset.id,@@ -186,7 +188,9 @@ class TestDatasetMetadataCreatePost(_UsesSQLiteSession):"""@staticmethod- def _call_post(api, session: Session, **kwargs):+ def _call_post(+ api: DatasetMetadataCreateServiceApi, session: Session, **kwargs: object+ ) -> tuple[dict[str, object], int]:# `post` is wrapped in @model_validate, so the unwrapped view expects the# validated model where the decorator would have injected it.metadata_args = MetadataArgs.model_validate(request.get_json() or {})@@ -196,12 +200,12 @@ class TestDatasetMetadataCreatePost(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_create_metadata_success(self,- mock_dataset_svc,- mock_meta_svc,+ mock_dataset_svc: MagicMock,+ mock_meta_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test successful metadata creation."""mock_meta_svc = mock_meta_svc.return_value.knowledge.metadatamock_dataset_svc.get_dataset_for_tenant.return_value = mock_dataset@@ -230,11 +234,11 @@ class TestDatasetMetadataCreatePost(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_create_metadata_dataset_not_found(self,- mock_dataset_svc,+ mock_dataset_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test 404 when dataset not found."""mock_dataset_svc.get_dataset_for_tenant.return_value = None@@ -261,12 +265,12 @@ class TestDatasetMetadataCreateGet(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_get_metadata_success(self,- mock_dataset_svc,- mock_meta_svc,+ mock_dataset_svc: MagicMock,+ mock_meta_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test successful metadata list retrieval."""mock_meta_svc = mock_meta_svc.return_value.knowledge.metadatamock_dataset_svc.get_dataset_for_tenant.return_value = mock_dataset@@ -294,11 +298,11 @@ class TestDatasetMetadataCreateGet(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_get_metadata_dataset_not_found(self,- mock_dataset_svc,+ mock_dataset_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test 404 when dataset not found."""mock_dataset_svc.get_dataset_for_tenant.return_value = None@@ -323,7 +327,9 @@ class TestDatasetMetadataServiceApiPatch(_UsesSQLiteSession):"""@staticmethod- def _call_patch(api, session: Session, **kwargs):+ def _call_patch(+ api: DatasetMetadataServiceApi, session: Session, **kwargs: object+ ) -> tuple[dict[str, object], int]:payload = MetadataUpdatePayload.model_validate(request.get_json() or {})return unwrap(api.patch)(api, payload, session, **kwargs)@@ -331,13 +337,13 @@ class TestDatasetMetadataServiceApiPatch(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_update_metadata_name_success(self,- mock_dataset_svc,- mock_meta_svc,+ mock_dataset_svc: MagicMock,+ mock_meta_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,+ mock_tenant: Tenant,+ mock_dataset: Dataset,account: Account,- ):+ ) -> None:"""Test successful metadata name update."""mock_meta_svc = mock_meta_svc.return_value.knowledge.metadatametadata_id = str(uuid.uuid4())@@ -363,7 +369,7 @@ class TestDatasetMetadataServiceApiPatch(_UsesSQLiteSession):assert status == 200assert response == {"id": metadata_id, "type": "string", "name": "New Name"}mock_dataset_svc.get_dataset_for_tenant.assert_called_once_with(- str(mock_dataset.id), mock_tenant.id, session=session+ mock_dataset.id, mock_tenant.id, session=session)mock_meta_svc.update_metadata_name.assert_called_once_with(DatasetRef(mock_tenant.id, mock_dataset.id), metadata_id, "New Name", actor_id=account.id@@ -372,11 +378,11 @@ class TestDatasetMetadataServiceApiPatch(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_update_metadata_dataset_not_found(self,- mock_dataset_svc,+ mock_dataset_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test 404 when dataset not found."""metadata_id = str(uuid.uuid4())mock_dataset_svc.get_dataset_for_tenant.return_value = None@@ -405,19 +411,19 @@ class TestDatasetMetadataServiceApiDelete(_UsesSQLiteSession):"""@staticmethod- def _call_delete(api, session: Session, **kwargs):+ def _call_delete(api: DatasetMetadataServiceApi, session: Session, **kwargs: object) -> tuple[str, int]:return unwrap(api.delete)(api, session, **kwargs)@patch("controllers.service_api.dataset.metadata.application_services")@patch("controllers.service_api.dataset.metadata.DatasetService")def test_delete_metadata_success(self,- mock_dataset_svc,- mock_meta_svc,+ mock_dataset_svc: MagicMock,+ mock_meta_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test successful metadata deletion."""mock_meta_svc = mock_meta_svc.return_value.knowledge.metadatametadata_id = str(uuid.uuid4())@@ -441,18 +447,18 @@ class TestDatasetMetadataServiceApiDelete(_UsesSQLiteSession):assert response == ("", 204)mock_dataset_svc.get_dataset_for_tenant.assert_called_once_with(- str(mock_dataset.id), mock_tenant.id, session=session+ mock_dataset.id, mock_tenant.id, session=session)mock_meta_svc.delete_metadata.assert_called_once_with(DatasetRef(mock_tenant.id, mock_dataset.id), metadata_id)@patch("controllers.service_api.dataset.metadata.DatasetService")def test_delete_metadata_dataset_not_found(self,- mock_dataset_svc,+ mock_dataset_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test 404 when dataset not found."""metadata_id = str(uuid.uuid4())mock_dataset_svc.get_dataset_for_tenant.return_value = None@@ -484,11 +490,11 @@ class TestDatasetMetadataBuiltInFieldGet(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.application_services")def test_get_built_in_fields_success(self,- mock_meta_svc,+ mock_meta_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test successful built-in fields retrieval."""mock_meta_svc = mock_meta_svc.return_value.knowledge.metadatamock_meta_svc.get_built_in_fields.return_value = [@@ -521,19 +527,21 @@ class TestDatasetMetadataBuiltInFieldAction(_UsesSQLiteSession):"""@staticmethod- def _call_post(api, session: Session, **kwargs):+ def _call_post(+ api: DatasetMetadataBuiltInFieldActionServiceApi, session: Session, **kwargs: object+ ) -> tuple[dict[str, object], int]:return unwrap(api.post)(api, session, **kwargs)@patch("controllers.service_api.dataset.metadata.application_services")@patch("controllers.service_api.dataset.metadata.DatasetService")def test_enable_built_in_field(self,- mock_dataset_svc,- mock_meta_svc,+ mock_dataset_svc: MagicMock,+ mock_meta_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test enabling built-in metadata field."""mock_meta_svc = mock_meta_svc.return_value.knowledge.metadatamock_dataset_svc.get_dataset_for_tenant.return_value = mock_dataset@@ -561,12 +569,12 @@ class TestDatasetMetadataBuiltInFieldAction(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_disable_built_in_field(self,- mock_dataset_svc,- mock_meta_svc,+ mock_dataset_svc: MagicMock,+ mock_meta_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test disabling built-in metadata field."""mock_meta_svc = mock_meta_svc.return_value.knowledge.metadatamock_dataset_svc.get_dataset_for_tenant.return_value = mock_dataset@@ -592,11 +600,11 @@ class TestDatasetMetadataBuiltInFieldAction(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_action_dataset_not_found(self,- mock_dataset_svc,+ mock_dataset_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test 404 when dataset not found."""mock_dataset_svc.get_dataset_for_tenant.return_value = None@@ -628,7 +636,9 @@ class TestDocumentMetadataEditPost(_UsesSQLiteSession):"""@staticmethod- def _call_post(api, session: Session, **kwargs):+ def _call_post(+ api: DocumentMetadataEditServiceApi, session: Session, **kwargs: object+ ) -> tuple[dict[str, object], int]:metadata_args = MetadataOperationData.model_validate(request.get_json() or {})return unwrap(api.post)(api, metadata_args, session, **kwargs)@@ -636,13 +646,13 @@ class TestDocumentMetadataEditPost(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_update_documents_metadata_success(self,- mock_dataset_svc,- mock_meta_svc,+ mock_dataset_svc: MagicMock,+ mock_meta_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,+ mock_tenant: Tenant,+ mock_dataset: Dataset,account: Account,- ):+ ) -> None:"""Test successful documents metadata update."""mock_meta_svc = mock_meta_svc.return_value.knowledge.metadatamock_dataset_svc.get_dataset_for_tenant.return_value = mock_dataset@@ -674,11 +684,11 @@ class TestDocumentMetadataEditPost(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_update_documents_metadata_dataset_not_found(self,- mock_dataset_svc,+ mock_dataset_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:"""Test 404 when dataset not found."""mock_dataset_svc.get_dataset_for_tenant.return_value = None@@ -701,12 +711,12 @@ class TestDocumentMetadataEditPost(_UsesSQLiteSession):@patch("controllers.service_api.dataset.metadata.DatasetService")def test_update_documents_metadata_translates_missing_resource(self,- mock_dataset_svc,- mock_meta_svc,+ mock_dataset_svc: MagicMock,+ mock_meta_svc: MagicMock,app: Flask,- mock_tenant,- mock_dataset,- ):+ mock_tenant: Tenant,+ mock_dataset: Dataset,+ ) -> None:mock_meta_svc = mock_meta_svc.return_value.knowledge.metadatamock_dataset_svc.get_dataset_for_tenant.return_value = mock_datasetmock_meta_svc.update_documents_metadata.side_effect = MetadataResourceNotFoundError("Document not found.")diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.tomlindex 3e3b54bd151..abd297d7910 100644--- a/api/tests/unit_tests/pyrefly.toml+++ b/api/tests/unit_tests/pyrefly.toml@@ -188,7 +188,6 @@ project-excludes = ["controllers/service_api/dataset/rag_pipeline/test_rag_pipeline_workflow.py","controllers/service_api/dataset/test_dataset_segment.py","controllers/service_api/dataset/test_document.py",- "controllers/service_api/dataset/test_metadata.py","controllers/service_api/dataset/test_rag_pipeline_file_upload_serialization.py","controllers/service_api/dataset/test_rag_pipeline_route_registration.py","controllers/service_api/test_index.py",