Decide which panel should be active for a dock based on ordering panels (#22346)

This means that `workspace::ToggleRightDock` will open the assistant if
no right-dock panel has been manually activated, instead of the chat as
before. Also cleans up the `active_panel_index` logic a bit.

cc @nathansobo 

Release Notes:

- Make `workspace::ToggleRightDock` open the assistant panel if no
right-dock panel has yet been activated

crates/assistant/src/assistant_panel.rs

@@ -1458,6 +1458,10 @@ impl Panel for AssistantPanel {
     fn toggle_action(&self) -> Box<dyn Action> {
         Box::new(ToggleFocus)
     }
+
+    fn activation_priority(&self) -> u32 {
+        4
+    }
 }
 
 impl EventEmitter<PanelEvent> for AssistantPanel {}

crates/assistant2/src/assistant_panel.rs

@@ -286,6 +286,10 @@ impl Panel for AssistantPanel {
     fn toggle_action(&self) -> Box<dyn Action> {
         Box::new(ToggleFocus)
     }
+
+    fn activation_priority(&self) -> u32 {
+        3
+    }
 }
 
 impl AssistantPanel {

crates/collab_ui/src/chat_panel.rs

@@ -1141,6 +1141,7 @@ impl Panel for ChatPanel {
             ChatPanelButton::WhenInCall => ActiveCall::global(cx)
                 .read(cx)
                 .room()
+                .filter(|room| room.read(cx).contains_guests())
                 .map(|_| ui::IconName::MessageBubbles),
         }
     }
@@ -1159,6 +1160,10 @@ impl Panel for ChatPanel {
             .room()
             .is_some_and(|room| room.read(cx).contains_guests())
     }
+
+    fn activation_priority(&self) -> u32 {
+        7
+    }
 }
 
 impl EventEmitter<PanelEvent> for ChatPanel {}

crates/collab_ui/src/collab_panel.rs

@@ -2763,6 +2763,10 @@ impl Panel for CollabPanel {
     fn persistent_name() -> &'static str {
         "CollabPanel"
     }
+
+    fn activation_priority(&self) -> u32 {
+        6
+    }
 }
 
 impl FocusableView for CollabPanel {

crates/collab_ui/src/notification_panel.rs

@@ -731,6 +731,10 @@ impl Panel for NotificationPanel {
     fn toggle_action(&self) -> Box<dyn gpui::Action> {
         Box::new(ToggleFocus)
     }
+
+    fn activation_priority(&self) -> u32 {
+        8
+    }
 }
 
 pub struct NotificationToast {

crates/git_ui/src/git_panel.rs

@@ -1237,6 +1237,10 @@ impl Panel for GitPanel {
     fn toggle_action(&self) -> Box<dyn Action> {
         Box::new(ToggleFocus)
     }
+
+    fn activation_priority(&self) -> u32 {
+        2
+    }
 }
 
 fn diff_display_editor(cx: &mut WindowContext) -> View<Editor> {

crates/outline_panel/src/outline_panel.rs

@@ -4468,6 +4468,10 @@ impl Panel for OutlinePanel {
         })
         .detach()
     }
+
+    fn activation_priority(&self) -> u32 {
+        5
+    }
 }
 
 impl FocusableView for OutlinePanel {

crates/project_panel/src/project_panel.rs

@@ -4252,6 +4252,10 @@ impl Panel for ProjectPanel {
                 .map_or(false, |entry| entry.is_dir())
         })
     }
+
+    fn activation_priority(&self) -> u32 {
+        0
+    }
 }
 
 impl FocusableView for ProjectPanel {

crates/terminal_view/src/terminal_panel.rs

@@ -1393,6 +1393,10 @@ impl Panel for TerminalPanel {
     fn pane(&self) -> Option<View<Pane>> {
         Some(self.active_pane.clone())
     }
+
+    fn activation_priority(&self) -> u32 {
+        1
+    }
 }
 
 struct InlineAssistTabBarButton {

crates/workspace/src/dock.rs

@@ -53,6 +53,7 @@ pub trait Panel: FocusableView + EventEmitter<PanelEvent> {
     fn remote_id() -> Option<proto::PanelId> {
         None
     }
+    fn activation_priority(&self) -> u32;
 }
 
 pub trait PanelHandle: Send + Sync {
@@ -74,6 +75,7 @@ pub trait PanelHandle: Send + Sync {
     fn icon_label(&self, cx: &WindowContext) -> Option<String>;
     fn focus_handle(&self, cx: &AppContext) -> FocusHandle;
     fn to_any(&self) -> AnyView;
+    fn activation_priority(&self, cx: &AppContext) -> u32;
 }
 
 impl<T> PanelHandle for View<T>
@@ -151,6 +153,10 @@ where
     fn focus_handle(&self, cx: &AppContext) -> FocusHandle {
         self.read(cx).focus_handle(cx).clone()
     }
+
+    fn activation_priority(&self, cx: &AppContext) -> u32 {
+        self.read(cx).activation_priority()
+    }
 }
 
 impl From<&dyn PanelHandle> for AnyView {
@@ -165,7 +171,7 @@ pub struct Dock {
     position: DockPosition,
     panel_entries: Vec<PanelEntry>,
     is_open: bool,
-    active_panel_index: usize,
+    active_panel_index: Option<usize>,
     focus_handle: FocusHandle,
     pub(crate) serialized_dock: Option<DockData>,
     resizeable: bool,
@@ -218,7 +224,7 @@ impl Dock {
         let workspace = cx.view().clone();
         let dock = cx.new_view(|cx: &mut ViewContext<Self>| {
             let focus_subscription = cx.on_focus(&focus_handle, |dock, cx| {
-                if let Some(active_entry) = dock.panel_entries.get(dock.active_panel_index) {
+                if let Some(active_entry) = dock.active_panel_entry() {
                     active_entry.panel.focus_handle(cx).focus(cx)
                 }
             });
@@ -231,7 +237,7 @@ impl Dock {
             Self {
                 position,
                 panel_entries: Default::default(),
-                active_panel_index: 0,
+                active_panel_index: None,
                 is_open: false,
                 focus_handle: focus_handle.clone(),
                 _subscriptions: [focus_subscription, zoom_subscription],
@@ -321,14 +327,15 @@ impl Dock {
             .position(|entry| entry.panel.remote_id() == Some(panel_id))
     }
 
-    pub fn active_panel_index(&self) -> usize {
+    fn active_panel_entry(&self) -> Option<&PanelEntry> {
         self.active_panel_index
+            .and_then(|index| self.panel_entries.get(index))
     }
 
     pub(crate) fn set_open(&mut self, open: bool, cx: &mut ViewContext<Self>) {
         if open != self.is_open {
             self.is_open = open;
-            if let Some(active_panel) = self.panel_entries.get(self.active_panel_index) {
+            if let Some(active_panel) = self.active_panel_entry() {
                 active_panel.panel.set_active(open, cx);
             }
 
@@ -363,7 +370,7 @@ impl Dock {
         panel: View<T>,
         workspace: WeakView<Workspace>,
         cx: &mut ViewContext<Self>,
-    ) {
+    ) -> usize {
         let subscriptions = [
             cx.observe(&panel, |_, _, cx| cx.notify()),
             cx.observe_global::<SettingsStore>({
@@ -399,10 +406,10 @@ impl Dock {
 
                     new_dock.update(cx, |new_dock, cx| {
                         new_dock.remove_panel(&panel, cx);
-                        new_dock.add_panel(panel.clone(), workspace.clone(), cx);
+                        let index = new_dock.add_panel(panel.clone(), workspace.clone(), cx);
                         if was_visible {
                             new_dock.set_open(true, cx);
-                            new_dock.activate_panel(new_dock.panels_len() - 1, cx);
+                            new_dock.activate_panel(index, cx);
                         }
                     });
                 }
@@ -456,17 +463,34 @@ impl Dock {
             }),
         ];
 
-        self.panel_entries.push(PanelEntry {
+        let index = match self
-            panel: Arc::new(panel.clone()),
+            .panel_entries
-            _subscriptions: subscriptions,
+            .binary_search_by_key(&panel.read(cx).activation_priority(), |entry| {
-        });
+                entry.panel.activation_priority(cx)
+            }) {
+            Ok(ix) => ix,
+            Err(ix) => ix,
+        };
+        if let Some(active_index) = self.active_panel_index.as_mut() {
+            if *active_index >= index {
+                *active_index += 1;
+            }
+        }
+        self.panel_entries.insert(
+            index,
+            PanelEntry {
+                panel: Arc::new(panel.clone()),
+                _subscriptions: subscriptions,
+            },
+        );
 
         if !self.restore_state(cx) && panel.read(cx).starts_open(cx) {
-            self.activate_panel(self.panel_entries.len() - 1, cx);
+            self.activate_panel(index, cx);
             self.set_open(true, cx);
         }
 
-        cx.notify()
+        cx.notify();
+        index
     }
 
     pub fn restore_state(&mut self, cx: &mut ViewContext<Self>) -> bool {
@@ -494,15 +518,17 @@ impl Dock {
             .iter()
             .position(|entry| entry.panel.panel_id() == Entity::entity_id(panel))
         {
-            match panel_ix.cmp(&self.active_panel_index) {
+            if let Some(active_panel_index) = self.active_panel_index.as_mut() {
-                std::cmp::Ordering::Less => {
+                match panel_ix.cmp(active_panel_index) {
-                    self.active_panel_index -= 1;
+                    std::cmp::Ordering::Less => {
+                        *active_panel_index -= 1;
+                    }
+                    std::cmp::Ordering::Equal => {
+                        self.active_panel_index = None;
+                        self.set_open(false, cx);
+                    }
+                    std::cmp::Ordering::Greater => {}
                 }
-                std::cmp::Ordering::Equal => {
-                    self.active_panel_index = 0;
-                    self.set_open(false, cx);
-                }
-                std::cmp::Ordering::Greater => {}
             }
             self.panel_entries.remove(panel_ix);
             cx.notify();
@@ -514,13 +540,13 @@ impl Dock {
     }
 
     pub fn activate_panel(&mut self, panel_ix: usize, cx: &mut ViewContext<Self>) {
-        if panel_ix != self.active_panel_index {
+        if Some(panel_ix) != self.active_panel_index {
-            if let Some(active_panel) = self.panel_entries.get(self.active_panel_index) {
+            if let Some(active_panel) = self.active_panel_entry() {
                 active_panel.panel.set_active(false, cx);
             }
 
-            self.active_panel_index = panel_ix;
+            self.active_panel_index = Some(panel_ix);
-            if let Some(active_panel) = self.panel_entries.get(self.active_panel_index) {
+            if let Some(active_panel) = self.active_panel_entry() {
                 active_panel.panel.set_active(true, cx);
             }
 
@@ -534,12 +560,13 @@ impl Dock {
     }
 
     pub fn active_panel(&self) -> Option<&Arc<dyn PanelHandle>> {
-        Some(&self.panel_entries.get(self.active_panel_index)?.panel)
+        let panel_entry = self.active_panel_entry()?;
+        Some(&panel_entry.panel)
     }
 
     fn visible_entry(&self) -> Option<&PanelEntry> {
         if self.is_open {
-            self.panel_entries.get(self.active_panel_index)
+            self.active_panel_entry()
         } else {
             None
         }
@@ -563,16 +590,14 @@ impl Dock {
 
     pub fn active_panel_size(&self, cx: &WindowContext) -> Option<Pixels> {
         if self.is_open {
-            self.panel_entries
+            self.active_panel_entry().map(|entry| entry.panel.size(cx))
-                .get(self.active_panel_index)
-                .map(|entry| entry.panel.size(cx))
         } else {
             None
         }
     }
 
     pub fn resize_active_panel(&mut self, size: Option<Pixels>, cx: &mut ViewContext<Self>) {
-        if let Some(entry) = self.panel_entries.get_mut(self.active_panel_index) {
+        if let Some(entry) = self.active_panel_entry() {
             let size = size.map(|size| size.max(RESIZE_HANDLE_SIZE).round());
 
             entry.panel.set_size(size, cx);
@@ -733,7 +758,7 @@ impl Render for PanelButtons {
                 let name = entry.panel.persistent_name();
                 let panel = entry.panel.clone();
 
-                let is_active_button = i == active_index && is_open;
+                let is_active_button = Some(i) == active_index && is_open;
                 let (action, tooltip) = if is_active_button {
                     let action = dock.toggle_action();
 
@@ -888,6 +913,10 @@ pub mod test {
         fn set_active(&mut self, active: bool, _cx: &mut ViewContext<Self>) {
             self.active = active;
         }
+
+        fn activation_priority(&self) -> u32 {
+            100
+        }
     }
 
     impl FocusableView for TestPanel {

crates/workspace/src/workspace.rs

@@ -2297,6 +2297,10 @@ impl Workspace {
             let was_visible = dock.is_open() && !other_is_zoomed;
             dock.set_open(!was_visible, cx);
 
+            if dock.active_panel().is_none() && dock.panels_len() > 0 {
+                dock.activate_panel(0, cx);
+            }
+
             if let Some(active_panel) = dock.active_panel() {
                 if was_visible {
                     if active_panel.focus_handle(cx).contains_focused(cx) {
@@ -7267,14 +7271,10 @@ mod tests {
         let (panel_1, panel_2) = workspace.update(cx, |workspace, cx| {
             let panel_1 = cx.new_view(|cx| TestPanel::new(DockPosition::Left, cx));
             workspace.add_panel(panel_1.clone(), cx);
-            workspace
+            workspace.toggle_dock(DockPosition::Left, cx);
-                .left_dock()
-                .update(cx, |left_dock, cx| left_dock.set_open(true, cx));
             let panel_2 = cx.new_view(|cx| TestPanel::new(DockPosition::Right, cx));
             workspace.add_panel(panel_2.clone(), cx);
-            workspace
+            workspace.toggle_dock(DockPosition::Right, cx);
-                .right_dock()
-                .update(cx, |right_dock, cx| right_dock.set_open(true, cx));
 
             let left_dock = workspace.left_dock();
             assert_eq!(

crates/zed/src/zed.rs

@@ -345,7 +345,7 @@ fn initialize_panels(prompt_builder: Arc<PromptBuilder>, cx: &mut ViewContext<Wo
             workspace.add_panel(channels_panel, cx);
             workspace.add_panel(chat_panel, cx);
             workspace.add_panel(notification_panel, cx);
-            workspace.add_panel(assistant_panel, cx);
+            workspace.add_panel(assistant_panel, cx)
         })?;
 
         let git_ui_enabled = git_ui_feature_flag.await;
@@ -380,7 +380,9 @@ fn initialize_panels(prompt_builder: Arc<PromptBuilder>, cx: &mut ViewContext<Wo
             } else {
                 workspace.register_action(assistant::AssistantPanel::inline_assist);
             }
-        })
+        })?;
+
+        anyhow::Ok(())
     })
     .detach();
 }