Add graphene-django instrumentation (#1451)

* Add graphene-django instrumentation

* Increase naming priority

* Remove unused import

* Add sychronous schema tests

* Clean up test files

* Remove commented out code

* Megalinter fixes

* Add operation & resolver tests

* Refine tests

* MegaLinter fixes

* Suggested reviewer changes

* Megalinter fixes

Author: lrafeei

newrelic/config.py

@@ -2700,6 +2700,10 @@ def _process_module_builtin_defaults():
         "graphene.types.schema", "newrelic.hooks.framework_graphene", "instrument_graphene_types_schema"
     )
 
+    _process_module_definition(
+        "graphene_django.views", "newrelic.hooks.component_graphenedjango", "instrument_graphene_django_views"
+    )
+
     _process_module_definition("graphql.graphql", "newrelic.hooks.framework_graphql", "instrument_graphql")
     _process_module_definition(
         "graphql.execution.execute", "newrelic.hooks.framework_graphql", "instrument_graphql_execute"

newrelic/hooks/component_graphenedjango.py

@@ -0,0 +1,102 @@
+# 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 functools
+import sys
+from inspect import isawaitable
+
+from newrelic.api.error_trace import ErrorTrace
+from newrelic.api.graphql_trace import GraphQLOperationTrace
+from newrelic.api.transaction import current_transaction
+from newrelic.common.object_names import callable_name
+from newrelic.common.object_wrapper import wrap_function_wrapper
+from newrelic.common.package_version_utils import get_package_version
+from newrelic.common.signature import bind_args
+from newrelic.core.graphql_utils import graphql_statement
+from newrelic.hooks.framework_graphql import GRAPHQL_VERSION, ignore_graphql_duplicate_exception
+
+GRAPHENE_DJANGO_VERSION = get_package_version("graphene_django")
+graphene_django_version_tuple = tuple(map(int, GRAPHENE_DJANGO_VERSION.split(".")))
+
+
+# Implementation from `newrelic.hooks.framework_graphql_py3`
+def nr_coro_execute_graphql_request_wrapper(wrapped, trace, ignore, result):
+    @functools.wraps(wrapped)
+    async def _nr_coro_execute_graphql_request_wrapper():
+        try:
+            with ErrorTrace(ignore=ignore):
+                result_ = await result
+        except:
+            trace.__exit__(*sys.exc_info())
+            raise
+        else:
+            trace.__exit__(None, None, None)
+            return result_
+
+    return _nr_coro_execute_graphql_request_wrapper()
+
+
+def wrap_GraphQLView_execute_graphql_request(wrapped, instance, args, kwargs):
+    transaction = current_transaction()
+
+    if not transaction:
+        return wrapped(*args, **kwargs)
+
+    transaction.add_framework_info(name="GraphQL", version=GRAPHQL_VERSION)
+    transaction.add_framework_info(name="GrapheneDjango", version=GRAPHENE_DJANGO_VERSION)
+    bound_args = bind_args(wrapped, args, kwargs)
+
+    try:
+        schema = instance.schema.graphql_schema
+        query = bound_args.get("query", None)
+    except TypeError:
+        return wrapped(*args, **kwargs)
+
+    transaction.set_transaction_name(callable_name(wrapped), "GraphQL", priority=11)
+
+    trace = GraphQLOperationTrace()
+
+    trace.statement = graphql_statement(query)
+    trace.product = "GrapheneDjango"
+
+    # Handle Schemas created from frameworks
+    if hasattr(schema, "_nr_framework"):
+        framework = schema._nr_framework
+        transaction.add_framework_info(name=framework[0], version=framework[1])
+
+    # Trace must be manually started and stopped to ensure it exists prior to and during the entire duration of the query.
+    # Otherwise subsequent instrumentation will not be able to find an operation trace and will have issues.
+    trace.__enter__()
+    try:
+        with ErrorTrace(ignore=ignore_graphql_duplicate_exception):
+            result = wrapped(*args, **kwargs)
+    except Exception:
+        # Execution finished synchronously, exit immediately.
+        trace.__exit__(*sys.exc_info())
+        raise
+    else:
+        trace.set_transaction_name(priority=14)
+        if isawaitable(result):
+            # Asynchronous implementations
+            # Return a coroutine that handles closing the operation trace
+            return nr_coro_execute_graphql_request_wrapper(wrapped, trace, ignore_graphql_duplicate_exception, result)
+        else:
+            # Execution finished synchronously, exit immediately.
+            trace.__exit__(None, None, None)
+            return result
+
+
+def instrument_graphene_django_views(module):
+    if hasattr(module, "GraphQLView") and hasattr(module.GraphQLView, "execute_graphql_request"):
+        wrap_function_wrapper(module, "GraphQLView.execute_graphql_request", wrap_GraphQLView_execute_graphql_request)

tests/component_graphenedjango/_target_application.py

@@ -0,0 +1,19 @@
+# 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 webtest
+from wsgi import application
+
+_target_application = webtest.TestApp(application)

tests/component_graphenedjango/_target_schema_sync.py

@@ -0,0 +1,146 @@
+# 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 dummy_app.models import AuthorModel, BookModel, LibraryModel, MagazineModel
+from graphene import Field, Int, List, NonNull, ObjectType, Schema, String, Union
+from graphene import Mutation as GrapheneMutation
+from graphene_django import DjangoObjectType
+
+
+class Author(DjangoObjectType):
+    class Meta:
+        model = AuthorModel
+        fields = "__all__"
+
+
+class Book(DjangoObjectType):
+    class Meta:
+        model = BookModel
+        fields = "__all__"
+
+
+class Magazine(DjangoObjectType):
+    class Meta:
+        model = MagazineModel
+        fields = "__all__"
+
+
+class Item(Union):
+    class Meta:
+        types = (Book, Magazine)
+
+
+class Library(DjangoObjectType):
+    class Meta:
+        model = LibraryModel
+        fields = "__all__"
+
+
+Storage = List(String)
+
+
+authors = [
+    Author(first_name="New", last_name="Relic"),
+    Author(first_name="Bob", last_name="Smith"),
+    Author(first_name="Leslie", last_name="Jones"),
+]
+
+books = [
+    Book(id=1, name="Python Agent: The Book", isbn="a-fake-isbn", author=authors[0], branch="riverside"),
+    Book(
+        id=2,
+        name="Ollies for O11y: A Sk8er's Guide to Observability",
+        isbn="a-second-fake-isbn",
+        author=authors[1],
+        branch="downtown",
+    ),
+    Book(id=3, name="[Redacted]", isbn="a-third-fake-isbn", author=authors[2], branch="riverside"),
+]
+
+magazines = [
+    Magazine(id=1, name="Reli Updates Weekly", issue=1, branch="riverside"),
+    Magazine(id=2, name="Reli Updates Weekly", issue=2, branch="downtown"),
+    Magazine(id=3, name="Node Weekly", issue=1, branch="riverside"),
+]
+
+
+libraries = ["riverside", "downtown"]
+libraries = [
+    Library(
+        id=i + 1,
+        branch=branch,
+        magazine=[m for m in magazines if m.branch == branch],
+        book=[b for b in books if b.branch == branch],
+    )
+    for i, branch in enumerate(libraries)
+]
+
+storage = []
+
+
+def resolve_library(self, info, index):
+    return libraries[index]
+
+
+def resolve_storage(self, info):
+    return [storage.pop()]
+
+
+def resolve_search(self, info, contains):
+    search_books = [b for b in books if contains in b.name]
+    search_magazines = [m for m in magazines if contains in m.name]
+    return search_books + search_magazines
+
+
+def resolve_hello(self, info):
+    return "Hello!"
+
+
+def resolve_echo(self, info, echo):
+    return echo
+
+
+def resolve_error(self, info):
+    raise RuntimeError("Runtime Error!")
+
+
+def resolve_storage_add(self, info, string):
+    storage.append(string)
+    return StorageAdd(string=string)
+
+
+class StorageAdd(GrapheneMutation):
+    class Arguments:
+        string = String(required=True)
+
+    string = String()
+    mutate = resolve_storage_add
+
+
+class Query(ObjectType):
+    library = Field(Library, index=Int(required=True), resolver=resolve_library)
+    hello = String(resolver=resolve_hello)
+    search = Field(List(Item), contains=String(required=True), resolver=resolve_search)
+    echo = Field(String, echo=String(required=True), resolver=resolve_echo)
+    storage = Field(Storage, resolver=resolve_storage)
+    error = String(resolver=resolve_error)
+    error_non_null = Field(NonNull(String), resolver=resolve_error)
+    error_middleware = String(resolver=resolve_hello)
+
+
+class Mutation(ObjectType):
+    storage_add = StorageAdd.Field()
+
+
+target_schema = Schema(query=Query, mutation=Mutation, auto_camelcase=False)

tests/component_graphenedjango/conftest.py

@@ -0,0 +1,37 @@
+# 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 pytest
+from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture
+
+_default_settings = {
+    "package_reporting.enabled": False,  # Turn off package reporting for testing as it causes slow downs.
+    "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,
+    "debug.log_autorum_middleware": True,
+}
+
+collector_agent_registration = collector_agent_registration_fixture(
+    app_name="Python Agent Test (framework_graphene-django)", default_settings=_default_settings
+)
+
+
+@pytest.fixture(scope="session")
+def wsgi_app():
+    from _target_application import _target_application as wsgi_application
+
+    return wsgi_application

tests/component_graphenedjango/dummy_app/__init__.py

@@ -0,0 +1,14 @@
+# 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.
+

tests/component_graphenedjango/dummy_app/apps.py

@@ -0,0 +1,20 @@
+# 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 django.apps import AppConfig
+
+
+class LibraryConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "dummy_app"

tests/component_graphenedjango/dummy_app/models.py

@@ -0,0 +1,42 @@
+# 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 django.db import models
+
+
+class AuthorModel(models.Model):
+    first_name = models.CharField(max_length=100)
+    last_name = models.CharField(max_length=100)
+
+
+class BookModel(models.Model):
+    id = models.IntegerField(primary_key=True)
+    name = models.CharField(max_length=100)
+    isbn = models.CharField(max_length=100)
+    author = models.ForeignKey(AuthorModel, on_delete=models.CASCADE)
+    branch = models.CharField(max_length=100)
+
+
+class MagazineModel(models.Model):
+    id = models.IntegerField(primary_key=True)
+    name = models.CharField(max_length=100)
+    issue = models.IntegerField()
+    branch = models.CharField(max_length=100)
+
+
+class LibraryModel(models.Model):
+    id = models.IntegerField(primary_key=True)
+    branch = models.CharField(max_length=100)
+    magazine = models.ManyToManyField(MagazineModel)
+    book = models.ManyToManyField(BookModel)