|
14 | 14 |
|
15 | 15 | import fastapi |
16 | 16 | import pytest |
| 17 | +from fastapi.background import BackgroundTasks |
17 | 18 | from fastapi.middleware.asyncexitstack import AsyncExitStackMiddleware |
18 | 19 | from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware |
19 | 20 | from fastapi.responses import JSONResponse, PlainTextResponse |
20 | 21 | from fastapi.routing import APIRoute |
21 | 22 | from fastapi.testclient import TestClient |
| 23 | +from starlette.background import BackgroundTask |
22 | 24 | from starlette.routing import Match |
23 | 25 | from starlette.types import Receive, Scope, Send |
24 | 26 |
|
@@ -482,6 +484,51 @@ def test_basic_fastapi_call(self): |
482 | 484 | for span in spans: |
483 | 485 | self.assertIn("GET /foobar", span.name) |
484 | 486 |
|
| 487 | + def test_background_task_span_parents_inner_spans(self): |
| 488 | + """Regression test for #4251: spans created inside a FastAPI |
| 489 | + BackgroundTask must be children of a dedicated background-task span |
| 490 | + instead of the already-closed request span.""" |
| 491 | + self.memory_exporter.clear() |
| 492 | + app = fastapi.FastAPI() |
| 493 | + self._instrumentor.instrument_app(app) |
| 494 | + tracer = self.tracer_provider.get_tracer(__name__) |
| 495 | + |
| 496 | + async def background_notify(): |
| 497 | + with tracer.start_as_current_span("inside-background-task"): |
| 498 | + pass |
| 499 | + |
| 500 | + @app.post("/checkout") |
| 501 | + async def checkout(background_tasks: BackgroundTasks): |
| 502 | + background_tasks.add_task(background_notify) |
| 503 | + return {"status": "processing"} |
| 504 | + |
| 505 | + with TestClient(app) as client: |
| 506 | + response = client.post("/checkout") |
| 507 | + self.assertEqual(200, response.status_code) |
| 508 | + spans = self.memory_exporter.get_finished_spans() |
| 509 | + request_span = next( |
| 510 | + span for span in spans if span.name == "POST /checkout" |
| 511 | + ) |
| 512 | + background_span = next( |
| 513 | + span |
| 514 | + for span in spans |
| 515 | + if span.name == "BackgroundTask background_notify" |
| 516 | + ) |
| 517 | + inner_span = next( |
| 518 | + span for span in spans if span.name == "inside-background-task" |
| 519 | + ) |
| 520 | + self.assertIsNotNone(background_span.parent) |
| 521 | + self.assertEqual( |
| 522 | + background_span.parent.span_id, |
| 523 | + request_span.context.span_id, |
| 524 | + ) |
| 525 | + self.assertIsNotNone(inner_span.parent) |
| 526 | + self.assertEqual( |
| 527 | + inner_span.parent.span_id, |
| 528 | + background_span.context.span_id, |
| 529 | + ) |
| 530 | + otel_fastapi.FastAPIInstrumentor().uninstrument_app(app) |
| 531 | + |
485 | 532 | def test_fastapi_route_attribute_added(self): |
486 | 533 | """Ensure that fastapi routes are used as the span name.""" |
487 | 534 | self._client.get("/user/123") |
@@ -977,6 +1024,49 @@ def test_basic_post_request_metric_success_both_semconv(self): |
977 | 1024 | if isinstance(point, NumberDataPoint): |
978 | 1025 | self.assertEqual(point.value, 0) |
979 | 1026 |
|
| 1027 | + def test_uninstrument_app_restores_background_task_call(self): |
| 1028 | + """Regression test for #4251: uninstrumentation must restore the |
| 1029 | + original BackgroundTask.__call__ after FastAPI patches it.""" |
| 1030 | + self.assertTrue(hasattr(BackgroundTask, "_otel_original_call")) |
| 1031 | + self._instrumentor.uninstrument_app(self._app) |
| 1032 | + self.assertFalse(hasattr(BackgroundTask, "_otel_original_call")) |
| 1033 | + |
| 1034 | + def test_background_task_span_not_duplicated_on_double_instrument_app( |
| 1035 | + self, |
| 1036 | + ): |
| 1037 | + """Regression test for #4251: repeated instrument_app calls must not |
| 1038 | + wrap BackgroundTask.__call__ multiple times or duplicate spans.""" |
| 1039 | + self.memory_exporter.clear() |
| 1040 | + app = fastapi.FastAPI() |
| 1041 | + self._instrumentor.instrument_app(app) |
| 1042 | + self._instrumentor.instrument_app(app) |
| 1043 | + tracer = self.tracer_provider.get_tracer(__name__) |
| 1044 | + |
| 1045 | + async def background_notify(): |
| 1046 | + with tracer.start_as_current_span("inside-background-task"): |
| 1047 | + pass |
| 1048 | + |
| 1049 | + @app.post("/checkout") |
| 1050 | + async def checkout(background_tasks: BackgroundTasks): |
| 1051 | + background_tasks.add_task(background_notify) |
| 1052 | + return {"status": "processing"} |
| 1053 | + |
| 1054 | + with TestClient(app) as client: |
| 1055 | + response = client.post("/checkout") |
| 1056 | + self.assertEqual(200, response.status_code) |
| 1057 | + spans = self.memory_exporter.get_finished_spans() |
| 1058 | + background_spans = [ |
| 1059 | + span |
| 1060 | + for span in spans |
| 1061 | + if span.name == "BackgroundTask background_notify" |
| 1062 | + ] |
| 1063 | + inner_spans = [ |
| 1064 | + span for span in spans if span.name == "inside-background-task" |
| 1065 | + ] |
| 1066 | + self.assertEqual(len(background_spans), 1) |
| 1067 | + self.assertEqual(len(inner_spans), 1) |
| 1068 | + otel_fastapi.FastAPIInstrumentor().uninstrument_app(app) |
| 1069 | + |
980 | 1070 | def test_metric_uninstrument_app(self): |
981 | 1071 | self._client.get("/foobar") |
982 | 1072 | self._instrumentor.uninstrument_app(self._app) |
|
0 commit comments