fix(time-style): cryptic panic with invalid --time-syle format string #1282
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
cafkafk
requested changes
Dec 29, 2024
There was a problem hiding this comment.
The fix is to create a dummy StrftimeItems and iterate over it for errors to validate the format string beforehand.
I wonder what the performance characteristics of doing this is
Currently, snapshot tests are failling, and will have to be regenerated. just has a template in the repository for doing this
I have a few comment here, sorry for the volume of change requests but I do think none of them are nitpicky
Validate --time-style format string during option parsing so we can give a good error message rather than let rayon handle the panic and give no context. Fixes: eza-community#1240
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.
Fixes: #1240
Validate --time-style format string during option parsing.
That format string is later given to chrono via
DateTime.format(fmt).to_string().ToStringis implemented forT: Displayin std but panics ifDisplay::fmtreturns an error, and the object returned byDateTime.format(StrftimeItems) lazily returns an error inDisplay::fmtwhen it finally sees something invalid in the format string. This is also done inside a rayon threadpool so the resulting panic has little context for users.The fix is to create a dummy
StrftimeItemsand iterate over it for errors to validate the format string beforehand.