feat: warn user when a instrumented package was already required open-telemetry#636 (open-telemetry#654)

* feat: warn user when a instrumented package was already required open-telemetry#636

* chore: address PR comments

* chore: extract package name from require.cache

* chore: use find instead of some

* chore: use require.resolve to find already required modules

* chore: try/catch require.resolve

Co-authored-by: Mayur Kale <[email protected]>

Author: vmarchaud

packages/opentelemetry-node/src/instrumentation/PluginLoader.ts

@@ -83,6 +83,25 @@ export class PluginLoader {
         return this;
       }
 
+      const alreadyRequiredModules = Object.keys(require.cache);
+      const requiredModulesToHook = modulesToHook.filter(
+        name =>
+          alreadyRequiredModules.find(cached => {
+            try {
+              return require.resolve(name) === cached;
+            } catch (err) {
+              return false;
+            }
+          }) !== undefined
+      );
+      if (requiredModulesToHook.length > 0) {
+        this.logger.warn(
+          `Some modules (${requiredModulesToHook.join(
+            ', '
+          )}) were already required when their respective plugin was loaded, some plugins might not work. Make sure the SDK is setup before you require in other modules.`
+        );
+      }
+
       // Enable the require hook.
       hook(modulesToHook, (exports, name, baseDir) => {
         if (this._hookState !== HookState.ENABLED) return exports;

packages/opentelemetry-node/test/instrumentation/PluginLoader.test.ts

@@ -86,6 +86,13 @@ const notSupportedVersionPlugins: Plugins = {
   },
 };
 
+const alreadyRequiredPlugins: Plugins = {
+  'already-require-module': {
+    enabled: true,
+    path: '@opentelemetry/plugin-supported-module',
+  },
+};
+
 describe('PluginLoader', () => {
   const provider = new NoopTracerProvider();
   const logger = new NoopLogger();
@@ -219,6 +226,23 @@ describe('PluginLoader', () => {
       assert.strictEqual(require('simple-module').value(), 0);
       pluginLoader.unload();
     });
+
+    it(`should warn when module was already loaded`, callback => {
+      const verifyWarnLogger = {
+        error: logger.error,
+        info: logger.info,
+        debug: logger.debug,
+        warn: (message: string, ...args: unknown[]) => {
+          assert(message.match(/were already required when/));
+          assert(message.match(/(already-require-module)/));
+          return callback();
+        },
+      };
+      require('already-require-module');
+      const pluginLoader = new PluginLoader(provider, verifyWarnLogger);
+      pluginLoader.load(alreadyRequiredPlugins);
+      pluginLoader.unload();
+    });
   });
 
   describe('.unload()', () => {