Strawberry Instrumentation (#357)

* Add strawberry instrumentation

* [Mega-Linter] Apply linters fixes

* [Mega-Linter] Apply linters fixes

* Fix instrumentation issues

* More instrumentation fixes

* Safer wrap_from_resolver argument binding

* Fix failing assertions

* Fix strawberry types

Co-authored-by: TimPansino <[email protected]>

Author: TimPansino

newrelic/config.py

@@ -2454,6 +2454,24 @@ def _process_module_builtin_defaults():
         "instrument_starlette_background_task",
     )
 
+    _process_module_definition(
+        "strawberry.asgi",
+        "newrelic.hooks.framework_strawberry",
+        "instrument_strawberry_asgi",
+    )
+
+    _process_module_definition(
+        "strawberry.schema.schema",
+        "newrelic.hooks.framework_strawberry",
+        "instrument_strawberry_schema",
+    )
+
+    _process_module_definition(
+        "strawberry.schema.schema_converter",
+        "newrelic.hooks.framework_strawberry",
+        "instrument_strawberry_schema_converter",
+    )
+
     _process_module_definition("uvicorn.config", "newrelic.hooks.adapter_uvicorn", "instrument_uvicorn_config")
 
     _process_module_definition("sanic.app", "newrelic.hooks.framework_sanic", "instrument_sanic_app")

newrelic/hooks/framework_strawberry.py

@@ -0,0 +1,127 @@
+# 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 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 strawberry
+
+    return ("Strawberry", getattr(strawberry, "__version__", None))
+
+
+def bind_execute(query, *args, **kwargs):
+    return query
+
+
+def wrap_execute_sync(wrapped, instance, args, kwargs):
+    transaction = current_transaction()
+
+    if not transaction:
+        return wrapped(*args, **kwargs)
+
+    try:
+        query = bind_execute(*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.statement = graphql_statement(query)
+        with ErrorTrace(ignore=ignore_graphql_duplicate_exception):
+            return wrapped(*args, **kwargs)
+
+
+async def wrap_execute(wrapped, instance, args, kwargs):
+    transaction = current_transaction()
+
+    if not transaction:
+        return await wrapped(*args, **kwargs)
+
+    try:
+        query = bind_execute(*args, **kwargs)
+    except TypeError:
+        return await 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.statement = graphql_statement(query)
+        with ErrorTrace(ignore=ignore_graphql_duplicate_exception):
+            return await wrapped(*args, **kwargs)
+
+
+def bind_from_resolver(field, *args, **kwargs):
+    return field
+
+
+def wrap_from_resolver(wrapped, instance, args, kwargs):
+    result = wrapped(*args, **kwargs)
+
+    try:
+        field = bind_from_resolver(*args, **kwargs)    
+    except TypeError:
+        pass
+    else:
+        if hasattr(field, "base_resolver"):
+            if hasattr(field.base_resolver, "wrapped_func"):
+                resolver_name = callable_name(field.base_resolver.wrapped_func)
+                result = TransactionNameWrapper(result, resolver_name, "GraphQL", priority=13)
+
+    return result
+
+
+def instrument_strawberry_schema(module):
+    if hasattr(module, "Schema"):
+        if hasattr(module.Schema, "execute"):
+            wrap_function_wrapper(module, "Schema.execute", wrap_execute)
+        if hasattr(module.Schema, "execute_sync"):
+            wrap_function_wrapper(module, "Schema.execute_sync", wrap_execute_sync)
+
+
+def instrument_strawberry_asgi(module):
+    if hasattr(module, "GraphQL"):
+        wrap_asgi_application(module, "GraphQL.__call__", framework=framework_details())
+
+
+def instrument_strawberry_schema_converter(module):
+    if hasattr(module, "GraphQLCoreConverter"):
+        if hasattr(module.GraphQLCoreConverter, "from_resolver"):
+            wrap_function_wrapper(module, "GraphQLCoreConverter.from_resolver", wrap_from_resolver)

tests/framework_ariadne/test_application.py

@@ -248,8 +248,8 @@ def test_exception_in_middleware(app, graphql_run):
     def _test():
         from graphql import MiddlewareManager
 
-        ok, response = graphql_run(app, query, middleware=MiddlewareManager(error_middleware))
-        assert not ok and response["errors"]
+        _, response = graphql_run(app, query, middleware=MiddlewareManager(error_middleware))
+        assert response["errors"]
 
     _test()
 
@@ -296,8 +296,8 @@ def test_exception_in_resolver(app, graphql_run, field):
     @validate_transaction_errors(errors=_test_runtime_error)
     @background_task()
     def _test():
-        ok, response = graphql_run(app, query)
-        assert not ok and response["errors"]
+        _, response = graphql_run(app, query)
+        assert response["errors"]
 
     _test()
 
@@ -352,8 +352,8 @@ def test_exception_in_validation(app, graphql_run, is_graphql_2, query, exc_clas
     @validate_transaction_errors(errors=[exc_class])
     @background_task()
     def _test():
-        ok, response = graphql_run(app, query)
-        assert not ok and response["errors"]
+        _, response = graphql_run(app, query)
+        assert response["errors"]
 
     _test()
 

tests/framework_strawberry/_target_application.py

@@ -12,11 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Union
+from typing import List, Union
 
 import strawberry.mutation
 import strawberry.type
-from strawberry import Schema, field, union
+from strawberry import Schema, field
 from strawberry.asgi import GraphQL
 from strawberry.schema.config import StrawberryConfig
 from strawberry.types.types import Optional
@@ -49,14 +49,12 @@ class Magazine:
 class Library:
     id: int
     branch: str
-    magazine: list[Magazine]
-    book: list[Book]
+    magazine: List[Magazine]
+    book: List[Book]
 
 
 Item = Union[Book, Magazine]
-
-
-Storage = list[str]
+Storage = List[str]
 
 
 authors = [
@@ -159,7 +157,7 @@ class Query:
     library: Library = field(resolver=resolve_library)
     hello: str = field(resolver=resolve_hello)
     hello_async: str = field(resolver=resolve_hello_async)
-    search: list[Item] = field(resolver=resolve_search)
+    search: List[Item] = field(resolver=resolve_search)
     echo: str = field(resolver=resolve_echo)
     storage: Storage = field(resolver=resolve_storage)
     error: Optional[str] = field(resolver=resolve_error)