feat(nuxt): Make dynamic import() wrapping default #13958

s1gr1d · 2024-10-11T12:50:05Z

BREAKING CHANGE: The --import flag must not be added anymore. If it is still set, the server-side will be initialized twice and this leads to unexpected errors.

First merge this: #13945
Part of this: #13943

This PR makes it the default to include a rollup plugin that wraps the server entry file with a dynamic import (import()). This is a replacement for the node --import CLI flag.

If you still want to manually add the CLI flag you can use this option in the nuxt.config.ts file:

  sentry: {
    dynamicImportForServerEntry: false,
  }

(option name is up for discussion)

codecov · 2024-10-11T12:59:36Z

❌ 5 Tests Failed:

Tests completed	Failed	Passed	Skipped
636	5	631	28

View the top 3 failed tests by shortest run time

tracing.server.test.ts does not send transactions for build asset folder &quot;_nuxt&quot;

Stack Traces | 30s run time

tracing.server.test.ts:24:1 does not send transactions for build asset folder &quot;_nuxt&quot;

tracing.server.test.ts sends a server action transaction on pageload

Stack Traces | 30s run time

tracing.server.test.ts:5:1 sends a server action transaction on pageload

tracing.test.ts distributed tracing › capture a distributed pageload trace

Stack Traces | 30s run time

tracing.test.ts:7:3 capture a distributed pageload trace

To view individual test run time comparison to the main branch, go to the Test Analytics Dashboard

github-actions · 2024-10-11T13:54:05Z

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.73 KB	-	-
@sentry/browser - with treeshaking flags	21.53 KB	-	-
@sentry/browser (incl. Tracing)	35.12 KB	-	-
@sentry/browser (incl. Tracing, Replay)	71.83 KB	-	-
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	62.23 KB	-	-
@sentry/browser (incl. Tracing, Replay with Canvas)	76.19 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback)	88.97 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)	90.8 KB	-	-
@sentry/browser (incl. metrics)	27 KB	-	-
@sentry/browser (incl. Feedback)	39.87 KB	-	-
@sentry/browser (incl. sendFeedback)	27.38 KB	-	-
@sentry/browser (incl. FeedbackAsync)	32.17 KB	-	-
@sentry/react	25.49 KB	-	-
@sentry/react (incl. Tracing)	38.09 KB	-	-
@sentry/vue	26.91 KB	-	-
@sentry/vue (incl. Tracing)	37.02 KB	-	-
@sentry/svelte	22.87 KB	-	-
CDN Bundle	24.11 KB	-	-
CDN Bundle (incl. Tracing)	36.96 KB	-	-
CDN Bundle (incl. Tracing, Replay)	71.62 KB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback)	76.96 KB	-	-
CDN Bundle - uncompressed	70.7 KB	-	-
CDN Bundle (incl. Tracing) - uncompressed	109.73 KB	-	-
CDN Bundle (incl. Tracing, Replay) - uncompressed	222.17 KB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	235.38 KB	-	-
@sentry/nextjs (client)	38.06 KB	-	-
@sentry/sveltekit (client)	35.74 KB	-	-
@sentry/node	125.15 KB	-	-
@sentry/node - without tracing	94.25 KB	-	-
@sentry/aws-serverless	103.81 KB	-	-

View base workflow run

darthf1 · 2024-10-11T17:14:03Z

packages/nuxt/src/common/types.ts

-   * Enabling basic server tracing can be used for environments where modifying the node option `--import` is not possible.
-   * However, enabling this option only supports limited tracing instrumentation. Only http traces will be collected (but no database-specific traces etc.).
+   * If this option is `false`, the Sentry SDK won't wrap the server entry file with `import()`. Not wrapping the
+   * server entry file will disable Sentry on the server-side. When you set this option to `true`, make sure


Suggested change

* server entry file will disable Sentry on the server-side. When you set this option to `true`, make sure

* server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure

I think it should say false here?

true is correct here, but I'll rephrase the JSDoc a bit so it is less confusing :)

s1gr1d · 2024-10-14T15:00:19Z

packages/nuxt/src/common/types.ts

   */
-  experimental_basicServerTracing?: boolean;
+  dynamicImportWrapping?: boolean;


I am not sure about the naming here as it is quite technical but describes what it does. I thought about some other names such as autoSentryPreload (as Sentry is preloaded with this), dynamicImportForServerEntry (longer, more descriptive).

would go with dynamicImportForServerEntry

chargome

LGTM

chargome · 2024-10-15T13:43:51Z

packages/nuxt/src/common/types.ts

   */
-  experimental_basicServerTracing?: boolean;
+  dynamicImportWrapping?: boolean;


would go with dynamicImportForServerEntry

While the preset for Netlify exports the serverless handler function as `export { D as default }`, the Vercel preset exports this handler as `export { D as handler };`. This PR makes some adaptions to the code generation in the plugin to make it possible to re-export `default` functions. The previous snippet did not work as `default` is obviously not allowed as a function name.

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.34.0` -> `8.35.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.34.0/8.35.0) | | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.34.0` -> `8.35.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.34.0/8.35.0) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/node)</summary> ### [`v8.35.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8350) [Compare Source](getsentry/sentry-javascript@8.34.0...8.35.0) ##### Beta release of the official Nuxt Sentry SDK This release marks the beta release of the `@sentry/nuxt` Sentry SDK. For details on how to use it, check out the [Sentry Nuxt SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/nuxt). Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns. - **feat(nuxt): Make dynamic import() wrapping default ([#13958](getsentry/sentry-javascript#13958 (BREAKING) - **feat(nuxt): Add Rollup plugin to wrap server entry with `import()` ([#13945](getsentry/sentry-javascript#13945 **It is no longer required to add a Node `--import` flag. Please update your start command to avoid initializing Sentry twice (BREAKING CHANGE).** The SDK will now apply modifications during the build of your application to allow for patching of libraries during runtime. If run into issues with this change, you can disable this behavior in your `nuxt.config.ts` and use the `--import` flag instead: ```js sentry: { dynamicImportForServerEntry: false; } ``` - **feat(nuxt): Respect user-provided source map generation settings ([#14020](getsentry/sentry-javascript#14020 We now require you to explicitly enable sourcemaps for the clientside so that Sentry can un-minify your errors. We made this change so source maps aren't accidentally leaked to the public. Enable source maps on the client as follows: ```js export default defineNuxtConfig({ sourcemap: { client: true, }, }); ``` - feat(nuxt): Log server instrumentation might not work in dev ([#14021](getsentry/sentry-javascript#14021)) - feat(nuxt): Add Http `responseHook` with `waitUntil` ([#13986](getsentry/sentry-javascript#13986)) ##### Important Changes - **feat(vue): Add Pinia plugin ([#13841](getsentry/sentry-javascript#13841 Support for [Pinia](https://pinia.vuejs.org/) is added in this release for `@sentry/vue`. To capture Pinia state data, add `createSentryPiniaPlugin()` to your Pinia store: ```javascript import { createPinia } from 'pinia'; import { createSentryPiniaPlugin } from '@sentry/vue'; const pinia = createPinia(); pinia.use(createSentryPiniaPlugin()); ``` - **feat(node): Implement Sentry-specific http instrumentation ([#13763](getsentry/sentry-javascript#13763 This change introduces a new `SentryHttpInstrumentation` to handle non-span related HTTP instrumentation, allowing it to run side-by-side with OTel's `HttpInstrumentation`. This improves support for custom OTel setups and avoids conflicts with Sentry's instrumentation. Additionally, the `spans: false` option is reintroduced for `httpIntegration` to disable span emission while still allowing custom `HttpInstrumentation` instances (`httpIntegration({ spans: false })`). - **feat(core): Make stream instrumentation opt-in ([#13951](getsentry/sentry-javascript#13951 This change adds a new option `trackFetchStreamPerformance` to the browser tracing integration. Only when set to `true`, Sentry will instrument streams via fetch. ##### Other Changes - feat(node): Expose `suppressTracing` API ([#13875](getsentry/sentry-javascript#13875)) - feat(replay): Do not log "timeout while trying to read resp body" as exception ([#13965](getsentry/sentry-javascript#13965)) - chore(node): Bump `@opentelemetry/instrumentation-express` to `0.43.0` ([#13948](getsentry/sentry-javascript#13948)) - chore(node): Bump `@opentelemetry/instrumentation-fastify` to `0.40.0` ([#13983](getsentry/sentry-javascript#13983)) - fix: Ensure type for `init` is correct in meta frameworks ([#13938](getsentry/sentry-javascript#13938)) - fix(core): `.set` the `sentry-trace` header instead of `.append`ing in fetch instrumentation ([#13907](getsentry/sentry-javascript#13907)) - fix(module): keep version for node ESM package ([#13922](getsentry/sentry-javascript#13922)) - fix(node): Ensure `ignoreOutgoingRequests` of `httpIntegration` applies to breadcrumbs ([#13970](getsentry/sentry-javascript#13970)) - fix(replay): Fix onError sampling when loading an expired buffered session ([#13962](getsentry/sentry-javascript#13962)) - fix(replay): Ignore older performance entries when starting manually ([#13969](getsentry/sentry-javascript#13969)) - perf(node): Truncate breadcrumb messages created by console integration ([#14006](getsentry/sentry-javascript#14006)) Work in this release was contributed by [@ZakrepaShe](https://github.com/ZakrepaShe) and [@zhiyan114](https://github.com/zhiyan114). 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/251 Reviewed-by: Alexandre Soro <code@soro.dev> Co-authored-by: renovate <renovate@git.tristess.app> Co-committed-by: renovate <renovate@git.tristess.app>

s1gr1d mentioned this pull request Oct 11, 2024

[Nuxt] Improve tracing functionality in ESM #13943

Closed

3 tasks

darthf1 reviewed Oct 11, 2024

View reviewed changes

s1gr1d force-pushed the sig/server-wrapping-default branch 3 times, most recently from d211c67 to e12c03c Compare October 14, 2024 14:58

s1gr1d commented Oct 14, 2024

View reviewed changes

s1gr1d requested review from lforst, chargome and andreiborza October 14, 2024 15:01

chargome approved these changes Oct 15, 2024

View reviewed changes

s1gr1d and others added 5 commits October 16, 2024 17:08

feat(nuxt): Make dynamic import() wrapping default

200ba3a

delete --import

4ffcaa8

fix dev mode

3c1829f

rename option

f0577d2

s1gr1d force-pushed the sig/server-wrapping-default branch from 7a54dcd to f0577d2 Compare October 16, 2024 15:12

s1gr1d merged commit 6bc37f0 into develop Oct 17, 2024
118 of 119 checks passed

s1gr1d deleted the sig/server-wrapping-default branch October 17, 2024 07:37

s1gr1d mentioned this pull request Oct 30, 2024

feat(nuxt): Add entrypointWrappedFunctions to define async wrapped server functions #14104

Merged

q1blue mentioned this pull request Nov 11, 2024

[Snyk] Upgrade @sentry/react from 7.16.0 to 8.35.0 https-quantumblockchainai-atlassian-net/ossinsight#983

Open

This was referenced Nov 13, 2024

[Snyk] Upgrade @sentry/browser from 8.34.0 to 8.35.0 MTES-MCT/ecobalyse#826

Closed

[Snyk] Upgrade @sentry/node from 8.34.0 to 8.35.0 MTES-MCT/ecobalyse#827

Closed

[Snyk] Upgrade @sentry/profiling-node from 8.34.0 to 8.35.0 MTES-MCT/ecobalyse#828

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(nuxt): Make dynamic import() wrapping default #13958

feat(nuxt): Make dynamic import() wrapping default #13958

s1gr1d commented Oct 11, 2024 •

edited

Loading

codecov bot commented Oct 11, 2024 •

edited

Loading

github-actions bot commented Oct 11, 2024 •

edited

Loading

darthf1 Oct 11, 2024

s1gr1d Oct 14, 2024

s1gr1d Oct 14, 2024

chargome Oct 15, 2024

chargome left a comment

chargome Oct 15, 2024

	* server entry file will disable Sentry on the server-side. When you set this option to `true`, make sure
	* server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure

feat(nuxt): Make dynamic import() wrapping default #13958

feat(nuxt): Make dynamic import() wrapping default #13958

Conversation

s1gr1d commented Oct 11, 2024 • edited Loading

codecov bot commented Oct 11, 2024 • edited Loading

❌ 5 Tests Failed:

github-actions bot commented Oct 11, 2024 • edited Loading

size-limit report 📦

darthf1 Oct 11, 2024

Choose a reason for hiding this comment

s1gr1d Oct 14, 2024

Choose a reason for hiding this comment

s1gr1d Oct 14, 2024

Choose a reason for hiding this comment

chargome Oct 15, 2024

Choose a reason for hiding this comment

chargome left a comment

Choose a reason for hiding this comment

chargome Oct 15, 2024

Choose a reason for hiding this comment

s1gr1d commented Oct 11, 2024 •

edited

Loading

codecov bot commented Oct 11, 2024 •

edited

Loading

github-actions bot commented Oct 11, 2024 •

edited

Loading