feat(nuxt): allow custom configuration files paths in Nuxt module by victorgarciaesgi · Pull Request #20650 · getsentry/sentry-javascript

victorgarciaesgi · 2026-05-04T12:51:46Z

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

If you've added code that should be tested, please add tests.
Ensure your code lints and the test suite passes (yarn lint) & (yarn test).
Link an issue if there is one related to your pull request. If no issue is linked, one will be auto-generated and linked.

Context

I work in a big monorepo with 60+ Nuxt apps.

To enable Sentry in all those apps, they use a shared configuration, handled by an internal "proxy" module.
Each app can just install and enable this module to share the same common configuration.

The problem is: with the official Sentry module, each app would have to declare its own:

sentry.client.config.ts
sentry.server.config.ts

Which isn't very convenient when we have 60+ apps to enable.

Basically in the "proxy" module, I wanted to do this:

setup(options, nuxt) {
     const {resolve} = createResolver(import.meta.url);

     await installModule('@sentry/nuxt/module', {
           configRootDir: resolve('./runtime'),
     });
}

Result

This PR adds configDir option to the Nuxt module, allowing more flexible configuration and avoid creating a sentry.**.config.ts for each app 👌

The module can now search in a custom directory path instead of the project root path.

I'm successfully running this change as a pnpm patch on my monorepo so I wanted to contribute it.

cursor · 2026-05-04T12:57:08Z

+
+    expect(result).toBe(expectedPath);
+    expect(resolvePathMock).toHaveBeenCalledWith('~/server-sentry-config.ts');
+  });


Feat PR lacks integration or E2E test coverage

Low Severity

This feat PR only includes unit tests for findDefaultSdkInitFile and a type test. Per project rules, feat PRs need at least one integration or E2E test to verify the full feature works end-to-end (e.g., that a custom config file is correctly picked up and wired through the Nuxt module setup).

^{Triggered by project rule: PR Review Guidelines for Cursor Bot}

^{Reviewed by Cursor Bugbot for commit b947a37. Configure here.}

This is a Nuxt module related change, I couln't find the need for an integration test

cursor · 2026-05-04T13:12:37Z

+        }
+      } catch {
+        // Fails silently as the file is optional
+      }


Custom server config paths skip critical server-side setup

High Severity

When a custom serverConfigFile path is provided that doesn't contain the substring .server.config (e.g. the documented example ~/server-sentry-config.ts), the guard at module.ts line 173 (serverConfigFile?.includes('.server.config')) evaluates to false. This silently skips all critical server-side setup: addServerConfigToBuild, addSentryTopImport, and addDynamicImportEntryFileWrapper. The server SDK will register plugins but never actually load the config file, making autoInjectServerSentry non-functional for custom-named config files.

Additional Locations (1)

packages/nuxt/src/common/types.ts#L240-L255

^{Reviewed by Cursor Bugbot for commit 490c666. Configure here.}

s1gr1d

Thanks for this contribution!

Just a general question: how does your setup look like? Because in case you are using Nuxt layers, a shared config already works.

s1gr1d · 2026-05-04T13:30:41Z

+   * }
+   * ```
+   */
+  clientConfigFile?: string;


What do you think about adding clientConfigPath and serverConfigPath?
So you can provide a specific pathname to a folder where the SDK will look for the config.

Yep that seems better i'll change it 👍
I've not handled the case of a folder path, could a single configRootDir: string work better? That way it works for both client and server

True, that would be even better. You could call it configDir. The root part is a bit misleading as it's just a simple path for where we can find the config.

@s1gr1d I implemented the single configRootDir, which is much simpler to use & implement 👍

Sorry didn't see your comment, renamed it 👌

victorgarciaesgi · 2026-05-04T13:48:55Z

Hey @s1gr1d thanks for the fast response!

We're not using layers yet, our structure basically looks like this:

app-1/
app-2/
lib-nuxt/
├─ internal-sentry-module/

app-1 would declare "internal-sentry-module": "workspace:*" in its package.json.
Then a common Nuxt config declares the sentry module.

Co-authored-by: Sigrid <32902192+s1gr1d@users.noreply.github.com>

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

There are 3 total unresolved issues (including 2 from previous reviews).

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 207be84. Configure here.}

Co-authored-by: Sigrid <32902192+s1gr1d@users.noreply.github.com>

victorgarciaesgi · 2026-05-05T13:21:40Z

Suggestions applied 👌

Co-authored-by: Sigrid <32902192+s1gr1d@users.noreply.github.com>

sentry · 2026-05-06T13:29:55Z

  }

  // As a fallback, also check CWD (left for pure compatibility)
-  const cwd = process.cwd();
+  const rootDir = options?.configDir ? await resolvePath(options.configDir, { type: 'dir' }) : process.cwd();
  for (const relativePath of relativePaths) {
-    const fullPath = path.resolve(cwd, relativePath);
+    const fullPath = path.resolve(rootDir, relativePath);
    if (fs.existsSync(fullPath)) {


Bug: The configDir option is only used as a fallback. If a Sentry config file exists in the project root (a default Nuxt layer), the configDir is silently ignored.
_{Severity: MEDIUM}

Suggested Fix

Prioritize the configDir if it is provided. Before iterating through Nuxt layers, check if options.configDir is set. If it is, search for the configuration file exclusively within that directory. The layer-based search should only be used as a fallback when configDir is not specified.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: packages/nuxt/src/vite/utils.ts#L59-L65 Potential issue: The logic for finding the Sentry SDK init file prioritizes searching through all Nuxt layers before considering the `configDir` option. In a standard Nuxt application, the project root is one of the layers. Consequently, if a `sentry.client.config.ts` or `sentry.server.config.ts` file is present in the project root, it will be used, and the path specified in `configDir` will be silently ignored. This contradicts the documented behavior that `configDir` should replace the default lookup location, leading to unexpected configuration being loaded. The fallback comment 'As a fallback, also check CWD' confirms this last-resort implementation.

victorgarciaesgi added 2 commits May 4, 2026 14:40

feat(nuxt): allow custom configuration files paths in Nuxt module

37cb8d6

chore: format

b947a37

victorgarciaesgi requested a review from a team as a code owner May 4, 2026 12:51

sentry Bot reviewed May 4, 2026

View reviewed changes

Comment thread packages/nuxt/src/module.ts

cursor Bot reviewed May 4, 2026

View reviewed changes

victorgarciaesgi added 2 commits May 4, 2026 15:07

chore: fix lint

490c666

chore: throw Error if provided path is not found

ef02bd4

cursor Bot reviewed May 4, 2026

View reviewed changes

sentry Bot reviewed May 4, 2026

View reviewed changes

Comment thread packages/nuxt/src/vite/utils.ts Outdated

cursor Bot reviewed May 4, 2026

View reviewed changes

Comment thread packages/nuxt/src/vite/utils.ts Outdated

chore: clean duplicated Error thrown

48ded16

s1gr1d reviewed May 4, 2026

View reviewed changes

victorgarciaesgi and others added 2 commits May 4, 2026 15:50

Update packages/nuxt/src/common/types.ts

fead18f

Co-authored-by: Sigrid <32902192+s1gr1d@users.noreply.github.com>

feat: replaced with configRootDir

c1ed6c9

sentry Bot reviewed May 4, 2026

View reviewed changes

Comment thread packages/nuxt/src/vite/utils.ts Outdated

chore: ajusted description

207be84

sentry Bot reviewed May 4, 2026

View reviewed changes

Comment thread packages/nuxt/src/vite/utils.ts Outdated

cursor Bot reviewed May 4, 2026

View reviewed changes

Comment thread packages/nuxt/src/vite/utils.ts Outdated

victorgarciaesgi and others added 4 commits May 4, 2026 19:33

use resolveAlias instead of resolvePath

4e4b30e

fix: added missing type: 'dir'

b2e0bf3

fix: renamed config configDir

d0dc685

Merge branch 'develop' into develop

6fc8f2a

s1gr1d reviewed May 5, 2026

View reviewed changes

Comment thread packages/nuxt/src/vite/utils.ts Outdated

Comment thread packages/nuxt/src/common/types.ts Outdated

Comment thread packages/nuxt/src/common/types.ts Outdated

Comment thread packages/nuxt/src/common/types.ts Outdated

victorgarciaesgi and others added 2 commits May 5, 2026 15:20

Update packages/nuxt/src/common/types.ts

92ef57d

Co-authored-by: Sigrid <32902192+s1gr1d@users.noreply.github.com>

chore: applied suggestions

134c385

victorgarciaesgi and others added 2 commits May 6, 2026 15:24

Merge branch 'develop' into develop

3cadbd5

Apply suggestions from code review

b49a967

Co-authored-by: Sigrid <32902192+s1gr1d@users.noreply.github.com>

sentry Bot reviewed May 6, 2026

View reviewed changes

Uh oh!

Conversation

victorgarciaesgi commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Result

Uh oh!

Uh oh!

Uh oh!

cursor Bot May 4, 2026

Choose a reason for hiding this comment

Feat PR lacks integration or E2E test coverage

Uh oh!

victorgarciaesgi May 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cursor Bot May 4, 2026

Choose a reason for hiding this comment

Custom server config paths skip critical server-side setup

Uh oh!

Uh oh!

Uh oh!

s1gr1d left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

s1gr1d May 4, 2026

Choose a reason for hiding this comment

Uh oh!

victorgarciaesgi May 4, 2026

Choose a reason for hiding this comment

Uh oh!

s1gr1d May 4, 2026

Choose a reason for hiding this comment

Uh oh!

victorgarciaesgi May 4, 2026

Choose a reason for hiding this comment

Uh oh!

victorgarciaesgi May 4, 2026

Choose a reason for hiding this comment

Uh oh!

victorgarciaesgi commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

victorgarciaesgi commented May 5, 2026

Uh oh!

sentry Bot May 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

victorgarciaesgi commented May 4, 2026 •

edited

Loading

victorgarciaesgi commented May 4, 2026 •

edited

Loading