feat(browser): Add skipBrowserExtensionCheck escape hatch option (#14147)

Add a general escape hatch for the browser extension detection check 
in favour of  further bloating the bundle size by introducing more special
cases in the extension check.

This way, we still initially block `Sentry.init` and make users think
twice how to proceed. However, we don't have to adapt the check every
time a false positive gets reported.

Author: Lms24

dev-packages/browser-integration-tests/suites/manual-client/force-init-chrome-extension/init.js

@@ -0,0 +1,11 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+// We mock this here to simulate a Chrome browser extension
+window.chrome = { runtime: { id: 'mock-extension-id' } };
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  skipBrowserExtensionCheck: true,
+});

dev-packages/browser-integration-tests/suites/manual-client/force-init-chrome-extension/test.ts

@@ -0,0 +1,16 @@
+import { expect } from '@playwright/test';
+import { sentryTest } from '../../../utils/fixtures';
+
+sentryTest(
+  'initializes inside a Chrome browser extension if `skipBrowserExtensionCheck` is set',
+  async ({ getLocalTestUrl, page }) => {
+    const url = await getLocalTestUrl({ testDir: __dirname });
+    await page.goto(url);
+
+    const isInitialized = await page.evaluate(() => {
+      return !!(window as any).Sentry.isInitialized();
+    });
+
+    expect(isInitialized).toBe(true);
+  },
+);

packages/browser/src/client.ts

@@ -26,7 +26,26 @@ import { createUserFeedbackEnvelope } from './userfeedback';
  */
 export type BrowserOptions = Options<BrowserTransportOptions> &
   BrowserClientReplayOptions &
-  BrowserClientProfilingOptions;
+  BrowserClientProfilingOptions & {
+    /**
+     * Important: Only set this option if you know what you are doing!
+     *
+     * By default, the SDK will check if `Sentry.init` is called in a browser extension.
+     * In case it is, it will stop initialization and log a warning
+     * because browser extensions require a different Sentry initialization process:
+     * https://docs.sentry.io/platforms/javascript/best-practices/shared-environments/
+     *
+     * Setting up the SDK in a browser extension with global error monitoring is not recommended
+     * and will likely flood you with errors from other web sites or extensions. This can heavily
+     * impact your quota and cause interference with your and other Sentry SDKs in shared environments.
+     *
+     * If this check wrongfully flags your setup as a browser extension, you can set this
+     * option to `true` to skip the check.
+     *
+     * @default false
+     */
+    skipBrowserExtensionCheck?: boolean;
+  };
 
 /**
  * Configuration options for the Sentry Browser SDK Client class

packages/browser/src/sdk.ts

@@ -160,7 +160,7 @@ declare const __SENTRY_RELEASE__: string | undefined;
 export function init(browserOptions: BrowserOptions = {}): Client | undefined {
   const options = applyDefaultOptions(browserOptions);
 
-  if (shouldShowBrowserExtensionError()) {
+  if (!options.skipBrowserExtensionCheck && shouldShowBrowserExtensionError()) {
     consoleSandbox(() => {
       // eslint-disable-next-line no-console
       console.error(