build(replay): Provide full browser+tracing+replay bundle #6793

mydea · 2023-01-16T14:23:13Z

Adds another CDN bundle bundle.tracing.replay.js which includes both tracing and replay.

github-actions · 2023-01-16T14:30:32Z

size-limit report 📦

Path	Size
@sentry/browser - ES5 CDN Bundle (gzipped + minified)	19.82 KB (-0.01% 🔽)
@sentry/browser - ES5 CDN Bundle (minified)	61.44 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped + minified)	18.49 KB (+0.01% 🔺)
@sentry/browser - ES6 CDN Bundle (minified)	54.74 KB (0%)
@sentry/browser - Webpack (gzipped + minified)	20.22 KB (0%)
@sentry/browser - Webpack (minified)	66.17 KB (0%)
@sentry/react - Webpack (gzipped + minified)	20.24 KB (0%)
@sentry/nextjs Client - Webpack (gzipped + minified)	47.51 KB (0%)
@sentry/browser + @sentry/tracing - ES5 CDN Bundle (gzipped + minified)	26.73 KB (+0.02% 🔺)
@sentry/browser + @sentry/tracing - ES6 CDN Bundle (gzipped + minified)	25.01 KB (-0.02% 🔽)
@sentry/replay ES6 CDN Bundle (gzipped + minified)	43.12 KB (-0.81% 🔽)
@sentry/replay - Webpack (gzipped + minified)	38.45 KB (-0.99% 🔽)
@sentry/browser + @sentry/tracing + @sentry/replay - ES6 CDN Bundle (gzipped + minified)	60.33 KB (added)

mydea · 2023-01-16T15:44:49Z

packages/tracing/rollup.bundle.config.js

+      replace({
+        preventAssignment: true,
+        values: {
+          __SENTRY_REPLAY_VERSION__: JSON.stringify(pkg.version),


Reminder to ourselves: In the next version, we should get rid of this. By now all docs etc. point to importing replay directly from @sentry/browser, so this should always be in sync.

Can we document this here #5194 or in a new issue?

Oh wait you mean next version of the SDK, not next major version. Ignore me!

I don't think this needs to be in a major release. We're tracking this in #6366

mydea · 2023-01-16T15:45:55Z

packages/tracing/src/index.bundle.replay.ts

+
+import * as Sentry from './index.bundle';
+
+Sentry.Integrations.Replay = Replay;


It was the easiest/cleanest way I could find to handle this in a dedicated input file. Otherwise it gets quite messy when trying to do this inside of index.bundle.ts 😬

Note: This means we only have a single default export here, and can't do our usual import * as Sentry stuff. but since we only use this to generate the bundle, and there it works as expected, I'd say that's fine?

I think this is fine and with this change, the full CDN bundle usage is identical to the addon bundle (docs).

Lms24

Looks good! I wanna go over this tomorrow again to double check I didn't miss anything but great work!

Lms24 · 2023-01-16T17:02:21Z

packages/replay/README.md

-  src="https://browser.sentry-cdn.com/7.24.1/bundle.tracing.min.js"
-  crossorigin="anonymous"
-></script>
-
-// Replay integration bundle
-<script
-  src="https://browser.sentry-cdn.com/7.24.1/replay.min.js"


l: Hmm it probably makes sense to show the full CDN bundle here but I'd like to keep the addon bundle around and documented (at least in docs) as I think some people might prefer it 🤔 Especially, if we're considering using the loader to lazy load it in the future.

Hmm yeah, I guess the reason to use it is if you want replay but not tracing - fair! I can add both somehow - probably leave the "full" bundle on top and add a section below on standalone usage.

Added another section below 👍

Lms24 · 2023-01-16T17:11:09Z

packages/tracing/src/index.bundle.replay.ts

+
+import * as Sentry from './index.bundle';
+
+Sentry.Integrations.Replay = Replay;


I think this is fine and with this change, the full CDN bundle usage is identical to the addon bundle (docs).

Lms24

Ok, double checked and I think this looks good 🚀
Also checked that we're uploading this as an artifact on release branches ✅

Lms24 · 2023-01-17T09:21:30Z

packages/replay/README.md

-// Replay integration bundle
-<script
-  src="https://browser.sentry-cdn.com/7.24.1/replay.min.js"
+  src="https://browser.sentry-cdn.com/7.31.0/bundle.tracing.replay.min.js"


Can't comment there directly but:
L95-96: Let's remove the text as this doesn't apply anymore if we tell them in this snippet to use the full bundle.

mydea added the Package: replay Issues related to the Sentry Replay SDK label Jan 16, 2023

mydea requested a review from Lms24 January 16, 2023 14:23

mydea self-assigned this Jan 16, 2023

mydea force-pushed the fn/replay-full-bundle branch 2 times, most recently from 20272b7 to 7265349 Compare January 16, 2023 14:57

mydea mentioned this pull request Jan 16, 2023

test(replay): Test against CDN bundles in Playwright integration tests #6770

Merged

mydea force-pushed the fn/replay-full-bundle branch from 7265349 to 77c2dc0 Compare January 16, 2023 15:40

mydea marked this pull request as ready for review January 16, 2023 15:43

mydea requested review from AbhiPrasad, billyvg and lforst January 16, 2023 15:43

mydea commented Jan 16, 2023

View reviewed changes

mydea force-pushed the fn/replay-full-bundle branch 2 times, most recently from 29d3018 to f9bd33c Compare January 16, 2023 16:54

Lms24 reviewed Jan 16, 2023

View reviewed changes

mydea force-pushed the fn/replay-full-bundle branch from f9bd33c to f5ec17a Compare January 17, 2023 08:54

Lms24 approved these changes Jan 17, 2023

View reviewed changes

Lms24 mentioned this pull request Jan 17, 2023

ref(replay): Send SDK version in Replay events #6814

Merged

mydea added 4 commits January 17, 2023 11:03

build(replay): Provide full browser+tracing+replay bundle

55505df

fix tests

9a81100

update CDN docs

f87e46b

update docs

53c298b

mydea force-pushed the fn/replay-full-bundle branch from f5ec17a to 53c298b Compare January 17, 2023 10:04

mydea enabled auto-merge (squash) January 17, 2023 10:04

mydea merged commit 660d4bb into master Jan 17, 2023

mydea deleted the fn/replay-full-bundle branch January 17, 2023 10:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build(replay): Provide full browser+tracing+replay bundle #6793

build(replay): Provide full browser+tracing+replay bundle #6793

mydea commented Jan 16, 2023 •

edited

Loading

github-actions bot commented Jan 16, 2023 •

edited

Loading

mydea Jan 16, 2023

AbhiPrasad Jan 16, 2023

AbhiPrasad Jan 16, 2023

Lms24 Jan 16, 2023

mydea Jan 16, 2023

mydea Jan 16, 2023

Lms24 Jan 16, 2023

Lms24 left a comment

Lms24 Jan 16, 2023

mydea Jan 17, 2023

mydea Jan 17, 2023

Lms24 Jan 16, 2023

Lms24 left a comment

Lms24 Jan 17, 2023


		import * as Sentry from './index.bundle';

		Sentry.Integrations.Replay = Replay;

build(replay): Provide full browser+tracing+replay bundle #6793

build(replay): Provide full browser+tracing+replay bundle #6793

Conversation

mydea commented Jan 16, 2023 • edited Loading

github-actions bot commented Jan 16, 2023 • edited Loading

size-limit report 📦

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lms24 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lms24 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mydea commented Jan 16, 2023 •

edited

Loading

github-actions bot commented Jan 16, 2023 •

edited

Loading