Return a more user-friendly error in workspace targeting for overlaps #2982
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
bufdev
reviewed
May 16, 2024
| for _, moduleDirPath := range moduleDirPaths { | ||
| if normalpath.ContainsPath(moduleDirPath, inputPath, normalpath.Relative) { | ||
| // In the case where the inputPath would appear to be relative to moduleDirPath, |
There was a problem hiding this comment.
If the path does exist but is empty though, this will be a confusing error message as well right?
There was a problem hiding this comment.
Yeah, this is true -- ideally I want to check if the directory is a valid prefix for the bucket. Given the IsEmpty check, I've tweaked this to return ErrNoTargetProtoFiles since the inputPath is empty (and I still think this is a valuable check/improvement over just returning the overlap error).
|
Let's punt this until after the release |
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.
In the past, if the an overlap is found between
moduleDirPathandinputPath,but
inputPathdoes not exist (e.g.moduleDirPath == "."andinputPath == "fake-path")then it would return the error:
Which isn't particularly clear, since
fake-pathdoesn't exist. Added a check to return anicer error to the user by checking
inputPath. Also included test cases forv1andv2workspaces.