ref: Update export

mydea · mydea · commit f71eb6919c0e · 2023-03-20T11:53:33.000+01:00
diff --git a/package.json b/package.json
@@ -97,7 +97,6 @@
     "karma-firefox-launcher": "^1.1.0",
     "lerna": "6.5.0-alpha.2",
     "madge": "4.0.2",
-    "magic-string": "^0.27.0",
     "mocha": "^6.1.4",
     "nodemon": "^2.0.16",
     "npm-run-all": "^4.1.5",
@@ -108,7 +107,6 @@
     "rollup": "^2.67.1",
     "rollup-plugin-cleanup": "3.2.1",
     "rollup-plugin-license": "^2.6.1",
-    "rollup-plugin-modify": "^3.0.0",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.31.2",
     "sinon": "^7.3.2",
diff --git a/packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim /init.js b/packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim /init.js
@@ -0,0 +1,12 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  sampleRate: 1,
+  integrations: [new Sentry.Integrations.BrowserTracing()],
+});
+
+// This should not fail
+Sentry.addTracingExtensions();
diff --git a/packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim /template.html b/packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim /template.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+  </head>
+  <body>
+    <button onclick="console.log('Test log')">Click me</button>
+  </body>
+</html>
diff --git a/packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim /test.ts b/packages/browser-integration-tests/suites/tracing/browserTracingIntegrationShim /test.ts
@@ -0,0 +1,36 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../utils/fixtures';
+
+sentryTest(
+  'exports a shim Integrations.BrowserTracing integration for non-tracing bundles',
+  async ({ getLocalTestPath, page }) => {
+    const bundle = process.env.PW_BUNDLE;
+
+    if (!bundle || !bundle.startsWith('bundle_') || bundle.includes('tracing')) {
+      sentryTest.skip();
+    }
+
+    const consoleMessages: string[] = [];
+    page.on('console', msg => consoleMessages.push(msg.text()));
+
+    let requestCount = 0;
+    await page.route('https://dsn.ingest.sentry.io/**/*', route => {
+      requestCount++;
+      return route.fulfill({
+        status: 200,
+        contentType: 'application/json',
+        body: JSON.stringify({ id: 'test-id' }),
+      });
+    });
+
+    const url = await getLocalTestPath({ testDir: __dirname });
+
+    await page.goto(url);
+
+    expect(requestCount).toBe(0);
+    expect(consoleMessages).toEqual([
+      'You are using new BrowserTracing() even though this bundle does not include tracing.',
+    ]);
+  },
+);
diff --git a/packages/browser-integration-tests/suites/tracing/browserTracingShim/init.js b/packages/browser-integration-tests/suites/tracing/browserTracingShim/init.js
@@ -5,5 +5,8 @@ window.Sentry = Sentry;
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
   sampleRate: 1,
-  integrations: [new Sentry.Integrations.BrowserTracing()],
+  integrations: [new Sentry.BrowserTracing()],
 });
+
+// This should not fail
+Sentry.addTracingExtensions();
diff --git a/packages/browser/rollup.bundle.config.js b/packages/browser/rollup.bundle.config.js
@@ -5,11 +5,9 @@ const builds = [];
 ['es5', 'es6'].forEach(jsVersion => {
   const baseBundleConfig = makeBaseBundleConfig({
     bundleType: 'standalone',
-    entrypoints: ['src/index.ts'],
+    entrypoints: ['src/index.bundle.ts'],
     jsVersion,
     licenseTitle: '@sentry/browser',
-    includeReplay: 'shim',
-    includeBrowserTracing: 'shim',
     outputFileBase: () => `bundles/bundle${jsVersion === 'es5' ? '.es5' : ''}`,
   });
 
@@ -19,12 +17,10 @@ const builds = [];
 // Full bundle incl. replay only available for es6
 const replayBaseBundleConfig = makeBaseBundleConfig({
   bundleType: 'standalone',
-  entrypoints: ['src/index.ts'],
+  entrypoints: ['src/index.bundle.replay.ts'],
   jsVersion: 'es6',
   licenseTitle: '@sentry/browser & @sentry/replay',
   outputFileBase: () => 'bundles/bundle.replay',
-  includeReplay: true,
-  includeBrowserTracing: 'shim',
 });
 
 builds.push(...makeBundleConfigVariants(replayBaseBundleConfig));
diff --git a/packages/browser/src/index.bundle.base.ts b/packages/browser/src/index.bundle.base.ts
@@ -0,0 +1,23 @@
+export * from './exports';
+
+import { Integrations as CoreIntegrations } from '@sentry/core';
+import type { Integration } from '@sentry/types';
+
+import { WINDOW } from './helpers';
+import * as BrowserIntegrations from './integrations';
+
+let windowIntegrations = {};
+
+// This block is needed to add compatibility with the integrations packages when used with a CDN
+if (WINDOW.Sentry && WINDOW.Sentry.Integrations) {
+  windowIntegrations = WINDOW.Sentry.Integrations;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const INTEGRATIONS: Record<string, new (...args: any[]) => Integration> = {
+  ...windowIntegrations,
+  ...CoreIntegrations,
+  ...BrowserIntegrations,
+};
+
+export { INTEGRATIONS as Integrations };
diff --git a/packages/browser/src/index.bundle.replay.ts b/packages/browser/src/index.bundle.replay.ts
@@ -0,0 +1,13 @@
+// This is exported so the loader does not fail when switching off Replay/Tracing
+import { addTracingExtensions, BrowserTracing } from '@sentry-internal/integration-shims';
+import { Replay } from '@sentry/replay';
+
+import * as Sentry from './index.bundle.base';
+
+// TODO (v8): Remove this as it was only needed for backwards compatibility
+Sentry.Integrations.Replay = Replay;
+
+Sentry.Integrations.BrowserTracing = BrowserTracing;
+
+export * from './index.bundle.base';
+export { BrowserTracing, addTracingExtensions, Replay };
diff --git a/packages/browser/src/index.bundle.ts b/packages/browser/src/index.bundle.ts
@@ -0,0 +1,12 @@
+// This is exported so the loader does not fail when switching off Replay/Tracing
+import { addTracingExtensions, BrowserTracing, Replay } from '@sentry-internal/integration-shims';
+
+import * as Sentry from './index.bundle.base';
+
+// TODO (v8): Remove this as it was only needed for backwards compatibility
+Sentry.Integrations.Replay = Replay;
+
+Sentry.Integrations.BrowserTracing = BrowserTracing;
+
+export * from './index.bundle.base';
+export { BrowserTracing, addTracingExtensions, Replay };
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -20,25 +20,9 @@ const INTEGRATIONS = {
 
 export { INTEGRATIONS as Integrations };
 
-// DO NOT DELETE THESE COMMENTS!
-// We want to exclude Replay/Offline from CDN bundles, so we remove the block below with our
-// makeExcludeBlockPlugin Rollup plugin when generating bundles. Everything between
-// ROLLUP_EXCLUDE_*_FROM_BUNDLES_BEGIN and _END__ is removed for bundles.
-
-// __ROLLUP_EXCLUDE_REPLAY_FROM_BUNDLES_BEGIN__
 export { Replay } from '@sentry/replay';
-// __ROLLUP_EXCLUDE_REPLAY_FROM_BUNDLES_END__
-
-// __ROLLUP_EXCLUDE_BROWSER_TRACING_FROM_BUNDLES_BEGIN__
 export { BrowserTracing } from '@sentry-internal/tracing';
 export { addTracingExtensions } from '@sentry/core';
-// __ROLLUP_EXCLUDE_BROWSER_TRACING_FROM_BUNDLES_END__
-
-// __ROLLUP_EXCLUDE_OFFLINE_FROM_BUNDLES_BEGIN__
 export { makeBrowserOfflineTransport } from './transports/offline';
-// __ROLLUP_EXCLUDE_OFFLINE_FROM_BUNDLES_END__
-
-// __ROLLUP_EXCLUDE_BROWSER_PROFILING_FROM_BUNDLES_BEGIN__
 export { onProfilingStartRouteTransaction } from './profiling/hubextensions';
 export { BrowserProfilingIntegration } from './profiling/integration';
-// __ROLLUP_EXCLUDE_BROWSER_PROFILING_FROM_BUNDLES_END__
diff --git a/packages/integration-shims/src/BrowserTracing.ts b/packages/integration-shims/src/BrowserTracing.ts
@@ -29,3 +29,8 @@ class BrowserTracingShim implements Integration {
 }
 
 export { BrowserTracingShim as BrowserTracing };
+
+/** Shim function */
+export function addTracingExtensions(): void {
+  // noop
+}
diff --git a/packages/integration-shims/src/index.ts b/packages/integration-shims/src/index.ts
@@ -1,2 +1,2 @@
 export { Replay } from './Replay';
-export { BrowserTracing } from './BrowserTracing';
+export { BrowserTracing, addTracingExtensions } from './BrowserTracing';
diff --git a/packages/tracing/rollup.bundle.config.js b/packages/tracing/rollup.bundle.config.js
@@ -8,7 +8,6 @@ const builds = [];
     entrypoints: ['src/index.bundle.ts'],
     jsVersion,
     licenseTitle: '@sentry/tracing & @sentry/browser',
-    includeReplay: false,
     outputFileBase: () => `bundles/bundle.tracing${jsVersion === 'es5' ? '.es5' : ''}`,
   });
 
@@ -22,7 +21,6 @@ const replayBaseBundleConfig = makeBaseBundleConfig({
   jsVersion: 'es6',
   licenseTitle: '@sentry/tracing & @sentry/browser & @sentry/replay',
   outputFileBase: () => 'bundles/bundle.tracing.replay',
-  includeReplay: true,
 });
 
 builds.push(...makeBundleConfigVariants(replayBaseBundleConfig));
diff --git a/packages/tracing/src/index.bundle.base.ts b/packages/tracing/src/index.bundle.base.ts
@@ -67,11 +67,8 @@ if (GLOBAL_OBJ.Sentry && GLOBAL_OBJ.Sentry.Integrations) {
   windowIntegrations = GLOBAL_OBJ.Sentry.Integrations;
 }
 
-// For whatever reason, it does not recognize BrowserTracing or some of the BrowserIntegrations as Integration
-const INTEGRATIONS: Record<
-  string,
-  Integration | typeof BrowserTracing | typeof BrowserIntegrations[keyof typeof BrowserIntegrations]
-> = {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const INTEGRATIONS: Record<string, new (...args: any[]) => Integration> = {
   ...windowIntegrations,
   ...BrowserIntegrations,
   BrowserTracing,
diff --git a/packages/tracing/src/index.bundle.replay.ts b/packages/tracing/src/index.bundle.replay.ts
@@ -8,5 +8,4 @@ import * as Sentry from './index.bundle';
 Sentry.Integrations.Replay = Replay;
 
 export { Replay };
-
 export * from './index.bundle.base';
diff --git a/packages/tracing/src/index.bundle.ts b/packages/tracing/src/index.bundle.ts
@@ -1,4 +1,12 @@
 // This is exported so the loader does not fail when switching off Replay
-export { Replay } from '@sentry-internal/integration-shims';
+import { Replay } from '@sentry-internal/integration-shims';
 
+import * as Sentry from './index.bundle';
+
+// TODO (v8): Remove this as it was only needed for backwards compatibility
+// We want replay to be available under Sentry.Replay, to be consistent
+// with the NPM package version.
+Sentry.Integrations.Replay = Replay;
+
+export { Replay };
 export * from './index.bundle.base';
diff --git a/rollup/bundleHelpers.js b/rollup/bundleHelpers.js
@@ -16,40 +16,21 @@ import {
   makeSucrasePlugin,
   makeTerserPlugin,
   makeTSPlugin,
-  makeExcludeBlockPlugin,
   makeSetSDKSourcePlugin,
-  makeIntegrationShimPlugin,
 } from './plugins/index.js';
 import { mergePlugins } from './utils';
 
 const BUNDLE_VARIANTS = ['.js', '.min.js', '.debug.min.js'];
 
 export function makeBaseBundleConfig(options) {
-  const {
-    bundleType,
-    entrypoints,
-    jsVersion,
-    licenseTitle,
-    outputFileBase,
-    packageSpecificConfig,
-    includeReplay,
-    includeOffline,
-    includeBrowserProfiling,
-    includeBrowserTracing,
-  } = options;
+  const { bundleType, entrypoints, jsVersion, licenseTitle, outputFileBase, packageSpecificConfig } = options;
 
   const nodeResolvePlugin = makeNodeResolvePlugin();
   const sucrasePlugin = makeSucrasePlugin();
   const cleanupPlugin = makeCleanupPlugin();
   const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
   const licensePlugin = makeLicensePlugin(licenseTitle);
   const tsPlugin = makeTSPlugin(jsVersion.toLowerCase());
-  const excludeReplayPlugin = makeExcludeBlockPlugin('REPLAY');
-  const excludeOfflineTransport = makeExcludeBlockPlugin('OFFLINE');
-  const excludeBrowserProfiling = makeExcludeBlockPlugin('BROWSER_PROFILING');
-  const excludeBrowserTracing = makeExcludeBlockPlugin('BROWSER_TRACING');
-  const replayShimPlugin = makeIntegrationShimPlugin('@sentry/replay');
-  const browserTracingShimPlugin = makeIntegrationShimPlugin('@sentry-internal/tracing');
 
   // The `commonjs` plugin is the `esModuleInterop` of the bundling world. When used with `transformMixedEsModules`, it
   // will include all dependencies, imported or required, in the final bundle. (Without it, CJS modules aren't included
@@ -66,27 +47,6 @@ export function makeBaseBundleConfig(options) {
     plugins: [markAsBrowserBuildPlugin],
   };
 
-  if (includeReplay === 'shim') {
-    standAloneBundleConfig.plugins.push(replayShimPlugin);
-  } else if (!includeReplay) {
-    standAloneBundleConfig.plugins.push(excludeReplayPlugin);
-  }
-
-  if (!includeOffline) {
-    standAloneBundleConfig.plugins.push(excludeOfflineTransport);
-  }
-
-  if (!includeBrowserProfiling) {
-    standAloneBundleConfig.plugins.push(excludeBrowserProfiling);
-  }
-
-  if (includeBrowserTracing === 'shim') {
-    standAloneBundleConfig.plugins.push(browserTracingShimPlugin);
-  }
-  if (!includeBrowserTracing) {
-    standAloneBundleConfig.plugins.push(excludeBrowserTracing);
-  }
-
   // used by `@sentry/integrations` and `@sentry/wasm` (bundles which need to be combined with a stand-alone SDK bundle)
   const addOnBundleConfig = {
     // These output settings are designed to mimic an IIFE. We don't use Rollup's `iife` format because we don't want to
diff --git a/rollup/plugins/bundlePlugins.js b/rollup/plugins/bundlePlugins.js
@@ -8,17 +8,13 @@
  * Typescript plugin docs: https://github.com/ezolenko/rollup-plugin-typescript2
  */
 
-import path from 'path';
-
 import commonjs from '@rollup/plugin-commonjs';
 import deepMerge from 'deepmerge';
 import license from 'rollup-plugin-license';
 import resolve from '@rollup/plugin-node-resolve';
 import replace from '@rollup/plugin-replace';
 import { terser } from 'rollup-plugin-terser';
 import typescript from 'rollup-plugin-typescript2';
-import MagicString from 'magic-string';
-import modify from 'rollup-plugin-modify';
 
 /**
  * Create a plugin to add an identification banner to the top of stand-alone bundles.
@@ -181,55 +177,6 @@ export function makeTSPlugin(jsVersion) {
   return plugin;
 }
 
-/**
- * Creates a Rollup plugin that removes all code between the `__ROLLUP_EXCLUDE_FROM_BUNDLES_BEGIN__`
- * and `__ROLLUP_EXCLUDE_FROM_BUNDLES_END__` comment guards.
- * This is used to exclude certain exports from variants of the browser bundle.
- */
-export function makeExcludeBlockPlugin(type) {
-  const replacementRegex = new RegExp(
-    `\\/\\/ __ROLLUP_EXCLUDE_${type}_FROM_BUNDLES_BEGIN__(.|\n)*__ROLLUP_EXCLUDE_${type}_FROM_BUNDLES_END__`,
-    'm',
-  );
-
-  const browserIndexFilePath = path.resolve(__dirname, '../../packages/browser/src/index.ts');
-
-  const plugin = {
-    transform(code, id) {
-      const resolvedPath = path.resolve(id);
-      const shouldReplaceInFile = resolvedPath === browserIndexFilePath;
-
-      if (!shouldReplaceInFile || !replacementRegex.test(code)) {
-        return null;
-      }
-
-      const ms = new MagicString(code);
-      const transformedCode = ms.replace(replacementRegex, '');
-      return {
-        code: transformedCode.toString(),
-        map: transformedCode.generateMap({ hires: true }),
-      };
-    },
-  };
-
-  plugin.name = 'excludeBlock';
-
-  return plugin;
-}
-
-export function makeIntegrationShimPlugin(originalImportName) {
-  // This is designed to replace the re-export in browser/index.ts to export the shim
-  const plugin = modify({
-    find: originalImportName,
-    replace: '@sentry-internal/integration-shims',
-  });
-
-  // give it a nicer name for later, when we'll need to sort the plugins
-  plugin.name = 'integrationShimPlugin';
-
-  return plugin;
-}
-
 // We don't pass these plugins any options which need to be calculated or changed by us, so no need to wrap them in
 // another factory function, as they are themselves already factory functions.
 export { resolve as makeNodeResolvePlugin };
diff --git a/yarn.lock b/yarn.lock
