-
Notifications
You must be signed in to change notification settings - Fork 19
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
Bad UX when .resh_history.json
is corrupted
#171
Comments
Thanks for the thorough description of the issue and steps leading to it. Great suggestions. Currently, there is just one simple self-healing mechanism for This was added as a fix for situations when people hard reset their computers or something similar. Most of the times Resh appends to the file so only one line at the end of the file is corrupted. Silently dropping a single corrupted line solves that. The limit of just one line is motivated the fact that we don't want to risk silently dropping a lot of lines. I agree that the UX is bad when larger corruption happens to the history file. |
In
This should point people into docs where they will find something like this:
|
In |
I am going to write a chronological list of what I did, and summarize my suggestions for improvements at the bottom.
I restarted the terminal; the errors persisted.
I verified that no
resh-daemon
was running.I tried invoking
resh-daemon
myself:It gave error code 1, but no further explanation.
resh-daemon --help
did not give a help and probably just ignored the flag.man resh-daemon
(understandably) did not find an entry.The related issues I found on resh's GitHub did not talk about file corruption or a fix.
I ran
jq . .resh_history.json
, which – after some time – yieldedYou can make of my "story" whatever you want, but here is what I'd suggest as improvements:
Since the error messages are rather annoying anyway, why not add further information about how to proceed if restarting the terminal doesn't work, e.g. deleting the history file, checking for updates, temporarily disabling resh or reporting an Issue on GitHub.
resh-daemon
should tell me what's wrong, or at least give me an intuitive option to do so. In case there already are such options, I expect to find them using--help
orman
.One might consider expanding the notes on troubleshooting in the README or a separate file/wiki.
Backstory: Log spam completely filled my SSD, which probably caused the corruption.
The text was updated successfully, but these errors were encountered: