feat(replay): Allow to treeshake rrweb features#9274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mydea merged 2 commits into from
Oct 19, 2023
Merged

feat(replay): Allow to treeshake rrweb features #9274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1577428
feat(replay): Allow to treeshake rrweb features
mydea Oct 17, 2023
26985d6
do not include canvas in CDN bundle
mydea Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .size-limit.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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,
Comment on lines +20 to +22

@Lms24Lms24Oct 17, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm kind of unfortunate that we have inverse semantics here to the __SENTRY_DEBUG__ flag but i actually prefer the verbose EXCLUDE naming pattern.

@mydeamydeaOct 17, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I was/am also thinking about this - but IMHO for an opt-in behavior it's nicer to set this to true if I want to shake this out... 🤔 Maybe we can think about this for __SENTRY_DEBUG__ in v8 as well, make this __SENTRY_STRIP_DEBUG__: true or something like this..

__RRWEB_EXCLUDE_IFRAME__: true,
}),
);
return config;
},
},
{
name: '@sentry/browser (incl. Tracing) - Webpack (gzipped)',
path: 'packages/browser/build/npm/esm/index.js',
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,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",
Expand Down
4 changes: 2 additions & 2 deletions packages/replay/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,8 +52,8 @@
"devDependencies": {
"@babel/core": "^7.17.5",
"@sentry-internal/replay-worker": "7.74.1",
"@sentry-internal/rrweb": "2.0.1",
"@sentry-internal/rrweb-snapshot": "2.0.1",
"@sentry-internal/rrweb": "2.1.0",
"@sentry-internal/rrweb-snapshot": "2.1.0",
"jsdom-worker": "^0.2.1"
},
"dependencies": {
Expand Down
10 changes: 8 additions & 2 deletions rollup/bundleHelpers.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
makeBrowserBuildPlugin,
makeCommonJSPlugin,
makeIsDebugBuildPlugin,
makeRrwebBuildPlugin,
makeLicensePlugin,
makeNodeResolvePlugin,
makeCleanupPlugin,
Expand All@@ -34,6 +35,11 @@ export function makeBaseBundleConfig(options) {
const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
const licensePlugin = makeLicensePlugin(licenseTitle);
const tsPlugin = makeTSPlugin('es5');
const rrwebBuildPlugin = makeRrwebBuildPlugin({
excludeCanvas: true,
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
Expand All@@ -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)
Expand DownExpand Up@@ -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
Expand Down
15 changes: 14 additions & 1 deletion rollup/npmHelpers.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
makeNodeResolvePlugin,
makeCleanupPlugin,
makeSucrasePlugin,
makeRrwebBuildPlugin,
makeDebugBuildStatementReplacePlugin,
makeSetSDKSourcePlugin,
} from './plugins/index.js';
Expand All@@ -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,
Expand DownExpand Up@@ -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: [
Expand Down
29 changes: 29 additions & 0 deletions rollup/plugins/npmPlugins.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(replay): Allow to treeshake rrweb features#9274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Oct 19, 2023
 Merged


feat(replay): Allow to treeshake rrweb features
#9274
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1577428

feat(replay): Allow to treeshake rrweb features


mydea Oct 17, 2023
26985d6

do not include canvas in CDN bundle


mydea Oct 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,

Comment on lines

+20
 to 
+22

@Lms24Lms24Oct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm kind of unfortunate that we have inverse semantics here to the __SENTRY_DEBUG__ flag but i actually prefer the verbose EXCLUDE naming pattern.
@mydeamydeaOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I was/am also thinking about this - but IMHO for an opt-in behavior it's nicer to set this to true if I want to shake this out... 🤔 Maybe we can think about this for __SENTRY_DEBUG__ in v8 as well, make this __SENTRY_STRIP_DEBUG__: true or something like this..
 __RRWEB_EXCLUDE_IFRAME__: true,
 }),
 );
 return config;
 },
 },
 {
 name: '@sentry/browser (incl. Tracing) - Webpack (gzipped)',
 path: 'packages/browser/build/npm/esm/index.js',
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,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",
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,8 +52,8 @@
 "devDependencies": {
 "@babel/core": "^7.17.5",
 "@sentry-internal/replay-worker": "7.74.1",
 "@sentry-internal/rrweb": "2.0.1",
 "@sentry-internal/rrweb-snapshot": "2.0.1",
 "@sentry-internal/rrweb": "2.1.0",
 "@sentry-internal/rrweb-snapshot": "2.1.0",
 "jsdom-worker": "^0.2.1"
 },
 "dependencies": {
Expand Down

10 changes: 8 additions & 2 deletions
rollup/bundleHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
 makeBrowserBuildPlugin,
 makeCommonJSPlugin,
 makeIsDebugBuildPlugin,
 makeRrwebBuildPlugin,
 makeLicensePlugin,
 makeNodeResolvePlugin,
 makeCleanupPlugin,
Expand All@@ -34,6 +35,11 @@ export function makeBaseBundleConfig(options) {
 const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
 const licensePlugin = makeLicensePlugin(licenseTitle);
 const tsPlugin = makeTSPlugin('es5');
 const rrwebBuildPlugin = makeRrwebBuildPlugin({
 excludeCanvas: true,
 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
Expand All@@ -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)
Expand DownExpand Up@@ -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
Expand Down

15 changes: 14 additions & 1 deletion
rollup/npmHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 makeNodeResolvePlugin,
 makeCleanupPlugin,
 makeSucrasePlugin,
 makeRrwebBuildPlugin,
 makeDebugBuildStatementReplacePlugin,
 makeSetSDKSourcePlugin,
} from './plugins/index.js';
Expand All@@ -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,
Expand DownExpand Up@@ -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: [
Expand Down

29 changes: 29 additions & 0 deletions
rollup/plugins/npmPlugins.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(replay): Allow to treeshake rrweb features#9274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Oct 19, 2023
 Merged


feat(replay): Allow to treeshake rrweb features
#9274
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1577428

feat(replay): Allow to treeshake rrweb features


mydea Oct 17, 2023
26985d6

do not include canvas in CDN bundle


mydea Oct 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,

Comment on lines

+20
 to 
+22

@Lms24Lms24Oct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm kind of unfortunate that we have inverse semantics here to the __SENTRY_DEBUG__ flag but i actually prefer the verbose EXCLUDE naming pattern.
@mydeamydeaOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I was/am also thinking about this - but IMHO for an opt-in behavior it's nicer to set this to true if I want to shake this out... 🤔 Maybe we can think about this for __SENTRY_DEBUG__ in v8 as well, make this __SENTRY_STRIP_DEBUG__: true or something like this..
 __RRWEB_EXCLUDE_IFRAME__: true,
 }),
 );
 return config;
 },
 },
 {
 name: '@sentry/browser (incl. Tracing) - Webpack (gzipped)',
 path: 'packages/browser/build/npm/esm/index.js',
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,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",
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,8 +52,8 @@
 "devDependencies": {
 "@babel/core": "^7.17.5",
 "@sentry-internal/replay-worker": "7.74.1",
 "@sentry-internal/rrweb": "2.0.1",
 "@sentry-internal/rrweb-snapshot": "2.0.1",
 "@sentry-internal/rrweb": "2.1.0",
 "@sentry-internal/rrweb-snapshot": "2.1.0",
 "jsdom-worker": "^0.2.1"
 },
 "dependencies": {
Expand Down

10 changes: 8 additions & 2 deletions
rollup/bundleHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
 makeBrowserBuildPlugin,
 makeCommonJSPlugin,
 makeIsDebugBuildPlugin,
 makeRrwebBuildPlugin,
 makeLicensePlugin,
 makeNodeResolvePlugin,
 makeCleanupPlugin,
Expand All@@ -34,6 +35,11 @@ export function makeBaseBundleConfig(options) {
 const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
 const licensePlugin = makeLicensePlugin(licenseTitle);
 const tsPlugin = makeTSPlugin('es5');
 const rrwebBuildPlugin = makeRrwebBuildPlugin({
 excludeCanvas: true,
 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
Expand All@@ -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)
Expand DownExpand Up@@ -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
Expand Down

15 changes: 14 additions & 1 deletion
rollup/npmHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 makeNodeResolvePlugin,
 makeCleanupPlugin,
 makeSucrasePlugin,
 makeRrwebBuildPlugin,
 makeDebugBuildStatementReplacePlugin,
 makeSetSDKSourcePlugin,
} from './plugins/index.js';
Expand All@@ -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,
Expand DownExpand Up@@ -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: [
Expand Down

29 changes: 29 additions & 0 deletions
rollup/plugins/npmPlugins.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(replay): Allow to treeshake rrweb features#9274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Oct 19, 2023
 Merged


feat(replay): Allow to treeshake rrweb features
#9274
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1577428

feat(replay): Allow to treeshake rrweb features


mydea Oct 17, 2023
26985d6

do not include canvas in CDN bundle


mydea Oct 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,

Comment on lines

+20
 to 
+22

@Lms24Lms24Oct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm kind of unfortunate that we have inverse semantics here to the __SENTRY_DEBUG__ flag but i actually prefer the verbose EXCLUDE naming pattern.
@mydeamydeaOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I was/am also thinking about this - but IMHO for an opt-in behavior it's nicer to set this to true if I want to shake this out... 🤔 Maybe we can think about this for __SENTRY_DEBUG__ in v8 as well, make this __SENTRY_STRIP_DEBUG__: true or something like this..
 __RRWEB_EXCLUDE_IFRAME__: true,
 }),
 );
 return config;
 },
 },
 {
 name: '@sentry/browser (incl. Tracing) - Webpack (gzipped)',
 path: 'packages/browser/build/npm/esm/index.js',
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,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",
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,8 +52,8 @@
 "devDependencies": {
 "@babel/core": "^7.17.5",
 "@sentry-internal/replay-worker": "7.74.1",
 "@sentry-internal/rrweb": "2.0.1",
 "@sentry-internal/rrweb-snapshot": "2.0.1",
 "@sentry-internal/rrweb": "2.1.0",
 "@sentry-internal/rrweb-snapshot": "2.1.0",
 "jsdom-worker": "^0.2.1"
 },
 "dependencies": {
Expand Down

10 changes: 8 additions & 2 deletions
rollup/bundleHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
 makeBrowserBuildPlugin,
 makeCommonJSPlugin,
 makeIsDebugBuildPlugin,
 makeRrwebBuildPlugin,
 makeLicensePlugin,
 makeNodeResolvePlugin,
 makeCleanupPlugin,
Expand All@@ -34,6 +35,11 @@ export function makeBaseBundleConfig(options) {
 const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
 const licensePlugin = makeLicensePlugin(licenseTitle);
 const tsPlugin = makeTSPlugin('es5');
 const rrwebBuildPlugin = makeRrwebBuildPlugin({
 excludeCanvas: true,
 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
Expand All@@ -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)
Expand DownExpand Up@@ -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
Expand Down

15 changes: 14 additions & 1 deletion
rollup/npmHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 makeNodeResolvePlugin,
 makeCleanupPlugin,
 makeSucrasePlugin,
 makeRrwebBuildPlugin,
 makeDebugBuildStatementReplacePlugin,
 makeSetSDKSourcePlugin,
} from './plugins/index.js';
Expand All@@ -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,
Expand DownExpand Up@@ -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: [
Expand Down

29 changes: 29 additions & 0 deletions
rollup/plugins/npmPlugins.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(replay): Allow to treeshake rrweb features#9274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Oct 19, 2023
 Merged


feat(replay): Allow to treeshake rrweb features
#9274
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1577428

feat(replay): Allow to treeshake rrweb features


mydea Oct 17, 2023
26985d6

do not include canvas in CDN bundle


mydea Oct 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,

Comment on lines

+20
 to 
+22

@Lms24Lms24Oct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm kind of unfortunate that we have inverse semantics here to the __SENTRY_DEBUG__ flag but i actually prefer the verbose EXCLUDE naming pattern.
@mydeamydeaOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I was/am also thinking about this - but IMHO for an opt-in behavior it's nicer to set this to true if I want to shake this out... 🤔 Maybe we can think about this for __SENTRY_DEBUG__ in v8 as well, make this __SENTRY_STRIP_DEBUG__: true or something like this..
 __RRWEB_EXCLUDE_IFRAME__: true,
 }),
 );
 return config;
 },
 },
 {
 name: '@sentry/browser (incl. Tracing) - Webpack (gzipped)',
 path: 'packages/browser/build/npm/esm/index.js',
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,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",
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,8 +52,8 @@
 "devDependencies": {
 "@babel/core": "^7.17.5",
 "@sentry-internal/replay-worker": "7.74.1",
 "@sentry-internal/rrweb": "2.0.1",
 "@sentry-internal/rrweb-snapshot": "2.0.1",
 "@sentry-internal/rrweb": "2.1.0",
 "@sentry-internal/rrweb-snapshot": "2.1.0",
 "jsdom-worker": "^0.2.1"
 },
 "dependencies": {
Expand Down

10 changes: 8 additions & 2 deletions
rollup/bundleHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
 makeBrowserBuildPlugin,
 makeCommonJSPlugin,
 makeIsDebugBuildPlugin,
 makeRrwebBuildPlugin,
 makeLicensePlugin,
 makeNodeResolvePlugin,
 makeCleanupPlugin,
Expand All@@ -34,6 +35,11 @@ export function makeBaseBundleConfig(options) {
 const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
 const licensePlugin = makeLicensePlugin(licenseTitle);
 const tsPlugin = makeTSPlugin('es5');
 const rrwebBuildPlugin = makeRrwebBuildPlugin({
 excludeCanvas: true,
 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
Expand All@@ -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)
Expand DownExpand Up@@ -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
Expand Down

15 changes: 14 additions & 1 deletion
rollup/npmHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 makeNodeResolvePlugin,
 makeCleanupPlugin,
 makeSucrasePlugin,
 makeRrwebBuildPlugin,
 makeDebugBuildStatementReplacePlugin,
 makeSetSDKSourcePlugin,
} from './plugins/index.js';
Expand All@@ -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,
Expand DownExpand Up@@ -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: [
Expand Down

29 changes: 29 additions & 0 deletions
rollup/plugins/npmPlugins.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(replay): Allow to treeshake rrweb features#9274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Oct 19, 2023
 Merged


feat(replay): Allow to treeshake rrweb features
#9274
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1577428

feat(replay): Allow to treeshake rrweb features


mydea Oct 17, 2023
26985d6

do not include canvas in CDN bundle


mydea Oct 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,

Comment on lines

+20
 to 
+22

@Lms24Lms24Oct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm kind of unfortunate that we have inverse semantics here to the __SENTRY_DEBUG__ flag but i actually prefer the verbose EXCLUDE naming pattern.
@mydeamydeaOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I was/am also thinking about this - but IMHO for an opt-in behavior it's nicer to set this to true if I want to shake this out... 🤔 Maybe we can think about this for __SENTRY_DEBUG__ in v8 as well, make this __SENTRY_STRIP_DEBUG__: true or something like this..
 __RRWEB_EXCLUDE_IFRAME__: true,
 }),
 );
 return config;
 },
 },
 {
 name: '@sentry/browser (incl. Tracing) - Webpack (gzipped)',
 path: 'packages/browser/build/npm/esm/index.js',
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,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",
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,8 +52,8 @@
 "devDependencies": {
 "@babel/core": "^7.17.5",
 "@sentry-internal/replay-worker": "7.74.1",
 "@sentry-internal/rrweb": "2.0.1",
 "@sentry-internal/rrweb-snapshot": "2.0.1",
 "@sentry-internal/rrweb": "2.1.0",
 "@sentry-internal/rrweb-snapshot": "2.1.0",
 "jsdom-worker": "^0.2.1"
 },
 "dependencies": {
Expand Down

10 changes: 8 additions & 2 deletions
rollup/bundleHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
 makeBrowserBuildPlugin,
 makeCommonJSPlugin,
 makeIsDebugBuildPlugin,
 makeRrwebBuildPlugin,
 makeLicensePlugin,
 makeNodeResolvePlugin,
 makeCleanupPlugin,
Expand All@@ -34,6 +35,11 @@ export function makeBaseBundleConfig(options) {
 const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
 const licensePlugin = makeLicensePlugin(licenseTitle);
 const tsPlugin = makeTSPlugin('es5');
 const rrwebBuildPlugin = makeRrwebBuildPlugin({
 excludeCanvas: true,
 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
Expand All@@ -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)
Expand DownExpand Up@@ -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
Expand Down

15 changes: 14 additions & 1 deletion
rollup/npmHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 makeNodeResolvePlugin,
 makeCleanupPlugin,
 makeSucrasePlugin,
 makeRrwebBuildPlugin,
 makeDebugBuildStatementReplacePlugin,
 makeSetSDKSourcePlugin,
} from './plugins/index.js';
Expand All@@ -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,
Expand DownExpand Up@@ -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: [
Expand Down

29 changes: 29 additions & 0 deletions
rollup/plugins/npmPlugins.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(replay): Allow to treeshake rrweb features#9274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Oct 19, 2023
 Merged


feat(replay): Allow to treeshake rrweb features
#9274
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1577428

feat(replay): Allow to treeshake rrweb features


mydea Oct 17, 2023
26985d6

do not include canvas in CDN bundle


mydea Oct 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,

Comment on lines

+20
 to 
+22

@Lms24Lms24Oct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm kind of unfortunate that we have inverse semantics here to the __SENTRY_DEBUG__ flag but i actually prefer the verbose EXCLUDE naming pattern.
@mydeamydeaOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I was/am also thinking about this - but IMHO for an opt-in behavior it's nicer to set this to true if I want to shake this out... 🤔 Maybe we can think about this for __SENTRY_DEBUG__ in v8 as well, make this __SENTRY_STRIP_DEBUG__: true or something like this..
 __RRWEB_EXCLUDE_IFRAME__: true,
 }),
 );
 return config;
 },
 },
 {
 name: '@sentry/browser (incl. Tracing) - Webpack (gzipped)',
 path: 'packages/browser/build/npm/esm/index.js',
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,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",
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,8 +52,8 @@
 "devDependencies": {
 "@babel/core": "^7.17.5",
 "@sentry-internal/replay-worker": "7.74.1",
 "@sentry-internal/rrweb": "2.0.1",
 "@sentry-internal/rrweb-snapshot": "2.0.1",
 "@sentry-internal/rrweb": "2.1.0",
 "@sentry-internal/rrweb-snapshot": "2.1.0",
 "jsdom-worker": "^0.2.1"
 },
 "dependencies": {
Expand Down

10 changes: 8 additions & 2 deletions
rollup/bundleHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
 makeBrowserBuildPlugin,
 makeCommonJSPlugin,
 makeIsDebugBuildPlugin,
 makeRrwebBuildPlugin,
 makeLicensePlugin,
 makeNodeResolvePlugin,
 makeCleanupPlugin,
Expand All@@ -34,6 +35,11 @@ export function makeBaseBundleConfig(options) {
 const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
 const licensePlugin = makeLicensePlugin(licenseTitle);
 const tsPlugin = makeTSPlugin('es5');
 const rrwebBuildPlugin = makeRrwebBuildPlugin({
 excludeCanvas: true,
 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
Expand All@@ -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)
Expand DownExpand Up@@ -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
Expand Down

15 changes: 14 additions & 1 deletion
rollup/npmHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 makeNodeResolvePlugin,
 makeCleanupPlugin,
 makeSucrasePlugin,
 makeRrwebBuildPlugin,
 makeDebugBuildStatementReplacePlugin,
 makeSetSDKSourcePlugin,
} from './plugins/index.js';
Expand All@@ -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,
Expand DownExpand Up@@ -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: [
Expand Down

29 changes: 29 additions & 0 deletions
rollup/plugins/npmPlugins.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(replay): Allow to treeshake rrweb features#9274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Oct 19, 2023
 Merged


feat(replay): Allow to treeshake rrweb features
#9274
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1577428

feat(replay): Allow to treeshake rrweb features


mydea Oct 17, 2023
26985d6

do not include canvas in CDN bundle


mydea Oct 18, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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,

Comment on lines

+20
 to 
+22

@Lms24Lms24Oct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm kind of unfortunate that we have inverse semantics here to the __SENTRY_DEBUG__ flag but i actually prefer the verbose EXCLUDE naming pattern.
@mydeamydeaOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I was/am also thinking about this - but IMHO for an opt-in behavior it's nicer to set this to true if I want to shake this out... 🤔 Maybe we can think about this for __SENTRY_DEBUG__ in v8 as well, make this __SENTRY_STRIP_DEBUG__: true or something like this..
 __RRWEB_EXCLUDE_IFRAME__: true,
 }),
 );
 return config;
 },
 },
 {
 name: '@sentry/browser (incl. Tracing) - Webpack (gzipped)',
 path: 'packages/browser/build/npm/esm/index.js',
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,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",
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,8 +52,8 @@
 "devDependencies": {
 "@babel/core": "^7.17.5",
 "@sentry-internal/replay-worker": "7.74.1",
 "@sentry-internal/rrweb": "2.0.1",
 "@sentry-internal/rrweb-snapshot": "2.0.1",
 "@sentry-internal/rrweb": "2.1.0",
 "@sentry-internal/rrweb-snapshot": "2.1.0",
 "jsdom-worker": "^0.2.1"
 },
 "dependencies": {
Expand Down

10 changes: 8 additions & 2 deletions
rollup/bundleHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
 makeBrowserBuildPlugin,
 makeCommonJSPlugin,
 makeIsDebugBuildPlugin,
 makeRrwebBuildPlugin,
 makeLicensePlugin,
 makeNodeResolvePlugin,
 makeCleanupPlugin,
Expand All@@ -34,6 +35,11 @@ export function makeBaseBundleConfig(options) {
 const markAsBrowserBuildPlugin = makeBrowserBuildPlugin(true);
 const licensePlugin = makeLicensePlugin(licenseTitle);
 const tsPlugin = makeTSPlugin('es5');
 const rrwebBuildPlugin = makeRrwebBuildPlugin({
 excludeCanvas: true,
 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
Expand All@@ -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)
Expand DownExpand Up@@ -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
Expand Down

15 changes: 14 additions & 1 deletion
rollup/npmHelpers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
 makeNodeResolvePlugin,
 makeCleanupPlugin,
 makeSucrasePlugin,
 makeRrwebBuildPlugin,
 makeDebugBuildStatementReplacePlugin,
 makeSetSDKSourcePlugin,
} from './plugins/index.js';
Expand All@@ -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,
Expand DownExpand Up@@ -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: [
Expand Down

29 changes: 29 additions & 0 deletions
rollup/plugins/npmPlugins.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Loading