feat(nuxt): Respect user-provided source map generation settings #14020

s1gr1d · 2024-10-18T10:00:20Z

Nuxt implementation for: #13993
Fixes: #13997

In Nuxt, there are 3 places to set source maps (and all need to be enabled):

sourcemap
nitro.rollupConfig.output.sourcemap
vite.build.sourcemap

As Nuxt sets sourcemap.client: false (docs here), it's not possible to determine whether this setting was set by the user or the framework. Users have to set this manually like this:

export default defineNuxtConfig({
  sourcemap: {
    client: true,
  },
})

With this PR, all source maps are set to 'hidden' if they were undefined before and keep the setting otherwise. This is done in 3 separate functions (one for vite, rollup and nuxt) to better distinguish between the settings.

chargome

LGTM

chargome · 2024-10-18T10:03:32Z

packages/nuxt/src/vite/sourceMaps.ts

+export type UserSourcemapSetting = 'enabled' | 'disabled' | 'unset' | undefined;
+
+/**
+ *  Setup source maps for Sentry inside the Nuxt module during build time (in Vite for Nuxt and Rollup for N itr/**


Suggested change

* Setup source maps for Sentry inside the Nuxt module during build time (in Vite for Nuxt and Rollup for N itr/**

* Setup source maps for Sentry inside the Nuxt module during build time (in Vite for Nuxt and Rollup for Nitro)

oh noo that is left from biome (in WebStorm), it continuously messed up this file 😢 Especially in JSDoc and function declarations.

chargome · 2024-10-18T10:10:28Z

packages/nuxt/src/vite/sourceMaps.ts

+      - keep this setting (emit a warning that errors won't be unminified in Sentry)
+      - We will not upload anything
+    2. users enabled source map generation (true, hidden, inline).
+      - keep this setting this and


Suggested change

- keep this setting this and

- keep this setting and

chargome · 2024-10-18T10:23:36Z

packages/nuxt/src/vite/sourceMaps.ts

+
+  const nitroSourcemap = nitroConfig.rollupConfig.output.sourcemap;
+
+  if (nitroSourcemap === false) {


l: the logic in here is basically the same for vite rollup and nuxt, maybe this could be moved into a function instead

I thought about that as it would make the code eventually shorter. But I kept the three different functions (and so the duplication) because I think it adds more complexity if those functions are combined into one. The log outputs and the sourcmap option source are different for vite, rollup and nuxt and a function abstraction would make it very difficult to read. I think it's better to have some duplication here for the purpose of readability.

chargome · 2024-10-18T10:24:58Z

packages/nuxt/src/vite/sourceMaps.ts

+  nitroConfig.rollupConfig = nitroConfig.rollupConfig || {};
+  nitroConfig.rollupConfig.output = nitroConfig.rollupConfig.output || { sourcemap: undefined };
+
+  let previousUserSourceMapSetting: UserSourcemapSetting;


l: some vars use sourcemap camel-cased, others not

Changed all variables/comments to "source maps" and sourceMap according to https://tc39.es/source-map/

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.34.0` -> `8.35.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.34.0/8.35.0) | | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.34.0` -> `8.35.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.34.0/8.35.0) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/node)</summary> ### [`v8.35.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8350) [Compare Source](getsentry/sentry-javascript@8.34.0...8.35.0) ##### Beta release of the official Nuxt Sentry SDK This release marks the beta release of the `@sentry/nuxt` Sentry SDK. For details on how to use it, check out the [Sentry Nuxt SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/nuxt). Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns. - **feat(nuxt): Make dynamic import() wrapping default ([#13958](getsentry/sentry-javascript#13958 (BREAKING) - **feat(nuxt): Add Rollup plugin to wrap server entry with `import()` ([#13945](getsentry/sentry-javascript#13945 **It is no longer required to add a Node `--import` flag. Please update your start command to avoid initializing Sentry twice (BREAKING CHANGE).** The SDK will now apply modifications during the build of your application to allow for patching of libraries during runtime. If run into issues with this change, you can disable this behavior in your `nuxt.config.ts` and use the `--import` flag instead: ```js sentry: { dynamicImportForServerEntry: false; } ``` - **feat(nuxt): Respect user-provided source map generation settings ([#14020](getsentry/sentry-javascript#14020 We now require you to explicitly enable sourcemaps for the clientside so that Sentry can un-minify your errors. We made this change so source maps aren't accidentally leaked to the public. Enable source maps on the client as follows: ```js export default defineNuxtConfig({ sourcemap: { client: true, }, }); ``` - feat(nuxt): Log server instrumentation might not work in dev ([#14021](getsentry/sentry-javascript#14021)) - feat(nuxt): Add Http `responseHook` with `waitUntil` ([#13986](getsentry/sentry-javascript#13986)) ##### Important Changes - **feat(vue): Add Pinia plugin ([#13841](getsentry/sentry-javascript#13841 Support for [Pinia](https://pinia.vuejs.org/) is added in this release for `@sentry/vue`. To capture Pinia state data, add `createSentryPiniaPlugin()` to your Pinia store: ```javascript import { createPinia } from 'pinia'; import { createSentryPiniaPlugin } from '@sentry/vue'; const pinia = createPinia(); pinia.use(createSentryPiniaPlugin()); ``` - **feat(node): Implement Sentry-specific http instrumentation ([#13763](getsentry/sentry-javascript#13763 This change introduces a new `SentryHttpInstrumentation` to handle non-span related HTTP instrumentation, allowing it to run side-by-side with OTel's `HttpInstrumentation`. This improves support for custom OTel setups and avoids conflicts with Sentry's instrumentation. Additionally, the `spans: false` option is reintroduced for `httpIntegration` to disable span emission while still allowing custom `HttpInstrumentation` instances (`httpIntegration({ spans: false })`). - **feat(core): Make stream instrumentation opt-in ([#13951](getsentry/sentry-javascript#13951 This change adds a new option `trackFetchStreamPerformance` to the browser tracing integration. Only when set to `true`, Sentry will instrument streams via fetch. ##### Other Changes - feat(node): Expose `suppressTracing` API ([#13875](getsentry/sentry-javascript#13875)) - feat(replay): Do not log "timeout while trying to read resp body" as exception ([#13965](getsentry/sentry-javascript#13965)) - chore(node): Bump `@opentelemetry/instrumentation-express` to `0.43.0` ([#13948](getsentry/sentry-javascript#13948)) - chore(node): Bump `@opentelemetry/instrumentation-fastify` to `0.40.0` ([#13983](getsentry/sentry-javascript#13983)) - fix: Ensure type for `init` is correct in meta frameworks ([#13938](getsentry/sentry-javascript#13938)) - fix(core): `.set` the `sentry-trace` header instead of `.append`ing in fetch instrumentation ([#13907](getsentry/sentry-javascript#13907)) - fix(module): keep version for node ESM package ([#13922](getsentry/sentry-javascript#13922)) - fix(node): Ensure `ignoreOutgoingRequests` of `httpIntegration` applies to breadcrumbs ([#13970](getsentry/sentry-javascript#13970)) - fix(replay): Fix onError sampling when loading an expired buffered session ([#13962](getsentry/sentry-javascript#13962)) - fix(replay): Ignore older performance entries when starting manually ([#13969](getsentry/sentry-javascript#13969)) - perf(node): Truncate breadcrumb messages created by console integration ([#14006](getsentry/sentry-javascript#14006)) Work in this release was contributed by [@ZakrepaShe](https://github.com/ZakrepaShe) and [@zhiyan114](https://github.com/zhiyan114). Thank you for your contributions! </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/251 Reviewed-by: Alexandre Soro <[email protected]> Co-authored-by: renovate <[email protected]> Co-committed-by: renovate <[email protected]>

feat(nuxt): Respect user-provided sourcemap generation settings

fe665ab

s1gr1d mentioned this pull request Oct 18, 2024

[v9] Respect user-provided sourcemap generation settings #13993

Open

s1gr1d requested review from Lms24, lforst and chargome and removed request for Lms24 October 18, 2024 10:01

Merge branch 'develop' into sig/nuxt-sourcemaps

7bba582

chargome approved these changes Oct 18, 2024

View reviewed changes

s1gr1d and others added 2 commits October 18, 2024 13:27

review comments

7902873

Merge branch 'develop' into sig/nuxt-sourcemaps

d3f8c86

s1gr1d changed the title ~~feat(nuxt): Respect user-provided sourcemap generation settings~~ feat(nuxt): Respect user-provided source map generation settings Oct 18, 2024

s1gr1d merged commit 54d286b into develop Oct 18, 2024
118 of 119 checks passed

s1gr1d deleted the sig/nuxt-sourcemaps branch October 18, 2024 11:45

s1gr1d mentioned this pull request Oct 18, 2024

NuxtJS: Source map deletion after upload #13632

Closed

github-actions bot mentioned this pull request Oct 21, 2024

Sourcemaps and events with debug ids are not matching #13997

Closed

3 tasks

q1blue mentioned this pull request Nov 11, 2024

[Snyk] Upgrade @sentry/react from 7.16.0 to 8.35.0 https-quantumblockchainai-atlassian-net/ossinsight#983

Open

oddouu mentioned this pull request Nov 12, 2024

Sourcemaps and events with debug ids are not matching #14247

Closed

3 tasks

This was referenced Nov 13, 2024

[Snyk] Upgrade @sentry/browser from 8.34.0 to 8.35.0 MTES-MCT/ecobalyse#826

Closed

[Snyk] Upgrade @sentry/node from 8.34.0 to 8.35.0 MTES-MCT/ecobalyse#827

Closed

[Snyk] Upgrade @sentry/profiling-node from 8.34.0 to 8.35.0 MTES-MCT/ecobalyse#828

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(nuxt): Respect user-provided source map generation settings #14020

feat(nuxt): Respect user-provided source map generation settings #14020

s1gr1d commented Oct 18, 2024 •

edited

Loading

chargome left a comment

chargome Oct 18, 2024

s1gr1d Oct 18, 2024

chargome Oct 18, 2024

chargome Oct 18, 2024

s1gr1d Oct 18, 2024

chargome Oct 18, 2024

s1gr1d Oct 18, 2024

	* Setup source maps for Sentry inside the Nuxt module during build time (in Vite for Nuxt and Rollup for N itr/**
	* Setup source maps for Sentry inside the Nuxt module during build time (in Vite for Nuxt and Rollup for Nitro)


		const nitroSourcemap = nitroConfig.rollupConfig.output.sourcemap;

		if (nitroSourcemap === false) {

feat(nuxt): Respect user-provided source map generation settings #14020

feat(nuxt): Respect user-provided source map generation settings #14020

Conversation

s1gr1d commented Oct 18, 2024 • edited Loading

chargome left a comment

Choose a reason for hiding this comment

chargome Oct 18, 2024

Choose a reason for hiding this comment

s1gr1d Oct 18, 2024

Choose a reason for hiding this comment

chargome Oct 18, 2024

Choose a reason for hiding this comment

chargome Oct 18, 2024

Choose a reason for hiding this comment

s1gr1d Oct 18, 2024

Choose a reason for hiding this comment

chargome Oct 18, 2024

Choose a reason for hiding this comment

s1gr1d Oct 18, 2024

Choose a reason for hiding this comment

s1gr1d commented Oct 18, 2024 •

edited

Loading