Add sendClientReport option to disable sdk client reports

Author: kamilogorek

packages/browser/src/backend.ts

@@ -62,6 +62,7 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
       ...this._options.transportOptions,
       dsn: this._options.dsn,
       tunnel: this._options.tunnel,
+      sendClientReports: this._options.sendClientReports,
       _metadata: this._options._metadata,
     };
 

packages/browser/src/sdk.ts

@@ -88,6 +88,9 @@ export function init(options: BrowserOptions = {}): void {
   if (options.autoSessionTracking === undefined) {
     options.autoSessionTracking = true;
   }
+  if (options.sendClientReports === undefined) {
+    options.sendClientReports = true;
+  }
 
   initAndBind(BrowserClient, options);
 

packages/browser/src/transports/base.ts

@@ -42,11 +42,13 @@ export abstract class BaseTransport implements Transport {
     // eslint-disable-next-line deprecation/deprecation
     this.url = this._api.getStoreEndpointWithUrlEncodedAuth();
 
-    document.addEventListener('visibilitychange', () => {
-      if (document.visibilityState === 'hidden') {
-        this._flushOutcomes();
-      }
-    });
+    if (this.options.sendClientReport) {
+      document.addEventListener('visibilitychange', () => {
+        if (document.visibilityState === 'hidden') {
+          this._flushOutcomes();
+        }
+      });
+    }
   }
 
   /**
@@ -67,6 +69,10 @@ export abstract class BaseTransport implements Transport {
    * @inheritDoc
    */
   public recordLostEvent(type: Outcome): void {
+    if (!this.options.sendClientReport) {
+      return;
+    }
+
     logger.log(`Adding ${type} outcome`);
     this._outcomes[type] = (this._outcomes[type] ?? 0) + 1;
   }
@@ -75,6 +81,10 @@ export abstract class BaseTransport implements Transport {
    * Send outcomes as an envelope
    */
   protected _flushOutcomes(): void {
+    if (!this.options.sendClientReport) {
+      return;
+    }
+
     if (!navigator || typeof navigator.sendBeacon !== 'function') {
       logger.warn('Beacon API not available, skipping sending outcomes.');
       return;

packages/types/src/options.ts

@@ -132,6 +132,11 @@ export interface Options {
    */
   autoSessionTracking?: boolean;
 
+  /**
+   * Automatically send SDK Client Report
+   */
+  sendClientReports?: boolean;
+
   /**
    * Initial data to populate scope.
    */

packages/types/src/transport.ts

@@ -64,6 +64,8 @@ export interface TransportOptions {
   fetchParameters?: { [key: string]: string };
   /** The envelope tunnel to use. */
   tunnel?: string;
+  /** Automatically send SDK Client Report */
+  sendClientReport?: boolean;
   /**
    * Set of metadata about the SDK that can be internally used to enhance envelopes and events,
    * and provide additional data about every request.