sentry-vite-plugin: enable source mapping for Web Worker source files

[mattico]

I'm using vite and the sentryVitePlugin. My app uses web workers which are imported with new Worker(new URL('./workerLineStats.ts', import.meta.url), { type: 'module' });. Vite understands that and outputs workerLineStats-LjpNa9wZ.js and a .map file.

I'm using DebugIDs for the main app, but those don't work for the web worker files. The debug output from sentry-vite-plugin includes:

[sentry-vite-plugin] Debug: Could not determine debug ID from bundle. This can happen if you did not clean your output folder before installing the Sentry plugin. File will not be source mapped: /workspaces/data-portal/apps/frontend/build/assets/workers/OverallStats.worker-BPsL_pTV.js

Alternatively, uploadLegacySourcemaps could be used for the web worker files, but I'm having trouble making that work as well, see below.

---

Edit: generalized issue to the root problem of sourcemaps for workers in Vite, rather than the specific suggested fix of uploadLegacySourcemaps globs.

[chargome]

@mattico would generally just providing the asset path work for you?

uploadLegacySourcemaps: [
  'build/assets/'
]

[mattico]

@mattico would generally just providing the asset path work for you?

uploadLegacySourcemaps: [
  'build/assets/'
]

I suppose it would, though it would also upload dozens of unnecessary sourcemaps for all the files which have DebugIDs.

[Lms24]

Just jumping in here because we talked about this yesterday: The behaviour of the include entry (or just the string as in your case) for uploadLegacySourcemaps always was that users specify a directory and the plugin/sentry-cli would scan this directory, including sub-directories, for .map and .js files to process and upload (see doc here). So, in contrast to the newer assets option for debugIds, glob patterns were never supported (for better of for worse).

The problem with changing this is that it could break user setups that rely on the specific behaviour, so we're not yet sure if we want to do this.

In an effort to avoid this potential breakage: is there a way you could build just the worker into a specific sub directory that you can then point the plugin towards? I fully understand this isn't ideal for you and we usually don't want to tell you what to do. Just this case of combined debugID and legacy source maps upload, in the same directory, is a bit of an edge case (something, we admittedly didn't yet come across).

[mattico]

The problem with changing this is that it could break user setups that rely on the specific behaviour, so we're not yet sure if we want to do this.

Understandable. I'll be less prescriptive and let's refocus this issue on the root of the problem: sourcemaps for webworkers in Vite.

In an effort to avoid this potential breakage: is there a way you could build just the worker into a specific sub directory that you can then point the plugin towards? I fully understand this isn't ideal for you and we usually don't want to tell you what to do. Just this case of combined debugID and legacy source maps upload, in the same directory, is a bit of an edge case (something, we admittedly didn't yet come across).

I spent some time on this trying to modify Vite's build.rollupOptions, puzzling over why none of the worker files were processed by any of the hooks (assetFileNames, chunkFileNames, entryFileNames). Then I realized Vite has completely separate rollupOptions just for workers 🤦. This config does work to put all the workers output js/map files in a workers subdirectory:

  worker: {
    rollupOptions: {
      output: {
        entryFileNames: 'assets/workers/[name]-[hash].js',
      },
    }
  },

However I still ran into a snag with uploadLegacySourcemaps. I can't get it to actually upload any sourcemaps. Here's my configuration:

sentryVitePlugin({
  disable: false,
  org: 'beck-enterprises',
  project: 'data-portal-frontend',
  release: {
    // Uncomment these lines to test locally (with DP_RELEASE=1) without needing an auth token or creating a release
    create: false,
    finalize: false,
    name: `data-portal-frontend@${PACKAGE_VERSION}`,
    uploadLegacySourcemaps: [
      'build/assets/workers/',
      'build/assets/',
      'assets/',
      'assets/workers/',
      path.resolve(__dirname, './build/assets/workers/'),
      path.resolve(__dirname, './build/assets/'),
    ],
  },
  bundleSizeOptimizations: {
    excludeReplayShadowDom: true, // I don't think we have any custom elements/shadow dom
    excludeReplayIframe: true, // We don't have any iframes
  },
  debug: true,
}),

Am I missing something? I tried every path I could think of for the legacy source maps to make sure that wasn't the issue. No source maps are uploaded for any of the worker files, and the only mention of them in sentry-vite-plugin's output are the debugId messages:

[sentry-vite-plugin] Debug: Could not determine debug ID from bundle. This can happen if you did not clean your output folder before installing the Sentry plugin. File will not be source mapped: /workspaces/data-portal/apps/frontend/build/assets/workers/LineRenderer.worker-Dk-urqO_.js

---

Alternatively, perhaps sentry-vite-plugin could be changed to include DebugIDs in worker source files? Since vite processes worker files with a separate rollup invocation, maybe the sentry-vite-plugin needs to hook into that as well?