feat(replay): Allow to treeshake rrweb features

getsentry · Oct 17, 2023 · 9d7a3f2 · 9d7a3f2
1 parent d46bc08
commit 9d7a3f2
Show file tree

Hide file tree

Showing 6 changed files with 285 additions and 5 deletions.
diff --git a/.size-limit.js b/.size-limit.js
@@ -7,6 +7,25 @@ module.exports = [
     gzip: true,
     limit: '90 KB',
   },
+  {
+    name: '@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)',
+    path: 'packages/browser/build/npm/esm/index.js',
+    import: '{ init, Replay, BrowserTracing }',
+    gzip: true,
+    limit: '90 KB',
+    modifyWebpackConfig: function (config) {
+      const webpack = require('webpack');
+      config.plugins.push(
+        new webpack.DefinePlugin({
+          __SENTRY_DEBUG__: false,
+          __RRWEB_EXCLUDE_CANVAS__: true,
+          __RRWEB_EXCLUDE_SHADOW_DOM__: true,
+          __RRWEB_EXCLUDE_IFRAME__: true,
+        }),
+      );
+      return config;
+    },
+  },
   {
     name: '@sentry/browser (incl. Tracing) - Webpack (gzipped)',
     path: 'packages/browser/build/npm/esm/index.js',

diff --git a/package.json b/package.json
@@ -84,6 +84,7 @@
     "@rollup/plugin-sucrase": "^4.0.3",
     "@rollup/plugin-typescript": "^8.3.1",
     "@size-limit/preset-small-lib": "~9.0.0",
+    "@size-limit/webpack": "~9.0.0",
     "@strictsoftware/typedoc-plugin-monorepo": "^0.3.1",
     "@types/chai": "^4.1.3",
     "@types/jest": "^27.4.1",

diff --git a/rollup/bundleHelpers.js b/rollup/bundleHelpers.js
@@ -10,6 +10,7 @@ import {
   makeBrowserBuildPlugin,
   makeCommonJSPlugin,
   makeIsDebugBuildPlugin,
+  makeRrwebBuildPlugin,
   makeLicensePlugin,
   makeNodeResolvePlugin,
   makeCleanupPlugin,
@@ -34,6 +35,11 @@ export function makeBaseBundleConfig(options) {
   const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
   const licensePlugin = makeLicensePlugin(licenseTitle);
   const tsPlugin = makeTSPlugin('es5');
+  const rrwebBuildPlugin = makeRrwebBuildPlugin({
+    excludeCanvas: false,
+    excludeIframe: false,
+    excludeShadowDom: false,
+  });
 
   // 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
@@ -51,7 +57,7 @@ export function makeBaseBundleConfig(options) {
       },
     },
     context: 'window',
-    plugins: [markAsBrowserBuildPlugin],
+    plugins: [rrwebBuildPlugin, markAsBrowserBuildPlugin],
   };
 
   // used by `@sentry/integrations` and `@sentry/wasm` (bundles which need to be combined with a stand-alone SDK bundle)
@@ -84,7 +90,7 @@ export function makeBaseBundleConfig(options) {
       // code to add after the CJS wrapper
       footer: '}(window));',
     },
-    plugins: [markAsBrowserBuildPlugin],
+    plugins: [rrwebBuildPlugin, markAsBrowserBuildPlugin],
   };
 
   // used by `@sentry/serverless`, when creating the lambda layer

diff --git a/rollup/npmHelpers.js b/rollup/npmHelpers.js
@@ -12,6 +12,7 @@ import {
   makeNodeResolvePlugin,
   makeCleanupPlugin,
   makeSucrasePlugin,
+  makeRrwebBuildPlugin,
   makeDebugBuildStatementReplacePlugin,
   makeSetSDKSourcePlugin,
 } from './plugins/index.js';
@@ -34,6 +35,11 @@ export function makeBaseNPMConfig(options = {}) {
   const cleanupPlugin = makeCleanupPlugin();
   const extractPolyfillsPlugin = makeExtractPolyfillsPlugin();
   const setSdkSourcePlugin = makeSetSDKSourcePlugin('npm');
+  const rrwebBuildPlugin = makeRrwebBuildPlugin({
+    excludeCanvas: undefined,
+    excludeShadowDom: undefined,
+    excludeIframe: undefined,
+  });
 
   const defaultBaseConfig = {
     input: entrypoints,
@@ -84,7 +90,14 @@ export function makeBaseNPMConfig(options = {}) {
       interop: esModuleInterop ? 'auto' : 'esModule',
     },
 
-    plugins: [nodeResolvePlugin, setSdkSourcePlugin, sucrasePlugin, debugBuildStatementReplacePlugin, cleanupPlugin],
+    plugins: [
+      nodeResolvePlugin,
+      setSdkSourcePlugin,
+      sucrasePlugin,
+      debugBuildStatementReplacePlugin,
+      rrwebBuildPlugin,
+      cleanupPlugin,
+    ],
 
     // don't include imported modules from outside the package in the final output
     external: [

diff --git a/rollup/plugins/npmPlugins.js b/rollup/plugins/npmPlugins.js
@@ -105,4 +105,33 @@ export function makeDebugBuildStatementReplacePlugin() {
   });
 }
 
+/**
+ * Creates a plugin to replace build flags of rrweb with either a constant (if passed true/false) or with a safe statement that:
+ * a) evaluates to `true`
+ * b) can easily be modified by our users' bundlers to evaluate to false, facilitating the treeshaking of logger code.
+ *
+ * When `undefined` is passed,
+ * end users can define e.g. `__SENTRY_EXCLUDE_CANVAS__` in their bundler to shake out canvas specific rrweb code.
+ */
+export function makeRrwebBuildPlugin({ excludeCanvas, excludeShadowDom, excludeIframe } = {}) {
+  const values = {};
+
+  if (typeof excludeCanvas === 'boolean') {
+    values['__RRWEB_EXCLUDE_CANVAS__'] = excludeCanvas;
+  }
+
+  if (typeof excludeShadowDom === 'boolean') {
+    values['__RRWEB_EXCLUDE_SHADOW_DOM__'] = excludeShadowDom;
+  }
+
+  if (typeof excludeIframe === 'boolean') {
+    values['__RRWEB_EXCLUDE_IFRAME__'] = excludeIframe;
+  }
+
+  return replace({
+    preventAssignment: true,
+    values,
+  });
+}
+
 export { makeExtractPolyfillsPlugin } from './extractPolyfillsPlugin.js';