From 052799e8939cfcdd7a7ff48daf45a766bf6cc546 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=BF=A0=20/=20green?= Date: Wed, 30 Oct 2024 15:34:08 +0900 Subject: [PATCH] fix: `define` in environment config was not working (#18515) --- packages/vite/src/node/config.ts | 1 + .../vite/src/node/plugins/clientInjections.ts | 30 +++++++++++-------- packages/vite/src/node/plugins/define.ts | 22 +++++++------- playground/define/__tests__/define.spec.ts | 4 +++ playground/define/index.html | 3 ++ playground/define/vite.config.js | 7 +++++ 6 files changed, 43 insertions(+), 24 deletions(-) diff --git a/packages/vite/src/node/config.ts b/packages/vite/src/node/config.ts index 95872da64..57970a7a6 100644 --- a/packages/vite/src/node/config.ts +++ b/packages/vite/src/node/config.ts @@ -637,6 +637,7 @@ function resolveEnvironmentOptions( const consumer = options.consumer ?? (isClientEnvironment ? 'client' : 'server') return { + define: options.define, resolve, consumer, webCompatible: options.webCompatible ?? consumer === 'client', diff --git a/packages/vite/src/node/plugins/clientInjections.ts b/packages/vite/src/node/plugins/clientInjections.ts index 9ad7c47ca..356959a6c 100644 --- a/packages/vite/src/node/plugins/clientInjections.ts +++ b/packages/vite/src/node/plugins/clientInjections.ts @@ -3,6 +3,7 @@ import type { Plugin } from '../plugin' import type { ResolvedConfig } from '../config' import { CLIENT_ENTRY, ENV_ENTRY } from '../constants' import { isObject, normalizePath, resolveHostname } from '../utils' +import { usePerEnvironmentState } from '../environment' import { replaceDefine, serializeDefine } from './define' // ids in transform are normalized to unix style @@ -16,6 +17,19 @@ const normalizedEnvEntry = normalizePath(ENV_ENTRY) export function clientInjectionsPlugin(config: ResolvedConfig): Plugin { let injectConfigValues: (code: string) => string + const getDefineReplacer = usePerEnvironmentState((environment) => { + const userDefine: Record = {} + for (const key in environment.config.define) { + // import.meta.env.* is handled in `importAnalysis` plugin + if (!key.startsWith('import.meta.env.')) { + userDefine[key] = environment.config.define[key] + } + } + const serializedDefines = serializeDefine(userDefine) + const definesReplacement = () => serializedDefines + return (code: string) => code.replace(`__DEFINES__`, definesReplacement) + }) + return { name: 'vite:client-inject', async buildStart() { @@ -51,18 +65,8 @@ export function clientInjectionsPlugin(config: ResolvedConfig): Plugin { hmrBase = path.posix.join(hmrBase, hmrConfig.path) } - const userDefine: Record = {} - for (const key in config.define) { - // import.meta.env.* is handled in `importAnalysis` plugin - if (!key.startsWith('import.meta.env.')) { - userDefine[key] = config.define[key] - } - } - const serializedDefines = serializeDefine(userDefine) - const modeReplacement = escapeReplacement(config.mode) const baseReplacement = escapeReplacement(devBase) - const definesReplacement = () => serializedDefines const serverHostReplacement = escapeReplacement(serverHost) const hmrProtocolReplacement = escapeReplacement(protocol) const hmrHostnameReplacement = escapeReplacement(host) @@ -77,7 +81,6 @@ export function clientInjectionsPlugin(config: ResolvedConfig): Plugin { return code .replace(`__MODE__`, modeReplacement) .replace(/__BASE__/g, baseReplacement) - .replace(`__DEFINES__`, definesReplacement) .replace(`__SERVER_HOST__`, serverHostReplacement) .replace(`__HMR_PROTOCOL__`, hmrProtocolReplacement) .replace(`__HMR_HOSTNAME__`, hmrHostnameReplacement) @@ -93,13 +96,14 @@ export function clientInjectionsPlugin(config: ResolvedConfig): Plugin { // TODO: Remove options?.ssr, Vitest currently hijacks this plugin const ssr = options?.ssr ?? this.environment.config.consumer === 'server' if (id === normalizedClientEntry || id === normalizedEnvEntry) { - return injectConfigValues(code) + const defineReplacer = getDefineReplacer(this) + return defineReplacer(injectConfigValues(code)) } else if (!ssr && code.includes('process.env.NODE_ENV')) { // replace process.env.NODE_ENV instead of defining a global // for it to avoid shimming a `process` object during dev, // avoiding inconsistencies between dev and build const nodeEnv = - config.define?.['process.env.NODE_ENV'] || + this.environment.config.define?.['process.env.NODE_ENV'] || JSON.stringify(process.env.NODE_ENV || config.mode) return await replaceDefine(this.environment, code, id, { 'process.env.NODE_ENV': nodeEnv, diff --git a/packages/vite/src/node/plugins/define.ts b/packages/vite/src/node/plugins/define.ts index 39d7b6bf8..2c2156c58 100644 --- a/packages/vite/src/node/plugins/define.ts +++ b/packages/vite/src/node/plugins/define.ts @@ -46,18 +46,18 @@ export function definePlugin(config: ResolvedConfig): Plugin { importMetaFallbackKeys['import.meta.env'] = `undefined` } - const userDefine: Record = {} - const userDefineEnv: Record = {} - for (const key in config.define) { - userDefine[key] = handleDefineValue(config.define[key]) - - // make sure `import.meta.env` object has user define properties - if (isBuild && key.startsWith('import.meta.env.')) { - userDefineEnv[key.slice(16)] = config.define[key] - } - } - function generatePattern(environment: Environment) { + const userDefine: Record = {} + const userDefineEnv: Record = {} + for (const key in environment.config.define) { + userDefine[key] = handleDefineValue(environment.config.define[key]) + + // make sure `import.meta.env` object has user define properties + if (isBuild && key.startsWith('import.meta.env.')) { + userDefineEnv[key.slice(16)] = environment.config.define[key] + } + } + const replaceProcessEnv = environment.config.webCompatible const define: Record = { diff --git a/playground/define/__tests__/define.spec.ts b/playground/define/__tests__/define.spec.ts index 399e9c801..71fa61035 100644 --- a/playground/define/__tests__/define.spec.ts +++ b/playground/define/__tests__/define.spec.ts @@ -3,6 +3,7 @@ import viteConfig from '../vite.config' import { page } from '~utils' const defines = viteConfig.define +const envDefines = viteConfig.environments.client.define test('string', async () => { expect(await page.textContent('.exp')).toBe( @@ -48,6 +49,9 @@ test('string', async () => { expect(await page.textContent('.define-in-dep')).toBe( defines.__STRINGIFIED_OBJ__, ) + expect(await page.textContent('.define-in-environment')).toBe( + envDefines.__DEFINE_IN_ENVIRONMENT__, + ) }) test('ignores constants in string literals', async () => { diff --git a/playground/define/index.html b/playground/define/index.html index 164ba46c6..7c8fc55ba 100644 --- a/playground/define/index.html +++ b/playground/define/index.html @@ -21,6 +21,7 @@

define variable in html: __EXP__

import json:

define in dep:

+

define in environment:

Define ignores string literals

@@ -114,6 +115,8 @@ import { defined } from '@vitejs/test-commonjs-dep' text('.define-in-dep', JSON.stringify(defined)) + text('.define-in-environment', JSON.stringify(__DEFINE_IN_ENVIRONMENT__)) + text('.ignores-string-literals .process-env-dot', 'process.env.') text( '.ignores-string-literals .global-process-env-dot', diff --git a/playground/define/vite.config.js b/playground/define/vite.config.js index d6c4d2270..0712c4d01 100644 --- a/playground/define/vite.config.js +++ b/playground/define/vite.config.js @@ -31,4 +31,11 @@ export default defineConfig({ __STRINGIFIED_OBJ__: JSON.stringify({ foo: true }), 'import.meta.env.SOME_IDENTIFIER': '__VITE_SOME_IDENTIFIER__', }, + environments: { + client: { + define: { + __DEFINE_IN_ENVIRONMENT__: '"defined only in client"', + }, + }, + }, })