feat: inject environment variables from .env files into edge functions locally #5620

danez · 2023-04-12T14:31:41Z

Summary

This allows any environment variables that are coming from dot-env files (.env) to be accessed in edge functions.

Similar to what is described here: https://docs.netlify.com/configure-builds/environment-variables/#build-locally

For us to review and ship your PR efficiently, please perform the following steps:

Open a bug/issue before writing your code 🧑‍💻. This ensures we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or something that`s on fire 🔥 (e.g. incident related), you can skip this step.
Read the contribution guidelines 📖. This ensures your code follows our style guide and
passes our tests.
Update or add tests (if any source code was changed or added) 🧪
Update or add documentation (if features were changed or added) 📝
Make sure the status checks below are successful ✅

A picture of a cute animal (not mandatory, but encouraged)

github-actions · 2023-04-12T14:33:32Z

📊 Benchmark results

Comparing with f30d409

Package size: 302 MB

(no change)

^  302 MB  302 MB  302 MB  302 MB  302 MB  302 MB 
│   ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |▒▒|  
└───┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴──>
    T-5     T-4     T-3     T-2     T-1      T

Legend

T-5 (6c4d01e): 302 MB
T-4 (fb40e95): 302 MB
T-3 (23d191a): 302 MB
T-2 (7e305a9): 302 MB
T-1 (f30d409): 302 MB
T (current commit): 302 MB

danez · 2023-04-12T15:02:16Z

src/utils/dev.mjs

+ * @param {Record<string, { sources: string[], value: string}>} env
+ * @return {void}
+ */
+export const injectEnvVariables = (env) => {


I made this function to only inject variables into process.env and split out all the dotenv stuff into the function above.

danez · 2023-04-12T15:03:57Z

src/commands/dev/dev.mjs

@@ -96,7 +96,8 @@ const dev = async (options, command) => {
    log(`${NETLIFYDEVLOG} Injecting environment variable values for ${chalk.yellow('all scopes')}`)
  }

-  await injectEnvVariables({ devConfig, env, site })
+  env = await addDotEnvVariables({ devConfig, env, site })
+  injectEnvVariables(env)


addDotEnvVariables now mutates env here and adds the variables from the dot-env files to it, so that later one we can use them in edge-functions. Previously dotenv variables were only added to process.env directly.

danez · 2023-04-12T15:09:02Z

tests/integration/100.command.dev.test.cjs

@@ -1,4 +1,4 @@
-// Handlers are meant to be async outside tests
+const { platform } = require('os')


I couldn't figure out what this comment means or where it applies to :D

klavavej · 2023-04-12T22:03:06Z

@danez - I'm not sure what part of this PR you want me to review. I took a look through and couldn't identify any changes that will impact what's shown in the cli docs at https://deploy-preview-5620--cli.netlify.app/

Could you point me to the part of this PR that needs my review?

I do see that docs.netlify.com documents some limitations around this behavior that will need to be updated/removed (on the Environment variables and functions page and the Edge Functions limits page)- I can open a PR to get the ball rolling on those changes.

danez · 2023-04-12T22:13:42Z

@danez - I'm not sure what part of this PR you want me to review. I took a look through and couldn't identify any changes that will impact what's shown in the cli docs at https://deploy-preview-5620--cli.netlify.app/

Could you point me to the part of this PR that needs my review?

I do see that docs.netlify.com documents some limitations around this behavior that will need to be updated/removed (on the Environment variables and functions page and the Edge Functions limits page)- I can open a PR to get the ball rolling on those changes.

Sorry, i didn't mean to ask for a review. I just wanted to let you know that this is something that is changing which we might want to document :)

eduardoboucas

Nice! Left a couple of comments but nothing blocking.

src/commands/dev/dev-exec.mjs

src/lib/edge-functions/registry.mjs

…s locally

khendrikse

Looks good

danez self-assigned this Apr 12, 2023

danez force-pushed the env-edge branch from 2e186fb to eb23376 Compare April 12, 2023 14:54

danez changed the title ~~feat: inject environment variables from .env files into edge function…~~ feat: inject environment variables from .env files into edge functions locally Apr 12, 2023

danez added the needs docs label Apr 12, 2023

danez requested a review from klavavej April 12, 2023 14:56

danez force-pushed the env-edge branch from eb23376 to 337baf9 Compare April 12, 2023 15:00

danez marked this pull request as ready for review April 12, 2023 15:00

danez requested a review from a team April 12, 2023 15:00

danez commented Apr 12, 2023

View reviewed changes

danez force-pushed the env-edge branch from 337baf9 to 0ff3157 Compare April 12, 2023 15:13

eduardoboucas previously approved these changes Apr 13, 2023

View reviewed changes

src/commands/dev/dev-exec.mjs Outdated Show resolved Hide resolved

src/lib/edge-functions/registry.mjs Show resolved Hide resolved

danez dismissed eduardoboucas’s stale review via 5b12fc5 April 13, 2023 18:07

danez force-pushed the env-edge branch 3 times, most recently from 3494edb to 252a386 Compare April 14, 2023 12:53

danez added 2 commits April 14, 2023 17:18

feat: inject environment variables from .env files into edge function…

2dea9b5

…s locally

chore: test

5940f0e

danez force-pushed the env-edge branch from 252a386 to 5940f0e Compare April 14, 2023 15:18

danez added 2 commits April 17, 2023 13:42

chore: rename function

84d4c24

Merge branch 'main' into env-edge

2e6bc5a

danez requested review from eduardoboucas and a team and removed request for klavavej April 17, 2023 11:47

Merge branch 'main' into env-edge

ac4f55f

khendrikse previously approved these changes Apr 17, 2023

View reviewed changes

danez added the automerge Add to Kodiak auto merge queue label Apr 17, 2023

chore: fix test on windows

597839d

danez dismissed khendrikse’s stale review via 597839d April 17, 2023 12:59

danez requested a review from khendrikse April 17, 2023 12:59

khendrikse approved these changes Apr 17, 2023

View reviewed changes

kodiakhq bot merged commit 9066166 into main Apr 17, 2023

kodiakhq bot deleted the env-edge branch April 17, 2023 13:10

token-generator-app bot mentioned this pull request Apr 17, 2023

chore(main): release 14.0.0 #5600

Merged

CASABECI mentioned this pull request May 8, 2024

[Snyk] Fix for 1 vulnerabilities CASABECI/cli#9

Open

MaxMood96 mentioned this pull request May 9, 2024

[Snyk] Security upgrade @netlify/build from 28.4.5 to 29.41.3 MaxMood96/cli-2#161

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: inject environment variables from .env files into edge functions locally #5620

feat: inject environment variables from .env files into edge functions locally #5620

danez commented Apr 12, 2023 •

edited

Loading

github-actions bot commented Apr 12, 2023 •

edited

Loading

danez Apr 12, 2023

danez Apr 12, 2023 •

edited

Loading

danez Apr 12, 2023

klavavej commented Apr 12, 2023

danez commented Apr 12, 2023

eduardoboucas left a comment

khendrikse left a comment

		@@ -1,4 +1,4 @@
		// Handlers are meant to be async outside tests
		const { platform } = require('os')

feat: inject environment variables from .env files into edge functions locally #5620

feat: inject environment variables from .env files into edge functions locally #5620

Conversation

danez commented Apr 12, 2023 • edited Loading

Summary

github-actions bot commented Apr 12, 2023 • edited Loading

📊 Benchmark results

Package size: 302 MB

danez Apr 12, 2023

Choose a reason for hiding this comment

danez Apr 12, 2023 • edited Loading

Choose a reason for hiding this comment

danez Apr 12, 2023

Choose a reason for hiding this comment

klavavej commented Apr 12, 2023

danez commented Apr 12, 2023

eduardoboucas left a comment

Choose a reason for hiding this comment

khendrikse left a comment

Choose a reason for hiding this comment

danez commented Apr 12, 2023 •

edited

Loading

github-actions bot commented Apr 12, 2023 •

edited

Loading

danez Apr 12, 2023 •

edited

Loading