fix: Recalculate completion when going through prompt history #3193
Conversation
It should not be possible to update the line without also updating the completion since the completion holds an index into the line.
with_line was the last function where recalculate completion had to be done manually. This function now also recalculates the completion so that it's impossible to forget.
|
With the last two commits it's no longer possible to call a function that modifies the prompt line without also updating the completion. The only direct calls to recalculate the completion now happen when you want to have a completion with an empty line. I think this makes sense since you might not always want to have the completion list. |
There was a problem hiding this comment.
@Frojdholm Thank you for this solution.
I've done some manual testing locally and it has not crashed on me yet.
I am new to Rust.. not to programming.. and these changes look solid to me.
I also noticed the pairing of exit_selection and recalculate_completion and am wondering if an extra (private) function to join them is warranted to keep the code short. But as the order may or may not be of importance (reversed in clear function) this may just add noise, especially since this is local to this module.
great start on testing (for regression ;))
my 2cnts.
Keeping the selection index when the completion has been recalculated doesn't make sense. This clears the selection automatically, removing most needs to manually clear it.
Great!
I looked into it. In the future you could try to match the previous selection into the new list if possible, but I don't think the extra complexity would be worth it. |
There was a problem hiding this comment.
Since the whole prompt state is very interconnected (line, completion list and selection for example), care must be taken when modifying it so as not to make it go out of sync.
With these changes I think the public API of Prompt should be safe such that the internal state can't go out of sync by calling any public methods.
| let cursor = line.len(); | ||
| self.line = line; | ||
| self.cursor = cursor; | ||
| self.recalculate_completion(editor); |
There was a problem hiding this comment.
Another reasonable approach here would be to clear the completion list instead of recalculating it, since this function is likely to be used initializing a new prompt and the consumer might not want completions to be calculated instantly.
helix-term/src/ui/picker.rs
Outdated
| @@ -466,12 +466,12 @@ impl<T: Item> Picker<T> { | |||
| .map(|(index, _score)| &self.options[*index]) | |||
| } | |||
|
|
|||
| pub fn save_filter(&mut self, cx: &Context) { | |||
| pub fn save_filter(&mut self, cx: &mut Context) { | |||
…editor#3193) * fix: Recalculate completion when going through prompt history * Update completion when the prompt line is changed It should not be possible to update the line without also updating the completion since the completion holds an index into the line. * Fix Prompt::with_line recalculate completion with_line was the last function where recalculate completion had to be done manually. This function now also recalculates the completion so that it's impossible to forget. * Exit selection when recalculating completion Keeping the selection index when the completion has been recalculated doesn't make sense. This clears the selection automatically, removing most needs to manually clear it. * Remove &mut on save_filter Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
…editor#3193) * fix: Recalculate completion when going through prompt history * Update completion when the prompt line is changed It should not be possible to update the line without also updating the completion since the completion holds an index into the line. * Fix Prompt::with_line recalculate completion with_line was the last function where recalculate completion had to be done manually. This function now also recalculates the completion so that it's impossible to forget. * Exit selection when recalculating completion Keeping the selection index when the completion has been recalculated doesn't make sense. This clears the selection automatically, removing most needs to manually clear it. * Remove &mut on save_filter Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
…editor#3193) * fix: Recalculate completion when going through prompt history * Update completion when the prompt line is changed It should not be possible to update the line without also updating the completion since the completion holds an index into the line. * Fix Prompt::with_line recalculate completion with_line was the last function where recalculate completion had to be done manually. This function now also recalculates the completion so that it's impossible to forget. * Exit selection when recalculating completion Keeping the selection index when the completion has been recalculated doesn't make sense. This clears the selection automatically, removing most needs to manually clear it. * Remove &mut on save_filter Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
Fixes a panic related to completion when using the arrow keys to navigate through the prompt history.
Minimal reproduction steps for the panic
It should not be possible to modify the prompt
linewithout also updating completion list. Most functions modifying thelineupdate the completions.Prompt::insert_strandPrompt::change_historydoes not which allows this panic to happen. This means that the<c-s>shortcut probably also can create a panic and there are also possible panics in the DAP prompt as well (helix-term/src/commands/dap.rs).This PR fixes the immediate problem, but I think I real solution should force update the completion list when updating the prompt line in some centralized way. Another solution might be to tie the completion list more tightly to the prompt line itself so that it can be recalculated if needed when completing.