ref: Event processors always overwrite (#225)

untitaker · web-flow · commit 32e7a05e63d7 · 2018-12-29T17:45:16.000+01:00
diff --git a/sentry_sdk/integrations/aiohttp.py b/sentry_sdk/integrations/aiohttp.py
@@ -66,24 +66,16 @@ def aiohttp_processor(event, hint):
 
             request_info = event.setdefault("request", {})
 
-            if "url" not in request_info:
-                request_info["url"] = "%s://%s%s" % (
-                    request.scheme,
-                    request.host,
-                    request.path,
-                )
-
-            if "query_string" not in request_info:
-                request_info["query_string"] = request.query_string
-
-            if "method" not in request_info:
-                request_info["method"] = request.method
-
-            if "env" not in request_info:
-                request_info["env"] = {"REMOTE_ADDR": request.remote}
+            request_info["url"] = "%s://%s%s" % (
+                request.scheme,
+                request.host,
+                request.path,
+            )
 
-            if "headers" not in request_info:
-                request_info["headers"] = _filter_headers(dict(request.headers))
+            request_info["query_string"] = request.query_string
+            request_info["method"] = request.method
+            request_info["env"] = {"REMOTE_ADDR": request.remote}
+            request_info["headers"] = _filter_headers(dict(request.headers))
 
         return event
 
diff --git a/sentry_sdk/integrations/aws_lambda.py b/sentry_sdk/integrations/aws_lambda.py
@@ -130,25 +130,32 @@ def event_processor(event, hint):
 
         request = event.setdefault("request", {})
 
-        if "httpMethod" in aws_event and "method" not in request:
+        if "httpMethod" in aws_event:
             request["method"] = aws_event["httpMethod"]
-        if "url" not in request:
-            request["url"] = _get_url(aws_event, aws_context)
-        if "queryStringParameters" in aws_event and "query_string" not in request:
+
+        request["url"] = _get_url(aws_event, aws_context)
+
+        if "queryStringParameters" in aws_event:
             request["query_string"] = aws_event["queryStringParameters"]
-        if "headers" in aws_event and "headers" not in request:
+
+        if "headers" in aws_event:
             request["headers"] = _filter_headers(aws_event["headers"])
+
         if aws_event.get("body", None):
             # Unfortunately couldn't find a way to get structured body from AWS
             # event. Meaning every body is unstructured to us.
             request["data"] = AnnotatedValue("", {"rem": [["!raw", "x", 0, 0]]})
 
         if _should_send_default_pii():
             user_info = event.setdefault("user", {})
-            if "id" not in user_info:
-                user_info["id"] = aws_event.get("identity", {}).get("userArn")
-            if "ip_address" not in user_info:
-                user_info["ip_address"] = aws_event.get("identity", {}).get("sourceIp")
+
+            id = aws_event.get("identity", {}).get("userArn")
+            if id is not None:
+                user_info["id"] = id
+
+            ip = aws_event.get("identity", {}).get("sourceIp")
+            if ip is not None:
+                user_info["ip_address"] = ip
 
         return event
 
diff --git a/sentry_sdk/integrations/celery.py b/sentry_sdk/integrations/celery.py
@@ -48,8 +48,7 @@ def _handle_task_prerun(sender, task, args, kwargs, **_):
 def _make_event_processor(args, kwargs, task):
     def event_processor(event, hint):
         with capture_internal_exceptions():
-            if "transaction" not in event:
-                event["transaction"] = task.name
+            event["transaction"] = task.name
 
         with capture_internal_exceptions():
             extra = event.setdefault("extra", {})
diff --git a/sentry_sdk/integrations/django/__init__.py b/sentry_sdk/integrations/django/__init__.py
@@ -122,16 +122,15 @@ def event_processor(event, hint):
         if request is None:
             return event
 
-        if "transaction" not in event:
-            try:
-                if integration.transaction_style == "function_name":
-                    event["transaction"] = transaction_from_function(
-                        resolve(request.path).func
-                    )
-                elif integration.transaction_style == "url":
-                    event["transaction"] = LEGACY_RESOLVER.resolve(request.path)
-            except Exception:
-                pass
+        try:
+            if integration.transaction_style == "function_name":
+                event["transaction"] = transaction_from_function(
+                    resolve(request.path).func
+                )
+            elif integration.transaction_style == "url":
+                event["transaction"] = LEGACY_RESOLVER.resolve(request.path)
+        except Exception:
+            pass
 
         with capture_internal_exceptions():
             DjangoRequestExtractor(request).extract_into_event(event)
@@ -185,23 +184,20 @@ def _set_user_info(request, event):
     if user is None or not is_authenticated(user):
         return
 
-    if "id" not in user_info:
-        try:
-            user_info["id"] = str(user.pk)
-        except Exception:
-            pass
+    try:
+        user_info["id"] = str(user.pk)
+    except Exception:
+        pass
 
-    if "email" not in user_info:
-        try:
-            user_info["email"] = user.email
-        except Exception:
-            pass
+    try:
+        user_info["email"] = user.email
+    except Exception:
+        pass
 
-    if "username" not in user_info:
-        try:
-            user_info["username"] = user.get_username()
-        except Exception:
-            pass
+    try:
+        user_info["username"] = user.get_username()
+    except Exception:
+        pass
 
 
 class _FormatConverter(object):
diff --git a/sentry_sdk/integrations/flask.py b/sentry_sdk/integrations/flask.py
@@ -118,14 +118,13 @@ def inner(event, hint):
         if request is None:
             return event
 
-        if "transaction" not in event:
-            try:
-                if integration.transaction_style == "endpoint":
-                    event["transaction"] = request.url_rule.endpoint
-                elif integration.transaction_style == "url":
-                    event["transaction"] = request.url_rule.rule
-            except Exception:
-                pass
+        try:
+            if integration.transaction_style == "endpoint":
+                event["transaction"] = request.url_rule.endpoint
+            elif integration.transaction_style == "url":
+                event["transaction"] = request.url_rule.rule
+        except Exception:
+            pass
 
         with capture_internal_exceptions():
             FlaskRequestExtractor(request).extract_into_event(event)
@@ -166,13 +165,12 @@ def _add_user_to_event(event):
 
         user_info = event.setdefault("user", {})
 
-        if "id" not in user_info:
-            try:
-                user_info["id"] = user.get_id()
-                # TODO: more configurable user attrs here
-            except AttributeError:
-                # might happen if:
-                # - flask_login could not be imported
-                # - flask_login is not configured
-                # - no user is logged in
-                pass
+        try:
+            user_info["id"] = user.get_id()
+            # TODO: more configurable user attrs here
+        except AttributeError:
+            # might happen if:
+            # - flask_login could not be imported
+            # - flask_login is not configured
+            # - no user is logged in
+            pass
diff --git a/sentry_sdk/integrations/modules.py b/sentry_sdk/integrations/modules.py
@@ -32,6 +32,5 @@ def setup_once():
         @add_global_event_processor
         def processor(event, hint):
             if Hub.current.get_integration(ModulesIntegration) is not None:
-                if "modules" not in event:
-                    event["modules"] = dict(_get_installed_modules())
+                event["modules"] = dict(_get_installed_modules())
             return event
diff --git a/sentry_sdk/integrations/pyramid.py b/sentry_sdk/integrations/pyramid.py
@@ -138,23 +138,21 @@ def event_processor(event, hint):
         if request is None:
             return event
 
-        if "transaction" not in event:
-            try:
-                if integration.transaction_style == "route_name":
-                    event["transaction"] = request.matched_route.name
-                elif integration.transaction_style == "route_pattern":
-                    event["transaction"] = request.matched_route.pattern
-            except Exception:
-                pass
+        try:
+            if integration.transaction_style == "route_name":
+                event["transaction"] = request.matched_route.name
+            elif integration.transaction_style == "route_pattern":
+                event["transaction"] = request.matched_route.pattern
+        except Exception:
+            pass
 
         with capture_internal_exceptions():
             PyramidRequestExtractor(request).extract_into_event(event)
 
         if _should_send_default_pii():
             with capture_internal_exceptions():
                 user_info = event.setdefault("user", {})
-                if "id" not in user_info:
-                    user_info["id"] = authenticated_userid(request)
+                user_info["id"] = authenticated_userid(request)
 
         return event
 
diff --git a/sentry_sdk/integrations/rq.py b/sentry_sdk/integrations/rq.py
@@ -56,8 +56,7 @@ def event_processor(event, hint):
         job = weak_job()
         if job is not None:
             with capture_internal_exceptions():
-                if "transaction" not in event:
-                    event["transaction"] = job.func_name
+                event["transaction"] = job.func_name
 
             with capture_internal_exceptions():
                 extra = event.setdefault("extra", {})
diff --git a/sentry_sdk/integrations/sanic.py b/sentry_sdk/integrations/sanic.py
@@ -125,24 +125,16 @@ def sanic_processor(event, hint):
             request_info = event["request"]
             urlparts = urlparse.urlsplit(request.url)
 
-            if "url" not in request_info:
-                request_info["url"] = "%s://%s%s" % (
-                    urlparts.scheme,
-                    urlparts.netloc,
-                    urlparts.path,
-                )
-
-            if "query_string" not in request_info:
-                request_info["query_string"] = urlparts.query
-
-            if "method" not in request_info:
-                request_info["method"] = request.method
-
-            if "env" not in request_info:
-                request_info["env"] = {"REMOTE_ADDR": request.remote_addr}
-
-            if "headers" not in request_info:
-                request_info["headers"] = _filter_headers(dict(request.headers))
+            request_info["url"] = "%s://%s%s" % (
+                urlparts.scheme,
+                urlparts.netloc,
+                urlparts.path,
+            )
+
+            request_info["query_string"] = urlparts.query
+            request_info["method"] = request.method
+            request_info["env"] = {"REMOTE_ADDR": request.remote_addr}
+            request_info["headers"] = _filter_headers(dict(request.headers))
 
         return event
 
diff --git a/sentry_sdk/integrations/tornado.py b/sentry_sdk/integrations/tornado.py
@@ -92,35 +92,26 @@ def tornado_processor(event, hint):
 
         request = handler.request
 
-        if "transaction" not in event:
-            with capture_internal_exceptions():
-                method = getattr(handler, handler.request.method.lower())
-                event["transaction"] = transaction_from_function(method)
+        with capture_internal_exceptions():
+            method = getattr(handler, handler.request.method.lower())
+            event["transaction"] = transaction_from_function(method)
 
         with capture_internal_exceptions():
             extractor = TornadoRequestExtractor(request)
             extractor.extract_into_event(event)
 
             request_info = event["request"]
 
-            if "url" not in request_info:
-                request_info["url"] = "%s://%s%s" % (
-                    request.protocol,
-                    request.host,
-                    request.path,
-                )
-
-            if "query_string" not in request_info:
-                request_info["query_string"] = request.query
-
-            if "method" not in request_info:
-                request_info["method"] = request.method
-
-            if "env" not in request_info:
-                request_info["env"] = {"REMOTE_ADDR": request.remote_ip}
+            request_info["url"] = "%s://%s%s" % (
+                request.protocol,
+                request.host,
+                request.path,
+            )
 
-            if "headers" not in request_info:
-                request_info["headers"] = _filter_headers(dict(request.headers))
+            request_info["query_string"] = request.query
+            request_info["method"] = request.method
+            request_info["env"] = {"REMOTE_ADDR": request.remote_ip}
+            request_info["headers"] = _filter_headers(dict(request.headers))
 
         with capture_internal_exceptions():
             if handler.current_user and _should_send_default_pii():
diff --git a/sentry_sdk/integrations/wsgi.py b/sentry_sdk/integrations/wsgi.py
@@ -189,14 +189,13 @@ def event_processor(event, hint):
 
             if _should_send_default_pii():
                 user_info = event.setdefault("user", {})
-                if "ip_address" not in user_info:
-                    user_info.setdefault("ip_address", client_ip)
-
-            request_info.setdefault("url", request_url)
-            request_info.setdefault("query_string", query_string)
-            request_info.setdefault("method", method)
-            request_info.setdefault("env", env)
-            request_info.setdefault("headers", headers)
+                user_info["ip_address"] = client_ip
+
+            request_info["url"] = request_url
+            request_info["query_string"] = query_string
+            request_info["method"] = method
+            request_info["env"] = env
+            request_info["headers"] = headers
 
         return event
 
diff --git a/tests/test_basics.py b/tests/test_basics.py
@@ -7,6 +7,7 @@
     push_scope,
     configure_scope,
     capture_exception,
+    capture_message,
     add_breadcrumb,
     last_event_id,
     Hub,
@@ -271,3 +272,32 @@ def test_scope_popped_too_soon(sentry_init, caplog):
     record, = (x for x in caplog.records if x.levelname == "ERROR")
 
     assert record.message == ("Scope popped too soon. Popped 1 scopes too many.")
+
+
+def test_scope_event_processor_order(sentry_init, capture_events):
+    def before_send(event, hint):
+        event["message"] += "baz"
+        return event
+
+    sentry_init(debug=True, before_send=before_send)
+    events = capture_events()
+
+    with push_scope() as scope:
+
+        @scope.add_event_processor
+        def foo(event, hint):
+            event["message"] += "foo"
+            return event
+
+        with push_scope() as scope:
+
+            @scope.add_event_processor
+            def bar(event, hint):
+                event["message"] += "bar"
+                return event
+
+            capture_message("hi")
+
+    event, = events
+
+    assert event["message"] == "hifoobarbaz"
