fix(cdn): Fix SDK source for CDN bundles #13475

mydea · 2024-08-27T11:38:31Z

We used to replace __SENTRY_SDK_SOURCE__ when we built @sentry/utils, which means that we could not overwrite it anymore for the CDN bundles, resulting in the SDK source being npm for the CDN bundles.

This PR changes this so that this is correct now.

Closes #13435

github-actions · 2024-08-27T11:46:13Z

size-limit report 📦

⚠️ Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.

Path	Size	% Change	Change
@sentry/browser	22.52 KB	-	-
@sentry/browser (incl. Tracing)	34.85 KB	-	-
@sentry/browser (incl. Tracing, Replay)	71.21 KB	-	-
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	64.48 KB	-	-
@sentry/browser (incl. Tracing, Replay with Canvas)	75.57 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback)	88.29 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)	90.13 KB	-	-
@sentry/browser (incl. metrics)	26.83 KB	-	-
@sentry/browser (incl. Feedback)	39.59 KB	-	-
@sentry/browser (incl. sendFeedback)	27.18 KB	-	-
@sentry/browser (incl. FeedbackAsync)	31.9 KB	-	-
@sentry/react	25.28 KB	-	-
@sentry/react (incl. Tracing)	37.83 KB	-	-
@sentry/vue	26.66 KB	-	-
@sentry/vue (incl. Tracing)	36.68 KB	-	-
@sentry/svelte	22.65 KB	-	-
CDN Bundle	23.77 KB	+0.01%	+2 B 🔺
CDN Bundle (incl. Tracing)	36.53 KB	+0.01%	+2 B 🔺
CDN Bundle (incl. Tracing, Replay)	70.86 KB	+0.01%	+2 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)	76.17 KB	+0.01%	+2 B 🔺
CDN Bundle - uncompressed	69.61 KB	-	-
CDN Bundle (incl. Tracing) - uncompressed	108.28 KB	-	-
CDN Bundle (incl. Tracing, Replay) - uncompressed	219.66 KB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	232.85 KB	-	-
@sentry/nextjs (client)	37.6 KB	-	-
@sentry/sveltekit (client)	35.44 KB	-	-
@sentry/node	115.71 KB	+0.01%	+1 B 🔺
@sentry/node - without tracing	90.1 KB	+0.01%	+1 B 🔺
@sentry/aws-serverless	99.51 KB	-	-

View base workflow run

mydea · 2024-08-27T14:51:17Z

dev-packages/rollup-utils/bundleHelpers.mjs

@@ -51,6 +50,7 @@ export function makeBaseBundleConfig(options) {
      intro: () => {
        return 'exports = window.Sentry || {};';
      },
+      banner: 'window.SENTRY_SDK_SOURCE = window.SENTRY_SDK_SOURCE || "cdn";',


So I changed this to completely remove the build-time const replacement, and instead inject this for the main CDN bundles. So the logic is now: Take window.SENTRY_SDK_SOURCE || 'npm', leading to npm bundle size not increasing.

The previous approach favored bundle size for the CDN bundles, but IMHO this is the "better" approach as it keeps CDN-specific stuff in the CDN bundles 🤔

The CDN bundles now look like this at the top:

/*! @sentry/browser 8.26.0 (8205969a4) | https://github.com/getsentry/sentry-javascript */ window.SENTRY_SDK_SOURCE = window.SENTRY_SDK_SOURCE || "cdn"; var Sentry = (function (exports) { // remaining code...

ok, scratch that, I changed it again to not add any overhead anywhere 😅

mydea · 2024-08-27T15:43:03Z

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

@@ -63,8 +63,9 @@ export function makeIsDebugBuildPlugin(includeDebugging) {
 export function makeSetSDKSourcePlugin(sdkSource) {
  return replace({
    preventAssignment: false,
+    delimiters: ['', ''],


So with this change, we should now have no real bundle size impact in either scenario. We simply do not overwrite stuff at all by default, returning npm. But for CDN bundles, we replace the comment, not the value itself, which is correctly minified to what we want.

Note that without the delimiter part, it does not correctly replace the string, for whatever reason.

Lms24

Change looks good to me but didn't we say we'd remove the SDK source?

mydea · 2024-08-28T08:04:21Z

Change looks good to me but didn't we say we'd remove the SDK source?

I first did this, but this actually increased bundle size for CDN bundles (a bit) because we need to read the global and handle it already existing (which is the case for the loader). So I ended up with this approach which has no bundle size impact for neither CDN nor NPM :)

This reverts commit 711e454.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.26.0` -> `8.30.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.26.0/8.30.0) | | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.26.0` -> `8.30.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.26.0/8.30.0) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/node)</summary> ### [`v8.30.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8300) [Compare Source](getsentry/sentry-javascript@8.29.0...8.30.0) ##### Important Changes - *feat(node): Add `kafkajs` integration ([#13528](getsentry/sentry-javascript#13528 This release adds a new integration that instruments `kafkajs` library with spans and traces. This integration is automatically enabled by default, but can be included with the `Sentry.kafkaIntegration()` import. ```js Sentry.init({ integrations: [Sentry.kafkaIntegration()], }); ``` ##### Other Changes - feat(core): Allow adding measurements without global client ([#13612](getsentry/sentry-javascript#13612)) - feat(deps): Bump [@opentelemetry/instrumentation-undici](https://github.com/opentelemetry/instrumentation-undici) from 0.5.0 to 0.6.0 ([#13622](getsentry/sentry-javascript#13622)) - feat(deps): Bump [@sentry/cli](https://github.com/sentry/cli) from 2.33.0 to 2.35.0 ([#13624](getsentry/sentry-javascript#13624)) - feat(node): Use `@opentelemetry/instrumentation-undici` for fetch tracing ([#13485](getsentry/sentry-javascript#13485)) - feat(nuxt): Add server config to root folder ([#13583](getsentry/sentry-javascript#13583)) - feat(otel): Upgrade [@opentelemetry/semantic-conventions](https://github.com/opentelemetry/semantic-conventions) to 1.26.0 ([#13631](getsentry/sentry-javascript#13631)) - fix(browser): check supportedEntryTypes before caling the function ([#13541](getsentry/sentry-javascript#13541)) - fix(browser): Ensure Standalone CLS span timestamps are correct ([#13649](getsentry/sentry-javascript#13649)) - fix(nextjs): Widen removal of 404 transactions ([#13628](getsentry/sentry-javascript#13628)) - fix(node): Remove ambiguity and race conditions when matching local variables to exceptions ([#13501](getsentry/sentry-javascript#13501)) - fix(node): Update OpenTelemetry instrumentation package for solidstart and opentelemetry ([#13640](getsentry/sentry-javascript#13640)) - fix(node): Update OpenTelemetry instrumentation package for solidstart and opentelemetry ([#13642](getsentry/sentry-javascript#13642)) - fix(vue): Ensure Vue `trackComponents` list matches components with or without `<>` ([#13543](getsentry/sentry-javascript#13543)) - ref(profiling): Conditionally shim cjs globals ([#13267](getsentry/sentry-javascript#13267)) Work in this release was contributed by [@Zen-cronic](https://github.com/Zen-cronic) and [@odanado](https://github.com/odanado). Thank you for your contributions! ### [`v8.29.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8290) [Compare Source](getsentry/sentry-javascript@8.28.0...8.29.0) ##### Important Changes - **Beta releases of official Solid and SolidStart Sentry SDKs** This release marks the beta releases of the `@sentry/solid` and `@sentry/solidstart` Sentry SDKs. For details on how to use them, check out the [Sentry Solid SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/solid) and the [Sentry SolidStart SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/solidstart) respectively. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns. - **feat(node): Option to only wrap instrumented modules ([#13139](getsentry/sentry-javascript#13139 Adds the SDK option to only wrap ES modules with `import-in-the-middle` that specifically need to be instrumented. ```javascript import * as Sentry from '@sentry/node'; Sentry.init({ dsn: '__PUBLIC_DSN__', registerEsmLoaderHooks: { onlyIncludeInstrumentedModules: true }, }); ``` - **feat(node): Update OpenTelemetry packages to instrumentation v0.53.0 ([#13587](getsentry/sentry-javascript#13587 All internal OpenTelemetry instrumentation was updated to their latest version. This adds support for Mongoose v7 and v8 and fixes various bugs related to ESM mode. ##### Other Changes - feat(nextjs): Emit warning when using turbopack ([#13566](getsentry/sentry-javascript#13566)) - feat(nextjs): Future-proof Next.js config options overriding ([#13586](getsentry/sentry-javascript#13586)) - feat(node): Add `generic-pool` integration ([#13465](getsentry/sentry-javascript#13465)) - feat(nuxt): Upload sourcemaps generated by Nitro ([#13382](getsentry/sentry-javascript#13382)) - feat(solidstart): Add `browserTracingIntegration` by default ([#13561](getsentry/sentry-javascript#13561)) - feat(solidstart): Add `sentrySolidStartVite` plugin to simplify source maps upload ([#13493](getsentry/sentry-javascript#13493)) - feat(vue): Only start UI spans if parent is available ([#13568](getsentry/sentry-javascript#13568)) - fix(cloudflare): Guard `context.waitUntil` call in request handler ([#13549](getsentry/sentry-javascript#13549)) - fix(gatsby): Fix assets path for sourcemaps upload ([#13592](getsentry/sentry-javascript#13592)) - fix(nextjs): Use posix paths for sourcemap uploads ([#13603](getsentry/sentry-javascript#13603)) - fix(node-fetch): Use stringified origin url ([#13581](getsentry/sentry-javascript#13581)) - fix(node): Replace dashes in `generic-pool` span origins with underscores ([#13579](getsentry/sentry-javascript#13579)) - fix(replay): Fix types in WebVitalData ([#13573](getsentry/sentry-javascript#13573)) - fix(replay): Improve replay web vital types ([#13602](getsentry/sentry-javascript#13602)) - fix(utils): Keep logger on carrier ([#13570](getsentry/sentry-javascript#13570)) Work in this release was contributed by [@Zen-cronic](https://github.com/Zen-cronic). Thank you for your contribution! ### [`v8.28.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8280) [Compare Source](getsentry/sentry-javascript@8.27.0...8.28.0) ##### Important Changes - **Beta release of official NestJS SDK** This release contains the beta version of `@sentry/nestjs`! For details on how to use it, check out the [README](https://github.com/getsentry/sentry-javascript/blob/master/packages/nestjs/README.md). Any feedback/bug reports are greatly appreciated, please reach out on GitHub. - **fix(browser): Remove faulty LCP, FCP and FP normalization logic ([#13502](getsentry/sentry-javascript#13502 This release fixes a bug in the `@sentry/browser` package and all SDKs depending on this package (e.g. `@sentry/react` or `@sentry/nextjs`) that caused the SDK to send incorrect web vital values for the LCP, FCP and FP vitals. The SDK previously incorrectly processed the original values as they were reported from the browser. When updating your SDK to this version, you might experience an increase in LCP, FCP and FP values, which potentially leads to a decrease in your performance score in the Web Vitals Insights module in Sentry. This is because the previously reported values were smaller than the actually measured values. We apologize for the inconvenience! ##### Other Changes - feat(nestjs): Add `SentryGlobalGraphQLFilter` ([#13545](getsentry/sentry-javascript#13545)) - feat(nestjs): Automatic instrumentation of nestjs interceptors after route execution ([#13264](getsentry/sentry-javascript#13264)) - feat(nextjs): Add `bundleSizeOptimizations` to build options ([#13323](getsentry/sentry-javascript#13323)) - feat(nextjs): Stabilize `captureRequestError` ([#13550](getsentry/sentry-javascript#13550)) - feat(nuxt): Wrap config in nuxt context ([#13457](getsentry/sentry-javascript#13457)) - feat(profiling): Expose profiler as top level primitive ([#13512](getsentry/sentry-javascript#13512)) - feat(replay): Add layout shift to CLS replay data ([#13386](getsentry/sentry-javascript#13386)) - feat(replay): Upgrade rrweb packages to 2.26.0 ([#13483](getsentry/sentry-javascript#13483)) - fix(cdn): Do not mangle \_metadata ([#13426](getsentry/sentry-javascript#13426)) - fix(cdn): Fix SDK source for CDN bundles ([#13475](getsentry/sentry-javascript#13475)) - fix(nestjs): Check arguments before instrumenting with `@Injectable` ([#13544](getsentry/sentry-javascript#13544)) - fix(nestjs): Ensure exception and host are correctly passed on when using [@WithSentry](https://github.com/WithSentry) ([#13564](getsentry/sentry-javascript#13564)) - fix(node): Suppress tracing for transport request execution rather than transport creation ([#13491](getsentry/sentry-javascript#13491)) - fix(replay): Consider more things as DOM mutations for dead clicks ([#13518](getsentry/sentry-javascript#13518)) - fix(vue): Correctly obtain component name ([#13484](getsentry/sentry-javascript#13484)) Work in this release was contributed by [@leopoldkristjansson](https://github.com/leopoldkristjansson), [@mhuggins](https://github.com/mhuggins) and [@filips123](https://github.com/filips123). Thank you for your contributions! ### [`v8.27.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8270) [Compare Source](getsentry/sentry-javascript@8.26.0...8.27.0) ##### Important Changes - **fix(nestjs): Exception filters in main app module are not being executed ([#13278](getsentry/sentry-javascript#13278 With this release nestjs error monitoring is no longer automatically set up after adding the `SentryModule` to your application, which led to issues in certain scenarios. You will now have to either add the `SentryGlobalFilter` to your main module providers or decorate the `catch()` method in your existing global exception filters with the newly released `@WithSentry()` decorator. See the [docs](https://docs.sentry.io/platforms/javascript/guides/nestjs/) for more details. ##### Other Changes - feat: Add options for passing nonces to feedback integration ([#13347](getsentry/sentry-javascript#13347)) - feat: Add support for SENTRY_SPOTLIGHT env var in Node ([#13325](getsentry/sentry-javascript#13325)) - feat(deps): bump [@prisma/instrumentation](https://github.com/prisma/instrumentation) from 5.17.0 to 5.18.0 ([#13327](getsentry/sentry-javascript#13327)) - feat(feedback): Improve error message for 403 errors ([#13441](getsentry/sentry-javascript#13441)) - fix(deno): Don't rely on `Deno.permissions.querySync` ([#13378](getsentry/sentry-javascript#13378)) - fix(replay): Ensure we publish replay CDN bundles ([#13437](getsentry/sentry-javascript#13437)) Work in this release was contributed by [@charpeni](https://github.com/charpeni). Thank you for your contribution! </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/61 Reviewed-by: Alexandre Soro <code@soro.dev> Co-authored-by: renovate <renovate@git.tristess.app> Co-committed-by: renovate <renovate@git.tristess.app>

mydea requested review from lforst, Lms24 and chargome August 27, 2024 11:38

mydea self-assigned this Aug 27, 2024

Lms24 approved these changes Aug 27, 2024

View reviewed changes

chargome approved these changes Aug 27, 2024

View reviewed changes

mydea force-pushed the fn/sdk-source-cdn branch from 77ae0dc to 711e454 Compare August 27, 2024 14:45

mydea commented Aug 27, 2024

View reviewed changes

mydea force-pushed the fn/sdk-source-cdn branch from 6e4bd4c to a1b2edb Compare August 28, 2024 06:34

mydea requested a review from Lms24 August 28, 2024 07:00

Lms24 approved these changes Aug 28, 2024

View reviewed changes

mydea added 8 commits August 28, 2024 11:35

add tests

40566db

fix it

22aeee8

ref: Do not use build-time constant for SDK source at all ??

7c18402

increase size limit

25939a4

Revert "ref: Do not use build-time constant for SDK source at all ??"

310fc22

This reverts commit 711e454.

reduce bundle size??!

59d5575

fix formatting

f2ba18f

fix test typo

c935831

mydea force-pushed the fn/sdk-source-cdn branch from b384318 to c935831 Compare August 28, 2024 09:36

tweak comment

df2fd99

mydea enabled auto-merge (squash) August 28, 2024 09:37

mydea merged commit 3964548 into develop Aug 28, 2024
129 checks passed

mydea deleted the fn/sdk-source-cdn branch August 28, 2024 09:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(cdn): Fix SDK source for CDN bundles #13475

fix(cdn): Fix SDK source for CDN bundles #13475

mydea commented Aug 27, 2024

github-actions bot commented Aug 27, 2024 •

edited

Loading

mydea Aug 27, 2024

mydea Aug 27, 2024

mydea Aug 27, 2024

mydea Aug 27, 2024

mydea Aug 27, 2024

Lms24 left a comment

mydea commented Aug 28, 2024

fix(cdn): Fix SDK source for CDN bundles #13475

fix(cdn): Fix SDK source for CDN bundles #13475

Conversation

mydea commented Aug 27, 2024

github-actions bot commented Aug 27, 2024 • edited Loading

size-limit report 📦

mydea Aug 27, 2024

Choose a reason for hiding this comment

mydea Aug 27, 2024

Choose a reason for hiding this comment

mydea Aug 27, 2024

Choose a reason for hiding this comment

mydea Aug 27, 2024

Choose a reason for hiding this comment

mydea Aug 27, 2024

Choose a reason for hiding this comment

Lms24 left a comment

Choose a reason for hiding this comment

mydea commented Aug 28, 2024

github-actions bot commented Aug 27, 2024 •

edited

Loading