Handle scope["server"] = None, by defaulting to 0.0.0.0:80

Author: Skeen

ext/opentelemetry-ext-asgi/src/opentelemetry/ext/asgi/__init__.py

@@ -79,19 +79,17 @@ def http_status_to_canonical_code(code: int, allow_redirect: bool = True):
 def collect_request_attributes(scope):
     """Collects HTTP request attributes from the ASGI scope and returns a
     dictionary to be used as span creation attributes."""
-
-    port = scope.get("server")[1]
-    server_host = scope.get("server")[0] + (
-        ":" + str(port) if port != 80 else ""
-    )
+    server = scope.get("server") or ['0.0.0.0', 80]
+    port = server[1]
+    server_host = server[0] + (":" + str(port) if port != 80 else "")
     http_url = scope.get("scheme") + "://" + server_host + scope.get("path")
     if scope.get("query_string"):
         http_url = http_url + ("?" + scope.get("query_string").decode("utf8"))
 
     result = {
         "component": scope.get("type"),
         "http.method": scope.get("method"),
-        "http.server_name": scope.get("server")[0],
+        "http.server_name": server[0],
         "http.scheme": scope.get("scheme"),
         "http.host": server_host,
         "host.port": port,

ext/opentelemetry-ext-asgi/tests/test_asgi_middleware.py

@@ -133,7 +133,7 @@ def validate_outputs(self, outputs, error=None, modifiers=None):
         for span, expected in zip(span_list, expected):
             self.assertEqual(span.name, expected["name"])
             self.assertEqual(span.kind, expected["kind"])
-            self.assertEqual(span.attributes, expected["attributes"])
+            self.assertDictEqual(dict(span.attributes), expected["attributes"])
 
     def test_basic_asgi_call(self):
         """Test that spans are emitted as expected."""
@@ -170,6 +170,24 @@ def update_expected_span_name(expected):
         outputs = self.get_all_output()
         self.validate_outputs(outputs, modifiers=[update_expected_span_name])
 
+    def test_behavior_with_scope_server_as_none(self):
+        """Test that middleware is ok when server is none in scope."""
+        def update_expected_server(expected):
+            expected[3]['attributes'].update({
+                'http.server_name': '0.0.0.0',
+                'http.host': '0.0.0.0',
+                'host.port': 80,
+                'http.url': 'http://0.0.0.0/'
+            })
+            return expected
+        self.scope["server"] = None
+        app = otel_asgi.OpenTelemetryMiddleware(simple_asgi)
+        self.seed_app(app)
+        self.send_default_request()
+        outputs = self.get_all_output()
+        self.validate_outputs(outputs, modifiers=[update_expected_server])
+
+
 
 class TestAsgiAttributes(unittest.TestCase):
     def setUp(self):