Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

Prevent existing tabs on move from emitting `AddItem` on reordering (#65795)

Matei Oprea2afec34882c9
diff --git a/crates/markdown_preview/src/markdown_preview_view.rs b/crates/markdown_preview/src/markdown_preview_view.rs
index 10470ff9318..7c2ec3a20dc 100644
--- a/crates/markdown_preview/src/markdown_preview_view.rs
+++ b/crates/markdown_preview/src/markdown_preview_view.rs
@@ -147,7 +147,7 @@ impl MarkdownPreviewView {
if cx
.global_mut::<SuppressedAutoPreviews>()
.0
- .remove(&item.item_id())
+ .contains(&item.item_id())
{
return;
}
@@ -1039,10 +1039,19 @@ impl MarkdownPreviewView {
return;
};
if !workspace.activate_item(&editor, true, true, window, cx) {
- // Re-adding the source emits `ItemAdded`; suppress its automatic preview once.
+ let editor_entity_id = editor.entity_id();
+ // Re-adding the source emits `ItemAdded`; suppress its automatic preview for the editor's lifetime.
cx.global_mut::<SuppressedAutoPreviews>()
.0
- .insert(editor.entity_id());
+ .insert(editor_entity_id);
+
+ App::observe_release(cx, &editor, move |_, cx| {
+ cx.global_mut::<SuppressedAutoPreviews>()
+ .0
+ .remove(&editor_entity_id);
+ })
+ .detach();
+
workspace.add_item(
pane.clone(),
Box::new(editor),
@@ -2368,6 +2377,7 @@ mod tests {
use util::paths::{PathStyle, PathWithPosition};
use util::rel_path::{RelPath, rel_path};
use util::test::TempTree;
+ use workspace::SplitDirection;
use workspace::item::{Item, ItemHandle, SerializableItem};
use workspace::path_link::{OpenTarget, OpenTargetFoundBy};
use workspace::{
@@ -3650,6 +3660,118 @@ mod tests {
assert_no_markdown_preview_items(cx, &multi_workspace);
}
+ #[gpui::test]
+ async fn reordering_editor_tab_after_returning_to_editor_does_not_reopen_preview(
+ cx: &mut TestAppContext,
+ ) {
+ let (project, workspace, multi_workspace) = markdown_workspace(
+ cx,
+ json!({ "note.md": "# Note\n", "plain.txt": "plain" }),
+ false,
+ )
+ .await;
+ cx.update(|cx| set_auto_preview_enabled(cx, true));
+
+ open_project_file(cx, &project, &multi_workspace, "plain.txt", None, false).await;
+ open_project_file(cx, &project, &multi_workspace, "note.md", None, true).await;
+
+ let preview = cx.update(|cx| {
+ workspace
+ .read(cx)
+ .active_item_as::<MarkdownPreviewView>(cx)
+ .unwrap()
+ });
+ let editor = preview.read_with(cx, |preview, _| {
+ preview.active_editor.as_ref().unwrap().editor.clone()
+ });
+
+ dispatch_close_and_return_to_editor(cx, &multi_workspace, &preview);
+ cx.run_until_parked();
+
+ assert_editor_is_active_and_focused(cx, &multi_workspace, &editor);
+ assert_no_markdown_preview_items(cx, &multi_workspace);
+
+ let pane = cx.update(|cx| workspace.read(cx).active_pane().clone());
+ let (editor_index_before_move, destination_index) = cx.update(|cx| {
+ let pane = pane.read(cx);
+ assert_eq!(pane.items_len(), 2);
+ let editor_index = pane.index_for_item(&editor).unwrap();
+ let other_index = if editor_index == 0 { 1 } else { 0 };
+ (editor_index, other_index)
+ });
+ multi_workspace
+ .update(cx, |_, window, cx| {
+ workspace::move_item(
+ &pane,
+ &pane,
+ editor.entity_id(),
+ destination_index,
+ true,
+ window,
+ cx,
+ );
+ })
+ .unwrap();
+ cx.run_until_parked();
+
+ cx.update(|cx| {
+ let editor_index_after_move = pane.read(cx).index_for_item(&editor).unwrap();
+ assert_ne!(editor_index_after_move, editor_index_before_move);
+ });
+
+ assert_editor_is_active_and_focused(cx, &multi_workspace, &editor);
+ assert_no_markdown_preview_items(cx, &multi_workspace);
+ }
+
+ #[gpui::test]
+ async fn moving_editor_tab_to_new_pane_after_returning_to_editor_does_not_reopen_preview(
+ cx: &mut TestAppContext,
+ ) {
+ let (project, workspace, multi_workspace) = markdown_workspace(
+ cx,
+ json!({ "note.md": "# Note\n", "plain.txt": "plain" }),
+ false,
+ )
+ .await;
+ cx.update(|cx| set_auto_preview_enabled(cx, true));
+
+ open_project_file(cx, &project, &multi_workspace, "plain.txt", None, false).await;
+ open_project_file(cx, &project, &multi_workspace, "note.md", None, true).await;
+
+ let preview = cx.update(|cx| {
+ workspace
+ .read(cx)
+ .active_item_as::<MarkdownPreviewView>(cx)
+ .unwrap()
+ });
+ let editor = preview.read_with(cx, |preview, _| {
+ preview.active_editor.as_ref().unwrap().editor.clone()
+ });
+
+ dispatch_close_and_return_to_editor(cx, &multi_workspace, &preview);
+ cx.run_until_parked();
+
+ assert_editor_is_active_and_focused(cx, &multi_workspace, &editor);
+ assert_no_markdown_preview_items(cx, &multi_workspace);
+
+ let pane_1 = cx.update(|cx| workspace.read(cx).active_pane().clone());
+ let pane_2 = multi_workspace
+ .update(cx, |_, window, cx| {
+ workspace.update(cx, |workspace, cx| {
+ workspace.split_pane(pane_1.clone(), SplitDirection::Right, window, cx)
+ })
+ })
+ .unwrap();
+ multi_workspace
+ .update(cx, |_, window, cx| {
+ workspace::move_item(&pane_1, &pane_2, editor.entity_id(), 0, false, window, cx);
+ })
+ .unwrap();
+ cx.run_until_parked();
+
+ assert_no_markdown_preview_items(cx, &multi_workspace);
+ }
+
#[gpui::test]
async fn preview_serialized_path_updates_when_source_file_is_renamed(cx: &mut TestAppContext) {
let app_state = init_test(cx);
@@ -4249,18 +4371,31 @@ mod tests {
editor.edit([(end..end, "dirty\n")], cx);
});
cx.update(|cx| set_auto_preview_enabled(cx, true));
-
- multi_workspace
+ let (target_pane, other_pane) = multi_workspace
.update(cx, |_, window, cx| {
workspace.update(cx, |workspace, cx| {
- workspace.add_item_to_active_pane(
- Box::new(editor.clone()),
- None,
- true,
+ let target_pane = workspace.active_pane().clone();
+ let other_pane = workspace.split_pane(
+ target_pane.clone(),
+ workspace::SplitDirection::Right,
window,
cx,
);
- });
+ (target_pane, other_pane)
+ })
+ })
+ .unwrap();
+ multi_workspace
+ .update(cx, |_, window, cx| {
+ workspace::move_item(
+ &target_pane,
+ &other_pane,
+ editor.entity_id(),
+ 1,
+ true,
+ window,
+ cx,
+ );
})
.unwrap();
cx.run_until_parked();
@@ -4273,6 +4408,7 @@ mod tests {
.iter()
.any(|pane| pane.read(cx).index_for_item(&editor).is_some())
);
+ assert_eq!(workspace.items_of_type::<Editor>(cx).count(), 1);
assert_eq!(
workspace.items_of_type::<MarkdownPreviewView>(cx).count(),
1
diff --git a/crates/workspace/src/pane.rs b/crates/workspace/src/pane.rs
index 70e7c500012..f11c6b52d48 100644
--- a/crates/workspace/src/pane.rs
+++ b/crates/workspace/src/pane.rs
@@ -1239,6 +1239,8 @@ impl Pane {
.iter()
.any(|existing_item| existing_item.item_id() == item.item_id());
+ let mut replaces_existing_item_in_pane = false;
+
if !item_already_exists {
self.close_items_on_item_open(window, cx);
}
@@ -1305,7 +1307,7 @@ impl Pane {
if existing_item_is_active && destination_index.is_none() {
insertion_index = existing_item_index;
} else {
- self.items.remove(existing_item_index);
+ let removed_item = self.items.remove(existing_item_index);
if existing_item_index < self.active_item_index {
self.active_item_index -= 1;
}
@@ -1318,6 +1320,10 @@ impl Pane {
} else if insertion_index <= self.active_item_index {
self.active_item_index += 1;
}
+
+ if removed_item.item_id() != item.item_id() {
+ replaces_existing_item_in_pane = true;
+ }
}
cx.notify();
@@ -1341,7 +1347,11 @@ impl Pane {
}
}
- cx.emit(Event::AddItem { item });
+ // only new adds or replaced items should be treated as "added". treating existing items as "added" would cause listeners
+ // like markdown auto preview to treat a pane move as a new item / fresh open.
+ if existing_item_index.is_none() || replaces_existing_item_in_pane {
+ cx.emit(Event::AddItem { item: item.clone() });
+ }
}
pub fn add_item(
@@ -7356,6 +7366,116 @@ mod tests {
assert_item_labels(&pane, ["A*", "B", "C"], cx);
}
+ #[gpui::test]
+ async fn test_move_item(cx: &mut TestAppContext) {
+ init_test(cx);
+ let fs = FakeFs::new(cx.executor());
+
+ let project = Project::test(fs, None, cx).await;
+ let (workspace, cx) =
+ cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
+ let pane = workspace.read_with(cx, |workspace, _| workspace.active_pane().clone());
+
+ let [first_item, _, _] = set_labeled_items(&pane, ["A", "B*", "C"], cx);
+
+ let add_item_event_count = Rc::new(Cell::new(0));
+ let _subscription = cx.update(|_, cx| {
+ cx.subscribe(&pane, {
+ let add_item_event_count = add_item_event_count.clone();
+ move |_pane, event: &Event, _cx| {
+ if matches!(event, Event::AddItem { .. }) {
+ add_item_event_count.set(add_item_event_count.get() + 1);
+ }
+ }
+ })
+ });
+
+ pane.update_in(cx, |pane, window, cx| {
+ // move pane
+ pane.add_item(first_item, false, false, Some(1), window, cx)
+ });
+
+ assert_item_labels(&pane, ["B", "A*", "C"], cx);
+ assert_eq!(add_item_event_count.get(), 0);
+
+ add_labeled_item(&pane, "D", false, cx);
+ assert_eq!(add_item_event_count.get(), 1);
+ }
+
+ #[gpui::test]
+ async fn test_move_item_to_different_pane(cx: &mut TestAppContext) {
+ init_test(cx);
+
+ let fs = FakeFs::new(cx.executor());
+
+ let project = Project::test(fs, None, cx).await;
+ let (workspace, cx) =
+ cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
+ let pane1 = workspace.read_with(cx, |workspace, _| workspace.active_pane().clone());
+ let pane2 = workspace.update_in(cx, |workspace, window, cx| {
+ workspace.split_pane(pane1.clone(), SplitDirection::Right, window, cx)
+ });
+
+ let item_a = pane1.update_in(cx, |pane, window, cx| {
+ let item = Box::new(cx.new(|cx| {
+ TestItem::new(cx)
+ .with_buffer_kind(ItemBufferKind::Singleton)
+ .with_label("a")
+ .with_project_items(&[TestProjectItem::new(1, "one.txt", cx)])
+ }));
+ pane.add_item(item.clone(), false, false, None, window, cx);
+ item
+ });
+
+ pane2.update_in(cx, |pane, window, cx| {
+ let item = Box::new(cx.new(|cx| {
+ TestItem::new(cx)
+ .with_buffer_kind(ItemBufferKind::Singleton)
+ .with_label("b")
+ .with_project_items(&[TestProjectItem::new(1, "one.txt", cx)])
+ }));
+ pane.add_item(item.clone(), false, false, None, window, cx);
+ item
+ });
+
+ assert_item_labels(&pane1, ["a*"], cx);
+ assert_item_labels(&pane2, ["b*"], cx);
+
+ let add_item_event_count = Rc::new(Cell::new(0));
+ let _subscription = cx.update(|_, cx| {
+ cx.subscribe(&pane2, {
+ let add_item_event_count = add_item_event_count.clone();
+ move |_pane, event: &Event, _cx| {
+ if matches!(event, Event::AddItem { .. }) {
+ add_item_event_count.set(add_item_event_count.get() + 1);
+ }
+ }
+ })
+ });
+ workspace.update_in(cx, |_, window, cx| {
+ move_item(
+ &pane1,
+ &pane2,
+ item_a.clone().entity_id(),
+ 2,
+ true,
+ window,
+ cx,
+ );
+ });
+
+ assert_item_labels(&pane1, [], cx);
+ assert_item_labels(&pane2, ["a*"], cx);
+
+ assert_eq!(add_item_event_count.get(), 1);
+
+ let pane_holding_item_a = workspace.read_with(cx, |workspace, _| {
+ let pane_id = workspace.pane_for_item_id(item_a.item_id()).unwrap();
+ pane_id
+ });
+ assert_eq!(pane_holding_item_a.entity_id(), pane2.entity_id());
+ }
+
#[gpui::test]
async fn test_add_item_with_same_project_entries(cx: &mut TestAppContext) {
init_test(cx);