Introduce sequencing for 'pane focus' related events #6349
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
Switching between panes (especially over domains where large latencies are involved) can cause a loop where we get stuck repeatedly switching back and forth between two panes. This happens because handlers of `PaneFocused` events can also produce these events, causing us to get stuck in a loop if we let the GUI process stale `PaneFocused` events. The solution is to introduce a 'serial' (AKA 'sequence number') for GUI-initiated pane focus changes. This will be echo'd back by the server, which allows the GUI to avoid processing the response if it has sent a new request in the mean time. CLI-initiated pane focus changes (eg. via `wezterm cli activate-pane`) will continue to be unconditionally handled by the client. closes: wez#4390 closes: wez#4693
dzderic
commented
Nov 2, 2024
| @@ -111,6 +116,7 @@ pub struct Mux { | |||
| num_panes_by_workspace: RwLock<HashMap<String, usize>>, | |||
| main_thread_id: std::thread::ThreadId, | |||
| agent: Option<AgentProxy>, | |||
| pane_focus_serial: RwLock<InputSerial>, | |||
There was a problem hiding this comment.
Is there a better place to put this?
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.
Switching between panes (especially over domains where large latencies are involved) can cause a loop where we get stuck repeatedly switching back and forth between two panes. This happens because handlers of
PaneFocusedevents can also produce these events, causing us to get stuck in a loop if we let the GUI process stalePaneFocusedevents.The solution is to introduce a 'serial' (AKA 'sequence number') for GUI-initiated pane focus changes. This will be echo'd back by the server, which allows the GUI to avoid processing the response if it has sent a new request in the mean time. CLI-initiated pane focus changes (eg. via
wezterm cli activate-pane) will continue to be unconditionally handled by the client.Inspired by #4737 and #4737 (comment)
Verified
activate-pane-direction,activate-paneandactivate-tabstill work correctlycloses: #4390
closes: #4693