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 cached embedding tests (#43798)

Eddy ZHANGa48ad19afc69
diff --git a/api/tests/unit_tests/core/rag/embedding/test_cached_embedding.py b/api/tests/unit_tests/core/rag/embedding/test_cached_embedding.py
index b52cf81e3ea..89634c9e7c3 100644
--- a/api/tests/unit_tests/core/rag/embedding/test_cached_embedding.py
+++ b/api/tests/unit_tests/core/rag/embedding/test_cached_embedding.py
@@ -8,6 +8,7 @@ This test file covers the methods not fully tested in test_embedding_service.py:
import base64
import logging
+from collections.abc import Callable
from dataclasses import dataclass
from decimal import Decimal
from unittest.mock import Mock, patch
@@ -61,7 +62,7 @@ class TestCacheEmbeddingMultimodalDocuments:
"""Test suite for CacheEmbedding.embed_multimodal_documents method."""
@pytest.fixture
- def mock_model_instance(self):
+ def mock_model_instance(self) -> Mock:
"""Create a mock ModelInstance for testing."""
model_instance = Mock()
model_instance.model = "vision-embedding-model"
@@ -79,7 +80,7 @@ class TestCacheEmbeddingMultimodalDocuments:
return model_instance
@pytest.fixture
- def sample_multimodal_result(self):
+ def sample_multimodal_result(self) -> EmbeddingResult:
"""Create a sample multimodal EmbeddingResult."""
embedding_vector = np.random.randn(1536)
normalized_vector = (embedding_vector / np.linalg.norm(embedding_vector)).tolist()
@@ -102,10 +103,10 @@ class TestCacheEmbeddingMultimodalDocuments:
def test_embed_single_multimodal_document_cache_miss(
self,
- mock_model_instance,
+ mock_model_instance: Mock,
sample_multimodal_result: EmbeddingResult,
embedding_session: Session,
- ):
+ ) -> None:
"""Test embedding a single multimodal document when cache is empty."""
cache_embedding = CacheEmbedding(mock_model_instance)
documents = [{"file_id": "file123", "content": "test content"}]
@@ -123,7 +124,9 @@ class TestCacheEmbeddingMultimodalDocuments:
assert persisted is not None
assert persisted.get_embedding() == result[0]
- def test_embed_multiple_multimodal_documents_cache_miss(self, mock_model_instance, embedding_session: Session):
+ def test_embed_multiple_multimodal_documents_cache_miss(
+ self, mock_model_instance: Mock, embedding_session: Session
+ ) -> None:
"""Test embedding multiple multimodal documents when cache is empty."""
cache_embedding = CacheEmbedding(mock_model_instance)
documents = [
@@ -162,7 +165,7 @@ class TestCacheEmbeddingMultimodalDocuments:
assert all(len(emb) == 1536 for emb in result)
assert embedding_session.scalar(select(func.count()).select_from(Embedding)) == 3
- def test_embed_multimodal_documents_cache_hit(self, mock_model_instance, embedding_session: Session):
+ def test_embed_multimodal_documents_cache_hit(self, mock_model_instance: Mock, embedding_session: Session) -> None:
"""Test embedding multimodal documents when embeddings are cached."""
cache_embedding = CacheEmbedding(mock_model_instance)
documents = [{"file_id": "file123"}]
@@ -178,7 +181,9 @@ class TestCacheEmbeddingMultimodalDocuments:
assert result[0] == normalized_cached
mock_model_instance.invoke_multimodal_embedding.assert_not_called()
- def test_embed_multimodal_documents_partial_cache_hit(self, mock_model_instance, embedding_session: Session):
+ def test_embed_multimodal_documents_partial_cache_hit(
+ self, mock_model_instance: Mock, embedding_session: Session
+ ) -> None:
"""Test embedding multimodal documents with mixed cache hits and misses."""
cache_embedding = CacheEmbedding(mock_model_instance)
documents = [
@@ -224,10 +229,10 @@ class TestCacheEmbeddingMultimodalDocuments:
def test_embed_multimodal_documents_nan_handling(
self,
- mock_model_instance,
+ mock_model_instance: Mock,
embedding_session: Session,
caplog: pytest.LogCaptureFixture,
- ):
+ ) -> None:
"""Test handling of NaN values in multimodal embeddings."""
cache_embedding = CacheEmbedding(mock_model_instance)
documents = [{"file_id": "valid"}, {"file_id": "nan"}]
@@ -263,12 +268,14 @@ class TestCacheEmbeddingMultimodalDocuments:
assert any(record.levelno == logging.WARNING for record in caplog.records)
- def test_embed_multimodal_documents_large_batch(self, mock_model_instance, embedding_session: Session):
+ def test_embed_multimodal_documents_large_batch(
+ self, mock_model_instance: Mock, embedding_session: Session
+ ) -> None:
"""Test embedding large batch of multimodal documents respecting MAX_CHUNKS."""
cache_embedding = CacheEmbedding(mock_model_instance)
documents = [{"file_id": f"file{i}"} for i in range(25)]
- def create_batch_result(batch_size):
+ def create_batch_result(batch_size: int) -> EmbeddingResult:
embeddings = []
for _ in range(batch_size):
vector = np.random.randn(1536)
@@ -300,7 +307,7 @@ class TestCacheEmbeddingMultimodalDocuments:
assert mock_model_instance.invoke_multimodal_embedding.call_count == 3
assert embedding_session.scalar(select(func.count()).select_from(Embedding)) == 25
- def test_embed_multimodal_documents_api_error(self, mock_model_instance, embedding_session: Session):
+ def test_embed_multimodal_documents_api_error(self, mock_model_instance: Mock, embedding_session: Session) -> None:
"""Test handling of API errors during multimodal embedding."""
cache_embedding = CacheEmbedding(mock_model_instance)
documents = [{"file_id": "file123"}]
@@ -315,10 +322,10 @@ class TestCacheEmbeddingMultimodalDocuments:
def test_embed_multimodal_documents_integrity_error_during_transform(
self,
- mock_model_instance,
- sample_multimodal_result,
+ mock_model_instance: Mock,
+ sample_multimodal_result: EmbeddingResult,
embedding_session: Session,
- ):
+ ) -> None:
"""Test handling of IntegrityError during embedding transformation."""
cache_embedding = CacheEmbedding(mock_model_instance)
documents = [{"file_id": "file123"}]
@@ -357,7 +364,7 @@ class TestCacheEmbeddingMultimodalQuery:
"""Test suite for CacheEmbedding.embed_multimodal_query method."""
@pytest.fixture
- def mock_model_instance(self):
+ def mock_model_instance(self) -> Mock:
"""Create a mock ModelInstance for testing."""
model_instance = Mock()
model_instance.model = "vision-embedding-model"
@@ -366,7 +373,7 @@ class TestCacheEmbeddingMultimodalQuery:
model_instance.credentials = {"api_key": "test-key"}
return model_instance
- def test_embed_multimodal_query_cache_miss(self, mock_model_instance):
+ def test_embed_multimodal_query_cache_miss(self, mock_model_instance: Mock) -> None:
"""Test embedding multimodal query when Redis cache is empty."""
cache_embedding = CacheEmbedding(mock_model_instance)
document = {"file_id": "file123"}
@@ -400,7 +407,7 @@ class TestCacheEmbeddingMultimodalQuery:
assert len(result) == 1536
mock_redis.setex.assert_called_once()
- def test_embed_multimodal_query_cache_hit(self, mock_model_instance):
+ def test_embed_multimodal_query_cache_hit(self, mock_model_instance: Mock) -> None:
"""Test embedding multimodal query when Redis cache has the value."""
cache_embedding = CacheEmbedding(mock_model_instance)
document = {"file_id": "file123"}
@@ -419,7 +426,7 @@ class TestCacheEmbeddingMultimodalQuery:
mock_redis.expire.assert_called_once()
mock_model_instance.invoke_multimodal_embedding.assert_not_called()
- def test_embed_multimodal_query_nan_handling(self, mock_model_instance):
+ def test_embed_multimodal_query_nan_handling(self, mock_model_instance: Mock) -> None:
"""Test handling of NaN values in multimodal query embeddings."""
cache_embedding = CacheEmbedding(mock_model_instance)
@@ -452,7 +459,9 @@ class TestCacheEmbeddingMultimodalQuery:
assert "Normalized embedding is nan" in str(exc_info.value)
- def test_embed_multimodal_query_api_error(self, mock_model_instance, config_overrides):
+ def test_embed_multimodal_query_api_error(
+ self, mock_model_instance: Mock, config_overrides: Callable[..., None]
+ ) -> None:
"""Test handling of API errors during multimodal query embedding."""
config_overrides(DEBUG=False)
cache_embedding = CacheEmbedding(mock_model_instance)
@@ -467,7 +476,9 @@ class TestCacheEmbeddingMultimodalQuery:
assert "API Error" in str(exc_info.value)
- def test_embed_multimodal_query_redis_set_error(self, mock_model_instance, config_overrides):
+ def test_embed_multimodal_query_redis_set_error(
+ self, mock_model_instance: Mock, config_overrides: Callable[..., None]
+ ) -> None:
"""Test handling of Redis set errors during multimodal query embedding."""
config_overrides(DEBUG=True)
cache_embedding = CacheEmbedding(mock_model_instance)
@@ -505,7 +516,7 @@ class TestCacheEmbeddingQueryErrors:
"""Test suite for error handling in CacheEmbedding.embed_query method."""
@pytest.fixture
- def mock_model_instance(self):
+ def mock_model_instance(self) -> Mock:
"""Create a mock ModelInstance for testing."""
model_instance = Mock()
model_instance.model = "text-embedding-ada-002"
@@ -515,8 +526,8 @@ class TestCacheEmbeddingQueryErrors:
return model_instance
def test_embed_query_api_error_debug_mode(
- self, mock_model_instance, caplog: pytest.LogCaptureFixture, config_overrides
- ):
+ self, mock_model_instance: Mock, caplog: pytest.LogCaptureFixture, config_overrides: Callable[..., None]
+ ) -> None:
"""Test handling of API errors in debug mode."""
config_overrides(DEBUG=True)
cache_embedding = CacheEmbedding(mock_model_instance)
@@ -534,8 +545,8 @@ class TestCacheEmbeddingQueryErrors:
assert any(record.levelno == logging.ERROR for record in caplog.records)
def test_embed_query_redis_set_error_debug_mode(
- self, mock_model_instance, caplog: pytest.LogCaptureFixture, config_overrides
- ):
+ self, mock_model_instance: Mock, caplog: pytest.LogCaptureFixture, config_overrides: Callable[..., None]
+ ) -> None:
"""Test handling of Redis set errors in debug mode."""
config_overrides(DEBUG=True)
cache_embedding = CacheEmbedding(mock_model_instance)
@@ -575,7 +586,7 @@ class TestCacheEmbeddingQueryErrors:
class TestCacheEmbeddingInitialization:
"""Test suite for CacheEmbedding initialization."""
- def test_initialization_sets_model_instance(self):
+ def test_initialization_sets_model_instance(self) -> None:
"""Test CacheEmbedding initialization stores the provided model instance."""
model_instance = Mock()
model_instance.model = "test-model"
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 024c4d6ccfd..89912852935 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -432,7 +432,6 @@ project-excludes = [
"core/rag/datasource/vdb/test_field.py",
"core/rag/datasource/vdb/test_vector_base.py",
"core/rag/datasource/vdb/test_vector_factory.py",
- "core/rag/embedding/test_cached_embedding.py",
"core/rag/embedding/test_embedding_base.py",
"core/rag/embedding/test_embedding_service.py",
"core/rag/extractor/blob/test_blob.py",