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

fix: define in environment config was not working #18515

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/vite/src/node/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -637,6 +637,7 @@ function resolveEnvironmentOptions(
const consumer =
options.consumer ?? (isClientEnvironment ? 'client' : 'server')
return {
define: options.define,
resolve,
consumer,
webCompatible: options.webCompatible ?? consumer === 'client',
Expand Down
30 changes: 17 additions & 13 deletions packages/vite/src/node/plugins/clientInjections.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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<string, any> = {}
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() {
Expand Down Expand Up @@ -51,18 +65,8 @@ export function clientInjectionsPlugin(config: ResolvedConfig): Plugin {
hmrBase = path.posix.join(hmrBase, hmrConfig.path)
}

const userDefine: Record<string, any> = {}
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)
Expand All @@ -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)
Expand All @@ -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,
Expand Down
20 changes: 10 additions & 10 deletions packages/vite/src/node/plugins/define.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,18 @@ export function definePlugin(config: ResolvedConfig): Plugin {
importMetaFallbackKeys['import.meta.env'] = `undefined`
}

const userDefine: Record<string, string> = {}
const userDefineEnv: Record<string, any> = {}
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<string, string> = {}
const userDefineEnv: Record<string, any> = {}
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]
}
}
}

function generatePattern(environment: Environment) {
const replaceProcessEnv = environment.config.webCompatible

const define: Record<string, string> = {
Expand Down
4 changes: 4 additions & 0 deletions playground/define/__tests__/define.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down Expand Up @@ -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 () => {
Expand Down
3 changes: 3 additions & 0 deletions playground/define/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ <h1>Define</h1>
<p>define variable in html: <code class="exp-define">__EXP__</code></p>
<p>import json: <code class="import-json"></code></p>
<p>define in dep: <code class="define-in-dep"></code></p>
<p>define in environment: <code class="define-in-environment"></code></p>

<h2>Define ignores string literals</h2>
<section class="ignores-string-literals">
Expand Down Expand Up @@ -114,6 +115,8 @@ <h2>Define undefined constants on import.meta.env when it's a invalid json</h2>
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',
Expand Down
7 changes: 7 additions & 0 deletions playground/define/vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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"',
},
},
},
})