fix: Correctly parse mixed chrome/node renderer stack traces (#509)

getsentry · Jul 9, 2022 · 3bc2a2f · 3bc2a2f
1 parent 61edd69
commit 3bc2a2f
Show file tree

Hide file tree

Showing 6 changed files with 184 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- fix: Correctly parse mixed Chrome/node stack traces in the renderer (#509)
+
 ## 4.0.0-beta.1
 
 Updating the underlying Sentry JavaScript SDK's to v7 forces a major version bump due to minor breaking changes in user

diff --git a/package.json b/package.json
@@ -85,7 +85,7 @@
     "chai-subset": "^1.6.0",
     "cross-env": "^7.0.3",
     "eslint": "7.27.0",
-    "electron": "15.3.0",
+    "electron": "19.0.8",
     "@electron/get": "^1.13.0",
     "electron-mocha": "^11.0.0",
     "electron-latest-versions": "^0.1.7",

diff --git a/src/renderer/sdk.ts b/src/renderer/sdk.ts
@@ -8,6 +8,7 @@ import { logger } from '@sentry/utils';
 
 import { ensureProcess } from '../common';
 import { EventToMain, ScopeToMain } from './integrations';
+import { electronRendererStackParser } from './stack-parse';
 
 export const defaultIntegrations = [...defaultBrowserIntegrations, new ScopeToMain(), new EventToMain()];
 
@@ -40,6 +41,10 @@ If init has been called in the preload and contextIsolation is disabled, is not
     options.defaultIntegrations = defaultIntegrations;
   }
 
+  if (options.stackParser === undefined) {
+    options.stackParser = electronRendererStackParser;
+  }
+
   if (options.dsn === undefined) {
     // Events are sent via the main process but browser SDK wont start without dsn
     options.dsn = 'https://12345@dummy.dsn/12345';

diff --git a/src/renderer/stack-parse.ts b/src/renderer/stack-parse.ts
@@ -0,0 +1,27 @@
+import { chromeStackLineParser } from '@sentry/browser';
+import { StackFrame, StackParser } from '@sentry/types';
+import { dropUndefinedKeys, nodeStackLineParser, stripSentryFramesAndReverse } from '@sentry/utils';
+
+const [, chrome] = chromeStackLineParser;
+const [, node] = nodeStackLineParser();
+
+/**
+ * A stack parser than combines Chrome and node.js parsers to give the best results even when nodeIntegration = true
+ */
+export const electronRendererStackParser: StackParser = (stack: string, skipFirst: number = 0): StackFrame[] => {
+  const frames: StackFrame[] = [];
+
+  for (const line of stack.split('\n').slice(skipFirst)) {
+    const chromeFrame = chrome(line);
+    const nodeFrame = node(line);
+
+    // We favour the chrome parser unless in_app == false
+    if (chromeFrame && nodeFrame?.in_app !== false) {
+      frames.push(chromeFrame);
+    } else if (nodeFrame) {
+      frames.push(dropUndefinedKeys(nodeFrame));
+    }
+  }
+
+  return stripSentryFramesAndReverse(frames);
+};
diff --git a/test/e2e/download.ts b/test/e2e/download.ts
@@ -1,4 +1,4 @@
-import { download as electronDownload } from '@electron/get';
+import { downloadArtifact as electronDownload } from '@electron/get';
 import electronExtract = require('extract-zip');
 import { existsSync } from 'fs';
 import { join } from 'path';
@@ -33,7 +33,7 @@ export async function downloadElectron(version: string): Promise<string> {
   const dir = join(cacheDir, `${version}-x64`);
 
   if (!existsSync(dir)) {
-    const zipPath = await electronDownload(version, { cacheRoot: cacheDir, downloadOptions: { arch: 'x64' } });
+    const zipPath = await electronDownload({ version, arch: 'x64', artifactName: 'electron' });
     await electronExtract(zipPath, { dir });
   }
 

diff --git a/test/unit/stack-parse.test.ts b/test/unit/stack-parse.test.ts
@@ -0,0 +1,147 @@
+import { expect, should, use } from 'chai';
+import chaiAsPromised = require('chai-as-promised');
+
+import { electronRendererStackParser } from '../../src/renderer/stack-parse';
+
+should();
+use(chaiAsPromised);
+
+describe('Parse mixed renderer stack traces', () => {
+  it('Electron v2', () => {
+    const stack = `Error: ENOENT: no such file or directory, open '/does-not-exist'
+    at Object.fs.openSync (fs.js:646:18)
+    at Object.module.(anonymous function) [as openSync] (ELECTRON_ASAR.js:166:20)
+    at fs.readFileSync (fs.js:551:33)
+    at fs.readFileSync (ELECTRON_ASAR.js:538:29)
+    at two (file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html:17:11)
+    at one (file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html:24:9)
+    at global.setTimeout (file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html:28:9)
+    at sentryWrapped (/Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/node_modules/@sentry/browser/cjs/helpers.js:87:17)`;
+
+    const frames = electronRendererStackParser(stack);
+
+    expect(frames).to.eql([
+      {
+        filename:
+          'file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html',
+        function: 'global.setTimeout',
+        in_app: true,
+        lineno: 28,
+        colno: 9,
+      },
+      {
+        filename:
+          'file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html',
+        function: 'one',
+        in_app: true,
+        lineno: 24,
+        colno: 9,
+      },
+      {
+        filename:
+          'file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html',
+        function: 'two',
+        in_app: true,
+        lineno: 17,
+        colno: 11,
+      },
+      {
+        filename: 'ELECTRON_ASAR.js',
+        function: 'fs.readFileSync',
+        lineno: 538,
+        colno: 29,
+        in_app: false,
+      },
+      {
+        filename: 'fs.js',
+        function: 'fs.readFileSync',
+        lineno: 551,
+        colno: 33,
+        in_app: false,
+      },
+      {
+        filename: 'ELECTRON_ASAR.js',
+        function: 'Object.module.(anonymous function) [as openSync]',
+        lineno: 166,
+        colno: 20,
+        in_app: false,
+      },
+      {
+        filename: 'fs.js',
+        function: 'Object.fs.openSync',
+        lineno: 646,
+        colno: 18,
+        in_app: false,
+      },
+    ]);
+  });
+
+  it('Electron v19', () => {
+    const stack = `Error: ENOENT: no such file or directory, open '/does-not-exist'
+    at Object.openSync (node:fs:585:3)
+    at Object.func [as openSync] (node:electron/js2c/asar_bundle:5:1812)
+    at readFileSync (node:fs:453:35)
+    at e.readFileSync (node:electron/js2c/asar_bundle:5:9160)
+    at two (file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html:17:11)
+    at one (file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html:24:9)
+    at file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html:28:9
+    at sentryWrapped (/Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/node_modules/@sentry/browser/cjs/helpers.js:87:17)`;
+
+    const frames = electronRendererStackParser(stack);
+
+    expect(frames).to.eql([
+      {
+        filename:
+          'file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html',
+        function: '?',
+        in_app: true,
+        lineno: 28,
+        colno: 9,
+      },
+      {
+        filename:
+          'file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html',
+        function: 'one',
+        in_app: true,
+        lineno: 24,
+        colno: 9,
+      },
+      {
+        filename:
+          'file:///Users/tim/Documents/Repositories/sentry-electron/test/e2e/dist/javascript-renderer/src/index.html',
+        function: 'two',
+        in_app: true,
+        lineno: 17,
+        colno: 11,
+      },
+      {
+        filename: 'node:electron/js2c/asar_bundle',
+        function: 'e.readFileSync',
+        lineno: 5,
+        colno: 9160,
+        in_app: false,
+      },
+      {
+        filename: 'node:fs',
+        function: 'readFileSync',
+        lineno: 453,
+        colno: 35,
+        in_app: false,
+      },
+      {
+        filename: 'node:electron/js2c/asar_bundle',
+        function: 'Object.func [as openSync]',
+        lineno: 5,
+        colno: 1812,
+        in_app: false,
+      },
+      {
+        filename: 'node:fs',
+        function: 'Object.openSync',
+        lineno: 585,
+        colno: 3,
+        in_app: false,
+      },
+    ]);
+  });
+});