Graphql server instrumentation (#499)

* Add GraphQL Server Sanic Instrumentation

* Co-authored-by: Timothy Pansino <[email protected]>
Co-authored-by: Uma Annamalai <[email protected]>

* Add co-authors

Co-authored-by: Timothy Pansino <[email protected]>
Co-authored-by: Uma Annamalai <[email protected]>

* Comment out Copyright notice message

Co-authored-by: Timothy Pansino <[email protected]>
Co-authored-by: Uma Annamalai <[email protected]>

Co-authored-by: Timothy Pansino <[email protected]>
Co-authored-by: Uma Annamalai <[email protected]>

Author: 3 people

newrelic/config.py

@@ -2153,6 +2153,12 @@ def _process_module_builtin_defaults():
         "instrument_flask_rest",
     )
 
+    _process_module_definition(
+        "graphql_server",
+        "newrelic.hooks.component_graphqlserver",
+        "instrument_graphqlserver",
+    )
+
     # _process_module_definition('web.application',
     #        'newrelic.hooks.framework_webpy')
     # _process_module_definition('web.template',

newrelic/hooks/component_graphqlserver.py

@@ -0,0 +1,49 @@
+from newrelic.api.asgi_application import wrap_asgi_application
+from newrelic.api.error_trace import ErrorTrace
+from newrelic.api.graphql_trace import GraphQLOperationTrace
+from newrelic.api.transaction import current_transaction
+from newrelic.api.transaction_name import TransactionNameWrapper
+from newrelic.common.object_names import callable_name
+from newrelic.common.object_wrapper import wrap_function_wrapper
+from newrelic.core.graphql_utils import graphql_statement
+from newrelic.hooks.framework_graphql import (
+    framework_version as graphql_framework_version,
+)
+from newrelic.hooks.framework_graphql import ignore_graphql_duplicate_exception
+
+def framework_details():
+    import graphql_server
+    return ("GraphQLServer", getattr(graphql_server, "__version__", None))
+
+def bind_query(schema, params, *args, **kwargs):
+    return getattr(params, "query", None)
+
+
+def wrap_get_response(wrapped, instance, args, kwargs):
+    transaction = current_transaction()
+
+    if not transaction:
+        return wrapped(*args, **kwargs)
+
+    try:
+        query = bind_query(*args, **kwargs)
+    except TypeError:
+        return wrapped(*args, **kwargs)
+
+    framework = framework_details()
+    transaction.add_framework_info(name=framework[0], version=framework[1])
+    transaction.add_framework_info(name="GraphQL", version=graphql_framework_version())
+
+    if hasattr(query, "body"):
+        query = query.body
+
+    transaction.set_transaction_name(callable_name(wrapped), "GraphQL", priority=10)
+
+    with GraphQLOperationTrace() as trace:
+        trace.product = "GraphQLServer"
+        trace.statement = graphql_statement(query)
+        with ErrorTrace(ignore=ignore_graphql_duplicate_exception):
+            return wrapped(*args, **kwargs)
+
+def instrument_graphqlserver(module):
+    wrap_function_wrapper(module, "get_response", wrap_get_response)    

tests/component_graphqlserver/_test_graphql.py

@@ -0,0 +1,38 @@
+# Copyright 2010 New Relic, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from sanic import Sanic
+from graphql_server.sanic import GraphQLView
+from testing_support.asgi_testing import AsgiTest
+
+from graphql import GraphQLObjectType, GraphQLString, GraphQLSchema, GraphQLField
+
+
+def resolve_hello(root, info):
+    return "Hello!"
+
+hello_field = GraphQLField(GraphQLString, resolve=resolve_hello)
+query = GraphQLObjectType(
+    name="Query",
+    fields={
+        "hello": hello_field,
+    },
+)
+
+app = Sanic(name="SanicGraphQL")
+routes = [
+    app.add_route(GraphQLView.as_view(schema=GraphQLSchema(query=query)), "/graphql"),
+]
+
+target_application = AsgiTest(app)

tests/component_graphqlserver/conftest.py

@@ -0,0 +1,38 @@
+# Copyright 2010 New Relic, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from testing_support.fixtures import (
+    code_coverage_fixture,
+    collector_agent_registration_fixture,
+    collector_available_fixture,
+)
+
+_coverage_source = [
+    "newrelic.hooks.component_graphqlserver",
+]
+
+code_coverage = code_coverage_fixture(source=_coverage_source)
+
+_default_settings = {
+    "transaction_tracer.explain_threshold": 0.0,
+    "transaction_tracer.transaction_threshold": 0.0,
+    "transaction_tracer.stack_trace_threshold": 0.0,
+    "debug.log_data_collector_payloads": True,
+    "debug.record_transaction_failure": True,
+}
+
+collector_agent_registration = collector_agent_registration_fixture(
+    app_name="Python Agent Test (component_graphqlserver)",
+    default_settings=_default_settings,
+)

tests/component_graphqlserver/test_graphql.py

@@ -0,0 +1,90 @@
+# Copyright 2010 New Relic, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import json
+
+import pytest
+from testing_support.fixtures import dt_enabled, validate_transaction_metrics
+from testing_support.validators.validate_span_events import validate_span_events
+from testing_support.validators.validate_transaction_count import (
+    validate_transaction_count,
+)
+
+
+@pytest.fixture(scope="session")
+def target_application():
+    import _test_graphql
+
+    return _test_graphql.target_application
+
+
+@dt_enabled
+def test_graphql_metrics_and_attrs(target_application):
+    from graphql import __version__ as graphql_version
+    from graphql_server import __version__ as graphql_server_version
+    from sanic import __version__ as sanic_version
+
+    FRAMEWORK_METRICS = [
+        ("Python/Framework/GraphQL/%s" % graphql_version, 1),
+        ("Python/Framework/GraphQLServer/%s" % graphql_server_version, 1),
+        ("Python/Framework/Sanic/%s" % sanic_version, 1),
+    ]
+    _test_scoped_metrics = [
+        ("GraphQL/resolve/GraphQLServer/hello", 1),
+        ("GraphQL/operation/GraphQLServer/query/<anonymous>/hello", 1),
+        ("Function/graphql_server.sanic.graphqlview:GraphQLView.post", 1),
+    ]
+    _test_unscoped_metrics = [
+        ("GraphQL/all", 1),
+        ("GraphQL/GraphQLServer/all", 1),
+        ("GraphQL/allWeb", 1),
+        ("GraphQL/GraphQLServer/allWeb", 1),
+    ] + _test_scoped_metrics
+
+    _expected_query_operation_attributes = {
+        "graphql.operation.type": "query",
+        "graphql.operation.name": "<anonymous>",
+        "graphql.operation.query": "{ hello }",
+    }
+    _expected_query_resolver_attributes = {
+        "graphql.field.name": "hello",
+        "graphql.field.parentType": "Query",
+        "graphql.field.path": "hello",
+        "graphql.field.returnType": "String",
+    }
+
+    @validate_span_events(exact_agents=_expected_query_operation_attributes)
+    @validate_span_events(exact_agents=_expected_query_resolver_attributes)
+    @validate_transaction_metrics(
+        "query/<anonymous>/hello",
+        "GraphQL",
+        scoped_metrics=_test_scoped_metrics,
+        rollup_metrics=_test_unscoped_metrics + FRAMEWORK_METRICS,
+    )
+    def _test():
+        response = target_application.make_request(
+            "POST", "/graphql", body=json.dumps({"query": "{ hello }"}), headers={"Content-Type": "application/json"}
+        )
+        assert response.status == 200
+        assert "Hello!" in response.body.decode("utf-8")
+
+    _test()
+
+
+@validate_transaction_count(0)
+def test_ignored_introspection_transactions(target_application):
+    response = target_application.make_request(
+        "POST", "/graphql", body=json.dumps({"query": "{ __schema { types { name } } }"}), headers={"Content-Type": "application/json"}
+    )
+    assert response.status == 200

tox.ini

@@ -60,6 +60,7 @@ envlist =
     python-component_djangorestframework-py27-djangorestframework0300,
     python-component_djangorestframework-{py36,py37,py38,py39,py310}-djangorestframeworklatest,
     python-component_flask_rest-{py27,py36,py37,py38,py39,pypy,pypy3},
+    python-component_graphqlserver-{py36,py37,py38,py39,py310},
     python-component_tastypie-{py27,pypy}-tastypie0143,
     python-component_tastypie-{py36,py37,py38,py39,pypy3}-tastypie{0143,latest},
     python-coroutines_asyncio-{py36,py37,py38,py39,py310,pypy3},
@@ -147,7 +148,7 @@ envlist =
 usefixtures =
     collector_available_fixture
     collector_agent_registration
-    code_coverage
+    ; code_coverage
 
 [testenv]
 deps =
@@ -182,6 +183,9 @@ deps =
     component_flask_rest: flask-restful
     component_flask_rest: flask-restplus
     component_flask_rest: flask-restx
+    component_graphqlserver: graphql-server[sanic]==3.0.0b5
+    component_graphqlserver: sanic>20
+    component_graphqlserver: jinja2
     component_tastypie-tastypie0143: django-tastypie<0.14.4
     component_tastypie-{py27,pypy}-tastypie0143: django<1.12
     component_tastypie-{py36,py37,py38,py39,pypy3}-tastypie0143: django<3.0.1
@@ -359,6 +363,7 @@ changedir =
     application_gearman: tests/application_gearman
     component_djangorestframework: tests/component_djangorestframework
     component_flask_rest: tests/component_flask_rest
+    component_graphqlserver: tests/component_graphqlserver
     component_tastypie: tests/component_tastypie
     coroutines_asyncio: tests/coroutines_asyncio
     cross_agent: tests/cross_agent