Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Oct 17, 2024

Conversation

s1gr1d
Copy link
Member

@s1gr1d s1gr1d commented Oct 11, 2024

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)

Copy link

codecov bot commented Oct 11, 2024

❌ 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 "_nuxt"
Stack Traces | 30s run time
tracing.server.test.ts:24:1 does not send transactions for build asset folder "_nuxt"
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

Copy link
Contributor

github-actions bot commented Oct 11, 2024

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

* 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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@s1gr1d s1gr1d force-pushed the sig/server-wrapping-default branch 3 times, most recently from d211c67 to e12c03c Compare October 14, 2024 14:58
*/
experimental_basicServerTracing?: boolean;
dynamicImportWrapping?: boolean;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would go with dynamicImportForServerEntry

Copy link
Member

@chargome chargome left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

*/
experimental_basicServerTracing?: boolean;
dynamicImportWrapping?: boolean;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would go with dynamicImportForServerEntry

s1gr1d and others added 5 commits October 16, 2024 17:08
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.
@s1gr1d s1gr1d force-pushed the sig/server-wrapping-default branch from 7a54dcd to f0577d2 Compare October 16, 2024 15:12
@s1gr1d s1gr1d merged commit 6bc37f0 into develop Oct 17, 2024
118 of 119 checks passed
@s1gr1d s1gr1d deleted the sig/server-wrapping-default branch October 17, 2024 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants