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.

Sign up for GitHub

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

Jump to bottom

fix(build): avoid re-define __vite_import_meta_env__ #17876

Merged
merged 5 commits into from
Aug 15, 2024
Merged

fix(build): avoid re-define __vite_import_meta_env__ #17876

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2f8e6ca
fix(build): avoid re-define `__vite_import_meta_env__`
yuzheng14 Aug 12, 2024
9296542
fix(build): forget to modify reg of bare import.meta.env
yuzheng14 Aug 13, 2024
980e28c
perf(build): :zap: improve performance of regex using `includes` and …
yuzheng14 Aug 14, 2024
4a84cdf
refactor: update
bluwy Aug 14, 2024
7fd010b
chore: update test
bluwy Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions packages/vite/src/node/__tests__/plugins/define.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,31 @@ describe('definePlugin', () => {
/const __vite_import_meta_env__ = .*;\nconst env = __vite_import_meta_env__;/,
)
})

test('already has marker', async () => {
const transform = await createDefinePluginTransform()
expect(
await transform(
'console.log(__vite_import_meta_env__);\nconst env = import.meta.env;',
),
).toMatch(
/const __vite_import_meta_env__\$ = .*;\nconsole.log\(__vite_import_meta_env__\);\nconst env = __vite_import_meta_env__\$;/,
)

expect(
await transform(
'console.log(__vite_import_meta_env__, __vite_import_meta_env__$);\n const env = import.meta.env;',
),
).toMatch(
/const __vite_import_meta_env__\$\$ = .*;\nconsole.log\(__vite_import_meta_env__, __vite_import_meta_env__\$\);\nconst env = __vite_import_meta_env__\$\$;/,
)

expect(
await transform(
'console.log(__vite_import_meta_env__);\nconst env = import.meta.env;\nconsole.log(import.meta.env.UNDEFINED);',
),
).toMatch(
/const __vite_import_meta_env__\$ = .*;\nconsole.log\(__vite_import_meta_env__\);\nconst env = __vite_import_meta_env__\$;\nconsole.log\(undefined {26}\);/,
)
})
})
26 changes: 17 additions & 9 deletions packages/vite/src/node/plugins/define.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import { isHTMLRequest } from './html'
const nonJsRe = /\.json(?:$|\?)/
const isNonJsRequest = (request: string): boolean => nonJsRe.test(request)
const importMetaEnvMarker = '__vite_import_meta_env__'
const bareImportMetaEnvRe = new RegExp(`${importMetaEnvMarker}(?!\\.)\\b`)
const importMetaEnvKeyRe = new RegExp(`${importMetaEnvMarker}\\..+?\\b`, 'g')

export function definePlugin(config: ResolvedConfig): Plugin {
const isBuild = config.command === 'build'
Expand Down Expand Up @@ -80,7 +78,6 @@ export function definePlugin(config: ResolvedConfig): Plugin {
SSR: ssr + '',
...userDefineEnv,
})
const banner = `const ${importMetaEnvMarker} = ${importMetaEnvVal};\n`

// Create regex pattern as a fast check before running esbuild
const patternKeys = Object.keys(userDefine)
Expand All @@ -94,7 +91,7 @@ export function definePlugin(config: ResolvedConfig): Plugin {
? new RegExp(patternKeys.map(escapeRegex).join('|'))
: null

return [define, pattern, banner] as const
return [define, pattern, importMetaEnvVal] as const
}

const defaultPattern = generatePattern(false)
Expand Down Expand Up @@ -122,23 +119,34 @@ export function definePlugin(config: ResolvedConfig): Plugin {
return
}

const [define, pattern, banner] = ssr ? ssrPattern : defaultPattern
const [define, pattern, importMetaEnvVal] = ssr
? ssrPattern
: defaultPattern
if (!pattern) return

// Check if our code needs any replacements before running esbuild
pattern.lastIndex = 0
if (!pattern.test(code)) return

let marker = importMetaEnvMarker
yuzheng14 marked this conversation as resolved.
Show resolved Hide resolved
while (new RegExp(escapeRegex(marker)).test(code)) {
marker += '$'
}
yuzheng14 marked this conversation as resolved.
Show resolved Hide resolved
if (marker !== importMetaEnvMarker && 'import.meta.env' in define) {
define['import.meta.env'] = marker
}
yuzheng14 marked this conversation as resolved.
Show resolved Hide resolved

const result = await replaceDefine(code, id, define, config)

// Replace `import.meta.env.*` with undefined
result.code = result.code.replaceAll(importMetaEnvKeyRe, (m) =>
'undefined'.padEnd(m.length),
result.code = result.code.replaceAll(
new RegExp(`${escapeRegex(marker)}\\..+?\\b`, 'g'),
(m) => 'undefined'.padEnd(m.length),
yuzheng14 marked this conversation as resolved.
Show resolved Hide resolved
)

// If there's bare `import.meta.env` references, prepend the banner
if (bareImportMetaEnvRe.test(result.code)) {
result.code = banner + result.code
if (new RegExp(escapeRegex(marker)).test(result.code)) {
result.code = `const ${marker} = ${importMetaEnvVal};\n` + result.code
yuzheng14 marked this conversation as resolved.
Show resolved Hide resolved

if (result.map) {
const map = JSON.parse(result.map)
Expand Down