feat: lazy request processing (#12)

* feat: lazy request processing

* chore: stylefixes

Author: untitaker

sentry_sdk/hub.py

@@ -174,6 +174,7 @@ def push_scope(self):
     def pop_scope_unsafe(self):
         """Pops a scope layer from the stack. Try to use the context manager
         `push_scope()` instead."""
+        self._pending_processors = []
         self._stack.pop()
 
     @contextmanager

sentry_sdk/integrations/_wsgi.py

@@ -37,9 +37,12 @@ class RequestExtractor(object):
     def __init__(self, request):
         self.request = request
 
-    def extract_into_scope(self, scope):
+    def extract_into_event(self, event):
+        if "request" in event:
+            return
+
         # if the code below fails halfway through we at least have some data
-        scope.request = request_info = {}
+        event["request"] = request_info = {}
 
         request_info["url"] = self.url
         request_info["query_string"] = self.query_string

sentry_sdk/integrations/django/__init__.py

@@ -34,18 +34,26 @@ def process_request(self, request):
         try:
             get_current_hub().push_scope()
 
+            get_current_hub().add_event_processor(
+                lambda: self.make_event_processor(request)
+            )
+
             with configure_scope() as scope:
                 scope.transaction = _get_transaction_from_request(request)
-                try:
-                    DjangoRequestExtractor(request).extract_into_scope(scope)
-                except Exception:
-                    get_current_hub().capture_internal_exception()
-
-                # TODO: user info
-
         except Exception:
             get_current_hub().capture_internal_exception()
 
+    def make_event_processor(self, request):
+        def processor(event):
+            try:
+                DjangoRequestExtractor(request).extract_into_event(event)
+            except Exception:
+                get_current_hub().capture_internal_exception()
+
+            # TODO: user info
+
+        return processor
+
 
 class DjangoRequestExtractor(RequestExtractor):
     @property

sentry_sdk/integrations/flask.py

@@ -25,46 +25,48 @@ def init_app(self, app):
             raise RuntimeError("Sentry registration is already registered")
         app.extensions[__name__] = True
 
-        appcontext_pushed.connect(_push_appctx, sender=app)
-        app.teardown_appcontext(_pop_appctx)
-        got_request_exception.connect(_capture_exception, sender=app)
-        app.before_request(_before_request)
+        appcontext_pushed.connect(self._push_appctx, sender=app)
+        app.teardown_appcontext(self._pop_appctx)
+        got_request_exception.connect(self._capture_exception, sender=app)
+        app.before_request(self._before_request)
 
+    def _push_appctx(self, *args, **kwargs):
+        get_current_hub().push_scope()
+        _app_ctx_stack.top._sentry_app_scope_pushed = True
 
-def _push_appctx(*args, **kwargs):
-    get_current_hub().push_scope()
-    _app_ctx_stack.top._sentry_app_scope_pushed = True
+    def _pop_appctx(self, exception):
+        get_current_hub().pop_scope_unsafe()
 
+    def _capture_exception(self, sender, exception, **kwargs):
+        capture_exception(exception)
 
-def _pop_appctx(exception):
-    get_current_hub().pop_scope_unsafe()
+    def _before_request(self, *args, **kwargs):
+        try:
+            assert getattr(
+                _app_ctx_stack.top, "_sentry_app_scope_pushed", None
+            ), "scope push failed"
 
+            with configure_scope() as scope:
+                if request.url_rule:
+                    scope.transaction = request.url_rule.endpoint
 
-def _capture_exception(sender, exception, **kwargs):
-    capture_exception(exception)
-
-
-def _before_request(*args, **kwargs):
-    try:
-        assert getattr(
-            _app_ctx_stack.top, "_sentry_app_scope_pushed", None
-        ), "scope push failed"
-
-        with configure_scope() as scope:
-            if request.url_rule:
-                scope.transaction = request.url_rule.endpoint
+                get_current_hub().add_event_processor(self.make_event_processor)
+        except Exception:
+            get_current_hub().capture_internal_exception()
 
+    def make_event_processor(self):
+        def processor(event):
             try:
-                FlaskRequestExtractor(request).extract_into_scope(scope)
+                FlaskRequestExtractor(request).extract_into_event(event)
             except Exception:
                 get_current_hub().capture_internal_exception()
 
             try:
-                _set_user_info(scope)
+                _set_user_info(event)
             except Exception:
                 get_current_hub().capture_internal_exception()
-    except Exception:
-        get_current_hub().capture_internal_exception()
+
+        return processor
 
 
 class FlaskRequestExtractor(RequestExtractor):
@@ -96,7 +98,10 @@ def size_of_file(self, file):
         return file.content_length
 
 
-def _set_user_info(scope):
+def _set_user_info(event):
+    if "user" in event:
+        return
+
     try:
         ip_address = request.access_route[0]
     except IndexError:
@@ -114,4 +119,4 @@ def _set_user_info(scope):
         # - no user is logged in
         pass
 
-    scope.user = user_info
+    event["user"] = user_info

tests/integrations/flask/test_flask.py

@@ -9,7 +9,7 @@
 
 from flask_login import LoginManager, login_user
 
-from sentry_sdk import configure_scope, capture_message
+from sentry_sdk import capture_message
 import sentry_sdk.integrations.flask as flask_sentry
 
 sentry = flask_sentry.FlaskSentry()
@@ -34,20 +34,16 @@ def hi():
     return app
 
 
-def test_has_context(app):
-    @app.route("/")
-    def index():
-        with configure_scope() as scope:
-            assert scope._data["transaction"] == "index"
-            assert "data" not in scope._data["request"]
-            assert scope._data["request"]["url"] == "http://localhost/"
-
-        return "ok"
-
+def test_has_context(app, capture_events):
     client = app.test_client()
-    response = client.get("/")
+    response = client.get("/message")
     assert response.status_code == 200
 
+    event, = capture_events
+    assert event["transaction"] == "hi"
+    assert "data" not in event["request"]
+    assert event["request"]["url"] == "http://localhost/message"
+
 
 @pytest.mark.parametrize("debug", (True, False))
 @pytest.mark.parametrize("testing", (True, False))

tests/test_utils.py

@@ -1,4 +1,4 @@
-from hypothesis import given, assume, settings
+from hypothesis import given, assume
 import hypothesis.strategies as st
 
 from sentry_sdk.utils import safe_repr
@@ -8,15 +8,13 @@
 
 
 @given(x=any_string)
-@settings(max_examples=1000)
 def test_safe_repr_never_broken_for_strings(x):
     r = safe_repr(x)
     assert isinstance(r, text_type)
     assert u"broken repr" not in r
 
 
 @given(x=any_string)
-@settings(max_examples=1000)
 def test_safe_repr_never_leaves_escapes_in(x):
     if isinstance(x, bytes):
         assume(b"\\u" not in x and b"\\x" not in x)