gateway: restore original filename in ReadFile error message #3990
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
All messages returned by os.Open are guaranteed to return a PathError. However, as these error messages are printed, they include the temporary directory for the mounted reference which is not useful to the caller. On an error, we can restore the filename in the PathError to the requested filename, as also seen in os.DirFS. Signed-off-by: Justin Chadwell <[email protected]>
tonistiigi
reviewed
Jul 6, 2023
cache/util/fsutil.go
Outdated
| // The filename here is internal to the mount, so we can restore | ||
| // the request base path for error reporting. | ||
| // See os.DirFS.Open for details. | ||
| err.(*os.PathError).Path = req.Filename |
There was a problem hiding this comment.
Although this is documented behavior, I don't like this direct type-cast. It should be type detection or errors.As.
cache/util/fsutil.go
Outdated
| if req.Range == nil { | ||
| dt, err = os.ReadFile(fp) | ||
| dt, err = io.ReadAll(f) | ||
| f.Close() |
There was a problem hiding this comment.
f.Close() duplication in here could be cleaner with defer.
Technically the io.ReadAll() duplication is not needed as well but not sure if that part is worth optimizing.
Signed-off-by: Tonis Tiigi <[email protected]>
crazy-max
approved these changes
Jul 7, 2023
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.
All messages returned by
os.Openare guaranteed to return aPathError. However, as these error messages are printed, they include the temporary directory for the mounted reference which is not useful to the caller.On an error, we can restore the filename in the PathError to the requested filename, as also seen in os.DirFS.
In the following example, we perform a docker build in an empty directory:
Before:
After (note the no temp mount in the error message):
(cc @nicks, we discussed simplification of docker error messages before)