feat(browser): Add `__SENTRY_RELEASE__` magic string #6322

lforst · 2022-11-29T10:30:02Z

This adds a magic string in the browser code that can be used by build tooling to inject a release value into the SDK during build time.

This is not used right now but it makes sense to introduce something like it as early as possible because, in the future, we want to move our bundler plugins to use this approach instead of injecting a variable on global.

Lms24 · 2022-11-29T10:37:43Z

packages/gatsby/gatsby-browser.js

-    // eslint-disable-next-line no-undef
-    release: __SENTRY_RELEASE__,


m: Let's just check that removing this doesn't change/break anything for Gatsby

Tested it in a gatsby app and it still works!

github-actions · 2022-11-29T10:40:50Z

size-limit report 📦

Path	Size
@sentry/browser - ES5 CDN Bundle (gzipped + minified)	19.55 KB (+0.07% 🔺)
@sentry/browser - ES5 CDN Bundle (minified)	60.49 KB (+0.12% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped + minified)	18.22 KB (+0.11% 🔺)
@sentry/browser - ES6 CDN Bundle (minified)	53.84 KB (+0.13% 🔺)
@sentry/browser - Webpack (gzipped + minified)	19.95 KB (+0.09% 🔺)
@sentry/browser - Webpack (minified)	65.32 KB (+0.11% 🔺)
@sentry/react - Webpack (gzipped + minified)	19.97 KB (+0.09% 🔺)
@sentry/nextjs Client - Webpack (gzipped + minified)	45.98 KB (+0.05% 🔺)
@sentry/browser + @sentry/tracing - ES5 CDN Bundle (gzipped + minified)	26.43 KB (+0.06% 🔺)
@sentry/browser + @sentry/tracing - ES6 CDN Bundle (gzipped + minified)	24.85 KB (+0.08% 🔺)
@sentry/replay index.js	83.65 KB (-0.07% 🔽)
@sentry/replay - Webpack (gzipped + minified)	83.67 KB (-0.07% 🔽)
@sentry/replay - Webpack (minified)	272.53 KB (-0.06% 🔽)

mydea · 2022-11-29T10:42:13Z

packages/browser/src/sdk.ts

@@ -97,6 +102,10 @@ export function init(options: BrowserOptions = {}): void {
    if (WINDOW.SENTRY_RELEASE && WINDOW.SENTRY_RELEASE.id) {
      options.release = WINDOW.SENTRY_RELEASE.id;
    }
+
+    if (typeof __SENTRY_RELEASE__ === 'string') {


l: Should this take precedence over a release set on window? just thinking, to make sure this is what we expect :)

Yes I think so. It's either that or the other way around.

Hmm, you are more "into" these things, but I imagine it could be weird if you somehow set window.SENTRY_RELEASE to a specific value, just to have it be overwritten by SENTRY_RELEASE?

I would put it like this: I would give precedence depending on how much work it is to set a value. To set window.SENTRY_RELEASE you just have to do exactly that - assign a value. To set __SENTRY_RELEASE__ you have to instruct your bundler to replace that string, probably even by using some plugin. I would argue that this is a lot more effort to set this value.

I guess there is the argument that we want to have the value be configurable via window even if the bundler injects something. I can change it.

I guess there is the argument that we want to have the value be configurable via window even if the bundler injects something.

Yeah, that's basically my thought - if someone overwrites this at runtime or whenever, I think it may make sense to have this take precendence. But I don't have strong feelings on this, so feel free to also keep it as it is if you think that makes more sense 👍

No I def like it. Will change!

AbhiPrasad · 2022-11-29T10:46:07Z

packages/browser/src/sdk.ts

@@ -97,6 +102,10 @@ export function init(options: BrowserOptions = {}): void {
    if (WINDOW.SENTRY_RELEASE && WINDOW.SENTRY_RELEASE.id) {


m: Should we deprecate and remove in v8?

That would kill old webpack plugin compatibility. We definitely could. But I would probably delay it by a major or two.

it would be a great way to get people to migrate to newer webpack plugin version, and also we can then point people to this as a feature in the first place when highlighting it in the changelog.

olivierchatry · 2022-12-02T13:09:49Z

Well, this change make my build crash, as I was using __SENTRY_RELEASE__ to pass the release value to my software :( renamed it for now.

lforst · 2022-12-02T14:04:14Z

Well, this change make my build crash, as I was using __SENTRY_RELEASE__ to pass the release value to my software :( renamed it for now.

Damn, sorry about that. Wasn't expecting to run into collisions. We will probably leave it at __SENTRY_RELEASE__ so the thing you rename it to probably is a long term solution!

gbiryukov · 2022-12-29T20:29:20Z

packages/browser/src/sdk.ts

@@ -93,6 +98,11 @@ export function init(options: BrowserOptions = {}): void {
    options.defaultIntegrations = defaultIntegrations;
  }
  if (options.release === undefined) {
+    // This allows build tooling to find-and-replace __SENTRY_RELEASE__ to inject a release value
+    if (typeof __SENTRY_RELEASE__ === 'string') {
+      options.release = __SENTRY_RELEASE__;


Potential pitfall of this approach is that any new release on user side will be changing vendor module source even if sentry version does not change. This will lead to new hash of vendor chunk of user app (which is usually the heaviest) and cache busting for end-users, need to download it again even if release contains only app changes.

Hi, good point! This isn't used yet so we can change it at any point. Do you have suggestions on how to solve it differently?

Simplest way is to provide release name as parameter at runtime.

Another way is to provide separate entry point that user need to include into build pipeline manually (or via bundler plugin, sentry webpack plugin does something similar). This entry file can have inline release name but user can choose chunk for this entry, for example inline chunk that will be inlined into index.html

The SDK already has a way of configuring a release name during runtime: Sentry.init({ release: 'your-release-name'})

As for the separate entry point - this is something users can pretty easily do themselves. The SDK will currently already read the release name from window.SENTRY_RELEASE.id or global.SENTRY_RELEASE.id if it is set. This is the global variable that the webpack plugin and our other bundler plugins leverage to inject a release https://github.com/getsentry/sentry-javascript-bundler-plugins. If you want to disable the release injection done by the plugins you can use the releaseInjectionTargets option.

Considering the above, I think we can confidently leave everything as-is. I like the idea of providing a separate entry point though. We will definitely consider it in the future.

Thanks for mentioning releaseInjectionTargets, was not aware of this option.

So considering this option and ability to provide release name at runtime, changes in PR can be mitigated with careful setup for those who care about long term caching.

Thank you for thoughtful reply.

feat(browser): Add __SENTRY_RELEASE__ magic string

bd1aa68

lforst requested review from mydea, Lms24 and AbhiPrasad November 29, 2022 10:30

lforst self-assigned this Nov 29, 2022

Lms24 approved these changes Nov 29, 2022

View reviewed changes

mydea reviewed Nov 29, 2022

View reviewed changes

AbhiPrasad reviewed Nov 29, 2022

View reviewed changes

lforst added 3 commits November 29, 2022 12:06

Fix test

9c193e0

Move

20fe284

Fix test

5d9ea17

lforst merged commit 9d69b0f into master Nov 30, 2022

lforst deleted the lforst-release-magic-string branch November 30, 2022 10:52

Lms24 mentioned this pull request Dec 13, 2022

Release info is not sent in the event payload (7.24.0 breaks it) #6504

Closed

3 tasks

gbiryukov reviewed Dec 29, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(browser): Add `__SENTRY_RELEASE__` magic string #6322

feat(browser): Add `__SENTRY_RELEASE__` magic string #6322

lforst commented Nov 29, 2022

Lms24 Nov 29, 2022

lforst Nov 30, 2022

github-actions bot commented Nov 29, 2022 •

edited

Loading

mydea Nov 29, 2022

lforst Nov 29, 2022

mydea Nov 29, 2022

lforst Nov 29, 2022

mydea Nov 29, 2022

lforst Nov 29, 2022

AbhiPrasad Nov 29, 2022

lforst Nov 29, 2022

AbhiPrasad Nov 29, 2022 •

edited

Loading

olivierchatry commented Dec 2, 2022 •

edited

Loading

lforst commented Dec 2, 2022

gbiryukov Dec 29, 2022

lforst Dec 29, 2022

gbiryukov Dec 29, 2022

lforst Dec 30, 2022

gbiryukov Jan 3, 2023

		// eslint-disable-next-line no-undef
		release: __SENTRY_RELEASE__,

		@@ -97,6 +102,10 @@ export function init(options: BrowserOptions = {}): void {
		if (WINDOW.SENTRY_RELEASE && WINDOW.SENTRY_RELEASE.id) {

feat(browser): Add __SENTRY_RELEASE__ magic string #6322

feat(browser): Add __SENTRY_RELEASE__ magic string #6322

Conversation

lforst commented Nov 29, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 29, 2022 • 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

Choose a reason for hiding this comment

AbhiPrasad Nov 29, 2022 • edited Loading

Choose a reason for hiding this comment

olivierchatry commented Dec 2, 2022 • edited Loading

lforst commented Dec 2, 2022

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

feat(browser): Add `__SENTRY_RELEASE__` magic string #6322

feat(browser): Add `__SENTRY_RELEASE__` magic string #6322

github-actions bot commented Nov 29, 2022 •

edited

Loading

AbhiPrasad Nov 29, 2022 •

edited

Loading

olivierchatry commented Dec 2, 2022 •

edited

Loading