Improve Env abstraction#4004
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Warning
- Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.
Pull request overview
This PR refactors and centralizes environment-variable handling by introducing ReadOnlyEnv alongside a writable Env, moving GitHub Actions env-var constants into environment.ts, and updating key helpers/tests to support environment injection (defaulting to getEnv() for compatibility).
Changes:
- Reworked the environment abstraction: added
ReadOnlyEnv, turnedEnvinto a class, and addedActionsEnvVars/newEnvVarentries insrc/environment.ts. - Updated
actions-util.tsandapi-client.tsto accept an injectable environment (defaulting togetEnv()), and adjusted tests accordingly. - Kept backward compatibility by re-exporting env helpers from
src/util.ts.
Show a summary per file
| File | Description |
|---|---|
| src/environment.ts | Introduces ReadOnlyEnv/Env classes, adds ActionsEnvVars, and expands EnvVar constants. |
| src/util.ts | Removes local env helper implementations and re-exports env helpers for backwards compatibility. |
| src/actions-util.ts | Switches env access to the new Env abstraction and threads an injectable env through several helpers. |
| src/api-client.ts | Allows getApiDetails/getApiClient to read required env vars via an injected ReadOnlyEnv. |
| src/testing-utils.ts | Updates test helpers to support setting Actions env vars via Env. |
| src/api-client.test.ts | Updates tests to pass a test environment object rather than stubbing required env param helpers. |
| src/setup-codeql.test.ts | Uses EnvVar constants for Code Scanning PR env vars. |
| src/init.test.ts | Uses ActionsEnvVars constant for RUNNER_ENVIRONMENT. |
| src/autobuild.ts | Uses ActionsEnvVars.RUNNER_ENVIRONMENT instead of a raw string lookup. |
| src/config/remote-file.ts | Switches ActionsEnvVars import to environment.ts. |
| src/config/remote-file.test.ts | Switches ActionsEnvVars import to environment.ts. |
| lib/entry-points.js | Generated JS output change (not reviewed; diff content excluded by policy). |
Review details
Files excluded by content exclusion policy (1)
- lib/entry-points.js
- Files reviewed: 11/12 changed files
- Comments generated: 1
- Review effort level: Low
Comment on lines
+70
to
+73
| export function getTemporaryDirectory(env: Env = getEnv()): string { | ||
| return ( | ||
| env.getOptional(EnvVar.TEMP) ?? env.getRequired(ActionsEnvVars.RUNNER_TEMP) | ||
| ); |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR cherry-picks some changes from #3994 and addresses review feedback there related to the new
Envabstraction.Main changes
action-utils.tscan now be provided with anEnvto use. For backwards-compatibility, they default togetEnv()if none is provided.Envinterface into anEnvclass and aReadOnlyEnvclass.environment.tsOut of scope
ReadOnlyEnvor supplying functions inaction-utils.tswith new arguments) everywhere that makes sense.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
dynamicworkflows (Default Setup, Code Quality, ...).Products:
analysis-kinds: code-scanning.analysis-kinds: code-quality.upload-sarifaction.Environments:
github.comand/or GitHub Enterprise Cloud with Data Residency.How did/will you validate this change?
.test.tsfiles).pr-checks).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist