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 OpenTelemetry decorator tests (#43976)

Eddy ZHANGd77de787ac56
diff --git a/api/tests/unit_tests/extensions/otel/decorators/test_base.py b/api/tests/unit_tests/extensions/otel/decorators/test_base.py
index 5d8c8620ebd..04a505febc2 100644
--- a/api/tests/unit_tests/extensions/otel/decorators/test_base.py
+++ b/api/tests/unit_tests/extensions/otel/decorators/test_base.py
@@ -11,6 +11,8 @@ Test coverage:
from collections.abc import Callable
import pytest
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
from opentelemetry.trace import StatusCode
from extensions.otel.decorators.base import trace_span
@@ -24,21 +26,21 @@ def _otel_enabled(config_overrides: Callable[..., None]) -> None:
class TestTraceSpanDecorator:
"""Test trace_span decorator basic functionality."""
- def test_decorated_function_executes_normally(self, tracer_provider_with_memory_exporter):
+ def test_decorated_function_executes_normally(self, tracer_provider_with_memory_exporter: TracerProvider) -> None:
"""Test that decorated function executes and returns correct value."""
@trace_span()
- def test_func(x, y):
+ def test_func(x: int, y: int) -> int:
return x + y
result = test_func(2, 3)
assert result == 5
- def test_decorator_with_args_and_kwargs(self, tracer_provider_with_memory_exporter):
+ def test_decorator_with_args_and_kwargs(self, tracer_provider_with_memory_exporter: TracerProvider) -> None:
"""Test that decorator correctly handles args and kwargs."""
@trace_span()
- def test_func(a, b, c=10):
+ def test_func(a: int, b: int, c: int = 10) -> int:
return a + b + c
result = test_func(1, 2, c=3)
@@ -48,11 +50,13 @@ class TestTraceSpanDecorator:
class TestTraceSpanWithMemoryExporter:
"""Test trace_span with MemorySpanExporter to verify span creation."""
- def test_span_is_created_and_exported(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_span_is_created_and_exported(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that span is created and exported to memory exporter."""
@trace_span()
- def test_func():
+ def test_func() -> str:
return "result"
test_func()
@@ -60,11 +64,13 @@ class TestTraceSpanWithMemoryExporter:
spans = memory_span_exporter.get_finished_spans()
assert len(spans) == 1
- def test_span_name_matches_function(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_span_name_matches_function(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that span name matches the decorated function."""
@trace_span()
- def my_test_function():
+ def my_test_function() -> str:
return "result"
my_test_function()
@@ -73,11 +79,13 @@ class TestTraceSpanWithMemoryExporter:
assert len(spans) == 1
assert "my_test_function" in spans[0].name
- def test_span_status_is_ok_on_success(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_span_status_is_ok_on_success(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that span status is OK when function succeeds."""
@trace_span()
- def test_func():
+ def test_func() -> str:
return "result"
test_func()
@@ -86,11 +94,13 @@ class TestTraceSpanWithMemoryExporter:
assert len(spans) == 1
assert spans[0].status.status_code == StatusCode.OK
- def test_span_status_is_error_on_exception(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_span_status_is_error_on_exception(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that span status is ERROR when function raises exception."""
@trace_span()
- def test_func():
+ def test_func() -> None:
raise ValueError("test error")
with pytest.raises(ValueError, match="test error"):
@@ -100,11 +110,13 @@ class TestTraceSpanWithMemoryExporter:
assert len(spans) == 1
assert spans[0].status.status_code == StatusCode.ERROR
- def test_exception_is_recorded_in_span(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_exception_is_recorded_in_span(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that exception details are recorded in span events."""
@trace_span()
- def test_func():
+ def test_func() -> None:
raise ValueError("test error")
with pytest.raises(ValueError):
diff --git a/api/tests/unit_tests/extensions/otel/decorators/test_handler.py b/api/tests/unit_tests/extensions/otel/decorators/test_handler.py
index e59f71deb9a..c2b80497e81 100644
--- a/api/tests/unit_tests/extensions/otel/decorators/test_handler.py
+++ b/api/tests/unit_tests/extensions/otel/decorators/test_handler.py
@@ -11,6 +11,8 @@ Test coverage:
from collections.abc import Callable
import pytest
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
from opentelemetry.trace import StatusCode
from extensions.otel.decorators.handler import SpanHandler
@@ -24,105 +26,93 @@ def _otel_enabled(config_overrides: Callable[..., None]) -> None:
class TestSpanHandlerExtractArguments:
"""Test SpanHandler._extract_arguments method."""
- def test_extract_positional_arguments(self):
+ def test_extract_positional_arguments(self) -> None:
"""Test extracting positional arguments."""
handler = SpanHandler()
- def func(a, b, c):
+ def func(a: int, b: int, c: int) -> None:
pass
- args = (1, 2, 3)
- kwargs = {}
- result = handler._extract_arguments(func, *args, **kwargs)
+ result = handler._extract_arguments(func, 1, 2, 3)
assert result is not None
assert result["a"] == 1
assert result["b"] == 2
assert result["c"] == 3
- def test_extract_keyword_arguments(self):
+ def test_extract_keyword_arguments(self) -> None:
"""Test extracting keyword arguments."""
handler = SpanHandler()
- def func(a, b, c):
+ def func(a: int, b: int, c: int) -> None:
pass
- args = ()
- kwargs = {"a": 1, "b": 2, "c": 3}
- result = handler._extract_arguments(func, *args, **kwargs)
+ result = handler._extract_arguments(func, a=1, b=2, c=3)
assert result is not None
assert result["a"] == 1
assert result["b"] == 2
assert result["c"] == 3
- def test_extract_mixed_arguments(self):
+ def test_extract_mixed_arguments(self) -> None:
"""Test extracting mixed positional and keyword arguments."""
handler = SpanHandler()
- def func(a, b, c):
+ def func(a: int, b: int, c: int) -> None:
pass
- args = (1,)
- kwargs = {"b": 2, "c": 3}
- result = handler._extract_arguments(func, *args, **kwargs)
+ result = handler._extract_arguments(func, 1, b=2, c=3)
assert result is not None
assert result["a"] == 1
assert result["b"] == 2
assert result["c"] == 3
- def test_extract_arguments_with_defaults(self):
+ def test_extract_arguments_with_defaults(self) -> None:
"""Test extracting arguments with default values."""
handler = SpanHandler()
- def func(a, b=10, c=20):
+ def func(a: int, b: int = 10, c: int = 20) -> None:
pass
- args = (1,)
- kwargs = {}
- result = handler._extract_arguments(func, *args, **kwargs)
+ result = handler._extract_arguments(func, 1)
assert result is not None
assert result["a"] == 1
assert result["b"] == 10
assert result["c"] == 20
- def test_extract_arguments_handles_self(self):
+ def test_extract_arguments_handles_self(self) -> None:
"""Test extracting arguments from instance method (with self)."""
handler = SpanHandler()
class MyClass:
- def method(self, a, b):
+ def method(self, a: int, b: int) -> None:
pass
instance = MyClass()
- args = (1, 2)
- kwargs = {}
- result = handler._extract_arguments(instance.method, *args, **kwargs)
+ result = handler._extract_arguments(instance.method, 1, 2)
assert result is not None
assert result["a"] == 1
assert result["b"] == 2
- def test_extract_arguments_returns_none_on_error(self):
+ def test_extract_arguments_returns_none_on_error(self) -> None:
"""Test that _extract_arguments returns None when extraction fails."""
handler = SpanHandler()
- def func(a, b):
+ def func(a: int, b: int) -> None:
pass
- args = (1,)
- kwargs = {}
- result = handler._extract_arguments(func, *args, **kwargs)
+ result = handler._extract_arguments(func, 1) # pyrefly: ignore[missing-argument]
assert result is None
- def test_signature_caching(self):
+ def test_signature_caching(self) -> None:
"""Test that function signatures are cached."""
handler = SpanHandler()
- def func(a, b):
+ def func(a: int, b: int) -> None:
pass
assert func not in handler._signature_cache
@@ -138,12 +128,14 @@ class TestSpanHandlerExtractArguments:
class TestSpanHandlerWrapper:
"""Test SpanHandler.wrapper default implementation."""
- def test_wrapper_creates_span(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_wrapper_creates_span(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that wrapper creates a span."""
handler = SpanHandler()
tracer = tracer_provider_with_memory_exporter.get_tracer(__name__)
- def test_func():
+ def test_func() -> str:
return "result"
result = handler.wrapper(tracer, test_func)
@@ -152,14 +144,16 @@ class TestSpanHandlerWrapper:
spans = memory_span_exporter.get_finished_spans()
assert len(spans) == 1
- def test_wrapper_sets_span_kind_internal(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_wrapper_sets_span_kind_internal(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that wrapper sets SpanKind to INTERNAL."""
from opentelemetry.trace import SpanKind
handler = SpanHandler()
tracer = tracer_provider_with_memory_exporter.get_tracer(__name__)
- def test_func():
+ def test_func() -> str:
return "result"
handler.wrapper(tracer, test_func)
@@ -168,12 +162,14 @@ class TestSpanHandlerWrapper:
assert len(spans) == 1
assert spans[0].kind == SpanKind.INTERNAL
- def test_wrapper_sets_status_ok_on_success(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_wrapper_sets_status_ok_on_success(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that wrapper sets status to OK when function succeeds."""
handler = SpanHandler()
tracer = tracer_provider_with_memory_exporter.get_tracer(__name__)
- def test_func():
+ def test_func() -> str:
return "result"
handler.wrapper(tracer, test_func)
@@ -182,12 +178,14 @@ class TestSpanHandlerWrapper:
assert len(spans) == 1
assert spans[0].status.status_code == StatusCode.OK
- def test_wrapper_records_exception_on_error(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_wrapper_records_exception_on_error(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that wrapper records exception when function raises."""
handler = SpanHandler()
tracer = tracer_provider_with_memory_exporter.get_tracer(__name__)
- def test_func():
+ def test_func() -> None:
raise ValueError("test error")
with pytest.raises(ValueError, match="test error"):
@@ -199,12 +197,14 @@ class TestSpanHandlerWrapper:
assert len(events) > 0
assert any("exception" in event.name.lower() for event in events)
- def test_wrapper_sets_status_error_on_exception(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_wrapper_sets_status_error_on_exception(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that wrapper sets status to ERROR when function raises exception."""
handler = SpanHandler()
tracer = tracer_provider_with_memory_exporter.get_tracer(__name__)
- def test_func():
+ def test_func() -> None:
raise ValueError("test error")
with pytest.raises(ValueError):
@@ -213,37 +213,42 @@ class TestSpanHandlerWrapper:
spans = memory_span_exporter.get_finished_spans()
assert len(spans) == 1
assert spans[0].status.status_code == StatusCode.ERROR
+ assert spans[0].status.description is not None
assert "test error" in spans[0].status.description
- def test_wrapper_re_raises_exception(self, tracer_provider_with_memory_exporter):
+ def test_wrapper_re_raises_exception(self, tracer_provider_with_memory_exporter: TracerProvider) -> None:
"""Test that wrapper re-raises exception after recording it."""
handler = SpanHandler()
tracer = tracer_provider_with_memory_exporter.get_tracer(__name__)
- def test_func():
+ def test_func() -> None:
raise ValueError("test error")
with pytest.raises(ValueError, match="test error"):
handler.wrapper(tracer, test_func)
- def test_wrapper_passes_arguments_correctly(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_wrapper_passes_arguments_correctly(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test that wrapper correctly passes arguments to wrapped function."""
handler = SpanHandler()
tracer = tracer_provider_with_memory_exporter.get_tracer(__name__)
- def test_func(a, b, c=10):
+ def test_func(a: int, b: int, c: int = 10) -> int:
return a + b + c
result = handler.wrapper(tracer, test_func, 1, 2, c=3)
assert result == 6
- def test_wrapper_with_memory_exporter(self, tracer_provider_with_memory_exporter, memory_span_exporter):
+ def test_wrapper_with_memory_exporter(
+ self, tracer_provider_with_memory_exporter: TracerProvider, memory_span_exporter: InMemorySpanExporter
+ ) -> None:
"""Test wrapper end-to-end with memory exporter."""
handler = SpanHandler()
tracer = tracer_provider_with_memory_exporter.get_tracer(__name__)
- def my_function(x):
+ def my_function(x: int) -> int:
return x * 2
result = handler.wrapper(tracer, my_function, 5)
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 9c8e18c075d..bf82c8a1225 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -519,8 +519,6 @@ project-excludes = [
"extensions/logstore/test_sql_escape.py",
"extensions/otel/decorators/handlers/test_generate_handler.py",
"extensions/otel/decorators/handlers/test_workflow_app_runner_handler.py",
- "extensions/otel/decorators/test_base.py",
- "extensions/otel/decorators/test_handler.py",
"extensions/otel/test_retrieval_tracing.py",
"extensions/test_celery_ssl.py",
"extensions/test_ext_login.py",