Nuxt module does not take into account "srcDir" for client instrumentation

[max-arias]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/nuxt

SDK Version

8.25.0

Framework Version

8.25.0

Link to Sentry event

No response

Reproduction Example/SDK Setup

No response

Steps to Reproduce

The Sentry module does not seem to take into account the srcDir config, it only uses the buildDir: https://github.com/getsentry/sentry-javascript/blob/master/packages/nuxt/src/module.ts#L30

The current work around is to create a client file both under your srcDir (ie. /src) and in your buildDir (ie /)

With the upcoming Nuxt 4 change where the src files will live in another dir, we should fix this

Expected Result

We should read sentry.client.config from the srcDir without needing a copy in the buildDir

Actual Result

rollup throws an error if there's nothing in "srcDir"

[s1gr1d]

Thanks for already testing the experimental Nuxt SDK and filing this! We will fix this, as we want to be compatible with Nuxt 4!

[s1gr1d]

A follow-up question @max-arias: Why would you want to add the config file in the src directory? Are there any issues with creating the Sentry config along with the Nuxt config in the root directory?

[max-arias]

@s1gr1d Yeah, if I try placing just sentry.client.config.ts at the root of my project, outside src I get a build error. This is after removing .nuxt/ and running a yarn install again.

ℹ Building client...                                                                                                                                                     10:38:17 AM
ℹ vite v5.4.0 building for production...                                                                                                                                 10:38:17 AM
[sentry-vite-plugin] Info: Sending telemetry data on issues and performance to Sentry. To disable telemetry, set `options.telemetry` to `false`.
ℹ ✓ 52 modules transformed.                                                                                                                                              10:38:18 AM

 ERROR  x Build failed in 1.15s                                                                                                                                           10:38:18 AM


[10:38:18 AM]  ERROR  Nuxt Build Error: [vite]: Rollup failed to resolve import "/sentry.client.config.ts" from "virtual:nuxt:/Users/<redacted>/dev/<redacted>/.nuxt/sentry-client-config.mjs".
This is most likely unintended because it can break your application at runtime.
If you do want to externalize this module explicitly add it to
build.rollupOptions.external

  This is most likely unintended because it can break your application at runtime.
  If you do want to externalize this module explicitly add it to
  build.rollupOptions.external
  at viteWarn (node_modules/vite/dist/node/chunks/dep-NjL7WTE1.js:65463:17)
  at onRollupWarning (node_modules/vite/dist/node/chunks/dep-NjL7WTE1.js:65495:5)
  at onwarn (node_modules/vite/dist/node/chunks/dep-NjL7WTE1.js:65158:7)
  at node_modules/rollup/dist/es/shared/node-entry.js:18625:13
  at Object.logger [as onLog] (node_modules/rollup/dist/es/shared/node-entry.js:20280:9)
  at ModuleLoader.handleInvalidResolvedId (node_modules/rollup/dist/es/shared/node-entry.js:19215:26)
  at node_modules/rollup/dist/es/shared/node-entry.js:19173:26

• If I place it just in src the the client is not initialized (it doesnt read the file)
• If I place in both I get no errors and the client is initialized, but it's a bit redundant 😅

[s1gr1d]

Thanks for clarifying, I'll take a look!

[s1gr1d]

Hy @max-arias this seems to be no issue anymore? 🤔

I just stumbled upon this still-open issue and modified the srcDir in the Nuxt config but I could not reproduce the build error. Does it still happen for you?

[XStarlink]

@s1gr1d Hello,

I had already tried installing Sentry this summer, and I encountered the issue mentioned here, along with others—it was too early.

Today I decided to try again, and now everything seems to be working except for a warning at the end of the build that says:

 WARN  [Sentry] An error occurred when trying to add the /Users/user/Code/app/sentry.server.config.ts file to the .output directory ENOENT: no such file or directory, access '/Users/user/Code/app/node_modules/.cache/nuxt/.nuxt/dist/server/sentry.server.config.mjs'           16:10:57

    at async Object.access (node:internal/fs/promises:605:10)
    at async node_modules/@sentry/nuxt/build/module/module.mjs:113:7
    at async build (node_modules/nuxt/dist/shared/nuxt.DQBGBwNc.mjs:7140:5)
    at async Object.run (node_modules/@nuxt/cli/dist/chunks/build.mjs:74:5)
    at async runCommand (node_modules/citty/dist/index.mjs:316:16)
    at async runCommand (node_modules/citty/dist/index.mjs:307:11)
    at async runMain (node_modules/citty/dist/index.mjs:445:7)

This strongly resembles of this issue.
However, after the build, when I check .output/server/sentry.server.config.mjs, the file does exist and is correctly populated by Sentry, it’s not the same as the one at the root of the project (which is expected, but just to confirm that it’s working).

So maybe there is a check for this file that happens too early in the script?

Thanks for your help!

[XStarlink]

@s1gr1d It looks like I was getting this warning only because I had debug: true in the Sentry.init of sentry.server.config.ts
I don’t see it anymore after setting debug: false, but maybe it’s still worth a quick look.

[s1gr1d]

Thanks for testing it and good to hear that it's working. I'll check the logging, this does not seem right.

edit: Fixed it with PR #15790

[github-actions]

A PR closing this issue has just been released 🚀

This issue was referenced by PR #15790, which was included in the 9.9.0 release.