Handle psycopg2's string composition (#170)

* Handle psycopg2's string composition

* Remove extraneous import

* Add tests, run black

Author: bmdavi3

sentry_sdk/integrations/django/__init__.py

@@ -7,6 +7,21 @@
 from django import VERSION as DJANGO_VERSION
 from django.core import signals
 
+try:
+    import psycopg2.sql
+
+    def sql_to_string(sql):
+        if isinstance(sql, psycopg2.sql.SQL):
+            return sql.string
+        return sql
+
+
+except ImportError:
+
+    def sql_to_string(sql):
+        return sql
+
+
 try:
     from django.urls import resolve
 except ImportError:
@@ -203,6 +218,7 @@ def format_sql(sql, params):
         # convert sql with named parameters to sql with unnamed parameters
         conv = _FormatConverter(params)
         if params:
+            sql = sql_to_string(sql)
             sql = sql % conv
             params = conv.params
         else:

tests/integrations/django/test_basic.py

@@ -141,6 +141,52 @@ def test_sql_queries(sentry_init, capture_events):
     assert crumb["message"] == """SELECT count(*) FROM people_person WHERE foo = 123"""
 
 
+@pytest.mark.django_db
+def test_sql_dict_query_params(sentry_init, capture_events):
+    sentry_init(integrations=[DjangoIntegration()], send_default_pii=True)
+    from django.db import connection
+
+    sql = connection.cursor()
+
+    events = capture_events()
+    with pytest.raises(Exception):
+        # table doesn't even exist
+        sql.execute(
+            """SELECT count(*) FROM people_person WHERE foo = %(my_foo)s""",
+            {"my_foo": 10},
+        )
+
+    capture_message("HI")
+
+    event, = events
+
+    crumb, = event["breadcrumbs"]
+    assert crumb["message"] == ("SELECT count(*) FROM people_person WHERE foo = 10")
+
+
+@pytest.mark.django_db
+def test_sql_psycopg2_string_composition(sentry_init, capture_events):
+    sentry_init(integrations=[DjangoIntegration()], send_default_pii=True)
+    from django.db import connection
+    from psycopg2 import sql as psycopg2_sql
+
+    sql = connection.cursor()
+
+    events = capture_events()
+    with pytest.raises(Exception):
+        # table doesn't even exist
+        sql.execute(
+            psycopg2_sql.SQL("SELECT %(my_param)s FROM people_person"), {"my_param": 10}
+        )
+
+    capture_message("HI")
+
+    event, = events
+
+    crumb, = event["breadcrumbs"]
+    assert crumb["message"] == ("SELECT 10 FROM people_person")
+
+
 @pytest.mark.django_db
 def test_sql_queries_large_params(sentry_init, capture_events):
     sentry_init(integrations=[DjangoIntegration()], send_default_pii=True)

tox.ini

@@ -42,6 +42,8 @@ envlist =
 deps =
     -r test-requirements.txt
 
+    django: psycopg2>=2.7.5
+
     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
     django-1.6: Django>=1.6,<1.7