Merge remote-tracking branch 'origin/master' into release/0.7.10

Author: untitaker

sentry_sdk/integrations/django/__init__.py

@@ -21,22 +21,6 @@
     from django.utils.datastructures import MultiValueDict  # type: ignore
     from typing import List
 
-try:
-    import psycopg2.sql  # type: ignore
-
-    def sql_to_string(sql):
-        # type: (Any) -> str
-        if isinstance(sql, psycopg2.sql.SQL):
-            return sql.string
-        return sql
-
-
-except ImportError:
-
-    def sql_to_string(sql):
-        # type: (Any) -> str
-        return sql
-
 
 try:
     from django.urls import resolve  # type: ignore
@@ -265,6 +249,12 @@ def files(self):
     def size_of_file(self, file):
         return file.size
 
+    def parsed_body(self):
+        try:
+            return self.request.data
+        except AttributeError:
+            return RequestExtractor.parsed_body(self)
+
 
 def _set_user_info(request, event):
     # type: (WSGIRequest, Dict[str, Any]) -> None
@@ -332,21 +322,38 @@ def record_sql(sql, params, cursor=None):
     if hub.get_integration(DjangoIntegration) is None:
         return
 
-    with capture_internal_exceptions():
-        if cursor and hasattr(cursor, "mogrify"):  # psycopg2
-            real_sql = cursor.mogrify(sql, params)
-            with capture_internal_exceptions():
+    real_sql = None
+    real_params = None
+
+    try:
+        # Prefer our own SQL formatting logic because it's the only one that
+        # has proper value trimming.
+        real_sql, real_params = format_sql(sql, params)
+        if real_sql:
+            real_sql = format_and_strip(real_sql, real_params)
+    except Exception:
+        pass
+
+    if not real_sql and cursor and hasattr(cursor, "mogrify"):
+        # If formatting failed and we're using psycopg2, it could be that we're
+        # looking at a query that uses Composed objects. Use psycopg2's mogrify
+        # function to format the query. We lose per-parameter trimming but gain
+        # accuracy in formatting.
+        #
+        # This is intentionally the second choice because we assume Composed
+        # queries are not widely used, while per-parameter trimming is
+        # generally highly desirable.
+        try:
+            if cursor and hasattr(cursor, "mogrify"):
+                real_sql = cursor.mogrify(sql, params)
                 if isinstance(real_sql, bytes):
                     real_sql = real_sql.decode(cursor.connection.encoding)
-        else:
-            real_sql, real_params = format_sql(sql, params)
-
-            if real_params:
-                try:
-                    real_sql = format_and_strip(real_sql, real_params)
-                except Exception:
-                    pass
-        hub.add_breadcrumb(message=real_sql, category="query")
+        except Exception:
+            pass
+
+    if real_sql:
+        with capture_internal_exceptions():
+            hub.add_breadcrumb(message=real_sql, category="query")
 
 
 def install_sql_hook():

sentry_sdk/utils.py

@@ -579,24 +579,41 @@ def to_string(value):
         return repr(value)[1:-1]
 
 
-def iter_event_frames(event):
+def iter_event_stacktraces(event):
     # type: (Dict[str, Any]) -> Iterator[Dict[str, Any]]
-    stacktraces = []
     if "stacktrace" in event:
-        stacktraces.append(event["stacktrace"])
+        yield event["stacktrace"]
     if "exception" in event:
         for exception in event["exception"].get("values") or ():
             if "stacktrace" in exception:
-                stacktraces.append(exception["stacktrace"])
-    for stacktrace in stacktraces:
+                yield exception["stacktrace"]
+
+
+def iter_event_frames(event):
+    # type: (Dict[str, Any]) -> Iterator[Dict[str, Any]]
+    for stacktrace in iter_event_stacktraces(event):
         for frame in stacktrace.get("frames") or ():
             yield frame
 
 
 def handle_in_app(event, in_app_exclude=None, in_app_include=None):
     # type: (Dict[str, Any], List, List) -> Dict[str, Any]
+    for stacktrace in iter_event_stacktraces(event):
+        handle_in_app_impl(
+            stacktrace.get("frames"),
+            in_app_exclude=in_app_exclude,
+            in_app_include=in_app_include,
+        )
+
+    return event
+
+
+def handle_in_app_impl(frames, in_app_exclude, in_app_include):
+    if not frames:
+        return
+
     any_in_app = False
-    for frame in iter_event_frames(event):
+    for frame in frames:
         in_app = frame.get("in_app")
         if in_app is not None:
             if in_app:
@@ -606,18 +623,18 @@ def handle_in_app(event, in_app_exclude=None, in_app_include=None):
         module = frame.get("module")
         if not module:
             continue
-
-        if _module_in_set(module, in_app_exclude):
-            frame["in_app"] = False
-        if _module_in_set(module, in_app_include):
+        elif _module_in_set(module, in_app_include):
             frame["in_app"] = True
             any_in_app = True
+        elif _module_in_set(module, in_app_exclude):
+            frame["in_app"] = False
 
     if not any_in_app:
-        for frame in iter_event_frames(event):
-            frame["in_app"] = True
+        for frame in frames:
+            if frame.get("in_app") is None:
+                frame["in_app"] = True
 
-    return event
+    return frames
 
 
 def exc_info_from_error(error):

tests/integrations/django/myapp/urls.py

@@ -32,5 +32,13 @@
     path("template-exc", views.template_exc, name="template_exc"),
 ]
 
+
+try:
+    urlpatterns.append(
+        path("rest-framework-exc", views.rest_framework_exc, name="rest_framework_exc")
+    )
+except AttributeError:
+    pass
+
 handler500 = views.handler500
 handler404 = views.handler404

tests/integrations/django/myapp/views.py

@@ -4,6 +4,18 @@
 from django.shortcuts import render
 from django.views.generic import ListView
 
+try:
+    from rest_framework.decorators import api_view
+
+    @api_view(["POST"])
+    def rest_framework_exc(request):
+        1 / 0
+
+
+except ImportError:
+    pass
+
+
 import sentry_sdk
 
 

tests/integrations/django/test_basic.py

@@ -1,4 +1,5 @@
 import pytest
+import json
 
 from werkzeug.test import Client
 from django.contrib.auth.models import User
@@ -225,7 +226,7 @@ def test_sql_psycopg2_string_composition(sentry_init, capture_events, query):
     if "postgres" not in connections:
         pytest.skip("postgres tests disabled")
 
-    import psycopg2
+    import psycopg2.sql
 
     sql = connections["postgres"].cursor()
 
@@ -248,7 +249,7 @@ def test_sql_psycopg2_placeholders(sentry_init, capture_events):
     if "postgres" not in connections:
         pytest.skip("postgres tests disabled")
 
-    import psycopg2
+    import psycopg2.sql
 
     sql = connections["postgres"].cursor()
 
@@ -389,3 +390,68 @@ def test_template_exception(sentry_init, client, capture_events):
         (None, None),
         (u"invalid_block_tag", u"django.template.base"),
     ]
+
+
+@pytest.mark.parametrize(
+    "type,event_request",
+    [
+        [
+            "json",
+            {
+                "cookies": {},
+                "data": {"foo": "bar"},
+                "env": {"SERVER_NAME": "localhost", "SERVER_PORT": "80"},
+                "headers": {
+                    "Content-Length": "14",
+                    "Content-Type": "application/json",
+                    "Host": "localhost",
+                },
+                "method": "POST",
+                "query_string": "",
+                "url": "http://localhost/rest-framework-exc",
+            },
+        ],
+        [
+            "formdata",
+            {
+                "cookies": {},
+                "data": {"foo": "bar"},
+                "env": {"SERVER_NAME": "localhost", "SERVER_PORT": "80"},
+                "headers": {
+                    "Content-Length": "7",
+                    "Content-Type": "application/x-www-form-urlencoded",
+                    "Host": "localhost",
+                },
+                "method": "POST",
+                "query_string": "",
+                "url": "http://localhost/rest-framework-exc",
+            },
+        ],
+    ],
+)
+def test_rest_framework_basic(
+    sentry_init, client, capture_events, capture_exceptions, type, event_request
+):
+    pytest.importorskip("rest_framework")
+    sentry_init(integrations=[DjangoIntegration()], send_default_pii=True)
+    exceptions = capture_exceptions()
+    events = capture_events()
+
+    if type == "json":
+        client.post(
+            reverse("rest_framework_exc"),
+            data=json.dumps({"foo": "bar"}),
+            content_type="application/json",
+        )
+    elif type == "formdata":
+        client.post(reverse("rest_framework_exc"), data={"foo": "bar"})
+    else:
+        assert False
+
+    error, = exceptions
+    assert isinstance(error, ZeroDivisionError)
+
+    event, = events
+    assert event["exception"]["values"][0]["mechanism"]["type"] == "django"
+
+    assert event["request"] == event_request

tests/utils/test_general.py

@@ -15,6 +15,7 @@
     format_and_strip,
     strip_string,
     filename_for_module,
+    handle_in_app_impl,
 )
 from sentry_sdk._compat import text_type
 
@@ -145,3 +146,24 @@ def test_parse_dsn_paths(given, expected):
 def test_parse_invalid_dsn(dsn):
     with pytest.raises(BadDsn):
         dsn = Dsn(dsn)
+
+
+@pytest.mark.parametrize("empty", [None, []])
+def test_in_app(empty):
+    assert handle_in_app_impl(
+        [{"module": "foo"}, {"module": "bar"}],
+        in_app_include=["foo"],
+        in_app_exclude=empty,
+    ) == [{"module": "foo", "in_app": True}, {"module": "bar"}]
+
+    assert handle_in_app_impl(
+        [{"module": "foo"}, {"module": "bar"}],
+        in_app_include=["foo"],
+        in_app_exclude=["foo"],
+    ) == [{"module": "foo", "in_app": True}, {"module": "bar"}]
+
+    assert handle_in_app_impl(
+        [{"module": "foo"}, {"module": "bar"}],
+        in_app_include=empty,
+        in_app_exclude=["foo"],
+    ) == [{"module": "foo", "in_app": False}, {"module": "bar", "in_app": True}]

tox.ini

@@ -41,7 +41,7 @@ envlist =
 deps =
     -r test-requirements.txt
 
-    py{2.7,3.4,3.5,3.6,3.7}-django: psycopg2>=2.7.5
+    django-{1.11,2.0,2.1}: djangorestframework>=3.0.0,<4.0.0
 
     django-{1.6,1.7,1.8}: pytest-django<3.0
     django-{1.9,1.10,1.11,2.0,2.1,dev}: pytest-django>=3.0