Nuxt sourcemap vs. vite & nitro sourcemap

[dargmuesli]

Hey @s1gr1d, thank you for making the Nuxt SDK happen!

1. I'm wondering why the nuxtConfig.sourcemap option is not respected when it comes to sourcemap deletion, but the nitroConfig.rollupConfig.output.sourcemap option.

2. Also in feat(nuxt): Respect user-provided source map generation settings #14020 you mention that all 3 sourcemap options need to be set, I'm wondering why? I expected nuxtConfig.sourcemap to be enough, and not to set viteConfig.build.sourcemap and nitroConfig.rollupConfig.output.sourcemap.

3. What about nitroConfig.sourcemap then? Isn't it setting nitroConfig.rollupConfig.output.sourcemap?

4. Finally, why is viteConfig.build.sourcemap true in the default Nuxt configuration, even without setting nuxtConfig.sourcemap? I thought Nuxt's default is { "server": true, "client": false } and vite stems from client?

I've created a stackblitz to tinker with this: https://stackblitz.com/edit/github-rlsfchm3?file=nuxt.config.ts

Again, I would've expected that setting sourcemap: true in Nuxt's configuration to be enough. Instead my source files are being deleted as nitroConfig.rollupConfig.output.sourcemap is undefined regardless of the nuxtConfig.sourcemap setting. I'm confused.

[s1gr1d]

Hello, thanks for reaching out.

1. What makes you think the sourcemap option in the Nuxt config is not respected when it comes to sourcemap deletion? Can you provide an example here?

2. Users only have to set it in the sourcemap.client option (like the wizard does for you) as this is the one option that is set to false per default by Nuxt and we cannot know whether this comes from a user-setting or because Nuxt set it. But I just see that we don't document this in the Sentry Nuxt docs. I will add this to the docs. And we need to set the sourcemap option in all 3 configurations because not every configuration is generating all source maps. The rollup source maps e.g. generate the source maps only for the server-side.

3. and 4. I would have to check this out myself.

I agree that the source maps settings for Nuxt are a bit complicated as there are so many. However, we have to make sure that the SDK respects the user-settings but also generate "hidden" source-maps if there is nothing set. Nevertheless, the setup could be improved here. I will take a look at this again.

We would need to create some sort of options hierarchy to improve this. Like if someone sets sourcemap: true in the Nuxt options, the source map setting should not be overwritten with "hidden" by Sentry in Rollup or Vite (as it is still undefined there).

[dargmuesli]

Thank you for looking into this!

1. sentry-javascript/packages/nuxt/src/vite/sourceMaps.ts

   Line 238 in 9a9fb89

   const nitroSourceMap = nitroConfig.rollupConfig.output.sourcemap;

   
   this showed me that nitroConfig.rollupConfig.output.sourcemap is used for determining whether sourcemaps will be kept, but setting nuxtConfig.sourcemap = true leaves nitroConfig.rollupConfig.output.sourcemap undefined (which is then translated to 'hidden' so the Sentry module's *.map removal kicks in). Actually, what I think was meant to be used instead is nitroConfig.sourcemap as this seems to be influenced by nuxtConfig.sourcemap.server.
2. as far as I see nuxtConfig.sourcemap.client is an alias to viteConfig.build.sourcemap and nuxtConfig.sourcemap.server to nitroConfig.sourcemap (with nuxtConfig.sourcemap being a shorthand for both). Factoring in 1., I think viteConfig.build.sourcemap and nitroConfig.sourcemap should be only read to get the result, but the users shouldn't be instructed to set those variants in their nuxt config and instead only configure nuxtConfig.sourcemap. Maybe I can pull in @danielroe here shortly, for quick a quick confirmation on or correction of my understanding on this ecosystem question.
3. see 2.
4. it appears that in development (without setting nuxtConfig.sourcemap) nuxt.options.sourcemap is {"server":true,"client":true} and when building it's {"server":true,"client":false}, so I might've been confused while looking at the dev output.

[s1gr1d]

1. and 3. I created a PR that is basing the decision on other options (not only the nitroConfig.rollupCOnfig.output.sourcemap option): feat(nuxt): Base decision on source maps upload only on Nuxt source map settings #15859

2. As already mentioned, users only have to set sourcemap.client manually. Source maps on the server-side are enabled automatically by Nuxt

3. Vite runs through 2 times (you'll see 2 logs here). One time, it shows the option for the client and one time it shows the option for the server. You can also check this by logging viteConfig.define['import.meta.server'] or 'import.meta.client'. Or just by checking env which is passed as the second parameter of the lifecycle hook.