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

Support missing import.meta.env #413

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Support missing import.meta.env #413

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b48df2
Support missing import.meta.env
princed Jun 20, 2022
4dbafba
Only add "import.meta.env." replacement when building
princed Jun 22, 2022
e6a651f
Use string argument instead of boolean
princed Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion packages/builder-vite/envs.ts
View file
Open in desktop
Expand Up @@ -22,7 +22,7 @@ export const allowedEnvPrefix = ['VITE_', 'STORYBOOK_'];
* Customized version of stringifyProcessEnvs from @storybook/core-common which
* uses import.meta.env instead of process.env and checks for allowed variables.
*/
export function stringifyProcessEnvs(raw: EnvsRaw, envPrefix: UserConfig['envPrefix']) {
export function stringifyProcessEnvs(raw: EnvsRaw, envPrefix: UserConfig['envPrefix'], isBuild: boolean) {
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the preferred way to do this is, but happy to change it if needed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use a mode of either production or development, to avoid a boolean trap.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like mode would be confusing here, because it's possible to build in development mode and serve in production. And vite itself uses command to derive this information:
https://github.com/vitejs/vite/blob/908c9e4cdd2cceb0f01495e38066ffe33c21ddb8/packages/vite/src/node/plugins/define.ts#L12

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you be okay with command: 'build' | 'serve' as an argument?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, thanks.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

const updatedRaw: EnvsRaw = {};
const envs = Object.entries(raw).reduce(
(acc: EnvsRaw, [key, value]) => {
Expand All @@ -46,5 +46,11 @@ export function stringifyProcessEnvs(raw: EnvsRaw, envPrefix: UserConfig['envPre
// const { foo } = import.meta.env;
envs['import.meta.env'] = JSON.stringify(stringifyEnvs(updatedRaw));

// Prevent build breaking on a missing var, similar to vite
// @see https://github.com/vitejs/vite/blob/908c9e4cdd2cceb0f01495e38066ffe33c21ddb8/packages/vite/src/node/plugins/define.ts#L50
if (isBuild) {
envs['import.meta.env.'] = '({}).';
}

return envs;
}
2 changes: 1 addition & 1 deletion packages/builder-vite/vite-server.ts
View file
Open in desktop
Expand Up @@ -29,7 +29,7 @@ export async function createViteServer(options: ExtendedOptions, devServer: Serv

const envsRaw = await presets.apply<Promise<EnvsRaw>>('env');
// Stringify env variables after getting `envPrefix` from the final config
const envs = stringifyProcessEnvs(envsRaw, finalConfig.envPrefix);
const envs = stringifyProcessEnvs(envsRaw, finalConfig.envPrefix, false);
// Update `define`
finalConfig.define = {
...finalConfig.define,
Expand Down