feat: add deploy-specific environment variable support to netlify deploy
#8413
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| import { InvalidArgumentError } from "commander"; | ||
|
Contributor
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Run the formatter before merge. The Format workflow fails for this file. Run 🧰 Tools🪛 GitHub Actions: Format / 0_Format.txt[error] 1-1: oxfmt formatting check failed. Run 'oxfmt' without '--check' to format this file. 🪛 GitHub Actions: Format / Format[error] 1-1: oxfmt formatting check failed. Run 'oxfmt' without '--check' to format this file. 🤖 Prompt for AI AgentsSource: Pipeline failures |
||
|
|
||
| export interface DeployEnvironmentVariable { | ||
| key: string; | ||
| value: string; | ||
| is_secret: boolean; | ||
| scopes: ["functions"]; | ||
| } | ||
|
|
||
| const MAX_KEY_LENGTH = 255; | ||
| const VALID_KEY_NAME = /^[a-zA-Z][a-zA-Z0-9_]*$/; | ||
|
|
||
| const RESERVED_KEY_NAMES = new Set([ | ||
| // AWS-specific env vars | ||
| "AWS_REGION", | ||
| "AWS_EXECUTION_ENV", | ||
| "AWS_LAMBDA_FUNCTION_NAME", | ||
| "AWS_LAMBDA_FUNCTION_MEMORY_SIZE", | ||
| "AWS_LAMBDA_FUNCTION_VERSION", | ||
| "AWS_LAMBDA_LOG_GROUP_NAME", | ||
| "AWS_LAMBDA_LOG_STREAM_NAME", | ||
| "AWS_ACCESS_KEY_ID", | ||
| "AWS_SECRET_ACCESS_KEY", | ||
| "AWS_SESSION_TOKEN", | ||
| "AWS_LAMBDA_RUNTIME_API", | ||
| "NETLIFY", | ||
| "BUILD_ID", | ||
| "CONTEXT", | ||
| "REPOSITORY_URL", | ||
| "BRANCH", | ||
| "HEAD", | ||
| "COMMIT_REF", | ||
| "CACHED_COMMIT_REF", | ||
| "PULL_REQUEST", | ||
| "REVIEW_ID", | ||
| "URL", | ||
| "DEPLOY_URL", | ||
| "DEPLOY_PRIME_URL", | ||
| "DEPLOY_ID", | ||
| "SITE_NAME", | ||
| "SITE_ID", | ||
| "NETLIFY_IMAGES_CDN_DOMAIN", | ||
| "INCOMING_HOOK_TITLE", | ||
| "INCOMING_HOOK_URL", | ||
| "INCOMING_HOOK_BODY", | ||
| ]); | ||
|
|
||
| const validateKey = (key: string): void => { | ||
| if (key.length > MAX_KEY_LENGTH) { | ||
| throw new InvalidArgumentError(`Key names should be ${MAX_KEY_LENGTH.toString()} characters or less.`); | ||
| } | ||
| if (!VALID_KEY_NAME.test(key)) { | ||
| throw new InvalidArgumentError( | ||
| "Key names must start with a letter and can only consist of alphanumeric characters and underscores", | ||
| ); | ||
| } | ||
| if (RESERVED_KEY_NAMES.has(key.toUpperCase())) { | ||
| throw new InvalidArgumentError(`${key} is a reserved key name`); | ||
| } | ||
| }; | ||
|
|
||
| export type DeployEnvVarFlag = "--env" | "--secret-env"; | ||
|
|
||
| /** | ||
| * Builds a Commander argument parser that accumulates `KEY=VALUE` arguments into a list of | ||
| * deploy-scoped environment variables. This lets the flag be repeated. | ||
| * | ||
| * Throws `InvalidArgumentError` if the argument is not in `KEY=VALUE` format, or if the key would | ||
| * be rejected by Envelope. | ||
| */ | ||
| // (TODO(ndhoule): Ideally we'd let the API call perform this validation and return an | ||
| // error, but it currently does not.) | ||
| export const parseDeployEnvVar = | ||
| (flag: DeployEnvVarFlag) => | ||
| (arg: string, previous: DeployEnvironmentVariable[] = []): DeployEnvironmentVariable[] => { | ||
| const separatorIndex = arg.indexOf("="); | ||
| if (separatorIndex === -1) { | ||
| throw new InvalidArgumentError(`Invalid ${flag} value "${arg}". Expected KEY=VALUE.`); | ||
| } | ||
|
|
||
| const key = arg.slice(0, separatorIndex); | ||
| if (key === "") { | ||
| throw new InvalidArgumentError(`Invalid ${flag} value "${arg}". Expected KEY=VALUE.`); | ||
| } | ||
| validateKey(key); | ||
|
|
||
| return [ | ||
| ...previous, | ||
| { | ||
| key, | ||
| value: arg.slice(separatorIndex + 1), | ||
| is_secret: flag === "--secret-env", | ||
| // Deploy-scoped variables only take effect in the functions scope. | ||
| scopes: ["functions"], | ||
| }, | ||
| ]; | ||
| }; | ||
|
|
||
| /** | ||
| * Combines the variables collected by `--env` and `--secret-env` into the single list the API | ||
| * expects. | ||
| */ | ||
| export const mergeDeployEnvVars = ( | ||
| env: DeployEnvironmentVariable[] = [], | ||
| secretEnv: DeployEnvironmentVariable[] = [], | ||
| ): DeployEnvironmentVariable[] => [...env, ...secretEnv]; | ||
|
|
||
| /** | ||
| * Returns the first key that appears more than once, or `undefined` if all keys are unique. | ||
| * | ||
| * The API rejects duplicate keys, and a single flag's parser cannot see the other flag's values, | ||
| * so callers must check the merged list. | ||
| */ | ||
| export const findDuplicateKey = (variables: DeployEnvironmentVariable[]): string | undefined => { | ||
| const seen = new Set<string>(); | ||
|
|
||
| for (const { key } of variables) { | ||
| if (seen.has(key)) { | ||
|
Contributor
There was a problem hiding this comment. Should we .toUpperCase() in case there is some case sensitive ops later ? could avoid some troubleshooting for us later |
||
| return key; | ||
| } | ||
| seen.add(key); | ||
| } | ||
|
|
||
| return undefined; | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think a couple of your changes are using the old formatter,might need to run some NPM commands to make CI happy