feat(nuxt): Add Rollup plugin to wrap server entry with `import()` #13945

s1gr1d · 2024-10-10T15:16:48Z

Feature Issue: #13943

Adds a Rollup plugin to wrap the server entry with import() to load it after Sentry was initialized.

The plugin is not yet in use (will do this in another PR - see linked issue above)

lforst

First pass. Generally looks good to me!

lforst · 2024-10-11T13:14:01Z

packages/nuxt/src/vite/addServerConfig.ts

+  );
+}
+
+function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPluginOption {


nit: If a function is only called in one place, and the calling function is already not that big, I always consider inlining it.

I considered this function as the rollup plugin so I didn't want to inline it in the push(). However, I could add a JSDoc here for the plugin.

lforst · 2024-10-11T13:17:32Z

packages/nuxt/src/vite/addServerConfig.ts

+      if (source === 'import-in-the-middle/hook.mjs') {
+        return { id: source, moduleSideEffects: true, external: true };
+      }


Did this end up working? If so, we should probably add a comment what this is doing here. Somebody coming across this is probably like "what the hell is this?".

Yes, that prevented the "Cannot find module" error in Netlify. I added a comment

lforst · 2024-10-11T13:19:45Z

packages/nuxt/src/vite/addServerConfig.ts

+
+        moduleInfo.moduleSideEffects = true;
+
+        const exportedFunctions = moduleInfo.exportedBindings?.['.'];


l: Quick comment what the '.' is about?

According to the rollup docs it's the "path of from". As the . entry includes the exports from the file I figured the dot means exactly that: The exports from this file 🤔

Yup, I know but I think we should add a comment about that 😄

lforst · 2024-10-11T13:20:45Z

packages/nuxt/src/vite/addServerConfig.ts

+        const exportedFunctions = moduleInfo.exportedBindings?.['.'];
+
+        // checks are needed to prevent multiple attachment of the suffix
+        return containsSuffix(source) || containsSuffix(resolution.id)


Aren't we already checking for containsSuffix(source) at the top of the hook?

Yes, for the source. I changed the code a bit so there is only the check for resolution.id at this point.

lforst · 2024-10-11T13:26:56Z

packages/nuxt/src/vite/utils.ts

+        `export function ${currFunctionName}(...args) {\n` +
+          `  return import(${JSON.stringify(entryId)}).then((res) => res.${currFunctionName}(...args));\n` +
+          '}\n',
+      ),


I would gravitate woards making this function async, awaiting the import, and calling it with .call(this, args), just so that the this is preserved in case it is passed. This is usually important when monkepatching.

lforst · 2024-10-11T13:27:39Z

packages/nuxt/src/vite/utils.ts

+ *
+ * Only exported for testing.
+ */
+export function stripQueryPart(url: string): string {


nit: Maybe we can make this function name a bit more representative of what it does.

Renamed it to removeSentryQueryFromPath

lforst · 2024-10-11T13:28:35Z

packages/nuxt/src/vite/utils.ts

+        .split(',')
+        .filter(param => param !== '' && param !== 'default')
+        // sanitize
+        .map((str: string) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))


What cases are we sanitizing for here?

This function gets the functions from a file to re-export them. Theoretically, another rollup plugin could inject code here. As discussed in person, this is code a user can control so it is unlikely to be used by attackers but I'll keep it with a small comment - just to be safe.

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: ```js sentry: { dynamicImportForServerEntry: false, } ``` (option name is up for discussion)

…13945) Feature Issue: #13943 Adds a Rollup plugin to wrap the server entry with `import()` to load it after Sentry was initialized. The plugin is not yet in use (will do this in another PR - see linked issue above)

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 requested review from mydea, lforst and Lms24 October 10, 2024 15:17

This was referenced Oct 10, 2024

[Nuxt] Improve tracing functionality in ESM #13943

Closed

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

Merged

lforst reviewed Oct 11, 2024

View reviewed changes

s1gr1d force-pushed the sig/server-entry-wrap-plugin branch from b5d568c to 0a7cd3c Compare October 14, 2024 10:52

s1gr1d requested a review from lforst October 14, 2024 10:53

s1gr1d added 2 commits October 14, 2024 13:48

feat(nuxt): Add Rollup plugin to wrap server entry with import()

ddd8a93

review comments

5f4c53d

s1gr1d force-pushed the sig/server-entry-wrap-plugin branch from 0a7cd3c to 5f4c53d Compare October 14, 2024 11:50

lforst approved these changes Oct 14, 2024

View reviewed changes

Merge branch 'develop' into sig/server-entry-wrap-plugin

6489b04

s1gr1d merged commit 8249a5e into develop Oct 14, 2024
118 checks passed

s1gr1d deleted the sig/server-entry-wrap-plugin branch October 14, 2024 14:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(nuxt): Add Rollup plugin to wrap server entry with `import()` #13945

feat(nuxt): Add Rollup plugin to wrap server entry with `import()` #13945

s1gr1d commented Oct 10, 2024 •

edited

Loading

lforst left a comment

lforst Oct 11, 2024

s1gr1d Oct 14, 2024

lforst Oct 11, 2024

s1gr1d Oct 14, 2024

lforst Oct 11, 2024

s1gr1d Oct 14, 2024

lforst Oct 14, 2024

lforst Oct 11, 2024

s1gr1d Oct 14, 2024

lforst Oct 11, 2024

lforst Oct 11, 2024

s1gr1d Oct 14, 2024

lforst Oct 11, 2024

s1gr1d Oct 14, 2024


		moduleInfo.moduleSideEffects = true;

		const exportedFunctions = moduleInfo.exportedBindings?.['.'];

feat(nuxt): Add Rollup plugin to wrap server entry with import() #13945

feat(nuxt): Add Rollup plugin to wrap server entry with import() #13945

Conversation

s1gr1d commented Oct 10, 2024 • edited Loading

lforst left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat(nuxt): Add Rollup plugin to wrap server entry with `import()` #13945

feat(nuxt): Add Rollup plugin to wrap server entry with `import()` #13945

s1gr1d commented Oct 10, 2024 •

edited

Loading