feat(integration): Add support for Sanic >=21.3 (getsentry#1146)

ahmedetefy · sentry-bot · web-flow · commit 73bb478f1d2b · 2021-07-08T08:15:06.000+02:00
* feat(integration): Add support for Sanic &gt;=21.3

* PR changes requested

* Fixed failing test + consistent transaction names

* fix: Formatting

* Trigger Build

* Small refactor

* Removed python 3.9 sanic 19 env due to lack of support

* Added checks for splitting app name from route name

Co-authored-by: sentry-bot &lt;markus+ghbot@sentry.io&gt;
diff --git a/sentry_sdk/integrations/sanic.py b/sentry_sdk/integrations/sanic.py
@@ -96,14 +96,29 @@ async def sentry_handle_request(self, request, *args, **kwargs):
 
         old_router_get = Router.get
 
-        def sentry_router_get(self, request):
-            # type: (Any, Request) -> Any
-            rv = old_router_get(self, request)
+        def sentry_router_get(self, *args):
+            # type: (Any, Union[Any, Request]) -> Any
+            rv = old_router_get(self, *args)
             hub = Hub.current
             if hub.get_integration(SanicIntegration) is not None:
                 with capture_internal_exceptions():
                     with hub.configure_scope() as scope:
-                        scope.transaction = rv[0].__name__
+                        if version >= (21, 3):
+                            # Sanic versions above and including 21.3 append the app name to the
+                            # route name, and so we need to remove it from Route name so the
+                            # transaction name is consistent across all versions
+                            sanic_app_name = self.ctx.app.name
+                            sanic_route = rv[0].name
+
+                            if sanic_route.startswith("%s." % sanic_app_name):
+                                # We add a 1 to the len of the sanic_app_name because there is a dot
+                                # that joins app name and the route name
+                                # Format: app_name.route_name
+                                sanic_route = sanic_route[len(sanic_app_name) + 1 :]
+
+                            scope.transaction = sanic_route
+                        else:
+                            scope.transaction = rv[0].__name__
             return rv
 
         Router.get = sentry_router_get
diff --git a/tests/integrations/sanic/test_sanic.py b/tests/integrations/sanic/test_sanic.py
@@ -9,14 +9,20 @@
 from sentry_sdk.integrations.sanic import SanicIntegration
 
 from sanic import Sanic, request, response, __version__ as SANIC_VERSION_RAW
+from sanic.response import HTTPResponse
 from sanic.exceptions import abort
 
 SANIC_VERSION = tuple(map(int, SANIC_VERSION_RAW.split(".")))
 
 
 @pytest.fixture
 def app():
-    app = Sanic(__name__)
+    if SANIC_VERSION >= (20, 12):
+        # Build (20.12.0) adds a feature where the instance is stored in an internal class
+        # registry for later retrieval, and so add register=False to disable that
+        app = Sanic(__name__, register=False)
+    else:
+        app = Sanic(__name__)
 
     @app.route("/message")
     def hi(request):
@@ -166,11 +172,46 @@ async def task(i):
         if SANIC_VERSION >= (19,):
             kwargs["app"] = app
 
-        await app.handle_request(
-            request.Request(**kwargs),
-            write_callback=responses.append,
-            stream_callback=responses.append,
-        )
+        if SANIC_VERSION >= (21, 3):
+            try:
+                app.router.reset()
+                app.router.finalize()
+            except AttributeError:
+                ...
+
+            class MockAsyncStreamer:
+                def __init__(self, request_body):
+                    self.request_body = request_body
+                    self.iter = iter(self.request_body)
+                    self.response = b"success"
+
+                def respond(self, response):
+                    responses.append(response)
+                    patched_response = HTTPResponse()
+                    patched_response.send = lambda end_stream: asyncio.sleep(0.001)
+                    return patched_response
+
+                def __aiter__(self):
+                    return self
+
+                async def __anext__(self):
+                    try:
+                        return next(self.iter)
+                    except StopIteration:
+                        raise StopAsyncIteration
+
+            patched_request = request.Request(**kwargs)
+            patched_request.stream = MockAsyncStreamer([b"hello", b"foo"])
+
+            await app.handle_request(
+                patched_request,
+            )
+        else:
+            await app.handle_request(
+                request.Request(**kwargs),
+                write_callback=responses.append,
+                stream_callback=responses.append,
+            )
 
         (r,) = responses
         assert r.status == 200
diff --git a/tox.ini b/tox.ini
@@ -39,6 +39,8 @@ envlist =
 
     {py3.5,py3.6,py3.7}-sanic-{0.8,18}
     {py3.6,py3.7}-sanic-19
+    {py3.6,py3.7,py3.8}-sanic-20
+    {py3.7,py3.8,py3.9}-sanic-21
 
     # TODO: Add py3.9
     {pypy,py2.7}-celery-3
@@ -139,6 +141,9 @@ deps =
     sanic-0.8: sanic>=0.8,<0.9
     sanic-18: sanic>=18.0,<19.0
     sanic-19: sanic>=19.0,<20.0
+    sanic-20: sanic>=20.0,<21.0
+    sanic-21: sanic>=21.0,<22.0
+    {py3.7,py3.8,py3.9}-sanic-21: sanic_testing
     {py3.5,py3.6}-sanic: aiocontextvars==0.2.1
     sanic: aiohttp
     py3.5-sanic: ujson<4
