[Nitro] Upload sourcemaps

[logaretm]

Since nitro involves a build step, we need to upload source maps via the Sentry rollup/vite plugins.

It should be similar to what we do already for Nuxt's SDK, except we would be only doing it for the server-side of things.

The process should integrate nicely with downstream SDK's that will use this like Nuxt's, including the checking for sourcemap settings conflicts set by the user.

Nitro Sourcemap setting <-> Rollup Sourcemap setting

This will probably mean we will do source map uploads in two steps, once for the server-side and have the downstream SDK upload any additional sourcemaps it needs to.

related to JS-142

[linear]

JS-1076

[MickL]

Nitro (v3) is now a Vite plugin, therefor for uploading sourcemaps @sentry/vite-plugin can be used:

vite.config.ts

import { defineConfig, loadEnv } from 'vite';
import { nitro } from 'nitro/vite';
import { sentryVitePlugin } from '@sentry/vite-plugin';

export default defineConfig(({ mode }) => {
  const env = loadEnv(mode, process.cwd(), '');

  return {
    plugins: [
      nitro(),
      sentryVitePlugin({
        org: env.SENTRY_ORG,
        project: env.SENTRY_PROJECT,
        authToken: env.SENTRY_AUTH_TOKEN,
      }),
    ],
  };
});

nitro.config.ts

import { defineNitroConfig } from 'nitro/config';

export default defineNitroConfig({
   sourcemap: true, // For Sentry
});

[logaretm]

Yep, we will need to figure out first our support plan for Nitro v2. Which wouldn't be solved in the same way, but for v3 we would piggyback on Vite hooks but we haven't explored any of that yet.

[MickL]

Personally I would suggest to not support Nitro v2. It is out for a lot of years and never had dedicated support. No need to make life hard IMO

The above code works perfectly fine in my Nitro v3 project btw. What would be cool tho, would be if there would be no need to manually read env file. Instead, a sentryNitroVitePlugin() wrapper could do this automatically and therefor provide a little better DX and cleaner code.