build(utils): Add build constant for cdn vs. npm bundles

Author: AbhiPrasad

packages/utils/src/env.ts

@@ -7,14 +7,16 @@
  *
  * Attention:
  * This file should not be used to define constants/flags that are intended to be used for tree-shaking conducted by
- * users. These fags should live in their respective packages, as we identified user tooling (specifically webpack)
+ * users. These flags should live in their respective packages, as we identified user tooling (specifically webpack)
  * having issues tree-shaking these constants across package boundaries.
  * An example for this is the __SENTRY_DEBUG__ constant. It is declared in each package individually because we want
  * users to be able to shake away expressions that it guards.
  */
 
 declare const __SENTRY_BROWSER_BUNDLE__: boolean | undefined;
 
+declare const __SENTRY_CDN_BUNDLE__: boolean | undefined;
+
 /**
  * Figures out if we're building a browser bundle.
  *
@@ -23,3 +25,10 @@ declare const __SENTRY_BROWSER_BUNDLE__: boolean | undefined;
 export function isBrowserBundle(): boolean {
   return typeof __SENTRY_BROWSER_BUNDLE__ !== 'undefined' && !!__SENTRY_BROWSER_BUNDLE__;
 }
+
+/**
+ * Figures out if we're a CDN or npm bundle.
+ */
+export function isCDNBundle(): 'cdn' | 'npm' {
+  return typeof __SENTRY_CDN_BUNDLE__ !== 'undefined' && !!__SENTRY_CDN_BUNDLE__ ? 'npm' : 'cdn';
+}

rollup/bundleHelpers.js

@@ -17,6 +17,7 @@ import {
   makeTerserPlugin,
   makeTSPlugin,
   makeExcludeReplayPlugin,
+  makeIsCDNBundlePlugin,
 } from './plugins/index.js';
 import { mergePlugins } from './utils';
 
@@ -141,28 +142,29 @@ export function makeBundleConfigVariants(baseConfig, options = {}) {
   const includeDebuggingPlugin = makeIsDebugBuildPlugin(true);
   const stripDebuggingPlugin = makeIsDebugBuildPlugin(false);
   const terserPlugin = makeTerserPlugin();
+  const isCDNBundlePlugin = makeIsCDNBundlePlugin(true);
 
   // The additional options to use for each variant we're going to create.
   const variantSpecificConfigMap = {
     '.js': {
       output: {
         entryFileNames: chunkInfo => `${baseConfig.output.entryFileNames(chunkInfo)}.js`,
       },
-      plugins: [includeDebuggingPlugin],
+      plugins: [includeDebuggingPlugin, isCDNBundlePlugin],
     },
 
     '.min.js': {
       output: {
         entryFileNames: chunkInfo => `${baseConfig.output.entryFileNames(chunkInfo)}.min.js`,
       },
-      plugins: [stripDebuggingPlugin, terserPlugin],
+      plugins: [stripDebuggingPlugin, terserPlugin, isCDNBundlePlugin],
     },
 
     '.debug.min.js': {
       output: {
         entryFileNames: chunkInfo => `${baseConfig.output.entryFileNames(chunkInfo)}.debug.min.js`,
       },
-      plugins: [includeDebuggingPlugin, terserPlugin],
+      plugins: [includeDebuggingPlugin, terserPlugin, isCDNBundlePlugin],
     },
   };
 

rollup/npmHelpers.js

@@ -13,6 +13,7 @@ import {
   makeCleanupPlugin,
   makeSucrasePlugin,
   makeDebugBuildStatementReplacePlugin,
+  makeIsCDNBundlePlugin,
 } from './plugins/index.js';
 import { mergePlugins } from './utils';
 
@@ -31,6 +32,7 @@ export function makeBaseNPMConfig(options = {}) {
   const debugBuildStatementReplacePlugin = makeDebugBuildStatementReplacePlugin();
   const cleanupPlugin = makeCleanupPlugin();
   const extractPolyfillsPlugin = makeExtractPolyfillsPlugin();
+  const isNPMBundlePlugin = makeIsCDNBundlePlugin(false);
 
   const defaultBaseConfig = {
     input: entrypoints,
@@ -87,6 +89,7 @@ export function makeBaseNPMConfig(options = {}) {
       debugBuildStatementReplacePlugin,
       cleanupPlugin,
       extractPolyfillsPlugin,
+      isNPMBundlePlugin,
     ],
 
     // don't include imported modules from outside the package in the final output

rollup/plugins/bundlePlugins.js

@@ -63,6 +63,14 @@ export function makeIsDebugBuildPlugin(includeDebugging) {
   });
 }
 
+export function makeIsCDNBundlePlugin(isCDNBundle) {
+  return replace({
+    values: {
+      __SENTRY_CDN_BUNDLE__: isCDNBundle,
+    },
+  });
+}
+
 /**
  * Create a plugin to set the value of the `__SENTRY_BROWSER_BUNDLE__` magic string.
  *