feat(nuxt): Improve logs about adding Node option 'import' #13726

s1gr1d · 2024-09-19T10:05:31Z

Adding the node option can be a confusing step. This adds a log output which already includes the correct file path to add. It looks like this:

[Sentry] Using your sentry.server.config.ts file for the server-side Sentry configuration. 
Make sure to add the Node option import to the Node command where you deploy and/or run your application. 
This preloads the Sentry configuration at server startup. You can do this via a 
command-line flag (node --import ./.output/server/sentry.server.config.mjs [...]) or via 
an environment variable (NODE_OPTIONS='--import ./.output/server/sentry.server.config.mjs' node [...]).

Lms24 · 2024-09-19T11:57:05Z

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

@@ -59,3 +59,29 @@ describe('findDefaultSdkInitFile', () => {
    expect(result).toBe('sentry.server.config.js');
  });
 });
+
+describe('getStringDiff', () => {


l:

Suggested change

describe('getStringDiff', () => {

describe('getStringSuffixDiff', () => {

Lms24 · 2024-09-19T11:58:44Z

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

+    expect(getStringSuffixDiff('', 'abc')).toBe('');
+  });
+
+  it('should return the suffix of the longer string when the shorter string is a prefix', () => {


l (no action required): what happens if the longer string is shorter (but not empty) that the shorter string param? 😅

Lms24 · 2024-09-19T11:59:57Z

packages/nuxt/src/module.ts

-              `[Sentry] Using your \`${serverConfigFile}\` file for the server-side Sentry configuration. In case you have a \`public/instrument.server\` file, the \`public/instrument.server\` file will be ignored. Make sure the file path in your node \`--import\` option matches the Sentry server config file in your \`.output\` folder and has a \`.mjs\` extension.`,
-            );
-          });
+            const serverConfigRelativePath = `.${getStringSuffixDiff(serverConfigPath, nitro.options.rootDir)}`;


no strong opinions but shouldn't path.relative basically do what you're trying to do here? (I might be missing something though)

Actually yes 😅

AbhiPrasad · 2024-09-19T12:22:02Z

packages/nuxt/src/module.ts

-            );
-          });
+            // For the default nitro node-preset build output this relative path would be: ./.output/server/sentry.server.config.mjs
+            const serverConfigRelativePath = `./${path.relative(nitro.options.rootDir, serverConfigPath)}`;


Let's use path.join instead of ./ as the / separator does not work in windows. In this case doesn't matter a ton, but always good to it consistent.

Good catch with windows! I could not use path.join in this case as this would not keep the folder name with the dot (.output). But I was able to achieve this with .${path.sep}${path.relative(...)}

# Conflicts: # packages/nuxt/src/module.ts

AbhiPrasad

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.30.0` -> `8.31.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.30.0/8.31.0) | | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.30.0` -> `8.31.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.30.0/8.31.0) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/node)</summary> ### [`v8.31.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8310) [Compare Source](getsentry/sentry-javascript@8.30.0...8.31.0) ##### Important Changes - **feat(node): Add `dataloader` integration ([#13664](getsentry/sentry-javascript#13664 This release adds a new integration for the [`dataloader` package](https://www.npmjs.com/package/dataloader). The Node SDK (and all SDKs that depend on it) will now automatically instrument `dataloader` instances. You can also add it manually: ```js Sentry.init({ integrations: [Sentry.dataloaderIntegration()], }); ``` ##### Other Changes - feat(browser): Add navigation `activationStart` timestamp to pageload span ([#13658](getsentry/sentry-javascript#13658)) - feat(gatsby): Add optional `deleteSourcemapsAfterUpload` ([#13610](getsentry/sentry-javascript#13610)) - feat(nextjs): Give app router prefetch requests a `http.server.prefetch` op ([#13600](getsentry/sentry-javascript#13600)) - feat(nextjs): Improve Next.js serverside span data quality ([#13652](getsentry/sentry-javascript#13652)) - feat(node): Add `disableInstrumentationWarnings` option ([#13693](getsentry/sentry-javascript#13693)) - feat(nuxt): Adding `experimental_basicServerTracing` option to Nuxt module ([#13643](getsentry/sentry-javascript#13643)) - feat(nuxt): Improve logs about adding Node option 'import' ([#13726](getsentry/sentry-javascript#13726)) - feat(replay): Add `onError` callback + other small improvements to debugging ([#13721](getsentry/sentry-javascript#13721)) - feat(replay): Add experimental option to allow for a checkout every 6 minutes ([#13069](getsentry/sentry-javascript#13069)) - feat(wasm): Unconditionally parse instruction addresses ([#13655](getsentry/sentry-javascript#13655)) - fix: Ensure all logs are wrapped with `consoleSandbox` ([#13690](getsentry/sentry-javascript#13690)) - fix(browser): Try multiple options for `lazyLoadIntegration` script parent element lookup ([#13717](getsentry/sentry-javascript#13717)) - fix(feedback): Actor color applies to feedback icon ([#13702](getsentry/sentry-javascript#13702)) - fix(feedback): Fix form width on mobile devices ([#13068](getsentry/sentry-javascript#13068)) - fix(nestjs): Preserve original function name on `SentryTraced` functions ([#13684](getsentry/sentry-javascript#13684)) - fix(node): Don't overwrite local variables for re-thrown errors ([#13644](getsentry/sentry-javascript#13644)) - fix(normalize): Treat Infinity as NaN both are non-serializable numbers ([#13406](getsentry/sentry-javascript#13406)) - fix(nuxt): Use correct server output file path ([#13725](getsentry/sentry-javascript#13725)) - fix(opentelemetry): Always use active span in `Propagator.inject` ([#13381](getsentry/sentry-javascript#13381)) - fix(replay): Fixes potential out-of-order segments ([#13609](getsentry/sentry-javascript#13609)) Work in this release was contributed by [@KyGuy2002](https://github.com/KyGuy2002), [@artzhookov](https://github.com/artzhookov), and [@julianCast](https://github.com/julianCast). Thank you for your contributions! </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/149 Reviewed-by: Alexandre Soro <[email protected]> Co-authored-by: renovate <[email protected]> Co-committed-by: renovate <[email protected]>

feat(nuxt): Improve logs about adding Node option 'import'

021077e

s1gr1d requested review from a team, Lms24 and AbhiPrasad and removed request for a team September 19, 2024 10:05

Lms24 reviewed Sep 19, 2024

View reviewed changes

Use path.relative

7a4b212

s1gr1d requested a review from Lms24 September 19, 2024 12:15

AbhiPrasad reviewed Sep 19, 2024

View reviewed changes

use path.sep instead of / (windows support)

4235d2a

s1gr1d requested a review from AbhiPrasad September 19, 2024 12:52

Merge branch 'refs/heads/develop' into sig/improve-console-messages

ecdc8eb

# Conflicts: # packages/nuxt/src/module.ts

AbhiPrasad approved these changes Sep 19, 2024

View reviewed changes

s1gr1d self-assigned this Sep 19, 2024

Lms24 approved these changes Sep 19, 2024

View reviewed changes

s1gr1d merged commit 336a236 into develop Sep 19, 2024
101 checks passed

s1gr1d deleted the sig/improve-console-messages branch September 19, 2024 15:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(nuxt): Improve logs about adding Node option 'import' #13726

feat(nuxt): Improve logs about adding Node option 'import' #13726

s1gr1d commented Sep 19, 2024

Lms24 Sep 19, 2024

Lms24 Sep 19, 2024

Lms24 Sep 19, 2024

s1gr1d Sep 19, 2024

AbhiPrasad Sep 19, 2024

s1gr1d Sep 19, 2024

AbhiPrasad left a comment

	describe('getStringDiff', () => {
	describe('getStringSuffixDiff', () => {

feat(nuxt): Improve logs about adding Node option 'import' #13726

feat(nuxt): Improve logs about adding Node option 'import' #13726

Conversation

s1gr1d commented Sep 19, 2024

Lms24 Sep 19, 2024

Choose a reason for hiding this comment

Lms24 Sep 19, 2024

Choose a reason for hiding this comment

Lms24 Sep 19, 2024

Choose a reason for hiding this comment

s1gr1d Sep 19, 2024

Choose a reason for hiding this comment

AbhiPrasad Sep 19, 2024

Choose a reason for hiding this comment

s1gr1d Sep 19, 2024

Choose a reason for hiding this comment

AbhiPrasad left a comment

Choose a reason for hiding this comment