fix: do not load plugin when they patch a different module than defin…

…ed in config #626
open-telemetry · Jan 3, 2020 · 7dd415c · 7dd415c
1 parent 6c98ab9
commit 7dd415c
Show file tree

Hide file tree

Showing 11 changed files with 46 additions and 2 deletions.
diff --git a/packages/opentelemetry-core/src/trace/instrumentation/BasePlugin.ts b/packages/opentelemetry-core/src/trace/instrumentation/BasePlugin.ts
@@ -28,7 +28,7 @@ import * as path from 'path';
 /** This class represent the base to patch plugin. */
 export abstract class BasePlugin<T> implements Plugin<T> {
   supportedVersions?: string[];
-  readonly moduleName?: string; // required for internalFilesExports
+  abstract readonly moduleName: string; // required for internalFilesExports
   readonly version?: string; // required for internalFilesExports
   protected readonly _basedir?: string; // required for internalFilesExports
 

diff --git a/packages/opentelemetry-node/src/instrumentation/PluginLoader.ts b/packages/opentelemetry-node/src/instrumentation/PluginLoader.ts
@@ -108,8 +108,16 @@ export class PluginLoader {
         // Expecting a plugin from module;
         try {
           const plugin: Plugin = require(modulePath).plugin;
-
           if (!utils.isSupportedVersion(version, plugin.supportedVersions)) {
+            this.logger.error(
+              `PluginLoader#load: Plugin ${name} only support module ${plugin.moduleName} with the versions: ${plugin.supportedVersions}`
+            );
+            return exports;
+          }
+          if (plugin.moduleName !== name) {
+            this.logger.error(
+              `PluginLoader#load: Entry ${name} use a plugin that instrument ${plugin.moduleName}`
+            );
             return exports;
           }
 

diff --git a/packages/opentelemetry-node/test/instrumentation/PluginLoader.test.ts b/packages/opentelemetry-node/test/instrumentation/PluginLoader.test.ts
@@ -85,6 +85,13 @@ const notSupportedVersionPlugins: Plugins = {
   },
 };
 
+const differentNamePlugins: Plugins = {
+  'random-module': {
+    enabled: true,
+    path: '@opentelemetry/plugin-http-module',
+  },
+};
+
 describe('PluginLoader', () => {
   const tracer = new NoopTracer();
   const logger = new NoopLogger();
@@ -218,6 +225,16 @@ describe('PluginLoader', () => {
       assert.strictEqual(require('simple-module').value(), 0);
       pluginLoader.unload();
     });
+
+    it('should not load a plugin that patch a different module that the one configured', () => {
+      const pluginLoader = new PluginLoader(tracer, logger);
+      assert.strictEqual(pluginLoader['_plugins'].length, 0);
+      pluginLoader.load(differentNamePlugins);
+      // @ts-ignore only to trigger the loading of the plugin
+      const randomModule = require('random-module');
+      assert.strictEqual(pluginLoader['_plugins'].length, 0);
+      pluginLoader.unload();
+    });
   });
 
   describe('.unload()', () => {

diff --git a/...y-node/test/instrumentation/node_modules/@opentelemetry/plugin-http-module/http-module.js b/...y-node/test/instrumentation/node_modules/@opentelemetry/plugin-http-module/http-module.js
diff --git a/...t/instrumentation/node_modules/@opentelemetry/plugin-notsupported-module/simple-module.js b/...t/instrumentation/node_modules/@opentelemetry/plugin-notsupported-module/simple-module.js
diff --git a/...de/test/instrumentation/node_modules/@opentelemetry/plugin-simple-module/simple-module.js b/...de/test/instrumentation/node_modules/@opentelemetry/plugin-simple-module/simple-module.js
diff --git a/...test/instrumentation/node_modules/@opentelemetry/plugin-supported-module/simple-module.js b/...test/instrumentation/node_modules/@opentelemetry/plugin-supported-module/simple-module.js
diff --git a/packages/opentelemetry-node/test/instrumentation/node_modules/random-module/index.js b/packages/opentelemetry-node/test/instrumentation/node_modules/random-module/index.js
diff --git a/packages/opentelemetry-node/test/instrumentation/node_modules/random-module/package.json b/packages/opentelemetry-node/test/instrumentation/node_modules/random-module/package.json
diff --git a/packages/opentelemetry-types/src/trace/instrumentation/Plugin.ts b/packages/opentelemetry-types/src/trace/instrumentation/Plugin.ts
@@ -28,6 +28,11 @@ export interface Plugin<T = any> {
    */
   supportedVersions?: string[];
 
+  /**
+   * Name of the module that the plugin instrument.
+   */
+  moduleName: string;
+
   /**
    * Method that enables the instrumentation patch.
    * @param moduleExports The value of the `module.exports` property that would

diff --git a/packages/opentelemetry-web/test/WebTracer.test.ts b/packages/opentelemetry-web/test/WebTracer.test.ts
@@ -24,6 +24,8 @@ import { WebTracer } from '../src/WebTracer';
 import { ZoneScopeManager } from '@opentelemetry/scope-zone';
 
 class DummyPlugin extends BasePlugin<unknown> {
+  moduleName = 'dummy';
+
   patch() {}
 
   unpatch() {}