feat: Add module integration (#1533)

Author: HazAT

packages/core/src/baseclient.ts

@@ -9,8 +9,8 @@ import {
   Severity,
   Status,
 } from '@sentry/types';
-import { getGlobalObject, uuid4 } from '@sentry/utils/misc';
 import { forget } from '@sentry/utils/async';
+import { getGlobalObject, uuid4 } from '@sentry/utils/misc';
 import { truncate } from '@sentry/utils/string';
 import { BackendClass } from './basebackend';
 import { Dsn } from './dsn';

packages/node/src/handlers.ts

@@ -5,25 +5,13 @@ import { forget } from '@sentry/utils/async';
 import { serialize } from '@sentry/utils/object';
 import { parse as parseCookie } from 'cookie';
 import * as domain from 'domain';
-import * as lsmod from 'lsmod';
 import { hostname } from 'os';
 import { parse as parseUrl } from 'url';
 import { NodeClient } from './client';
 import { getCurrentHub } from './hub';
 
 const DEFAULT_SHUTDOWN_TIMEOUT = 2000;
 
-let moduleCache: { [key: string]: string };
-
-/** JSDoc */
-function getModules(): { [key: string]: string } {
-  if (!moduleCache) {
-    // tslint:disable-next-line:no-unsafe-any
-    moduleCache = lsmod();
-  }
-  return moduleCache;
-}
-
 /** JSDoc */
 function extractRequestData(req: { [key: string]: any }): { [key: string]: string } {
   // headers:
@@ -129,7 +117,6 @@ function parseRequest(
       ...event.extra,
       node: global.process.version,
     },
-    modules: getModules(),
     request: {
       ...event.request,
       ...extractRequestData(req),

packages/node/src/integrations/index.ts

@@ -5,3 +5,4 @@ export { OnUnhandledRejection } from './onunhandledrejection';
 export { ClientOptions } from './clientoptions';
 export { SDKInformation } from './sdkinformation';
 export { LinkedErrors } from './linkederrors';
+export { Modules } from './modules';

packages/node/src/integrations/modules.ts

@@ -0,0 +1,36 @@
+import { Scope } from '@sentry/hub';
+import { Integration } from '@sentry/types';
+import * as lsmod from 'lsmod';
+import { NodeOptions } from '../backend';
+import { getCurrentHub } from '../hub';
+
+let moduleCache: { [key: string]: string };
+
+/** Add node modules / packages to the event */
+export class Modules implements Integration {
+  /**
+   * @inheritDoc
+   */
+  public name: string = 'Modules';
+
+  /**
+   * @inheritDoc
+   */
+  public install(_: NodeOptions = {}): void {
+    getCurrentHub().configureScope((scope: Scope) => {
+      scope.addEventProcessor(async event => ({
+        ...event,
+        modules: this.getModules(),
+      }));
+    });
+  }
+
+  /** Fetches the list of modules and the versions loaded by the entry file for your node.js app. */
+  private getModules(): { [key: string]: string } {
+    if (!moduleCache) {
+      // tslint:disable-next-line:no-unsafe-any
+      moduleCache = lsmod();
+    }
+    return moduleCache;
+  }
+}

packages/node/test/integrations/modules.test.ts

@@ -0,0 +1,17 @@
+import { captureMessage, configureScope, init, Integrations, SentryEvent } from '../../src';
+
+const dsn = 'https://[email protected]/4291';
+
+describe('Modules Integration', () => {
+  test('modules are added to an event', done => {
+    init({ dsn, integrations: () => [new Integrations.Modules()] });
+    configureScope(scope => {
+      scope.addEventProcessor(async (event: SentryEvent) => {
+        expect(event).toHaveProperty('modules');
+        done();
+        return null;
+      });
+    });
+    captureMessage('test');
+  });
+});