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 RAG pipeline queue tests (#43764)

Eddy ZHANGe44ed1b0c34d
diff --git a/api/tests/unit_tests/core/rag/pipeline/test_queue.py b/api/tests/unit_tests/core/rag/pipeline/test_queue.py
index 17c5f3c6b7c..4a1203f095c 100644
--- a/api/tests/unit_tests/core/rag/pipeline/test_queue.py
+++ b/api/tests/unit_tests/core/rag/pipeline/test_queue.py
@@ -18,7 +18,7 @@ from core.rag.pipeline.queue import TaskWrapper, TenantIsolatedTaskQueue
class TestTaskWrapper:
"""Test cases for TaskWrapper serialization/deserialization."""
- def test_serialize_simple_data(self):
+ def test_serialize_simple_data(self) -> None:
"""Test serialization of simple data types."""
data = {"key": "value", "number": 42, "list": [1, 2, 3]}
wrapper = TaskWrapper(data=data)
@@ -30,7 +30,7 @@ class TestTaskWrapper:
parsed = json.loads(serialized)
assert parsed["data"] == data
- def test_serialize_complex_data(self):
+ def test_serialize_complex_data(self) -> None:
"""Test serialization of complex nested data."""
data = {
"nested": {"deep": {"value": "test", "numbers": [1, 2, 3, 4, 5]}},
@@ -43,7 +43,7 @@ class TestTaskWrapper:
parsed = json.loads(serialized)
assert parsed["data"] == data
- def test_deserialize_valid_data(self):
+ def test_deserialize_valid_data(self) -> None:
"""Test deserialization of valid JSON data."""
original_data = {"key": "value", "number": 42}
# Serialize using TaskWrapper to get the correct format
@@ -53,7 +53,7 @@ class TestTaskWrapper:
wrapper = TaskWrapper.deserialize(serialized)
assert wrapper.data == original_data
- def test_deserialize_invalid_json(self):
+ def test_deserialize_invalid_json(self) -> None:
"""Test deserialization handles invalid JSON gracefully."""
invalid_json = "{invalid json}"
@@ -61,7 +61,7 @@ class TestTaskWrapper:
with pytest.raises(ValidationError):
TaskWrapper.deserialize(invalid_json)
- def test_serialize_ensure_ascii_false(self):
+ def test_serialize_ensure_ascii_false(self) -> None:
"""Test that serialization preserves Unicode characters."""
data = {"chinese": "中文测试", "emoji": "🚀"}
wrapper = TaskWrapper(data=data)
@@ -75,17 +75,17 @@ class TestTenantIsolatedTaskQueue:
"""Test cases for TenantIsolatedTaskQueue functionality."""
@pytest.fixture
- def mock_redis_client(self):
+ def mock_redis_client(self) -> MagicMock:
"""Mock Redis client for testing."""
mock_redis = MagicMock()
return mock_redis
@pytest.fixture
- def sample_queue(self, mock_redis_client):
+ def sample_queue(self, mock_redis_client: MagicMock) -> TenantIsolatedTaskQueue:
"""Create a sample TenantIsolatedTaskQueue instance."""
return TenantIsolatedTaskQueue("tenant-123", "test-key")
- def test_initialization(self, sample_queue):
+ def test_initialization(self, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test queue initialization with correct key generation."""
assert sample_queue._tenant_id == "tenant-123"
assert sample_queue._unique_key == "test-key"
@@ -93,7 +93,7 @@ class TestTenantIsolatedTaskQueue:
assert sample_queue._task_key == "tenant_test-key_task:tenant-123"
@patch("core.rag.pipeline.queue.redis_client")
- def test_get_task_key_exists(self, mock_redis, sample_queue):
+ def test_get_task_key_exists(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test getting task key when it exists."""
mock_redis.get.return_value = "1"
@@ -103,7 +103,7 @@ class TestTenantIsolatedTaskQueue:
mock_redis.get.assert_called_once_with("tenant_test-key_task:tenant-123")
@patch("core.rag.pipeline.queue.redis_client")
- def test_get_task_key_not_exists(self, mock_redis, sample_queue):
+ def test_get_task_key_not_exists(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test getting task key when it doesn't exist."""
mock_redis.get.return_value = None
@@ -113,7 +113,9 @@ class TestTenantIsolatedTaskQueue:
mock_redis.get.assert_called_once_with("tenant_test-key_task:tenant-123")
@patch("core.rag.pipeline.queue.redis_client")
- def test_set_task_waiting_time_default_ttl(self, mock_redis, sample_queue):
+ def test_set_task_waiting_time_default_ttl(
+ self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue
+ ) -> None:
"""Test setting task waiting flag with default TTL."""
sample_queue.set_task_waiting_time()
@@ -124,7 +126,9 @@ class TestTenantIsolatedTaskQueue:
)
@patch("core.rag.pipeline.queue.redis_client")
- def test_set_task_waiting_time_custom_ttl(self, mock_redis, sample_queue):
+ def test_set_task_waiting_time_custom_ttl(
+ self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue
+ ) -> None:
"""Test setting task waiting flag with custom TTL."""
custom_ttl = 1800
sample_queue.set_task_waiting_time(custom_ttl)
@@ -132,14 +136,14 @@ class TestTenantIsolatedTaskQueue:
mock_redis.setex.assert_called_once_with("tenant_test-key_task:tenant-123", custom_ttl, 1)
@patch("core.rag.pipeline.queue.redis_client")
- def test_delete_task_key(self, mock_redis, sample_queue):
+ def test_delete_task_key(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test deleting task key."""
sample_queue.delete_task_key()
mock_redis.delete.assert_called_once_with("tenant_test-key_task:tenant-123")
@patch("core.rag.pipeline.queue.redis_client")
- def test_push_tasks_string_list(self, mock_redis, sample_queue):
+ def test_push_tasks_string_list(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test pushing string tasks directly."""
tasks = ["task1", "task2", "task3"]
@@ -150,7 +154,7 @@ class TestTenantIsolatedTaskQueue:
)
@patch("core.rag.pipeline.queue.redis_client")
- def test_push_tasks_mixed_types(self, mock_redis, sample_queue):
+ def test_push_tasks_mixed_types(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test pushing mixed string and object tasks."""
tasks = ["string_task", {"object_task": "data", "id": 123}, "another_string"]
@@ -175,14 +179,14 @@ class TestTenantIsolatedTaskQueue:
assert wrapper.data == {"object_task": "data", "id": 123}
@patch("core.rag.pipeline.queue.redis_client")
- def test_push_tasks_empty_list(self, mock_redis, sample_queue):
+ def test_push_tasks_empty_list(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test pushing empty task list."""
sample_queue.push_tasks([])
mock_redis.lpush.assert_not_called()
@patch("core.rag.pipeline.queue.redis_client")
- def test_pull_tasks_default_count(self, mock_redis, sample_queue):
+ def test_pull_tasks_default_count(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test pulling tasks with default count (1)."""
mock_redis.rpop.side_effect = ["task1", None]
@@ -192,7 +196,7 @@ class TestTenantIsolatedTaskQueue:
assert mock_redis.rpop.call_count == 1
@patch("core.rag.pipeline.queue.redis_client")
- def test_pull_tasks_custom_count(self, mock_redis, sample_queue):
+ def test_pull_tasks_custom_count(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test pulling tasks with custom count."""
# First test: pull 3 tasks
mock_redis.rpop.side_effect = ["task1", "task2", "task3", None]
@@ -212,7 +216,7 @@ class TestTenantIsolatedTaskQueue:
assert mock_redis.rpop.call_count == 3
@patch("core.rag.pipeline.queue.redis_client")
- def test_pull_tasks_zero_count(self, mock_redis, sample_queue):
+ def test_pull_tasks_zero_count(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test pulling tasks with zero count returns empty list."""
result = sample_queue.pull_tasks(0)
@@ -220,7 +224,7 @@ class TestTenantIsolatedTaskQueue:
mock_redis.rpop.assert_not_called()
@patch("core.rag.pipeline.queue.redis_client")
- def test_pull_tasks_negative_count(self, mock_redis, sample_queue):
+ def test_pull_tasks_negative_count(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test pulling tasks with negative count returns empty list."""
result = sample_queue.pull_tasks(-1)
@@ -228,7 +232,9 @@ class TestTenantIsolatedTaskQueue:
mock_redis.rpop.assert_not_called()
@patch("core.rag.pipeline.queue.redis_client")
- def test_pull_tasks_with_wrapped_objects(self, mock_redis, sample_queue):
+ def test_pull_tasks_with_wrapped_objects(
+ self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue
+ ) -> None:
"""Test pulling tasks that include wrapped objects."""
# Create a wrapped task
task_data = {"task_id": 123, "data": "test"}
@@ -248,7 +254,9 @@ class TestTenantIsolatedTaskQueue:
assert result[1] == {"task_id": 123, "data": "test"}
@patch("core.rag.pipeline.queue.redis_client")
- def test_pull_tasks_with_invalid_wrapped_data(self, mock_redis, sample_queue):
+ def test_pull_tasks_with_invalid_wrapped_data(
+ self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue
+ ) -> None:
"""Test pulling tasks with invalid JSON falls back to string."""
# Invalid JSON string that cannot be deserialized
invalid_json = "invalid json data"
@@ -259,7 +267,7 @@ class TestTenantIsolatedTaskQueue:
assert result == [invalid_json]
@patch("core.rag.pipeline.queue.redis_client")
- def test_pull_tasks_bytes_decoding(self, mock_redis, sample_queue):
+ def test_pull_tasks_bytes_decoding(self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue) -> None:
"""Test pulling tasks handles bytes from Redis correctly."""
mock_redis.rpop.side_effect = [
b"task1", # bytes
@@ -272,7 +280,9 @@ class TestTenantIsolatedTaskQueue:
assert result == ["task1", "task2"]
@patch("core.rag.pipeline.queue.redis_client")
- def test_complex_object_serialization_roundtrip(self, mock_redis, sample_queue):
+ def test_complex_object_serialization_roundtrip(
+ self, mock_redis: MagicMock, sample_queue: TenantIsolatedTaskQueue
+ ) -> None:
"""Test complex object serialization and deserialization roundtrip."""
complex_task = {
"id": uuid4().hex,
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 3539b3c7cd1..d52fc2a852a 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -452,7 +452,6 @@ project-excludes = [
"core/rag/indexing/processor/test_qa_index_processor.py",
"core/rag/indexing/test_index_processor.py",
"core/rag/indexing/test_index_processor_base.py",
- "core/rag/pipeline/test_queue.py",
"core/rag/rerank/test_reranker.py",
"core/rag/retrieval/test_dataset_retrieval.py",
"core/rag/retrieval/test_dataset_retrieval_methods.py",