feat(nuxt): Adding `experimental_basicServerTracing` option to Nuxt module #13643

s1gr1d · 2024-09-10T09:31:00Z

Enabling this option will import the Sentry server config at the top of the server entry file. This can be used when adding the node option --import does not work. This however only comes with limited tracing functionality.

Example Usage:

export default defineNuxtConfig({
  sentry: {
    // ... other options
    experimental_basicServerTracing: true
  },
})

AbhiPrasad

should we add a note about this to the readme?

lforst · 2024-09-10T09:39:14Z

Example Usage:

export default defineNuxtConfig({
  sentry: {
    // ... other options
    simplifiedDeployment: true
  },
})

Correct me if I'm wrong but the way this option is defined here, it will not be properly typed and supported in the user's language server right?

Additionally, I would make the name a) a bit more dangerous sounding b) actually name it after what it does, because right now it sounds very good, even though it is a workaround. E.g. injectSentryConfigInServerBundleWorkaround <- this name obviously also sucks but it doesn't hide what it does from users.

github-actions · 2024-09-10T09:42:52Z

size-limit report 📦

Path	Size	% Change	Change
@sentry/browser	22.52 KB	-	-
@sentry/browser - with treeshaking flags	21.3 KB	-	-
@sentry/browser (incl. Tracing)	34.79 KB	-	-
@sentry/browser (incl. Tracing, Replay)	71.25 KB	-	-
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	61.69 KB	-	-
@sentry/browser (incl. Tracing, Replay with Canvas)	75.59 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback)	88.32 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)	90.16 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.75 KB	-	-
@sentry/vue	26.72 KB	-	-
@sentry/vue (incl. Tracing)	36.66 KB	-	-
@sentry/svelte	22.66 KB	-	-
CDN Bundle	23.77 KB	-	-
CDN Bundle (incl. Tracing)	36.49 KB	-	-
CDN Bundle (incl. Tracing, Replay)	70.95 KB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback)	76.26 KB	-	-
CDN Bundle - uncompressed	69.65 KB	-	-
CDN Bundle (incl. Tracing) - uncompressed	108.23 KB	-	-
CDN Bundle (incl. Tracing, Replay) - uncompressed	220.01 KB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	233.21 KB	-	-
@sentry/nextjs (client)	37.51 KB	-	-
@sentry/sveltekit (client)	35.36 KB	-	-
@sentry/node	120.5 KB	-0.01%	-1 B 🔽
@sentry/node - without tracing	92.78 KB	-	-
@sentry/aws-serverless	102.49 KB	-	-

View base workflow run

mydea · 2024-09-10T11:53:18Z

packages/nuxt/src/common/types.ts

+   *
+   * @default false
+   */
+  simplifiedDeployment?: boolean;


🧵 name bikeshedding :D

Some ideas:

basicTracingOnlyDeployment

noImportFlagDeployment

noImportFlagEnvironment

What do you think about a workaround_ prefix?

workaround_injectSentryConfigIntoServer

workaround_basicTracingWithServerConfigInject

I have no strong feelings either way! IMHO the question is, do we want to describe what the flag does, or when you need it? Describing what it does is obviously technically correct, but maybe makes it harder to understand when you would/should actually use this. I'll happily defer to you and other folks on the team about the name for this! We can also start with something like experimental_XXXX - we can still promote it to a non-experimental name later, if needed/wanted!

s1gr1d · 2024-09-10T11:55:24Z

will not be properly typed and supported in the user's language server right

@lforst This option is added to the module types and TS the language server picks that up

And I will change the name, wasn't so sure about it anyway so thanks for the suggestions 🙌

mydea · 2024-09-10T15:45:57Z

packages/nuxt/src/common/types.ts

+   *
+   * @default false
+   */
+  experimental_basicServerTracing?: boolean;


just a reminder to also update the PR title accordingly ;)

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): Adding simplifiedDeployment option to Nuxt module

709592f

s1gr1d requested review from Lms24 and andreiborza September 10, 2024 09:31

AbhiPrasad approved these changes Sep 10, 2024

View reviewed changes

mydea reviewed Sep 10, 2024

View reviewed changes

s1gr1d added 3 commits September 10, 2024 16:40

update readme with server setup

14a94e4

change option naming

8bd51f4

change option naming

5d80c8f

s1gr1d requested review from mydea and lforst September 10, 2024 15:20

Merge branch 'develop' into sig/nuxt-simplified-deploy

c03d616

mydea reviewed Sep 10, 2024

View reviewed changes

s1gr1d changed the title ~~feat(nuxt): Adding simplifiedDeployment option to Nuxt module~~ feat(nuxt): Adding experimental_basicServerTracing option to Nuxt module Sep 10, 2024

s1gr1d and others added 3 commits September 12, 2024 16:13

prettier fix

b997330

Merge branch 'develop' into sig/nuxt-simplified-deploy

cfdf1dd

Merge branch 'develop' into sig/nuxt-simplified-deploy

48eb052

s1gr1d enabled auto-merge (squash) September 13, 2024 07:35

s1gr1d merged commit df79871 into develop Sep 13, 2024
101 checks passed

s1gr1d deleted the sig/nuxt-simplified-deploy branch September 13, 2024 07:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(nuxt): Adding `experimental_basicServerTracing` option to Nuxt module #13643

feat(nuxt): Adding `experimental_basicServerTracing` option to Nuxt module #13643

s1gr1d commented Sep 10, 2024 •

edited

Loading

AbhiPrasad left a comment

lforst commented Sep 10, 2024 •

edited

Loading

github-actions bot commented Sep 10, 2024 •

edited

Loading

mydea Sep 10, 2024

s1gr1d Sep 10, 2024

mydea Sep 10, 2024

s1gr1d commented Sep 10, 2024

mydea Sep 10, 2024

feat(nuxt): Adding experimental_basicServerTracing option to Nuxt module #13643

feat(nuxt): Adding experimental_basicServerTracing option to Nuxt module #13643

Conversation

s1gr1d commented Sep 10, 2024 • edited Loading

AbhiPrasad left a comment

Choose a reason for hiding this comment

lforst commented Sep 10, 2024 • edited Loading

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

size-limit report 📦

mydea Sep 10, 2024

Choose a reason for hiding this comment

s1gr1d Sep 10, 2024

Choose a reason for hiding this comment

mydea Sep 10, 2024

Choose a reason for hiding this comment

s1gr1d commented Sep 10, 2024

mydea Sep 10, 2024

Choose a reason for hiding this comment

feat(nuxt): Adding `experimental_basicServerTracing` option to Nuxt module #13643

feat(nuxt): Adding `experimental_basicServerTracing` option to Nuxt module #13643

s1gr1d commented Sep 10, 2024 •

edited

Loading

lforst commented Sep 10, 2024 •

edited

Loading

github-actions bot commented Sep 10, 2024 •

edited

Loading