feat: align browser reported uncaught syntax errors (#881)

newrelic · Feb 9, 2024 · d4a0f30 · d4a0f30
1 parent f60e7f1
commit d4a0f30
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 0 deletions.
diff --git a/src/features/jserrors/instrument/index.js b/src/features/jserrors/instrument/index.js
@@ -128,6 +128,12 @@ export class Instrument extends InstrumentBase {
    * @returns {Error|UncaughtError} The error event converted to an Error object
    */
   #castErrorEvent (errorEvent) {
+    if (errorEvent.error instanceof SyntaxError && !/:\d+$/.test(errorEvent.error.stack?.trim())) {
+      const error = new UncaughtError(errorEvent.message, errorEvent.filename, errorEvent.lineno, errorEvent.colno)
+      error.name = SyntaxError.name
+      return error
+    }
+
     if (errorEvent.error instanceof Error) {
       return errorEvent.error
     }

diff --git a/tests/assets/js-error-syntax-error.html b/tests/assets/js-error-syntax-error.html
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<!--
+  Copyright 2020 New Relic Corporation.
+  PDX-License-Identifier: Apache-2.0
+-->
+<html>
+<head>
+  <title>RUM Unit Test</title>
+  {init} {config} {loader}
+</head>
+<body>
+This page throws an uncaught SyntaxError exception
+
+<!-- Fail with syntax error -->
+<script>
+  -
+</script>
+
+<!-- Fail with an eval syntax error -->
+<script>
+  eval('-')
+</script>
+</body>
+</html>
diff --git a/tests/specs/err/index.e2e.js b/tests/specs/err/index.e2e.js
@@ -45,4 +45,48 @@ describe('basic error capturing', () => {
     expect(errors.request.body.err.length).toEqual(expected.length)
     expect(errors.request.body.err).toEqual(expect.arrayContaining(expected))
   })
+
+  it('should capture file and line number for syntax errors', async () => {
+    const [errors] = await Promise.all([
+      browser.testHandle.expectErrors(),
+      browser.url(await browser.testHandle.assetURL('js-error-syntax-error.html'))
+        .then(() => browser.waitForAgentLoad())
+    ])
+
+    if (browserMatch(notIE)) {
+      expect(errors.request.body.err).toEqual(expect.arrayContaining([
+        expect.objectContaining({
+          params: expect.objectContaining({
+            stackHash: 334471736,
+            exceptionClass: 'SyntaxError',
+            stack_trace: expect.stringContaining('<inline>:18')
+          })
+        }),
+        expect.objectContaining({
+          params: expect.objectContaining({
+            stackHash: 334471761,
+            exceptionClass: 'SyntaxError',
+            stack_trace: expect.stringContaining('<inline>:22')
+          })
+        })
+      ]))
+    } else {
+      expect(errors.request.body.err).toEqual(expect.arrayContaining([
+        expect.objectContaining({
+          params: expect.objectContaining({
+            stackHash: 334471735,
+            exceptionClass: 'UncaughtError',
+            stack_trace: expect.stringContaining('<inline>:17')
+          })
+        }),
+        expect.objectContaining({
+          params: expect.objectContaining({
+            stackHash: 334471761,
+            exceptionClass: 'unknown',
+            stack_trace: expect.stringContaining('<inline>:22')
+          })
+        })
+      ]))
+    }
+  })
 })