Support ignoring browser extension errors

packages/js/src/Flare.ts

@@ -22,6 +22,7 @@ export class Flare {
         stage: '',
         maxGlowsPerReport: 30,
         reportingUrl: 'https://reporting.flareapp.io/api/reports',
+        reportBrowserExtensionErrors: false,
         debug: false,
         beforeEvaluate: (error) => error,
         beforeSubmit: (report) => report,
@@ -183,7 +184,12 @@ export class Flare {
             return;
         }
 
-        return this.http.report(reportToSubmit, this.config.reportingUrl, this.config.key);
+        return this.http.report(
+            reportToSubmit,
+            this.config.reportingUrl,
+            this.config.key,
+            this.config.reportBrowserExtensionErrors
+        );
     }
 
     // Deprecated, the following methods exist for backwards compatibility.

packages/js/src/api/Api.ts

@@ -2,13 +2,14 @@ import { Report } from '../types';
 import { flatJsonStringify } from '../util';
 
 export class Api {
-    report(report: Report, url: string, key: string): Promise<void> {
+    report(report: Report, url: string, key: string, reportBrowserExtensionErrors: boolean): Promise<void> {
         return fetch(url, {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
+                'X-Api-Token': key,
                 'X-Requested-With': 'XMLHttpRequest',
-                'x-api-token': key,
+                'X-Report-Browser-Extension-Errors': JSON.stringify(reportBrowserExtensionErrors),
             },
             body: flatJsonStringify({
                 ...report,

packages/js/src/types.ts

@@ -4,6 +4,7 @@ export type Config = {
     sourcemapVersion: string;
     stage: string;
     maxGlowsPerReport: number;
+    reportBrowserExtensionErrors: boolean;
     reportingUrl: string;
     debug: boolean;
     beforeEvaluate: (error: Error) => Error | false | null | Promise<Error | false | null>;

packages/js/tests/helpers/FakeApi.ts

@@ -4,13 +4,19 @@ import { Report } from '../../src/types';
 export class FakeApi extends Api {
     reports: Report[] = [];
 
-    report(report: Report): Promise<void> {
+    lastReport?: Report;
+    lastUrl?: string;
+    lastKey?: string;
+    lastReportBrowserExtensionErrors?: boolean;
+
+    report(report: Report, url: string, key: string, reportBrowserExtensionErrors: boolean): Promise<void> {
         this.reports.push(report);
 
-        return Promise.resolve();
-    }
+        this.lastUrl = url;
+        this.lastKey = key;
+        this.lastReportBrowserExtensionErrors = reportBrowserExtensionErrors;
+        this.lastReport = report;
 
-    get lastReport(): Report | undefined {
-        return this.reports[this.reports.length - 1];
+        return Promise.resolve();
     }
 }

packages/js/tests/report.test.ts

@@ -37,3 +37,17 @@ test('report the test message', async () => {
     expect(fakeHttp.reports).toHaveLength(1);
     expect(fakeHttp.lastReport?.message).toBe('The Flare client is set up correctly!');
 });
+
+test('does not report browser extension errors by default', async () => {
+    await client.test();
+
+    expect(fakeHttp.lastReportBrowserExtensionErrors).toBe(false);
+});
+
+test('can be configured to report browser extension errors', async () => {
+    client.configure({ reportBrowserExtensionErrors: true });
+
+    await client.test();
+
+    expect(fakeHttp.lastReportBrowserExtensionErrors).toBe(true);
+});