feat: RewriteFrames pluggable integration for Node

Author: kamilogorek

packages/node/src/integrations/pluggable/rewriteframes.ts

@@ -0,0 +1,71 @@
+import { Scope } from '@sentry/hub';
+import { Integration, SentryEvent, StackFrame } from '@sentry/types';
+import { basename } from 'path';
+import { getCurrentHub } from '../../hub';
+
+type StackFrameIteratee = (frame: StackFrame) => Promise<StackFrame>;
+
+/** Rewrite event frames paths */
+export class RewriteFrames implements Integration {
+  /**
+   * @inheritDoc
+   */
+  public name: string = 'RewriteFrames';
+
+  /**
+   * @inheritDoc
+   */
+  public iteratee: StackFrameIteratee = async (frame: StackFrame) => {
+    if (frame.filename && frame.filename.startsWith('/')) {
+      frame.filename = `app:///${basename(frame.filename)}`;
+    }
+    return frame;
+  };
+
+  /**
+   * @inheritDoc
+   */
+  public constructor(options: { iteratee?: StackFrameIteratee } = {}) {
+    if (options.iteratee) {
+      this.iteratee = options.iteratee;
+    }
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public install(): void {
+    getCurrentHub().configureScope((scope: Scope) => {
+      scope.addEventProcessor(async event => this.process(event));
+    });
+  }
+
+  /** JSDoc */
+  public async process(event: SentryEvent): Promise<SentryEvent> {
+    const frames = this.getFramesFromEvent(event);
+    if (frames) {
+      for (const i in frames) {
+        // tslint:disable-next-line
+        frames[i] = await this.iteratee(frames[i]);
+      }
+    }
+    return event;
+  }
+
+  /** JSDoc */
+  private getFramesFromEvent(event: SentryEvent): StackFrame[] | undefined {
+    const exception = event.exception;
+
+    if (exception) {
+      try {
+        return (exception as any).values[0].stacktrace.frames;
+      } catch (_oO) {
+        return undefined;
+      }
+    } else if (event.stacktrace) {
+      return event.stacktrace.frames;
+    } else {
+      return undefined;
+    }
+  }
+}

packages/node/test/integrations/rewriteframes.test.ts

@@ -0,0 +1,86 @@
+import { SentryEvent, StackFrame } from '@sentry/types';
+import { RewriteFrames } from '../../src/integrations/pluggable/rewriteframes';
+
+let rewriteFrames: RewriteFrames;
+let messageEvent: SentryEvent;
+let exceptionEvent: SentryEvent;
+
+describe('RewriteFrames', () => {
+  beforeEach(() => {
+    messageEvent = {
+      stacktrace: {
+        frames: [
+          {
+            filename: '/some/file1.js',
+          },
+          {
+            filename: '/some/file2.js',
+          },
+        ],
+      },
+    };
+    exceptionEvent = {
+      exception: {
+        values: [
+          {
+            stacktrace: {
+              frames: [
+                {
+                  filename: '/some/file1.js',
+                },
+                {
+                  filename: '/some/file2.js',
+                },
+              ],
+            },
+          },
+        ],
+      },
+    };
+  });
+
+  describe('default iteratee appends `app:///` if frame starts with `/`', () => {
+    beforeEach(() => {
+      rewriteFrames = new RewriteFrames();
+    });
+
+    it('transforms messageEvent frames', async () => {
+      const event = await rewriteFrames.process(messageEvent);
+      expect(event.stacktrace!.frames![0].filename).toEqual('app:///file1.js');
+      expect(event.stacktrace!.frames![1].filename).toEqual('app:///file2.js');
+    });
+
+    it('transforms exceptionEvent frames', async () => {
+      const event = await rewriteFrames.process(exceptionEvent);
+      expect(event.exception!.values![0].stacktrace!.frames![0].filename).toEqual('app:///file1.js');
+      expect(event.exception!.values![0].stacktrace!.frames![1].filename).toEqual('app:///file2.js');
+    });
+  });
+
+  describe('can use custom iteratee', () => {
+    beforeEach(() => {
+      rewriteFrames = new RewriteFrames({
+        iteratee: async (frame: StackFrame) => ({
+          ...frame,
+          function: 'whoops',
+        }),
+      });
+    });
+
+    it('transforms messageEvent frames', async () => {
+      const event = await rewriteFrames.process(messageEvent);
+      expect(event.stacktrace!.frames![0].filename).toEqual('/some/file1.js');
+      expect(event.stacktrace!.frames![0].function).toEqual('whoops');
+      expect(event.stacktrace!.frames![1].filename).toEqual('/some/file2.js');
+      expect(event.stacktrace!.frames![1].function).toEqual('whoops');
+    });
+
+    it('transforms exceptionEvent frames', async () => {
+      const event = await rewriteFrames.process(exceptionEvent);
+      expect(event.exception!.values![0].stacktrace!.frames![0].filename).toEqual('/some/file1.js');
+      expect(event.exception!.values![0].stacktrace!.frames![0].function).toEqual('whoops');
+      expect(event.exception!.values![0].stacktrace!.frames![1].filename).toEqual('/some/file2.js');
+      expect(event.exception!.values![0].stacktrace!.frames![1].function).toEqual('whoops');
+    });
+  });
+});