Add details in error message for missing Project.toml #467
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
I have seen this error come up a few times when `subdir` is missing or has a typo, which can confuse people. I think if we can pass through those parameters it might call more attention to whatever is wrong.
| # Get the (Julia)Project.toml, and make sure it is valid. | ||
| toml = gettoml(u.forge, repo, ref, subdir) | ||
| toml === nothing && return json(400; error="(Julia)Project.toml was not found") | ||
| toml === nothing && return json(400; error="(Julia)Project.toml was not found in repo `$repo` with ref `$ref` and subdir `$subdir`") |
Member
There was a problem hiding this comment.
repo, ref, and subdir are untrusted inputs provided by the user, so do we need to escape or sanitize them here?
Member
Author
There was a problem hiding this comment.
I don't think so, since error is just a string no matter what repo/subdir/ref are. So then json should serialize it to a JSON string (i.e. adding escaping if needed). So I can't really see what the issue would be in this case.
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.
I have seen this error come up a few times when
subdiris missing or has a typo, which can confuse people. I think if we can pass through those parameters it might call more attention to whatever is wrong.note: untested