feat(env): client/public variables #10848

florian-lefebvre · 2024-04-22T14:34:05Z

Depends on #10829

Changes

Implements client/public variables handling
Refactors how src/env.d.ts references are generated
Moves envField to the right place

Testing

Updates the astro sync test
Adds an integration test
Updates the validators test to also include getType

Docs

N/A

changeset-bot · 2024-04-22T14:34:09Z

⚠️ No Changeset found

Latest commit: e519f82

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

…public

ematipico

Left some comments

packages/astro/src/env/vite-plugin-env-virtual-mod.ts

ematipico · 2024-04-25T07:01:28Z

packages/astro/src/env/vite-plugin-env-virtual-mod.ts

+	const { clientContent, clientDts } = handleClientModule({ schema, loadedEnv });
+	handleDts({ settings, fs, content: clientDts });


We are generating code before the load function; is that correct? Shouldn't we generate code inside load? Types and client code will be emitted only if the user attempts to use the virtual module.

Yeah, I also think we should be lazy loading the virtual module code. One thing to also check though is if new env vars get picked up across server restarts. As a Vite plugin, it's best to cache or reset the cache with the buildStart/buildEnd/config/configResolved hooks etc so that we re-compute the env when needed.

packages/astro/src/env/vite-plugin-env-virtual-mod.ts

packages/astro/src/vite-plugin-inject-env-ts/index.ts

packages/astro/src/core/errors/errors-data.ts

packages/astro/src/env/constants.ts

Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com> Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>

ematipico

Great work here @florian-lefebvre!

* feat(env): add schema, types and envField (#10805) * feat(env): add validators (#10827) * feat(env): add vite plugin (#10829) * feat(env): client/public variables (#10848) Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com> Co-authored-by: Emanuele Stoppa <my.burning@gmail.com> * feat(env): server/public variables (#10881) Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com> Co-authored-by: Emanuele Stoppa <my.burning@gmail.com> * feat(env): server/secret variables (#10954) Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com> Co-authored-by: Emanuele Stoppa <my.burning@gmail.com> * fix: import * fix: test * feat: work on jsdoc * feat: more jsdoc * chore: remove todo * feat: fix test error and write changeset * feat: update config reference * feat: apply recommendations from review * feat: rework getEnv/setGetEnv * chore: move tests * fix: rename * fix: dev mode * chore: improve error * feat: add overrideProcessEnv helper * fix: make eslint happy * Update .changeset/poor-berries-occur.md Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update .changeset/poor-berries-occur.md Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update .changeset/poor-berries-occur.md Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update .changeset/poor-berries-occur.md Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * feat: fix build and address reviews * fix: container api * fix: tests * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update packages/astro/src/@types/astro.ts * chore: update changeset * feat: address reviews * feat: address Ema's reviews * Update .changeset/poor-berries-occur.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> --------- Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com> Co-authored-by: Emanuele Stoppa <my.burning@gmail.com> Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

florian-lefebvre added 17 commits April 17, 2024 16:52

feat: add schema, types and envField

c7fffe0

feat: move things around

0e90c5d

feat: add validators

94d6ffc

feat: rework everything

d717361

feat: default

d9ce895

chore: space

f136b1b

Merge branch 'feat/astro-env-config' into feat/astro-env-validators

0260bbb

feat: reuse types

b84cea9

feat: work on test

3f32ea6

feat: write test

ff99f0d

feat: add test

8896fa7

Merge branch 'feat/astro-env-config' into feat/astro-env-validators

9d8d425

feat: add vite plugin

07f586e

feat: update zod custom validation

5063b1f

feat: validation logic

b23233c

feat: work on types injection

e02b722

Merge branch 'feat/astro-env' into feat/astro-env-vite-plugin

e9d99a1

github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review labels Apr 22, 2024

florian-lefebvre added 6 commits April 22, 2024 16:37

fix: test

bff9024

Merge branch 'feat/astro-env-vite-plugin' into feat/astro-env-client-…

fc983d1

…public

fix: test

518fd15

fix: test

eeda833

fix: cli tests

9516c2c

feat: make things work

f23296d

github-actions bot added the pkg: example Related to an example package (scope) label Apr 22, 2024

florian-lefebvre added 3 commits April 22, 2024 18:19

feat: address todos

37ec524

Discard changes to examples/basics/astro.config.mjs

ae92463

Discard changes to examples/basics/src/env.d.ts

dc92fb6

florian-lefebvre added 3 commits April 24, 2024 15:50

feat: simplify injected types

c1539ed

feat: move plugin

4b5c28c

fix: imports

0c99784

florian-lefebvre requested review from ematipico and removed request for ematipico April 24, 2024 13:55

florian-lefebvre added 2 commits April 24, 2024 16:21

feat: add tests for getType

20875e7

feat: add test

82db951

florian-lefebvre marked this pull request as ready for review April 24, 2024 14:40

florian-lefebvre requested review from bluwy and ematipico April 25, 2024 05:47

Update index.ts

e093397

ematipico reviewed Apr 25, 2024

View reviewed changes

bluwy reviewed Apr 25, 2024

View reviewed changes

packages/astro/src/core/errors/errors-data.ts Outdated Show resolved Hide resolved

packages/astro/src/core/errors/errors-data.ts Outdated Show resolved Hide resolved

packages/astro/src/env/constants.ts Outdated Show resolved Hide resolved

florian-lefebvre and others added 9 commits April 25, 2024 13:20

fix: variable name conflict

770b806

Apply suggestions from code review

e29e48d

Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com> Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>

feat: harcode constants

aa0312d

feat: rename condition to meetsCondition

353446e

feat: rename function

82a3142

feat: simplify content/dts computation

4e37b39

feat: throw one error with all invalid variables

5cb7e59

feat: refactor for clarity and prepare server/public

5f12f8d

feat: use more vite hooks

e519f82

florian-lefebvre mentioned this pull request Apr 25, 2024

feat(env): server/public variables #10881

Merged

florian-lefebvre requested review from ematipico and bluwy April 26, 2024 07:00

ematipico approved these changes Apr 26, 2024

View reviewed changes

bluwy approved these changes Apr 26, 2024

View reviewed changes

florian-lefebvre merged commit eec5403 into feat/astro-env Apr 26, 2024
14 checks passed

florian-lefebvre deleted the feat/astro-env-client-public branch April 26, 2024 09:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(env): client/public variables #10848

feat(env): client/public variables #10848

florian-lefebvre commented Apr 22, 2024 •

edited

Loading

changeset-bot bot commented Apr 22, 2024 •

edited

Loading

ematipico left a comment

ematipico Apr 25, 2024

bluwy Apr 25, 2024

ematipico left a comment

		const { clientContent, clientDts } = handleClientModule({ schema, loadedEnv });
		handleDts({ settings, fs, content: clientDts });

feat(env): client/public variables #10848

feat(env): client/public variables #10848

Conversation

florian-lefebvre commented Apr 22, 2024 • edited Loading

Changes

Testing

Docs

changeset-bot bot commented Apr 22, 2024 • edited Loading

⚠️ No Changeset found

ematipico left a comment

Choose a reason for hiding this comment

ematipico Apr 25, 2024

Choose a reason for hiding this comment

bluwy Apr 25, 2024

Choose a reason for hiding this comment

ematipico left a comment

Choose a reason for hiding this comment

florian-lefebvre commented Apr 22, 2024 •

edited

Loading

changeset-bot bot commented Apr 22, 2024 •

edited

Loading