Abort theme command when an invalid environment is provided #6698
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
Contributor
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success3485 tests passing in 1406 suites. Report generated by 🧪jest coverage report action from e92155e |
graygilmore
reviewed
Dec 9, 2025
|
|
||
| // Single environment or no environment | ||
| if (environments.length <= 1) { | ||
| if (environments[0] && !flags.store) { |
Contributor
There was a problem hiding this comment.
I've re-read this a few times and I don't think I understand how this works. Wouldn't environments[0] imply that there is an environment?
Contributor
Author
There was a problem hiding this comment.
Yup! So when you pass in an environment like -e my-store or --environment my-store it's extracted in the base command as the environment before it checks if it's valid or not. Even after it checks and is found to not be a valid environment, the flag.environment still has the value.
So in our case we check if an environment was actually set (no running a regular command like theme list still works without), and if the store flag is missing from the env. If it is, we know the command would not work.
Contributor
There was a problem hiding this comment.
Ah! Because we'd populate flags.store based on the environment. I gotcha now!
graygilmore
approved these changes
Dec 9, 2025
Contributor
graygilmore
left a comment
graygilmore
left a comment
There was a problem hiding this comment.
I was always confused as to why it worked this way
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
WHY are these changes introduced?
When running theme commands with an environment that doesn't exist, we fall back to using the cached store data instead (which can be a different store entirely).
See below pictures.
Legitimate Environment
We get a warning that the environment isn't found but still use the prior store
WHAT is this pull request doing?
When running a theme command, we will check if the environment has the store flag which is needed, if it doesn't exist, stop the command and return a warning.
I chose this way as we already run
loadEnvironmentin the base command and it only renders a warning that the environment doesn't exist.How to test your changes?
Post-release steps
Measuring impact
How do we know this change was effective? Please choose one:
Checklist