fix: Remove beacon transport (#1953)

Same as #1952 for `4.x`

Author: HazAT

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 4.6.5
+
+- [browser] fix: Remove beacon transport.
+
 ## 4.6.4
 
 - [utils] fix: Prevent decycling from referencing original objects

packages/browser/src/backend.ts

@@ -1,10 +1,10 @@
 import { BaseBackend, Options, SentryError } from '@sentry/core';
 import { SentryEvent, SentryEventHint, Severity, Transport } from '@sentry/types';
 import { isDOMError, isDOMException, isError, isErrorEvent, isPlainObject } from '@sentry/utils/is';
-import { supportsBeacon, supportsFetch } from '@sentry/utils/supports';
+import { supportsFetch } from '@sentry/utils/supports';
 import { addExceptionTypeValue, eventFromPlainObject, eventFromStacktrace, prepareFramesForEvent } from './parsers';
 import { computeStackTrace } from './tracekit';
-import { BeaconTransport, FetchTransport, XHRTransport } from './transports';
+import { FetchTransport, XHRTransport } from './transports';
 
 /**
  * Configuration options for the Sentry Browser SDK.
@@ -58,8 +58,6 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
 
     if (this.options.transport) {
       return new this.options.transport(transportOptions);
-    } else if (supportsBeacon()) {
-      return new BeaconTransport(transportOptions);
     } else if (supportsFetch()) {
       return new FetchTransport(transportOptions);
     }

packages/browser/src/integrations/breadcrumbs.ts

@@ -5,7 +5,7 @@ import { logger } from '@sentry/utils/logger';
 import { getEventDescription, getGlobalObject, parseUrl } from '@sentry/utils/misc';
 import { deserialize, fill, safeNormalize } from '@sentry/utils/object';
 import { includes, safeJoin } from '@sentry/utils/string';
-import { supportsBeacon, supportsHistory, supportsNativeFetch } from '@sentry/utils/supports';
+import { supportsHistory, supportsNativeFetch } from '@sentry/utils/supports';
 import { BrowserClient } from '../client';
 import { breadcrumbEventHandler, keypressEventHandler, wrap } from './helpers';
 
@@ -24,7 +24,6 @@ export interface SentryWrappedXMLHttpRequest extends XMLHttpRequest {
 
 /** JSDoc */
 interface BreadcrumbIntegrations {
-  beacon?: boolean;
   console?: boolean;
   dom?: boolean;
   fetch?: boolean;
@@ -53,7 +52,6 @@ export class Breadcrumbs implements Integration {
    */
   public constructor(options?: BreadcrumbIntegrations) {
     this.options = {
-      beacon: true,
       console: true,
       dom: true,
       fetch: true,
@@ -64,56 +62,6 @@ export class Breadcrumbs implements Integration {
     };
   }
 
-  /** JSDoc */
-  private instrumentBeacon(): void {
-    if (!supportsBeacon()) {
-      return;
-    }
-
-    /** JSDoc */
-    function beaconReplacementFunction(originalBeaconFunction: () => void): () => void {
-      return function(this: History, ...args: any[]): void {
-        const url = args[0];
-        const data = args[1];
-        // If the browser successfully queues the request for delivery, the method returns "true" and returns "false" otherwise.
-        // https://developer.mozilla.org/en-US/docs/Web/API/Beacon_API/Using_the_Beacon_API
-        const result = originalBeaconFunction.apply(this, args);
-
-        const client = getCurrentHub().getClient() as BrowserClient;
-        const dsn = client && client.getDsn();
-        if (dsn) {
-          const filterUrl = new API(dsn).getStoreEndpoint();
-          // if Sentry key appears in URL, don't capture it as a request
-          // but rather as our own 'sentry' type breadcrumb
-          if (filterUrl && includes(url, filterUrl)) {
-            addSentryBreadcrumb(data);
-            return result;
-          }
-        }
-
-        // What is wrong with you TypeScript...
-        const breadcrumbData = ({
-          category: 'beacon',
-          data,
-          type: 'http',
-        } as any) as { [key: string]: any };
-
-        if (!result) {
-          breadcrumbData.level = Severity.Error;
-        }
-
-        Breadcrumbs.addBreadcrumb(breadcrumbData, {
-          input: args,
-          result,
-        });
-
-        return result;
-      };
-    }
-
-    fill(global.navigator, 'sendBeacon', beaconReplacementFunction);
-  }
-
   /** JSDoc */
   private instrumentConsole(): void {
     if (!('console' in global)) {
@@ -481,9 +429,6 @@ export class Breadcrumbs implements Integration {
     if (this.options.fetch) {
       this.instrumentFetch();
     }
-    if (this.options.beacon) {
-      this.instrumentBeacon();
-    }
     if (this.options.history) {
       this.instrumentHistory();
     }

packages/browser/src/transports/beacon.ts

@@ -1,4 +1,3 @@
 export { BaseTransport } from './base';
 export { FetchTransport } from './fetch';
 export { XHRTransport } from './xhr';
-export { BeaconTransport } from './beacon';

packages/browser/src/transports/index.ts

@@ -92,17 +92,6 @@ export function supportsNativeFetch(): boolean {
   return fetch.toString().indexOf('native') !== -1;
 }
 
-/**
- * Tells whether current environment supports sendBeacon API
- * {@link supportsBeacon}.
- *
- * @returns Answer to the given question.
- */
-export function supportsBeacon(): boolean {
-  const global = getGlobalObject();
-  return 'navigator' in global && 'sendBeacon' in global.navigator;
-}
-
 /**
  * Tells whether current environment supports ReportingObserver API
  * {@link supportsReportingObserver}.