chore: it builds :O

Author: logaretm

dev-packages/rollup-utils/bundleHelpers.mjs

@@ -3,48 +3,46 @@
  */
 
 import { builtinModules } from 'module';
-
+import path from 'node:path';
+import fs from 'node:fs';
 import deepMerge from 'deepmerge';
 
 import {
   makeBrowserBuildPlugin,
-  makeCleanupPlugin,
   makeIsDebugBuildPlugin,
-  makeLicensePlugin,
   makeRrwebBuildPlugin,
   makeSetSDKSourcePlugin,
-  makeSucrasePlugin,
+  makeBannerOptions,
   makeTerserPlugin,
 } from './plugins/index.mjs';
 import { mergePlugins } from './utils.mjs';
-import { makeProductionReplacePlugin } from './plugins/npmPlugins.mjs';
 
 const BUNDLE_VARIANTS = ['.js', '.min.js', '.debug.min.js'];
 
+const packageDotJSON = JSON.parse(fs.readFileSync(path.resolve(process.cwd(), './package.json'), { encoding: 'utf8' }));
+
 export function makeBaseBundleConfig(options) {
-  const { bundleType, entrypoints, licenseTitle, outputFileBase, packageSpecificConfig, sucrase } = options;
+  const { bundleType, entrypoints, licenseTitle, outputFileBase, packageSpecificConfig } = options;
 
-  const sucrasePlugin = makeSucrasePlugin({}, sucrase);
-  const cleanupPlugin = makeCleanupPlugin();
   const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
-  const licensePlugin = makeLicensePlugin(licenseTitle);
+  const banner = makeBannerOptions(licenseTitle, packageDotJSON.version);
   const rrwebBuildPlugin = makeRrwebBuildPlugin({
     excludeIframe: false,
     excludeShadowDom: false,
   });
-  const productionReplacePlugin = makeProductionReplacePlugin();
 
   // used by `@sentry/browser`
   const standAloneBundleConfig = {
     output: {
+      banner,
       format: 'iife',
       name: 'Sentry',
       intro: () => {
         return 'exports = window.Sentry || {};';
       },
     },
     context: 'window',
-    plugins: [rrwebBuildPlugin, markAsBrowserBuildPlugin, licensePlugin],
+    plugins: [rrwebBuildPlugin, markAsBrowserBuildPlugin],
   };
 
   // used by `@sentry/wasm` & pluggable integrations from core/browser (bundles which need to be combined with a stand-alone SDK bundle)
@@ -55,7 +53,7 @@ export function makeBaseBundleConfig(options) {
       format: 'cjs',
 
       // code to add before the CJS wrapper
-      banner: '(function (__window) {',
+      banner: `${banner}\n(function (__window) {`,
 
       // code to add just inside the CJS wrapper, before any of the wrapped code
       intro: 'var exports = {};',
@@ -78,14 +76,15 @@ export function makeBaseBundleConfig(options) {
       // code to add after the CJS wrapper
       footer: '}(window));',
     },
-    plugins: [rrwebBuildPlugin, markAsBrowserBuildPlugin, licensePlugin],
+    plugins: [rrwebBuildPlugin, markAsBrowserBuildPlugin],
   };
 
   const workerBundleConfig = {
     output: {
+      banner,
       format: 'esm',
     },
-    plugins: [makeTerserPlugin(), licensePlugin],
+    plugins: [makeTerserPlugin()],
     // Don't bundle any of Node's core modules
     external: builtinModules,
   };
@@ -110,7 +109,6 @@ export function makeBaseBundleConfig(options) {
       strict: false,
       esModule: false,
     },
-    plugins: [sucrasePlugin, cleanupPlugin],
     treeshake: 'smallest',
   };
 
@@ -144,25 +142,35 @@ export function makeBundleConfigVariants(baseConfig, options = {}) {
   const terserPlugin = makeTerserPlugin();
   const setSdkSourcePlugin = makeSetSDKSourcePlugin('cdn');
 
+  const baseOutput = baseConfig.output;
+  if (!baseOutput || Array.isArray(baseOutput)) {
+    throw new Error('Base config must have a single output object');
+  }
+
+  const baseOutputEntryFileNames = baseOutput.entryFileNames;
+  if (typeof baseOutputEntryFileNames !== 'function') {
+    throw new Error('Base config must have a function for entryFileNames');
+  }
+
   // The additional options to use for each variant we're going to create.
   const variantSpecificConfigMap = {
     '.js': {
       output: {
-        entryFileNames: chunkInfo => `${baseConfig.output.entryFileNames(chunkInfo)}.js`,
+        entryFileNames: chunkInfo => `${baseOutputEntryFileNames(chunkInfo)}.js`,
       },
       plugins: [includeDebuggingPlugin, setSdkSourcePlugin],
     },
 
     '.min.js': {
       output: {
-        entryFileNames: chunkInfo => `${baseConfig.output.entryFileNames(chunkInfo)}.min.js`,
+        entryFileNames: chunkInfo => `${baseOutputEntryFileNames(chunkInfo)}.min.js`,
       },
       plugins: [stripDebuggingPlugin, setSdkSourcePlugin, terserPlugin],
     },
 
     '.debug.min.js': {
       output: {
-        entryFileNames: chunkInfo => `${baseConfig.output.entryFileNames(chunkInfo)}.debug.min.js`,
+        entryFileNames: chunkInfo => `${baseOutputEntryFileNames(chunkInfo)}.debug.min.js`,
       },
       plugins: [includeDebuggingPlugin, setSdkSourcePlugin, terserPlugin],
     },
@@ -172,10 +180,12 @@ export function makeBundleConfigVariants(baseConfig, options = {}) {
     if (!BUNDLE_VARIANTS.includes(variant)) {
       throw new Error(`Unknown bundle variant requested: ${variant}`);
     }
+
     return deepMerge(baseConfig, variantSpecificConfigMap[variant], {
       // Merge the plugin arrays and make sure the end result is in the correct order. Everything else can use the
       // default merge strategy.
       customMerge: key => (key === 'plugins' ? mergePlugins : undefined),
     });
   });
 }
+

dev-packages/rollup-utils/index.mjs

@@ -1,7 +1,5 @@
-// TODO Is this necessary?
-import * as plugins from './plugins/index.mjs';
-export { plugins };
-
+export * from './plugins/index.mjs';
 export * from './bundleHelpers.mjs';
 export * from './npmHelpers.mjs';
 export { insertAt } from './utils.mjs';
+

dev-packages/rollup-utils/npmHelpers.mjs

@@ -13,11 +13,9 @@ import deepMerge from 'deepmerge';
 
 import { defineConfig } from 'rollup';
 import {
-  makeCleanupPlugin,
   makeDebugBuildStatementReplacePlugin,
   makeProductionReplacePlugin,
   makeRrwebBuildPlugin,
-  makeSucrasePlugin,
 } from './plugins/index.mjs';
 import { makePackageNodeEsm } from './plugins/make-esm-plugin.mjs';
 import { mergePlugins } from './utils.mjs';
@@ -33,13 +31,10 @@ export function makeBaseNPMConfig(options = {}) {
     entrypoints = ['src/index.ts'],
     hasBundles = false,
     packageSpecificConfig = {},
-    sucrase = {},
     bundledBuiltins = [],
   } = options;
 
-  const sucrasePlugin = makeSucrasePlugin({}, sucrase);
   const debugBuildStatementReplacePlugin = makeDebugBuildStatementReplacePlugin();
-  const cleanupPlugin = makeCleanupPlugin();
   const rrwebBuildPlugin = makeRrwebBuildPlugin({
     excludeShadowDom: undefined,
     excludeIframe: undefined,
@@ -62,9 +57,6 @@ export function makeBaseNPMConfig(options = {}) {
         preset: 'es2015',
       },
 
-      // don't add `"use strict"` to the top of cjs files
-      strict: false,
-
       // do TS-3.8-style exports
       //     exports.dogs = are.great
       // rather than TS-3.9-style exports
@@ -73,12 +65,6 @@ export function makeBaseNPMConfig(options = {}) {
       //       get: () => are.great,
       //     });
       externalLiveBindings: false,
-
-      // Don't call `Object.freeze` on the results of `import * as someModule from '...'`
-      // (We don't need it, so why waste the bytes?)
-      freeze: false,
-
-      interop: 'esModule',
     },
 
     treeshake: {
@@ -92,7 +78,7 @@ export function makeBaseNPMConfig(options = {}) {
       },
     },
 
-    plugins: [sucrasePlugin, debugBuildStatementReplacePlugin, rrwebBuildPlugin, cleanupPlugin],
+    plugins: [debugBuildStatementReplacePlugin, rrwebBuildPlugin],
 
     // don't include imported modules from outside the package in the final output
     external: [
@@ -109,20 +95,30 @@ export function makeBaseNPMConfig(options = {}) {
   });
 }
 
+// TODO: Instead of runtime checks, we should use TypeScript to ensure the base config is valid.
 export function makeNPMConfigVariants(baseConfig, options = {}) {
   const { emitEsm = true, emitCjs = true, splitDevProd = false } = options;
+  const baseOutput = baseConfig.output;
+  if (!baseOutput || Array.isArray(baseOutput)) {
+    throw new Error('Base config must have a single output object');
+  }
+
+  const baseOutputDir = baseOutput.dir;
+  if (typeof baseOutputDir !== 'string') {
+    throw new Error('Base config must have a string for dir');
+  }
 
   const variantSpecificConfigs = [];
 
   if (emitCjs) {
     if (splitDevProd) {
-      variantSpecificConfigs.push({ output: { format: 'cjs', dir: path.join(baseConfig.output.dir, 'cjs/dev') } });
+      variantSpecificConfigs.push({ output: { format: 'cjs', dir: path.join(baseOutputDir, 'cjs/dev') } });
       variantSpecificConfigs.push({
-        output: { format: 'cjs', dir: path.join(baseConfig.output.dir, 'cjs/prod') },
+        output: { format: 'cjs', dir: path.join(baseOutputDir, 'cjs/prod') },
         plugins: [makeProductionReplacePlugin()],
       });
     } else {
-      variantSpecificConfigs.push({ output: { format: 'cjs', dir: path.join(baseConfig.output.dir, 'cjs') } });
+      variantSpecificConfigs.push({ output: { format: 'cjs', dir: path.join(baseOutputDir, 'cjs') } });
     }
   }
 
@@ -131,22 +127,22 @@ export function makeNPMConfigVariants(baseConfig, options = {}) {
       variantSpecificConfigs.push({
         output: {
           format: 'esm',
-          dir: path.join(baseConfig.output.dir, 'esm/dev'),
+          dir: path.join(baseOutputDir, 'esm/dev'),
           plugins: [makePackageNodeEsm()],
         },
       });
       variantSpecificConfigs.push({
         output: {
           format: 'esm',
-          dir: path.join(baseConfig.output.dir, 'esm/prod'),
+          dir: path.join(baseOutputDir, 'esm/prod'),
           plugins: [makeProductionReplacePlugin(), makePackageNodeEsm()],
         },
       });
     } else {
       variantSpecificConfigs.push({
         output: {
           format: 'esm',
-          dir: path.join(baseConfig.output.dir, 'esm'),
+          dir: path.join(baseOutputDir, 'esm'),
           plugins: [makePackageNodeEsm()],
         },
       });

dev-packages/rollup-utils/plugins/bundlePlugins.mjs

@@ -10,30 +10,20 @@
 
 import * as childProcess from 'child_process';
 
-import replace from '@rollup/plugin-replace';
+import { replacePlugin } from 'rolldown/plugins';
 import terser from '@rollup/plugin-terser';
-import license from 'rollup-plugin-license';
 
 /**
  * Create a plugin to add an identification banner to the top of stand-alone bundles.
  *
  * @param title The title to use for the SDK, if not the package name
+ * @param version The version of the SDK
  * @returns An instance of the `rollup-plugin-license` plugin
  */
-export function makeLicensePlugin(title) {
+export function makeBannerOptions(title, version) {
   const commitHash = childProcess.execSync('git rev-parse --short HEAD', { encoding: 'utf-8' }).trim();
 
-  const plugin = license({
-    banner: {
-      content: `/*! <%= data.title %> <%= pkg.version %> (${commitHash}) | https://github.com/getsentry/sentry-javascript */`,
-      data: { title },
-    },
-  });
-
-  // give it a nicer name for later, when we'll need to sort the plugins
-  plugin.name = 'license';
-
-  return plugin;
+  return `/*! ${title} ${version} (${commitHash}) | https://github.com/getsentry/sentry-javascript */`;
 }
 
 /**
@@ -44,28 +34,32 @@ export function makeLicensePlugin(title) {
  * 'false`
  */
 export function makeIsDebugBuildPlugin(includeDebugging) {
-  return replace({
-    // TODO `preventAssignment` will default to true in version 5.x of the replace plugin, at which point we can get rid
-    // of this. (It actually makes no difference in this case whether it's true or false, since we never assign to
-    // `__SENTRY_DEBUG__`, but if we don't give it a value, it will spam with warnings.)
-    preventAssignment: true,
-    values: {
+  return replacePlugin(
+    {
       // Flags in current package
-      __DEBUG_BUILD__: includeDebugging,
+      __DEBUG_BUILD__: JSON.stringify(includeDebugging),
       // Flags in built monorepo dependencies, from which the bundle pulls
-      __SENTRY_DEBUG__: includeDebugging,
+      __SENTRY_DEBUG__: JSON.stringify(includeDebugging),
     },
-  });
+    {
+      // TODO `preventAssignment` will default to true in version 5.x of the replace plugin, at which point we can get rid
+      // of this. (It actually makes no difference in this case whether it's true or false, since we never assign to
+      // `__SENTRY_DEBUG__`, but if we don't give it a value, it will spam with warnings.)
+      preventAssignment: true,
+    },
+  );
 }
 
 export function makeSetSDKSourcePlugin(sdkSource) {
-  return replace({
-    preventAssignment: false,
-    delimiters: ['', ''],
-    values: {
+  return replacePlugin(
+    {
       '/* __SENTRY_SDK_SOURCE__ */': `return ${JSON.stringify(sdkSource)};`,
     },
-  });
+    {
+      preventAssignment: false,
+      delimiters: ['', ''],
+    },
+  );
 }
 
 /**
@@ -75,13 +69,15 @@ export function makeSetSDKSourcePlugin(sdkSource) {
  * @returns An instance of the `replace` plugin to do the replacement of the magic string with `true` or 'false`
  */
 export function makeBrowserBuildPlugin(isBrowserBuild) {
-  return replace({
-    // TODO This will be the default in the next version of the `replace` plugin
-    preventAssignment: true,
-    values: {
-      __SENTRY_BROWSER_BUNDLE__: isBrowserBuild,
+  return replacePlugin(
+    {
+      __SENTRY_BROWSER_BUNDLE__: JSON.stringify(!!isBrowserBuild),
     },
-  });
+    {
+      // TODO This will be the default in the next version of the `replace` plugin
+      preventAssignment: true,
+    },
+  );
 }
 
 // `terser` options reference: https://github.com/terser/terser#api-reference
@@ -144,3 +140,4 @@ export function makeTerserPlugin() {
     },
   });
 }
+

dev-packages/rollup-utils/plugins/index.mjs

@@ -1,2 +1,3 @@
 export * from './bundlePlugins.mjs';
 export * from './npmPlugins.mjs';
+

dev-packages/rollup-utils/plugins/make-esm-plugin.mjs

@@ -33,3 +33,4 @@ export function makePackageNodeEsm() {
     },
   };
 }
+