@envelop/newrelic 3.4.0 → 4.0.0

package/README.md

@@ -45,7 +45,7 @@ const getEnveloped = envelop({
       includeResolverArgs: false, // default `false`. When set to `true`, includes all the arguments passed to resolvers with their values
       rootFieldsNaming: true, // default `false`. When set to `true` append the names of operation root fields to the transaction name
       skipError: error => { ... return true; }, // a function that allows you to skip reporting a given error to NewRelic. By default custom `EnvelopError`s will be skipped
-      operationNameProperty: 'id', // default empty. When passed will check for the property name passed, within the document object. Will eventually use its value as operation name. Useful for custom document properties (e.g. queryId/hash)
+      extractOperationName: (context) => context.request.body.customOperationName, // Allows to set a custom operation name to be used as transaction name and attribute
     }),
   ],
 });

package/index.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from '@envelop/core';
+import { Plugin, DefaultContext } from '@envelop/core';
 import { GraphQLError } from 'graphql';
 export declare type UseNewRelicOptions = {
     includeOperationDocument?: boolean;
@@ -7,7 +7,10 @@ export declare type UseNewRelicOptions = {
     trackResolvers?: boolean;
     includeResolverArgs?: boolean | RegExp;
     rootFieldsNaming?: boolean;
-    operationNameProperty?: string;
+    /**
+     * Function that returns a custom operation name to be used as transaction name and attribute
+     */
+    extractOperationName?: (context: DefaultContext) => string | undefined;
     /**
      * Indicates whether or not to skip reporting a given error to NewRelic.
      * By default, this plugin skips all `EnvelopError` errors and does not report them to NewRelic.

package/index.js

@@ -46,7 +46,6 @@ const DEFAULT_OPTIONS = {
     trackResolvers: false,
     includeResolverArgs: false,
     rootFieldsNaming: false,
-    operationNameProperty: '',
     skipError: defaultSkipError,
 };
 function defaultSkipError(error) {
@@ -72,7 +71,7 @@ const useNewRelic = (rawOptions) => {
     });
     return {
         async onExecute({ args }) {
-            var _a;
+            var _a, _b;
             const instrumentationApi = await instrumentationApi$;
             const transactionNameState = instrumentationApi.agent.tracer.getTransaction().nameState;
             const spanContext = instrumentationApi.agent.tracer.getSpanContext();
@@ -80,9 +79,9 @@ const useNewRelic = (rawOptions) => {
             const rootOperation = args.document.definitions.find(definitionNode => definitionNode.kind === graphql.Kind.OPERATION_DEFINITION);
             const operationType = rootOperation.operation;
             const document = graphql.print(args.document);
-            const operationName = args.document[options.operationNameProperty] ||
+            const operationName = ((_a = options.extractOperationName) === null || _a === void 0 ? void 0 : _a.call(options, args.contextValue)) ||
                 args.operationName ||
-                ((_a = rootOperation.name) === null || _a === void 0 ? void 0 : _a.value) ||
+                ((_b = rootOperation.name) === null || _b === void 0 ? void 0 : _b.value) ||
                 AttributeName.ANONYMOUS_OPERATION;
             let rootFields = null;
             if (options.rootFieldsNaming) {

package/index.mjs

@@ -23,7 +23,6 @@ const DEFAULT_OPTIONS = {
     trackResolvers: false,
     includeResolverArgs: false,
     rootFieldsNaming: false,
-    operationNameProperty: '',
     skipError: defaultSkipError,
 };
 function defaultSkipError(error) {
@@ -49,7 +48,7 @@ const useNewRelic = (rawOptions) => {
     });
     return {
         async onExecute({ args }) {
-            var _a;
+            var _a, _b;
             const instrumentationApi = await instrumentationApi$;
             const transactionNameState = instrumentationApi.agent.tracer.getTransaction().nameState;
             const spanContext = instrumentationApi.agent.tracer.getSpanContext();
@@ -57,9 +56,9 @@ const useNewRelic = (rawOptions) => {
             const rootOperation = args.document.definitions.find(definitionNode => definitionNode.kind === Kind.OPERATION_DEFINITION);
             const operationType = rootOperation.operation;
             const document = print(args.document);
-            const operationName = args.document[options.operationNameProperty] ||
+            const operationName = ((_a = options.extractOperationName) === null || _a === void 0 ? void 0 : _a.call(options, args.contextValue)) ||
                 args.operationName ||
-                ((_a = rootOperation.name) === null || _a === void 0 ? void 0 : _a.value) ||
+                ((_b = rootOperation.name) === null || _b === void 0 ? void 0 : _b.value) ||
                 AttributeName.ANONYMOUS_OPERATION;
             let rootFields = null;
             if (options.rootFieldsNaming) {

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/newrelic",
-  "version": "3.4.0",
+  "version": "4.0.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "^2.3.0",
+    "@envelop/core": "^2.3.1",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0",
     "newrelic": "^7 || ^8.0.0"
   },