-
Notifications
You must be signed in to change notification settings - Fork 3
Improve the error messages for file I/O errors #355
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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
This improves the error messages shown for file related I/O errors, by: - ensuring that the path is always included - adding additional suggestions to the error based on the context (which is now known, since specialised types are used for each of the common scenarios like checking if a file exists or reading a file to a string) We're able to make the errors richer than those provided by `fs-err`, since we know the context in which the errors have occurred. For example, in the error message for `ReadOptionalFileError`s we know not to say to check for a missing file or that the file is a directory, since `read_optional_file()` explicitly excludes those cases by design. If we used `io::Error` (or `fs-err`'s equivalent) we wouldn't have to rely on the user not using the wrong logging function for the wrong I/O error case, rather than relying on the type system to do that for us. These changes leave `log_io_error()` as being used only for the `Command` I/O cases. A later PR will switch adjust those usages too (but this PR is already large enough). Closes #270. GUS-W-12650236.
Malax
approved these changes
Apr 29, 2025
edmorley
added a commit
that referenced
this pull request
Apr 29, 2025
Similar to #355 but for I/O errors from spawning a `Command` instead of from file operations. Such Command I/O errors are only likely to happen in the case of a bug, so the error message now says as much. The error also now generates the program name from the command, so avoid it getting out of sync. The command's args are intentionally omitted, since they aren't relevant for errors that occur when spawning a command. (ie: For command not found, it's the program that's not found, not the args.) GUS-W-12650236.
edmorley
added a commit
that referenced
this pull request
Apr 29, 2025
Similar to #355 but for I/O errors from spawning a `Command` instead of from file operations. Such Command I/O errors are only likely to happen in the case of a bug, so the error message now says as much. The error also now generates the program name from the command, so avoid it getting out of sync. The command's args are intentionally omitted, since they aren't relevant for errors that occur when spawning a command. (ie: For command not found, it's the program that's not found, not the args.) GUS-W-12650236.
edmorley
added a commit
that referenced
this pull request
Apr 29, 2025
Similar to #355 but for I/O errors from spawning a `Command` instead of from file operations. Such Command I/O errors are only likely to happen in the case of a bug, so the error message now says as much. The error also now generates the program name from the command, so avoid it getting out of sync. The command's args are intentionally omitted, since they aren't relevant for errors that occur when spawning a command. (ie: For command not found, it's the program that's not found, not the args.) GUS-W-12650236.
heroku-linguist bot
added a commit
that referenced
this pull request
May 2, 2025
## heroku/python ### Removed - Removed support for the deprecated `runtime.txt` file. Python versions must now be specified using a `.python-version` file instead. ([#352](#352)) - Removed support for Ubuntu 20.04 (and thus Heroku-20 / `heroku/builder:20`). ([#358](#358)) ### Changed - Improved the error messages shown when `.python-version` contains an invalid Python version or stray invisible characters (such as ASCII control codes). ([#353](#353) and [#354](#354)) - Improved the error messages shown if I/O errors occur. ([#355](#355) and [#356](#356))
Merged
heroku-linguist bot
added a commit
to heroku/cnb-builder-images
that referenced
this pull request
May 2, 2025
## heroku/python ### Removed - Removed support for the deprecated `runtime.txt` file. Python versions must now be specified using a `.python-version` file instead. ([#352](heroku/buildpacks-python#352)) - Removed support for Ubuntu 20.04 (and thus Heroku-20 / `heroku/builder:20`). ([#358](heroku/buildpacks-python#358)) ### Changed - Improved the error messages shown when `.python-version` contains an invalid Python version or stray invisible characters (such as ASCII control codes). ([#353](heroku/buildpacks-python#353) and [#354](heroku/buildpacks-python#354)) - Improved the error messages shown if I/O errors occur. ([#355](heroku/buildpacks-python#355) and [#356](heroku/buildpacks-python#356))
edmorley
added a commit
to heroku/heroku-buildpack-python
that referenced
this pull request
May 2, 2025
Backports the improvements made as part of: - heroku/buildpacks-python#352 - heroku/buildpacks-python#353 - heroku/buildpacks-python#354 - heroku/buildpacks-python#355 Plus: - applies similar changes to equivalent error messages that only exist in the classic buildpack (eg the Pipenv errors) - switches to use of contractions as per the CX team's style guidelines GUS-W-18225347. GUS-W-18421778.
edmorley
added a commit
to heroku/heroku-buildpack-python
that referenced
this pull request
May 2, 2025
Backports the error message/build output improvements made as part of: - heroku/buildpacks-python#352 - heroku/buildpacks-python#353 - heroku/buildpacks-python#354 - heroku/buildpacks-python#355 Plus: - applies similar changes to equivalent error messages that only exist in the classic buildpack (eg the Pipenv errors) - switches to use of contractions as per the CX team's style guidelines GUS-W-18225347. GUS-W-18421778.
edmorley
added a commit
to heroku/heroku-buildpack-python
that referenced
this pull request
May 2, 2025
Backports the error message/build output improvements made as part of: - heroku/buildpacks-python#352 - heroku/buildpacks-python#353 - heroku/buildpacks-python#354 - heroku/buildpacks-python#355 Plus: - applies similar changes to equivalent error messages that only exist in the classic buildpack (eg the Pipenv errors) - switches to use of contractions as per the CX team's style guidelines GUS-W-18225347. GUS-W-18421778.
edmorley
added a commit
to heroku/heroku-buildpack-python
that referenced
this pull request
May 2, 2025
Backports the error message/build output improvements made as part of: - heroku/buildpacks-python#352 - heroku/buildpacks-python#353 - heroku/buildpacks-python#354 - heroku/buildpacks-python#355 Plus: - applies similar changes to equivalent error messages that only exist in the classic buildpack (eg the Pipenv errors) - switches to use of contractions as per the CX team's style guidelines GUS-W-18225347. GUS-W-18421778.
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.
This improves the error messages shown for file related I/O errors, by:
We're able to make the errors richer than those provided by
fs-err
, since we know the context in which the errors have occurred.For example, in the error message for
ReadOptionalFileError
s we know not to say to check for a missing file or that the file is a directory, sinceread_optional_file()
explicitly excludes those cases by design. If we usedio::Error
(orfs-err
's equivalent) we would have to rely on the user not using the wrong logging function for the wrong I/O error case, rather than relying on the type system to do that for us.These changes leave
log_io_error()
as being used only for theCommand
I/O cases. A later PR will switch adjust those usages too (but this PR is already large enough).Closes #270.
GUS-W-12650236.