Add tests for graphql and handle instrumentations that have multiple files

Author: drewcorlin1

package-lock.json

@@ -38,7 +38,7 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.7.0",
-    "@opentelemetry/sdk-node": "^0.49.1",
+    "@opentelemetry/sdk-node": "^0.50.0",
     "@types/mocha": "7.0.2",
     "@types/node": "18.6.5",
     "fastify": "4.15.0",
@@ -50,8 +50,8 @@
     "typescript": "4.4.4"
   },
   "dependencies": {
-    "@opentelemetry/auto-instrumentations-node": "0.42.0",
-    "@opentelemetry/instrumentation": "^0.49.1",
+    "@opentelemetry/auto-instrumentations-node": "0.44.0",
+    "@opentelemetry/instrumentation": "^0.50.0",
     "esbuild": "0.20.x"
   },
   "files": [

packages/esbuild-plugin-node/package.json

@@ -22,6 +22,7 @@ export function wrapModule(
     oTelInstrumentationPackage,
     oTelInstrumentationClass,
     instrumentationName,
+    instrumentedFileName,
     oTelInstrumentationConstructorArgs = '',
   }: ModuleParams
 ) {
@@ -35,6 +36,7 @@ export function wrapModule(
   const { ${oTelInstrumentationClass} } = require('${oTelInstrumentationPackage}');
   const { diag } = require('@opentelemetry/api');
   const instrumentations = new ${oTelInstrumentationClass}(${oTelInstrumentationConstructorArgs}).getModuleDefinitions();
+
   if (instrumentations.length > 1 && !'${instrumentationName}') {
     diag.error('instrumentationName must be specified because ${oTelInstrumentationClass} has multiple instrumentations');
     return;
@@ -55,8 +57,12 @@ export function wrapModule(
       diag.error('No patch nor files exist on instrumentation for ${oTelInstrumentationClass} ${instrumentationName}');
       return;
     } else if (instrumentation.files.length > 1) {
-      diag.error('Not sure how to handle multiple files for instrumentations for ${instrumentationName}');
-      return;
+      const instrumentationFile = instrumentation.files.find(file => file.name === '${instrumentedFileName}');
+      if (!instrumentationFile) {
+        diag.error('Not sure how to handle multiple files for instrumentations for ${instrumentationName} when none is found with name ${instrumentedFileName}');
+        return;
+      }
+      mod = instrumentationFile.patch(mod);
     }
   }
 

packages/esbuild-plugin-node/src/common.ts

@@ -33,6 +33,7 @@ function getModuleDefinitions(instrumentation: Instrumentation) {
 
 export const instrumentations: InstrumentationModuleDefinition<any>[] =
   getNodeAutoInstrumentations().flatMap(getModuleDefinitions);
+// console.log({ instrumentations });
 
 function configGenerator<T extends { enabled?: boolean }>(
   config?: T

packages/esbuild-plugin-node/src/config/main.ts

@@ -0,0 +1,22 @@
+import * as assert from 'assert';
+
+import { extractPackageAndModulePath } from './plugin';
+
+describe('extractPackageAndModulePath', () => {
+  it('', () => {
+    assert.deepStrictEqual(
+      extractPackageAndModulePath(
+        '/node_modules/@aws-sdk/middleware-stack/dist/cjs/MiddlewareStack.js',
+        '.'
+      ),
+      {
+        path: './node_modules/@aws-sdk/middleware-stack/dist/cjs/MiddlewareStack.js',
+        extractedModule: {
+          package: '@aws-sdk/middleware-stack',
+          path: 'dist/cjs/MiddlewareStack.js',
+        },
+      }
+    );
+    // @aws-sdk/middleware-stack/dist/cjs/MiddlewareStack.js
+  });
+});

packages/esbuild-plugin-node/src/plugin.test.ts

@@ -14,7 +14,11 @@
  * limitations under the License.
  */
 
-import { OnLoadArgs, OpenTelemetryPluginParams } from './types';
+import {
+  ExtractedModule,
+  OnLoadArgs,
+  OpenTelemetryPluginParams,
+} from './types';
 import { Plugin, PluginBuild } from 'esbuild';
 import {
   instrumentations,
@@ -31,11 +35,6 @@ const NODE_MODULES = 'node_modules/';
 
 const BUILT_INS = new Set(builtinModules.flatMap(b => [b, `node:${b}`]));
 
-interface ExtractedModule {
-  package: string | null;
-  path: string | null;
-}
-
 export function openTelemetryPlugin(
   pluginConfig?: OpenTelemetryPluginParams
 ): Plugin {
@@ -76,6 +75,7 @@ export function openTelemetryPlugin(
         return {
           path,
           pluginData: {
+            extractedModule,
             shouldPatchPackage: true,
             instrumentation: { name: matchingInstrumentation.name },
           },
@@ -103,6 +103,7 @@ export function openTelemetryPlugin(
               instrumentationName: pluginData.instrumentation.name,
               oTelInstrumentationClass: config.oTelInstrumentationClass,
               oTelInstrumentationPackage: config.oTelInstrumentationPackage,
+              instrumentedFileName: `${pluginData.extractedModule.package}/${pluginData.extractedModule.path}`,
               oTelInstrumentationConstructorArgs:
                 config.configGenerator(packageConfig),
             }),
@@ -130,7 +131,7 @@ function dotFriendlyResolve(path: string, directory: string): string {
  *   input: '/foo/node_modules/@co/stuff/foo/bar/baz.js'
  *   output: { package: '@co/stuff', path: 'foo/bar/baz.js' }
  */
-function extractPackageAndModulePath(
+export function extractPackageAndModulePath(
   path: string,
   resolveDir: string
 ): { path: string; extractedModule: ExtractedModule } {

packages/esbuild-plugin-node/src/plugin.ts

@@ -17,26 +17,34 @@
 import type { OnLoadArgs as EsbuildOnLoadArgs } from 'esbuild';
 import type { InstrumentationConfigMap } from '@opentelemetry/auto-instrumentations-node';
 
+// TODO: Get all names
 export type InstrumentedPackage =
   | 'fastify'
   | 'pino'
   | '@smithy/smithy-client'
   | '@smithy/middleware-stack';
 
+export interface ExtractedModule {
+  package: string | null;
+  path: string | null;
+}
+
 export type OnLoadArgs = Omit<EsbuildOnLoadArgs, 'pluginData'> & {
   pluginData?: {
     shouldPatchPackage: boolean;
     package: InstrumentedPackage;
     instrumentation: {
       name: InstrumentedPackage;
     };
+    extractedModule: ExtractedModule;
   };
 };
 
 export interface ModuleParams {
   oTelInstrumentationPackage: string;
   oTelInstrumentationClass: string;
   oTelInstrumentationConstructorArgs?: string;
+  instrumentedFileName: string;
   instrumentationName?: string;
 }