contrib/sanic: fix the format of set-cookie header stored in context

We are getting a Cookie instance from Sanic that by default get
translate to a dict that is not a proper type for an header. Instead
convert it to its string represantation.

Author: xrmx

elasticapm/contrib/sanic/utils.py

@@ -33,7 +33,7 @@
 
 from sanic import Sanic
 from sanic import __version__ as version
-from sanic.cookies import CookieJar
+from sanic.cookies import Cookie, CookieJar
 from sanic.request import Request
 from sanic.response import HTTPResponse
 
@@ -120,7 +120,14 @@ async def get_response_info(config: Config, response: HTTPResponse, event_type:
         result["status_code"] = response.status
 
     if config.capture_headers:
-        result["headers"] = dict(response.headers)
+
+        def normalize(v):
+            # we are getting entries for Set-Cookie headers as Cookie instances
+            if isinstance(v, Cookie):
+                return str(v)
+            return v
+
+        result["headers"] = {k: normalize(v) for k, v in response.headers.items()}
 
     if config.capture_body in ("all", event_type) and "octet-stream" not in response.content_type:
         result["body"] = response.body.decode("utf-8")

tests/contrib/sanic/sanic_tests.py

@@ -199,6 +199,7 @@ def test_cookies_normalization(sanic_elastic_app, elasticapm_client):
     _, resp = sanic_app.test_client.get(
         "/add-cookies",
     )
+    assert resp.status_code == 200
     assert len(apm._client.events[constants.TRANSACTION]) == 1
     transaction = apm._client.events[constants.TRANSACTION][0]
     assert transaction["context"]["response"]["cookies"] == {"some": {"value": "cookie", "path": "/"}}