Help the user fix their working copy if it gets into a bad state #751
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
olsen232
force-pushed
the
help-with-desynced-wc
branch
from
f0c4ac3
to
0b1ede6
Compare
If Kart crashes or otherwise is aborted partway through a checkout operation, it is possible for the contents of the working copy or individual working copy parts to end up out of sync with what should be checked out based on the git file `.kart/HEAD`. Until now, this caused an internal error to be raised - WorkingCopyTreeMismatch, which gave some clues as to what had gone wrong but no real help on how to fix it. Since Kart checks the WC state is valid as a precondition to most commands, arriving in this state with no clear idea of how to get out of it makes a Kart repo feel pretty broken, as most commands will simply raise the same internal error. This change adds an external error including error code (which also suppresses the stack trace). The error message contains instructions on how to fix the repo so that it can be used again, and if run in an interactive terminal, prompts the user to decide if they want to try this remedy immediately.
olsen232
force-pushed
the
help-with-desynced-wc
branch
from
0b1ede6
to
718474d
Compare
craigds
requested changes
Dec 21, 2022
kart/working_copy.py
Outdated
| subctx = click.Context(ctx.command, parent=ctx) | ||
| subctx.obj = ctx.obj | ||
| subctx.invoke(create_workingcopy, delete_existing=True, discard_changes=True) | ||
| sys.exit(0) |
There was a problem hiding this comment.
If you get here by running another command, seems like we should not exit here and instead just run the original command
There was a problem hiding this comment.
Added a prompt to see if the user still wants to do it. Didn't want to do it by default since it may not still make sense (ie, probably the command depends on the state of the WC in some way or we wouldn't have got here).
There was a problem hiding this comment.
Can you give an example of what they might be trying to do that would now be a bad thing to do?
status/diff/commit would all be sensible here AFAICT (commit would just noop due to no changes)
craigds
approved these changes
Dec 21, 2022
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.
If Kart crashes or otherwise is aborted partway through a checkout operation, it is possible for the contents of the working copy or individual working copy parts to end up out of sync with what should be checked out based on the git file
.kart/HEAD.Until now, this caused an internal error to be raised - WorkingCopyTreeMismatch, which gave some clues as to what had gone wrong but no real help on how to fix it. Since Kart checks the WC state is valid as a precondition to many commands, arriving in this state with no clear idea of how to get out of it makes a Kart repo feel pretty broken, as most commands will simply raise the same internal error.
This change adds an external error including error code (which also suppresses the stack trace). The error message
contains instructions on how to fix the repo so that it can be used again, and if run in an interactive terminal, prompts
the user to decide if they want to try this remedy immediately.