Validate project config srcDir within project root
#951
Conversation
This file contains 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
Adds validation within `validateProjectConfig` to ensure the srcDir of a project points to either the project root, or a subdirectory. This will help ensure a user doesn't attempt to upload a parent or root directory by mistake. Adds a suite of jest tests to confirm our current validations, as well as the new validation logic. To support the testing with mocks around `process.exit`, added `return` statements to all the spots in `validateProjectConfig` where the whole node process would be existing anyway. Open to reverting those changes and using exceptions in the mocking of `process.exit` if that'd be cleaner / clearer.
Also reworks the error message for srcOutsideProjectDir to be more informative and actionable
Drops including the "project root" filesystem path, and just has the message say project root.
brandenrodgers
approved these changes
Nov 7, 2023
| @@ -87,6 +88,8 @@ exports.handler = async options => { | |||
| process.exit(EXIT_CODES.ERROR); | |||
| } | |||
|
|
|||
| validateProjectConfig(projectConfig, projectDir); | |||
There was a problem hiding this comment.
Callout for the top level PR. This addition is intentional.
The dev command should be validating the project configuration for use later on.
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.
Description and Context
Adds validation within
validateProjectConfigto ensure the srcDir of a project points to either the project root, or a subdirectory. This will help ensure a user doesn't attempt to upload a parent or root directory by mistake.Adds a suite of jest tests to confirm our current validations, as well as the new validation logic.
To support the testing with mocks around
process.exit, addedreturnstatements to all the spots invalidateProjectConfigwhere the whole node process would be existing anyway. Open to reverting those changes and using exceptions in the mocking ofprocess.exitif that'd be cleaner / clearer.Screenshots
cc @camden11 @brandenrodgers