fix(newrelic): call getTransaction from the tracing agent (ardatan#5634)

* fix(newrelic): call getTransaction from the tracing agent

* Go

* Go

* Add newrelic as an integration test

* Go

* Go

* 🤦

Author: ardatan

.changeset/mean-hornets-prove.md

@@ -0,0 +1,5 @@
+---
+'@graphql-mesh/plugin-newrelic': patch
+---
+
+Fix getTransaction

declarations.d.ts

@@ -12,8 +12,13 @@ declare module 'ioredis-mock' {
 
 declare module 'newrelic' {
   const shim: any;
+  function startWebTransaction(url: string, callback: () => Promise<void>): void;
 }
 
 declare module 'newrelic/*' {
   export = shim;
 }
+
+declare module '@newrelic/test-utilities' {
+  export const TestAgent: any;
+}

jest.config.js

@@ -18,6 +18,12 @@ if (process.env.LEAK_TEST) {
 
 testMatch.push(process.env.INTEGRATION_TEST ? '!**/packages/**' : '!**/examples/**');
 
+testMatch.push(
+  process.env.INTEGRATION_TEST && !process.env.LEAK_TEST
+    ? '**/packages/plugins/newrelic/tests/**'
+    : '!**/packages/plugins/newrelic/tests/**',
+);
+
 module.exports = {
   testEnvironment: 'node',
   rootDir: ROOT_DIR,

newrelic_agent.log

@@ -46,9 +46,10 @@
     "@graphql-mesh/string-interpolation": "^0.5.0"
   },
   "devDependencies": {
+    "@newrelic/test-utilities": "6.5.5",
     "@types/newrelic": "9.14.0",
     "graphql-yoga": "4.0.3",
-    "newrelic": "10.3.2"
+    "newrelic": "9.15.0"
   },
   "publishConfig": {
     "access": "public",

packages/plugins/newrelic/package.json

@@ -1,3 +1,4 @@
+/* eslint-disable promise/param-names */
 import { Plugin } from 'graphql-yoga';
 import newRelic from 'newrelic';
 import NAMES from 'newrelic/lib/metrics/names.js';
@@ -13,8 +14,8 @@ const EnvelopAttributeName = 'Envelop_NewRelic_Plugin';
 
 export default function useMeshNewrelic(
   options: MeshPluginOptions<YamlConfig.NewrelicConfig>,
+  { instrumentationApi = newRelic?.shim, agentApi = newRelic }: any = {},
 ): MeshPlugin<any> & Plugin<any> {
-  const instrumentationApi = newRelic?.shim;
   if (!instrumentationApi?.agent) {
     options.logger.debug(
       'Agent unavailable. Please check your New Relic Agent configuration and ensure New Relic is enabled.',
@@ -29,13 +30,13 @@ export default function useMeshNewrelic(
   const logger = instrumentationApi.logger.child({ component: EnvelopAttributeName });
 
   const segmentByRequestContext = new WeakMap<any, any>();
-  const transactionCallback = new WeakMap<Request, () => void>();
 
   return {
     onPluginInit({ addPlugin }) {
       addPlugin(
         useNewRelic({
           ...options,
+          shim: instrumentationApi,
           extractOperationName: options.extractOperationName
             ? context =>
                 stringInterpolator.parse(options.extractOperationName, {
@@ -46,12 +47,11 @@ export default function useMeshNewrelic(
         }),
       );
     },
-    onRequest({ request, url }) {
-      const currentTransaction = instrumentationApi.getTransaction();
+    onRequest({ url, requestHandler, setRequestHandler }) {
+      const currentTransaction = instrumentationApi.agent.tracer.getTransaction();
       if (!currentTransaction) {
-        instrumentationApi.startWebTransaction(
-          url.pathname,
-          () => new Promise<void>(resolve => transactionCallback.set(request, resolve)),
+        setRequestHandler((...args) =>
+          agentApi.startWebTransaction(url.pathname, () => requestHandler(...args)),
         );
       }
     },
@@ -157,11 +157,5 @@ export default function useMeshNewrelic(
         httpDetailSegment.end();
       };
     },
-    onResponse({ request }) {
-      const callback = transactionCallback.get(request);
-      if (callback) {
-        callback();
-      }
-    },
   };
 }

packages/plugins/newrelic/src/index.ts

@@ -0,0 +1,72 @@
+/* eslint-disable import/no-extraneous-dependencies */
+
+import LocalforageCache from '@graphql-mesh/cache-localforage';
+import { createMeshHTTPHandler, MeshHTTPHandler } from '@graphql-mesh/http';
+import type { MeshInstance } from '@graphql-mesh/runtime';
+import { defaultImportFn, DefaultLogger, PubSub } from '@graphql-mesh/utils';
+import { TestAgent } from '@newrelic/test-utilities';
+import { getTestMesh } from '../../../testing/getTestMesh';
+import useMeshNewRelic from '../src';
+
+describe('New Relic', () => {
+  let mesh: MeshInstance;
+  let helper: any;
+  let httpHandler: MeshHTTPHandler;
+  beforeAll(async () => {
+    const logger = new DefaultLogger('New Relic Test');
+    const cache = new LocalforageCache();
+    const pubsub = new PubSub();
+    const baseDir = __dirname;
+    helper = TestAgent.makeInstrumented();
+    mesh = await getTestMesh({
+      logger,
+      cache,
+      pubsub,
+      additionalEnvelopPlugins: [
+        useMeshNewRelic(
+          {
+            logger,
+            cache,
+            pubsub,
+            baseDir,
+            importFn: defaultImportFn,
+          },
+          {
+            instrumentationApi: helper.getShim(),
+            agentApi: helper.getAgentApi(),
+          },
+        ),
+      ],
+    });
+    httpHandler = createMeshHTTPHandler({
+      baseDir,
+      getBuiltMesh: async () => mesh,
+    });
+  });
+  afterAll(async () => {
+    mesh.destroy();
+    return helper.unload();
+  });
+  it('should work', async () => {
+    const response = await httpHandler.fetch('/graphql', {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json',
+      },
+      body: JSON.stringify({
+        query: /* GraphQL */ `
+          query Test {
+            greetings
+          }
+        `,
+      }),
+    });
+    const result = await response.json();
+    expect(result).toEqual({
+      data: {
+        greetings: 'This is the `greetings` field of the root `Query` type',
+      },
+    });
+  });
+});

packages/plugins/newrelic/tests/newrelic.spec.ts

@@ -5,11 +5,11 @@ import { createSchema, createYoga, Repeater } from 'graphql-yoga';
 import LocalforageCache from '@graphql-mesh/cache-localforage';
 import GraphQLHandler from '@graphql-mesh/graphql';
 import StitchingMerger from '@graphql-mesh/merger-stitching';
-import { getMesh } from '@graphql-mesh/runtime';
+import { getMesh, GetMeshOptions } from '@graphql-mesh/runtime';
 import { InMemoryStoreStorageAdapter, MeshStore } from '@graphql-mesh/store';
 import { defaultImportFn, DefaultLogger, PubSub } from '@graphql-mesh/utils';
 
-export function getTestMesh() {
+export function getTestMesh(extraOptions?: Partial<GetMeshOptions>) {
   const yoga = createYoga({
     logging: false,
     schema: createSchema({
@@ -64,6 +64,7 @@ export function getTestMesh() {
           importFn: defaultImportFn,
         }),
       },
+      ...(extraOptions?.sources || []),
     ],
     cache,
     pubsub,
@@ -73,5 +74,6 @@ export function getTestMesh() {
       logger,
       store: store.child('Stitching'),
     }),
+    ...extraOptions,
   });
 }