feat: Add test matrix for sanic 19 (getsentry#584)

untitaker · web-flow · commit 0c93613df5de · 2020-01-07T16:53:49.000+01:00
* feat: Add test matrix for sanic 19

* fix: Fix test
diff --git a/tests/integrations/sanic/test_sanic.py b/tests/integrations/sanic/test_sanic.py
@@ -8,9 +8,11 @@
 from sentry_sdk import capture_message, configure_scope
 from sentry_sdk.integrations.sanic import SanicIntegration
 
-from sanic import Sanic, request, response
+from sanic import Sanic, request, response, __version__ as SANIC_VERSION_RAW
 from sanic.exceptions import abort
 
+SANIC_VERSION = tuple(map(int, SANIC_VERSION_RAW.split(".")))
+
 
 @pytest.fixture
 def app():
@@ -34,7 +36,7 @@ def test_request_data(sentry_init, app, capture_events):
     event, = events
     assert event["transaction"] == "hi"
     assert event["request"]["env"] == {"REMOTE_ADDR": ""}
-    assert set(event["request"]["headers"]) == {
+    assert set(event["request"]["headers"]) >= {
         "accept",
         "accept-encoding",
         "host",
@@ -123,6 +125,17 @@ def myhandler(request, exception):
 
 
 def test_concurrency(sentry_init, app):
+    """
+    Make sure we instrument Sanic in a way where request data does not leak
+    between request handlers. This test also implicitly tests our concept of
+    how async code should be instrumented, so if it breaks it likely has
+    ramifications for other async integrations and async usercode.
+
+    We directly call the request handler instead of using Sanic's test client
+    because that's the only way we could reproduce leakage with such a low
+    amount of concurrent tasks.
+    """
+
     sentry_init(integrations=[SanicIntegration()])
 
     @app.route("/context-check/<i>")
@@ -140,16 +153,21 @@ async def context_check(request, i):
     async def task(i):
         responses = []
 
-        await app.handle_request(
-            request.Request(
-                url_bytes="http://localhost/context-check/{i}".format(i=i).encode(
-                    "ascii"
-                ),
-                headers={},
-                version="1.1",
-                method="GET",
-                transport=None,
+        kwargs = {
+            "url_bytes": "http://localhost/context-check/{i}".format(i=i).encode(
+                "ascii"
             ),
+            "headers": {},
+            "version": "1.1",
+            "method": "GET",
+            "transport": None,
+        }
+
+        if SANIC_VERSION >= (19,):
+            kwargs["app"] = app
+
+        await app.handle_request(
+            request.Request(**kwargs),
             write_callback=responses.append,
             stream_callback=responses.append,
         )
diff --git a/tox.ini b/tox.ini
@@ -27,7 +27,8 @@ envlist =
     {pypy,py2.7,py3.5,py3.6,py3.7}-falcon-1.4
     {pypy,py2.7,py3.5,py3.6,py3.7,py3.8}-falcon-2.0
 
-    {py3.5,py3.6,py3.7}-sanic-{0.8,18}
+    py3.5-sanic-{0.8,18}
+    {py3.6,py3.7}-sanic-{0.8,18,19}
 
     {pypy,py2.7,py3.5,py3.6,py3.7,py3.8}-celery-{4.1,4.2,4.3,4.4}
     {pypy,py2.7}-celery-3
@@ -97,6 +98,7 @@ deps =
 
     sanic-0.8: sanic>=0.8,<0.9
     sanic-18: sanic>=18.0,<19.0
+    sanic-19: sanic>=19.0,<20.0
     {py3.5,py3.6}-sanic: aiocontextvars==0.2.1
     sanic: aiohttp
 
