wip

Author: sentrivana

sentry_sdk/integrations/stdlib.py

@@ -1,3 +1,4 @@
+import io
 import json
 import os
 import subprocess
@@ -157,7 +158,9 @@ def getresponse(self, *args, **kwargs):
         if getattr(self, "_sentrysdk_is_graphql_request", False):
             with capture_internal_exceptions():
                 try:
-                    response_body = json.loads(rv.read())
+                    response_data = rv.read()
+                    response_body = json.loads(response_data)
+                    rv.read = io.BytesIO(response_data).read
                 except (json.JSONDecodeError, UnicodeDecodeError):
                     return rv
 
@@ -204,7 +207,7 @@ def stdlib_processor(
 
             parsed_url = parse_url(url, sanitize=False)
             request_info["query_string"] = parsed_url.query
-            request_info["url"] = url
+            request_info["url"] = parsed_url.url
             request_info["method"] = method
             try:
                 request_info["data"] = json.loads(request_body)

tests/conftest.py

@@ -584,6 +584,12 @@ def do_GET(self):  # noqa: N802
         self.end_headers()
         return
 
+    def do_POST(self):  # noqa: N802
+        # Process an HTTP POST request and return a response with an HTTP 200 status.
+        self.send_response(200)
+        self.end_headers()
+        return
+
 
 def get_free_port():
     s = socket.socket(socket.AF_INET, type=socket.SOCK_STREAM)

tests/integrations/stdlib/test_httplib.py

@@ -1,4 +1,7 @@
+import json
 import random
+from textwrap import dedent
+from urllib.parse import urlencode
 
 import pytest
 
@@ -16,6 +19,13 @@
     # py3
     from http.client import HTTPConnection, HTTPSConnection
 
+try:
+    # py3
+    from urllib.parse import parse_qsl
+except ImportError:
+    # py2
+    from urlparse import parse_qsl  # type: ignore
+
 try:
     from unittest import mock  # python 3.3 and above
 except ImportError:
@@ -27,7 +37,7 @@
 from sentry_sdk.tracing import Transaction
 from sentry_sdk.integrations.stdlib import StdlibIntegration
 
-from tests.conftest import create_mock_http_server
+from tests.conftest import MockServerRequestHandler, create_mock_http_server
 
 PORT = create_mock_http_server()
 
@@ -340,3 +350,110 @@ def test_option_trace_propagation_targets(
         else:
             assert "sentry-trace" not in request_headers
             assert "baggage" not in request_headers
+
+
+def test_graphql_get_client_error_captured(sentry_init, capture_events):
+    sentry_init(integrations=[StdlibIntegration()])
+
+    graphql_response = {
+        "data": None,
+        "errors": [
+            {
+                "message": "some error",
+                "locations": [{"line": 2, "column": 3}],
+                "path": ["user"],
+            }
+        ],
+    }
+
+    events = capture_events()
+
+    params = {"query": "query QueryName {user{name}}"}
+
+    def do_GET(self):
+        self.send_response(200)
+        self.end_headers()
+        self.wfile.write(json.dumps(graphql_response).encode())
+
+    with mock.patch.object(MockServerRequestHandler, "do_GET", do_GET):
+        conn = HTTPConnection("localhost:{}".format(PORT))
+        conn.request("GET", "/graphql?" + urlencode(params))
+        response = conn.getresponse()
+
+    assert response.read() == json.dumps(graphql_response).encode()
+
+    (event,) = events
+
+    assert event["request"]["url"] == "http://localhost:{}/graphql".format(PORT)
+    assert event["request"]["method"] == "GET"
+    assert dict(parse_qsl(event["request"]["query_string"])) == params
+    assert "data" not in event["request"]
+    assert (
+        event["contexts"]["response"]["data"] == json.dumps(graphql_response).encode()
+    )
+
+    assert event["request"]["api_target"] == "graphql"
+    assert event["fingerprint"] == ["QueryName", "query", 200]
+    assert (
+        event["exception"]["values"][0]["value"]
+        == "GraphQL request failed, name: QueryName, type: query"
+    )
+
+
+def test_graphql_post_client_error_captured(sentry_init, capture_events):
+    sentry_init(integrations=[StdlibIntegration()])
+
+    graphql_request = {
+        "query": dedent(
+            """
+            mutation AddPet ($name: String!) {
+                addPet(name: $name) {
+                    id
+                    name
+                }
+            }
+        """
+        ),
+        "variables": {
+            "name": "Lucy",
+        },
+    }
+    graphql_response = {
+        "data": None,
+        "errors": [
+            {
+                "message": "already have too many pets",
+                "locations": [{"line": 1, "column": 1}],
+            }
+        ],
+    }
+
+    events = capture_events()
+
+    def do_POST(self):
+        self.send_response(200)
+        self.end_headers()
+        self.wfile.write(json.dumps(graphql_response).encode())
+
+    with mock.patch.object(MockServerRequestHandler, "do_POST", do_POST):
+        conn = HTTPConnection("localhost:{}".format(PORT))
+        conn.request("POST", "/graphql", body=json.dumps(graphql_request).encode())
+        response = conn.getresponse()
+
+    # the response can still be read normally
+    assert response.read() == json.dumps(graphql_response).encode()
+
+    (event,) = events
+
+    assert event["request"]["url"] == "http://localhost:{}/graphql".format(PORT)
+    assert event["request"]["method"] == "POST"
+    assert event["request"]["query_string"] == ""
+    assert event["request"]["data"] == graphql_request
+    assert event["contexts"]["response"]["data"] == graphql_response
+
+    assert event["request"]["api_target"] == "graphql"
+    assert event["fingerprint"] == ["AddPet", "mutation", 200]
+    assert (
+        event["exception"]["values"][0]["value"]
+        == "GraphQL request failed, name: AddPet, type: mutation"
+    )