feat(nuxt): Add server config to root folder #13583

s1gr1d · 2024-09-04T10:10:14Z

This is a draft PR as this approach leads to an error as hook.mjs is not included in the node_modules. This has been fixed upstream but was not yet released for nuxt.

Makes it possible to include a sentry.server.config.ts file in the root folder alongside sentry.client.config.ts. Currently, it has to be added in the public folder which is not 100% ideal.

github-actions · 2024-09-04T10:14:15Z

size-limit report 📦

⚠️ Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.

Path	Size	% Change	Change
@sentry/browser	22.52 KB	-	-
@sentry/browser - with treeshaking flags	21.3 KB	-	-
@sentry/browser (incl. Tracing)	34.78 KB	-	-
@sentry/browser (incl. Tracing, Replay)	71.23 KB	-	-
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	61.67 KB	-	-
@sentry/browser (incl. Tracing, Replay with Canvas)	75.57 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback)	88.3 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)	90.14 KB	-	-
@sentry/browser (incl. metrics)	26.83 KB	-	-
@sentry/browser (incl. Feedback)	39.6 KB	-	-
@sentry/browser (incl. sendFeedback)	27.19 KB	-	-
@sentry/browser (incl. FeedbackAsync)	31.9 KB	-	-
@sentry/react	25.28 KB	-	-
@sentry/react (incl. Tracing)	37.74 KB	-	-
@sentry/vue	26.67 KB	-	-
@sentry/vue (incl. Tracing)	36.61 KB	-	-
@sentry/svelte	22.65 KB	-	-
CDN Bundle	23.77 KB	-	-
CDN Bundle (incl. Tracing)	36.49 KB	-	-
CDN Bundle (incl. Tracing, Replay)	70.91 KB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback)	76.22 KB	-	-
CDN Bundle - uncompressed	69.63 KB	-	-
CDN Bundle (incl. Tracing) - uncompressed	108.21 KB	-	-
CDN Bundle (incl. Tracing, Replay) - uncompressed	219.87 KB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	233.07 KB	-	-
@sentry/nextjs (client)	37.51 KB	-	-
@sentry/sveltekit (client)	35.35 KB	-	-
@sentry/node	126.36 KB	+1.11%	+1.38 KB 🔺
@sentry/node - without tracing	98.84 KB	+3.5%	+3.34 KB 🔺
@sentry/aws-serverless	109.1 KB	+1.48%	+1.58 KB 🔺

View base workflow run

nandi95 · 2024-09-06T11:52:24Z

This indeed would be helpful as I have a project which a merge of a laravel a nuxt project. Nuxt project is in the folder nuxt and I have the srcDir in the nuxt config set. This module should respect that and the rootDir configuration of nuxt.

sentry-javascript/packages/nuxt/src/module.ts

Line 76 in a8e5f59

? path.join(cwd, 'public', `instrument.${type}.${e}`)

This indeed

s1gr1d · 2024-09-06T14:14:53Z

@nandi95 If I understand you correctly, you are defining a curstom rootDir in the nuxt config?

nandi95 · 2024-09-06T15:44:02Z

I only meant to say that I define a srcDir so it's not the default expected nuxt directory structure.
And remind that there's also a rootDir option.
This will especially be importent when nuxt 4 comes out and has a different folder structure.

andreiborza · 2024-09-08T23:51:23Z

packages/nuxt/src/vite/addServerConfig.ts

+  if (moduleOptions.debug) {
+    // eslint-disable-next-line no-console
+    console.log(
+      '[Sentry] Using your `sentry.server.config` file for the server-side Sentry configuration. In case you have a `public/instrument.server` file, it will be ignored.',


(...) it will be ignored

This reads a bit confusing, which of the two files are being ignored?

I think we could check here for the existence of the file and log explicitly if that file is getting ignored, wdyt?

Also, we are ignoring the public file here but users will still potentially --import it. This log makes it sound like it's completely ignored.

I think this log should be split up.

1st part (public): can we log a warning if we detect the file in public instead of the first part of this message? Otherwise, I don't think we need to bother users with it, right?

To the second part: Can we instead print the exact import command? Something like

"Make sure to add --import ./.output/sentry.server.config.mjs to your NODE_OPTIONS env variable"

andreiborza · 2024-09-08T23:55:57Z

packages/nuxt/src/vite/addServerConfig.ts

+        if (moduleOptions.debug) {
+          // eslint-disable-next-line no-console
+          console.log(
+            '[Sentry] Successfully added the content of the `sentry.server.config` file as `instrument-sentry.mjs` to the `.output/server` directory',


l: Maybe we can use destination here?

packages/nuxt/src/module.ts

Lms24

Nice work! Other than the console log, this looks good to me!

We can follow up with the e2e tests after this is merged, given we hit some road blocks there

Lms24 · 2024-09-09T08:22:55Z

packages/nuxt/test/vite/utils.test.ts

+  it('should return the server file with .ts extension if it exists', () => {
+    vi.spyOn(fs, 'existsSync').mockImplementation(filePath => {
+      return !(filePath instanceof URL) && filePath.includes('sentry.server.config.ts');
+    });
+
+    const result = findDefaultSdkInitFile('server');
+    expect(result).toBe('sentry.server.config.ts');
+  });
+
+  it('should return the client file with .mjs extension if it exists', () => {
+    vi.spyOn(fs, 'existsSync').mockImplementation(filePath => {
+      return !(filePath instanceof URL) && filePath.includes('sentry.client.config.mjs');
+    });
+
+    const result = findDefaultSdkInitFile('client');
+    expect(result).toBe('sentry.client.config.mjs');
+  });


l: For some test extra credit (feel free to disregard) - we could use an it.each to test against all file types we search for.

wanderowski · 2024-09-10T05:01:33Z

Hello! Thank you for the work you have done!

Could you please clarify, should we somehow modify the command for running the project on server in package.json? I see that now we can put sentry.server.config.ts in the root folder, but did not find any instructions on how to modify starting command. Previously, it was required to paste this:

{
  "scripts": {
    "preview": "NODE_OPTIONS='--import ./public/instrument.server.mjs' nuxt preview",
    "start": "node --import .output/public/instrument.server.mjs .output/server/index.mjs"
  }
}

If i put my config file in the root folder and deleted instrument.server.mjs from public folder, should I modify these commands as well?

s1gr1d · 2024-09-10T09:13:14Z

@wanderowski This PR is not released yet and more elaborate docs on this are still coming for the official docs page.

The file can be added like this:

"start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",

As it only affects the server, it can only be added to the start script. The preview script attempts to load data from the .nuxt folder as well and this would not work. It worked with the public folder as this folder is the same during development and in production.

However, it could be that your environment variables from the .env file are not yet loaded. You can explicitly include them with --env-file=.env (like described here).

wanderowski · 2024-09-10T10:47:00Z

@s1gr1d Thanks!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.26.0` -> `8.30.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.26.0/8.30.0) | | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.26.0` -> `8.30.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.26.0/8.30.0) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/node)</summary> ### [`v8.30.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8300) [Compare Source](getsentry/sentry-javascript@8.29.0...8.30.0) ##### Important Changes - *feat(node): Add `kafkajs` integration ([#13528](getsentry/sentry-javascript#13528 This release adds a new integration that instruments `kafkajs` library with spans and traces. This integration is automatically enabled by default, but can be included with the `Sentry.kafkaIntegration()` import. ```js Sentry.init({ integrations: [Sentry.kafkaIntegration()], }); ``` ##### Other Changes - feat(core): Allow adding measurements without global client ([#13612](getsentry/sentry-javascript#13612)) - feat(deps): Bump [@opentelemetry/instrumentation-undici](https://github.com/opentelemetry/instrumentation-undici) from 0.5.0 to 0.6.0 ([#13622](getsentry/sentry-javascript#13622)) - feat(deps): Bump [@sentry/cli](https://github.com/sentry/cli) from 2.33.0 to 2.35.0 ([#13624](getsentry/sentry-javascript#13624)) - feat(node): Use `@opentelemetry/instrumentation-undici` for fetch tracing ([#13485](getsentry/sentry-javascript#13485)) - feat(nuxt): Add server config to root folder ([#13583](getsentry/sentry-javascript#13583)) - feat(otel): Upgrade [@opentelemetry/semantic-conventions](https://github.com/opentelemetry/semantic-conventions) to 1.26.0 ([#13631](getsentry/sentry-javascript#13631)) - fix(browser): check supportedEntryTypes before caling the function ([#13541](getsentry/sentry-javascript#13541)) - fix(browser): Ensure Standalone CLS span timestamps are correct ([#13649](getsentry/sentry-javascript#13649)) - fix(nextjs): Widen removal of 404 transactions ([#13628](getsentry/sentry-javascript#13628)) - fix(node): Remove ambiguity and race conditions when matching local variables to exceptions ([#13501](getsentry/sentry-javascript#13501)) - fix(node): Update OpenTelemetry instrumentation package for solidstart and opentelemetry ([#13640](getsentry/sentry-javascript#13640)) - fix(node): Update OpenTelemetry instrumentation package for solidstart and opentelemetry ([#13642](getsentry/sentry-javascript#13642)) - fix(vue): Ensure Vue `trackComponents` list matches components with or without `<>` ([#13543](getsentry/sentry-javascript#13543)) - ref(profiling): Conditionally shim cjs globals ([#13267](getsentry/sentry-javascript#13267)) Work in this release was contributed by [@Zen-cronic](https://github.com/Zen-cronic) and [@odanado](https://github.com/odanado). Thank you for your contributions! ### [`v8.29.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8290) [Compare Source](getsentry/sentry-javascript@8.28.0...8.29.0) ##### Important Changes - **Beta releases of official Solid and SolidStart Sentry SDKs** This release marks the beta releases of the `@sentry/solid` and `@sentry/solidstart` Sentry SDKs. For details on how to use them, check out the [Sentry Solid SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/solid) and the [Sentry SolidStart SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/solidstart) respectively. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns. - **feat(node): Option to only wrap instrumented modules ([#13139](getsentry/sentry-javascript#13139 Adds the SDK option to only wrap ES modules with `import-in-the-middle` that specifically need to be instrumented. ```javascript import * as Sentry from '@sentry/node'; Sentry.init({ dsn: '__PUBLIC_DSN__', registerEsmLoaderHooks: { onlyIncludeInstrumentedModules: true }, }); ``` - **feat(node): Update OpenTelemetry packages to instrumentation v0.53.0 ([#13587](getsentry/sentry-javascript#13587 All internal OpenTelemetry instrumentation was updated to their latest version. This adds support for Mongoose v7 and v8 and fixes various bugs related to ESM mode. ##### Other Changes - feat(nextjs): Emit warning when using turbopack ([#13566](getsentry/sentry-javascript#13566)) - feat(nextjs): Future-proof Next.js config options overriding ([#13586](getsentry/sentry-javascript#13586)) - feat(node): Add `generic-pool` integration ([#13465](getsentry/sentry-javascript#13465)) - feat(nuxt): Upload sourcemaps generated by Nitro ([#13382](getsentry/sentry-javascript#13382)) - feat(solidstart): Add `browserTracingIntegration` by default ([#13561](getsentry/sentry-javascript#13561)) - feat(solidstart): Add `sentrySolidStartVite` plugin to simplify source maps upload ([#13493](getsentry/sentry-javascript#13493)) - feat(vue): Only start UI spans if parent is available ([#13568](getsentry/sentry-javascript#13568)) - fix(cloudflare): Guard `context.waitUntil` call in request handler ([#13549](getsentry/sentry-javascript#13549)) - fix(gatsby): Fix assets path for sourcemaps upload ([#13592](getsentry/sentry-javascript#13592)) - fix(nextjs): Use posix paths for sourcemap uploads ([#13603](getsentry/sentry-javascript#13603)) - fix(node-fetch): Use stringified origin url ([#13581](getsentry/sentry-javascript#13581)) - fix(node): Replace dashes in `generic-pool` span origins with underscores ([#13579](getsentry/sentry-javascript#13579)) - fix(replay): Fix types in WebVitalData ([#13573](getsentry/sentry-javascript#13573)) - fix(replay): Improve replay web vital types ([#13602](getsentry/sentry-javascript#13602)) - fix(utils): Keep logger on carrier ([#13570](getsentry/sentry-javascript#13570)) Work in this release was contributed by [@Zen-cronic](https://github.com/Zen-cronic). Thank you for your contribution! ### [`v8.28.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8280) [Compare Source](getsentry/sentry-javascript@8.27.0...8.28.0) ##### Important Changes - **Beta release of official NestJS SDK** This release contains the beta version of `@sentry/nestjs`! For details on how to use it, check out the [README](https://github.com/getsentry/sentry-javascript/blob/master/packages/nestjs/README.md). Any feedback/bug reports are greatly appreciated, please reach out on GitHub. - **fix(browser): Remove faulty LCP, FCP and FP normalization logic ([#13502](getsentry/sentry-javascript#13502 This release fixes a bug in the `@sentry/browser` package and all SDKs depending on this package (e.g. `@sentry/react` or `@sentry/nextjs`) that caused the SDK to send incorrect web vital values for the LCP, FCP and FP vitals. The SDK previously incorrectly processed the original values as they were reported from the browser. When updating your SDK to this version, you might experience an increase in LCP, FCP and FP values, which potentially leads to a decrease in your performance score in the Web Vitals Insights module in Sentry. This is because the previously reported values were smaller than the actually measured values. We apologize for the inconvenience! ##### Other Changes - feat(nestjs): Add `SentryGlobalGraphQLFilter` ([#13545](getsentry/sentry-javascript#13545)) - feat(nestjs): Automatic instrumentation of nestjs interceptors after route execution ([#13264](getsentry/sentry-javascript#13264)) - feat(nextjs): Add `bundleSizeOptimizations` to build options ([#13323](getsentry/sentry-javascript#13323)) - feat(nextjs): Stabilize `captureRequestError` ([#13550](getsentry/sentry-javascript#13550)) - feat(nuxt): Wrap config in nuxt context ([#13457](getsentry/sentry-javascript#13457)) - feat(profiling): Expose profiler as top level primitive ([#13512](getsentry/sentry-javascript#13512)) - feat(replay): Add layout shift to CLS replay data ([#13386](getsentry/sentry-javascript#13386)) - feat(replay): Upgrade rrweb packages to 2.26.0 ([#13483](getsentry/sentry-javascript#13483)) - fix(cdn): Do not mangle \_metadata ([#13426](getsentry/sentry-javascript#13426)) - fix(cdn): Fix SDK source for CDN bundles ([#13475](getsentry/sentry-javascript#13475)) - fix(nestjs): Check arguments before instrumenting with `@Injectable` ([#13544](getsentry/sentry-javascript#13544)) - fix(nestjs): Ensure exception and host are correctly passed on when using [@WithSentry](https://github.com/WithSentry) ([#13564](getsentry/sentry-javascript#13564)) - fix(node): Suppress tracing for transport request execution rather than transport creation ([#13491](getsentry/sentry-javascript#13491)) - fix(replay): Consider more things as DOM mutations for dead clicks ([#13518](getsentry/sentry-javascript#13518)) - fix(vue): Correctly obtain component name ([#13484](getsentry/sentry-javascript#13484)) Work in this release was contributed by [@leopoldkristjansson](https://github.com/leopoldkristjansson), [@mhuggins](https://github.com/mhuggins) and [@filips123](https://github.com/filips123). Thank you for your contributions! ### [`v8.27.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8270) [Compare Source](getsentry/sentry-javascript@8.26.0...8.27.0) ##### Important Changes - **fix(nestjs): Exception filters in main app module are not being executed ([#13278](getsentry/sentry-javascript#13278 With this release nestjs error monitoring is no longer automatically set up after adding the `SentryModule` to your application, which led to issues in certain scenarios. You will now have to either add the `SentryGlobalFilter` to your main module providers or decorate the `catch()` method in your existing global exception filters with the newly released `@WithSentry()` decorator. See the [docs](https://docs.sentry.io/platforms/javascript/guides/nestjs/) for more details. ##### Other Changes - feat: Add options for passing nonces to feedback integration ([#13347](getsentry/sentry-javascript#13347)) - feat: Add support for SENTRY_SPOTLIGHT env var in Node ([#13325](getsentry/sentry-javascript#13325)) - feat(deps): bump [@prisma/instrumentation](https://github.com/prisma/instrumentation) from 5.17.0 to 5.18.0 ([#13327](getsentry/sentry-javascript#13327)) - feat(feedback): Improve error message for 403 errors ([#13441](getsentry/sentry-javascript#13441)) - fix(deno): Don't rely on `Deno.permissions.querySync` ([#13378](getsentry/sentry-javascript#13378)) - fix(replay): Ensure we publish replay CDN bundles ([#13437](getsentry/sentry-javascript#13437)) Work in this release was contributed by [@charpeni](https://github.com/charpeni). Thank you for your contribution! </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/61 Reviewed-by: Alexandre Soro <[email protected]> Co-authored-by: renovate <[email protected]> Co-committed-by: renovate <[email protected]>

s1gr1d mentioned this pull request Sep 4, 2024

Nuxt SDK #9095

Open

s1gr1d added the Package: nuxt Issues related to the Sentry Nuxt SDK label Sep 4, 2024

feat(nuxt): Add server config to root folder

ea95e37

s1gr1d force-pushed the sig/server-config-nuxt branch from 6cd63cb to ea95e37 Compare September 5, 2024 11:42

s1gr1d added 2 commits September 6, 2024 14:05

Merge branch 'refs/heads/develop' into sig/server-config-nuxt

7671bd9

use public file method in e2e test

ae6d51c

s1gr1d marked this pull request as ready for review September 6, 2024 14:12

Merge branch 'develop' into sig/server-config-nuxt

d21dac2

s1gr1d requested a review from Lms24 September 6, 2024 14:14

andreiborza reviewed Sep 9, 2024

View reviewed changes

review comments: refine console logs

16ef5ac

s1gr1d requested a review from andreiborza September 9, 2024 07:42

andreiborza approved these changes Sep 9, 2024

View reviewed changes

change filename to sentry.server.config.mjs

5a72b0b

andreiborza reviewed Sep 9, 2024

View reviewed changes

packages/nuxt/src/module.ts Show resolved Hide resolved

Lms24 approved these changes Sep 9, 2024

View reviewed changes

s1gr1d and others added 2 commits September 9, 2024 10:30

create it.each test

2be97af

Merge branch 'develop' into sig/server-config-nuxt

e6a78fb

s1gr1d merged commit 45156d2 into develop Sep 9, 2024
102 checks passed

s1gr1d deleted the sig/server-config-nuxt branch September 9, 2024 10:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(nuxt): Add server config to root folder #13583

feat(nuxt): Add server config to root folder #13583

s1gr1d commented Sep 4, 2024

github-actions bot commented Sep 4, 2024 •

edited

Loading

nandi95 commented Sep 6, 2024

s1gr1d commented Sep 6, 2024

nandi95 commented Sep 6, 2024

andreiborza Sep 8, 2024

Lms24 Sep 9, 2024 •

edited

Loading

andreiborza Sep 8, 2024

Lms24 left a comment

Lms24 Sep 9, 2024

wanderowski commented Sep 10, 2024

s1gr1d commented Sep 10, 2024 •

edited

Loading

wanderowski commented Sep 10, 2024

feat(nuxt): Add server config to root folder #13583

feat(nuxt): Add server config to root folder #13583

Conversation

s1gr1d commented Sep 4, 2024

github-actions bot commented Sep 4, 2024 • edited Loading

size-limit report 📦

nandi95 commented Sep 6, 2024

s1gr1d commented Sep 6, 2024

nandi95 commented Sep 6, 2024

andreiborza Sep 8, 2024

Choose a reason for hiding this comment

Lms24 Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

andreiborza Sep 8, 2024

Choose a reason for hiding this comment

Lms24 left a comment

Choose a reason for hiding this comment

Lms24 Sep 9, 2024

Choose a reason for hiding this comment

wanderowski commented Sep 10, 2024

s1gr1d commented Sep 10, 2024 • edited Loading

wanderowski commented Sep 10, 2024

github-actions bot commented Sep 4, 2024 •

edited

Loading

Lms24 Sep 9, 2024 •

edited

Loading

s1gr1d commented Sep 10, 2024 •

edited

Loading