Actions: Make Env non-abstract
#19675
Merged
Conversation
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
`class Env` was previously abstract with no concrete descendants, so user queries like `any(Env e | ...)` would never produce results. In the JS library the corresponding class derived from `YamlNode` and has concrete descendants representing workflow-, job- and step-level `env` nodes. However these are dubiously useful since you can always just use `any(Step s).getEnv()` to achieve the same result. Since `EnvImpl` already fully characterises an `env` node, I simply make the class concrete.
There was a problem hiding this comment.
Pull Request Overview
This PR makes the Env class instantiable (no longer abstract) so that queries like any(Env e | ...) can return results, and updates its documentation comment.
- Removed the
abstractkeyword fromEnvto allow concrete instances. - Refined the class doc comment for
Env.
Comments suppressed due to low confidence (2)
actions/ql/lib/codeql/actions/Ast.qll:53
- [nitpick] Consider clarifying the doc comment to follow project conventions, e.g.,
/** Represents an env block at the workflow, job, or step level. */for consistency and clarity.
/** An `env` in workflow, job or step. */
actions/ql/lib/codeql/actions/Ast.qll:54
- Add a CodeQL test to verify that
Envis now concrete and queryable (e.g., ensureany(Env e)returns expected nodes) to prevent regressions.
class Env extends AstNode instanceof EnvImpl {
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.
class Envwas previously abstract with no concrete descendants, so user queries likeany(Env e | ...)would never produce results.In the JS library the corresponding class derived from
YamlNodeand has concrete descendants representing workflow-, job- and step-levelenvnodes. However these are dubiously useful since you can always just useany(Step s).getEnv()to achieve the same result. SinceEnvImplalready fully characterises anenvnode, I simply make the class concrete.