-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
ref(nuxt): Use addVitePlugin instead of deprecated vite:extendConfig
#19464
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
Open
s1gr1d
wants to merge
4
commits into
develop
Choose a base branch
from
sig/nuxt-vite-config
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import type { Nuxt } from '@nuxt/schema'; | ||
| import { sentryVitePlugin } from '@sentry/vite-plugin'; | ||
| import type { ConfigEnv, Plugin, UserConfig } from 'vite'; | ||
| import type { SentryNuxtModuleOptions } from '../common/types'; | ||
| import { extractNuxtSourceMapSetting, getPluginOptions, validateDifferentSourceMapSettings } from './sourceMaps'; | ||
|
|
||
| /** | ||
| * Creates a Vite plugin that adds the Sentry Vite plugin and validates source map settings. | ||
| */ | ||
| export function createSentryViteConfigPlugin(options: { | ||
| nuxt: Nuxt; | ||
| moduleOptions: SentryNuxtModuleOptions; | ||
| sourceMapsEnabled: boolean; | ||
| shouldDeleteFilesFallback: { client: boolean; server: boolean }; | ||
| }): Plugin { | ||
| const { nuxt, moduleOptions, sourceMapsEnabled, shouldDeleteFilesFallback } = options; | ||
| const isDebug = moduleOptions.debug; | ||
|
|
||
| return { | ||
| name: 'sentry-nuxt-vite-config', | ||
| config(viteConfig: UserConfig, env: ConfigEnv) { | ||
| // Only run in production builds | ||
| if (!sourceMapsEnabled || env.mode === 'development' || nuxt.options?._prepare) { | ||
| return; | ||
| } | ||
|
|
||
| // Detect runtime from Vite config | ||
| // In Nuxt, SSR builds have build.ssr: true, client builds don't | ||
| const runtime = viteConfig.build?.ssr ? 'server' : 'client'; | ||
|
|
||
| const nuxtSourceMapSetting = extractNuxtSourceMapSetting(nuxt, runtime); | ||
|
|
||
| // Initialize build config if needed | ||
| viteConfig.build = viteConfig.build || {}; | ||
| const viteSourceMap = viteConfig.build.sourcemap; | ||
|
|
||
| // Vite source map options are the same as the Nuxt source map config options (unless overwritten) | ||
| validateDifferentSourceMapSettings({ | ||
| nuxtSettingKey: `sourcemap.${runtime}`, | ||
| nuxtSettingValue: nuxtSourceMapSetting, | ||
| otherSettingKey: 'viteConfig.build.sourcemap', | ||
| otherSettingValue: viteSourceMap, | ||
| }); | ||
|
|
||
| if (isDebug) { | ||
| // eslint-disable-next-line no-console | ||
| console.log(`[Sentry] Adding Sentry Vite plugin to the ${runtime} runtime.`); | ||
| } | ||
|
|
||
| // Add Sentry plugin by mutating the config | ||
| // Vite plugin is added on the client and server side (plugin runs for both builds) | ||
| // Nuxt client source map is 'false' by default. Warning about this will be shown already in an earlier step, and it's also documented that `nuxt.sourcemap.client` needs to be enabled. | ||
| viteConfig.plugins = viteConfig.plugins || []; | ||
| viteConfig.plugins.push(sentryVitePlugin(getPluginOptions(moduleOptions, shouldDeleteFilesFallback))); | ||
| }, | ||
| }; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Stale
shouldDeleteFilesFallbackreference in Vite pluginHigh Severity
shouldDeleteFilesFallbackis initialized as{ client: true, server: true }withlet, then reassigned to a new object inside themodules:donehook. However,createSentryViteConfigPluginis called synchronously beforemodules:donefires, so it captures a reference to the initial object. Whenmodules:donelater reassigns the variable to a new object, the plugin still holds the stale{ client: true, server: true }reference. This causes the Vite plugin to always configure fallback source map file deletion, even when users explicitly enabled source maps (where it should be{ client: false, server: false }). The oldvite:extendConfighook used a closure reading the variable lazily, so it correctly saw the updated value. Thenitro:confighook still works correctly for the same reason.Additional Locations (2)
packages/nuxt/src/vite/sourceMaps.ts#L40-L56packages/nuxt/src/vite/sentryVitePlugin.ts#L15-L54