Lukas Wirth and Ben Kunkle created
BufferEvent::Edited had no way to distinguish local edits from remote
(collaboration) edits. This caused edit prediction behavior to fire on
the guest's editor when the host made document changes.
Release Notes:
- Fixed edit predictions triggering on collaboration guests when the
host edits the document.
---------
Co-authored-by: Ben Kunkle <ben@zed.dev>crates/action_log/src/action_log.rs | 2
crates/assistant_text_thread/src/text_thread.rs | 2
crates/channel/src/channel_buffer.rs | 2
crates/copilot/src/copilot.rs | 2
crates/edit_prediction/src/edit_prediction.rs | 2
crates/editor/src/editor.rs | 7 ++-
crates/git_ui/src/file_diff_view.rs | 2
crates/git_ui/src/text_diff_view.rs | 2
crates/language/src/buffer.rs | 30 ++++++++++------
crates/language/src/buffer_tests.rs | 21 ++++++++---
crates/multi_buffer/src/multi_buffer.rs | 14 +++++++
crates/multi_buffer/src/multi_buffer_tests.rs | 3 +
crates/project/src/lsp_store.rs | 2
crates/project/src/project.rs | 4 +-
crates/project/tests/integration/project_tests.rs | 12 +++---
crates/svg_preview/src/svg_preview_view.rs | 2
crates/vim/src/state.rs | 2
17 files changed, 72 insertions(+), 39 deletions(-)
@@ -209,7 +209,7 @@ impl ActionLog {
cx: &mut Context<Self>,
) {
match event {
- BufferEvent::Edited => {
+ BufferEvent::Edited { .. } => {
let Some(tracked_buffer) = self.tracked_buffers.get_mut(&buffer) else {
return;
};
@@ -1219,7 +1219,7 @@ impl TextThread {
} => cx.emit(TextThreadEvent::Operation(
TextThreadOperation::BufferOperation(operation.clone()),
)),
- language::BufferEvent::Edited => {
+ language::BufferEvent::Edited { .. } => {
self.count_remaining_tokens(cx);
self.reparse(cx);
cx.emit(TextThreadEvent::MessagesEdited);
@@ -221,7 +221,7 @@ impl ChannelBuffer {
})
.log_err();
}
- language::BufferEvent::Edited => {
+ language::BufferEvent::Edited { .. } => {
cx.emit(ChannelBufferEvent::BufferEdited);
}
_ => {}
@@ -949,7 +949,7 @@ impl Copilot {
&& let Some(registered_buffer) = server.registered_buffers.get_mut(&buffer.entity_id())
{
match event {
- language::BufferEvent::Edited => {
+ language::BufferEvent::Edited { .. } => {
drop(registered_buffer.report_changes(&buffer, cx));
}
language::BufferEvent::Saved => {
@@ -1217,7 +1217,7 @@ impl EditPredictionStore {
cx.subscribe(buffer, {
let project = project.downgrade();
move |this, buffer, event, cx| {
- if let language::BufferEvent::Edited = event
+ if let language::BufferEvent::Edited { .. } = event
&& let Some(project) = project.upgrade()
{
this.report_changes_for_buffer(&buffer, &project, false, cx);
@@ -24128,7 +24128,10 @@ impl Editor {
cx: &mut Context<Self>,
) {
match event {
- multi_buffer::Event::Edited { edited_buffer } => {
+ multi_buffer::Event::Edited {
+ edited_buffer,
+ is_local,
+ } => {
self.scrollbar_marker_state.dirty = true;
self.active_indent_guides_state.dirty = true;
self.refresh_active_diagnostics(cx);
@@ -24138,7 +24141,7 @@ impl Editor {
self.refresh_matching_bracket_highlights(&snapshot, cx);
self.refresh_outline_symbols_at_cursor(cx);
self.refresh_sticky_headers(&snapshot, cx);
- if self.has_active_edit_prediction() {
+ if *is_local && self.has_active_edit_prediction() {
self.update_visible_edit_prediction(window, cx);
}
@@ -108,7 +108,7 @@ impl FileDiffView {
for buffer in [&old_buffer, &new_buffer] {
cx.subscribe(buffer, move |this, _, event, _| match event {
- language::BufferEvent::Edited
+ language::BufferEvent::Edited { .. }
| language::BufferEvent::LanguageChanged(_)
| language::BufferEvent::Reparsed => {
this.buffer_changes_tx.send(()).ok();
@@ -165,7 +165,7 @@ impl TextDiffView {
let (buffer_changes_tx, mut buffer_changes_rx) = watch::channel(());
cx.subscribe(&source_buffer, move |this, _, event, _| match event {
- language::BufferEvent::Edited
+ language::BufferEvent::Edited { .. }
| language::BufferEvent::LanguageChanged(_)
| language::BufferEvent::Reparsed => {
this.buffer_changes_tx.send(()).ok();
@@ -359,7 +359,7 @@ pub enum BufferEvent {
is_local: bool,
},
/// The buffer was edited.
- Edited,
+ Edited { is_local: bool },
/// The buffer's `dirty` bit changed.
DirtyChanged,
/// The buffer was saved.
@@ -2457,7 +2457,7 @@ impl Buffer {
false
};
if let Some((transaction_id, start_version)) = self.text.end_transaction_at(now) {
- self.did_edit(&start_version, was_dirty, cx);
+ self.did_edit(&start_version, was_dirty, true, cx);
Some(transaction_id)
} else {
None
@@ -2844,7 +2844,13 @@ impl Buffer {
Some(edit_id)
}
- fn did_edit(&mut self, old_version: &clock::Global, was_dirty: bool, cx: &mut Context<Self>) {
+ fn did_edit(
+ &mut self,
+ old_version: &clock::Global,
+ was_dirty: bool,
+ is_local: bool,
+ cx: &mut Context<Self>,
+ ) {
self.was_changed();
if self.edits_since::<usize>(old_version).next().is_none() {
@@ -2852,7 +2858,7 @@ impl Buffer {
}
self.reparse(cx, true);
- cx.emit(BufferEvent::Edited);
+ cx.emit(BufferEvent::Edited { is_local });
if was_dirty != self.is_dirty() {
cx.emit(BufferEvent::DirtyChanged);
}
@@ -2964,7 +2970,7 @@ impl Buffer {
self.text.apply_ops(buffer_ops);
self.deferred_ops.insert(deferred_ops);
self.flush_deferred_ops(cx);
- self.did_edit(&old_version, was_dirty, cx);
+ self.did_edit(&old_version, was_dirty, false, cx);
// Notify independently of whether the buffer was edited as the operations could include a
// selection update.
cx.notify();
@@ -3119,7 +3125,7 @@ impl Buffer {
if let Some((transaction_id, operation)) = self.text.undo() {
self.send_operation(Operation::Buffer(operation), true, cx);
- self.did_edit(&old_version, was_dirty, cx);
+ self.did_edit(&old_version, was_dirty, true, cx);
self.restore_encoding_for_transaction(transaction_id, was_dirty);
Some(transaction_id)
} else {
@@ -3137,7 +3143,7 @@ impl Buffer {
let old_version = self.version.clone();
if let Some(operation) = self.text.undo_transaction(transaction_id) {
self.send_operation(Operation::Buffer(operation), true, cx);
- self.did_edit(&old_version, was_dirty, cx);
+ self.did_edit(&old_version, was_dirty, true, cx);
true
} else {
false
@@ -3159,7 +3165,7 @@ impl Buffer {
self.send_operation(Operation::Buffer(operation), true, cx);
}
if undone {
- self.did_edit(&old_version, was_dirty, cx)
+ self.did_edit(&old_version, was_dirty, true, cx)
}
undone
}
@@ -3169,7 +3175,7 @@ impl Buffer {
let operation = self.text.undo_operations(counts);
let old_version = self.version.clone();
self.send_operation(Operation::Buffer(operation), true, cx);
- self.did_edit(&old_version, was_dirty, cx);
+ self.did_edit(&old_version, was_dirty, true, cx);
}
/// Manually redoes a specific transaction in the buffer's redo history.
@@ -3179,7 +3185,7 @@ impl Buffer {
if let Some((transaction_id, operation)) = self.text.redo() {
self.send_operation(Operation::Buffer(operation), true, cx);
- self.did_edit(&old_version, was_dirty, cx);
+ self.did_edit(&old_version, was_dirty, true, cx);
self.restore_encoding_for_transaction(transaction_id, was_dirty);
Some(transaction_id)
} else {
@@ -3220,7 +3226,7 @@ impl Buffer {
self.send_operation(Operation::Buffer(operation), true, cx);
}
if redone {
- self.did_edit(&old_version, was_dirty, cx)
+ self.did_edit(&old_version, was_dirty, true, cx)
}
redone
}
@@ -3330,7 +3336,7 @@ impl Buffer {
if !ops.is_empty() {
for op in ops {
self.send_operation(Operation::Buffer(op), true, cx);
- self.did_edit(&old_version, was_dirty, cx);
+ self.did_edit(&old_version, was_dirty, true, cx);
}
}
}
@@ -458,15 +458,18 @@ fn test_edit_events(cx: &mut gpui::App) {
assert_eq!(
mem::take(&mut *buffer_1_events.lock()),
vec![
- BufferEvent::Edited,
+ BufferEvent::Edited { is_local: true },
BufferEvent::DirtyChanged,
- BufferEvent::Edited,
- BufferEvent::Edited,
+ BufferEvent::Edited { is_local: true },
+ BufferEvent::Edited { is_local: true },
]
);
assert_eq!(
mem::take(&mut *buffer_2_events.lock()),
- vec![BufferEvent::Edited, BufferEvent::DirtyChanged]
+ vec![
+ BufferEvent::Edited { is_local: false },
+ BufferEvent::DirtyChanged
+ ]
);
buffer1.update(cx, |buffer, cx| {
@@ -481,11 +484,17 @@ fn test_edit_events(cx: &mut gpui::App) {
});
assert_eq!(
mem::take(&mut *buffer_1_events.lock()),
- vec![BufferEvent::Edited, BufferEvent::DirtyChanged,]
+ vec![
+ BufferEvent::Edited { is_local: true },
+ BufferEvent::DirtyChanged,
+ ]
);
assert_eq!(
mem::take(&mut *buffer_2_events.lock()),
- vec![BufferEvent::Edited, BufferEvent::DirtyChanged]
+ vec![
+ BufferEvent::Edited { is_local: false },
+ BufferEvent::DirtyChanged
+ ]
);
}
@@ -119,6 +119,7 @@ pub enum Event {
DiffHunksToggled,
Edited {
edited_buffer: Option<Entity<Buffer>>,
+ is_local: bool,
},
TransactionUndone {
transaction_id: TransactionId,
@@ -1912,6 +1913,7 @@ impl MultiBuffer {
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
cx.emit(Event::ExcerptsAdded {
buffer,
@@ -1974,6 +1976,7 @@ impl MultiBuffer {
}
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
cx.emit(Event::ExcerptsRemoved {
ids,
@@ -2330,6 +2333,7 @@ impl MultiBuffer {
}
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
cx.emit(Event::ExcerptsRemoved {
ids,
@@ -2394,8 +2398,9 @@ impl MultiBuffer {
use language::BufferEvent;
let buffer_id = buffer.read(cx).remote_id();
cx.emit(match event {
- BufferEvent::Edited => Event::Edited {
+ &BufferEvent::Edited { is_local } => Event::Edited {
edited_buffer: Some(buffer),
+ is_local,
},
BufferEvent::DirtyChanged => Event::DirtyChanged,
BufferEvent::Saved => Event::Saved,
@@ -2484,6 +2489,7 @@ impl MultiBuffer {
}
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
}
@@ -2530,6 +2536,7 @@ impl MultiBuffer {
}
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
}
@@ -2769,6 +2776,7 @@ impl MultiBuffer {
cx.emit(Event::DiffHunksToggled);
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
}
@@ -2885,6 +2893,7 @@ impl MultiBuffer {
cx.emit(Event::DiffHunksToggled);
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
}
@@ -2952,6 +2961,7 @@ impl MultiBuffer {
}
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
cx.emit(Event::ExcerptsExpanded { ids: vec![id] });
cx.notify();
@@ -3059,6 +3069,7 @@ impl MultiBuffer {
}
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
cx.emit(Event::ExcerptsExpanded { ids });
cx.notify();
@@ -3702,6 +3713,7 @@ impl MultiBuffer {
cx.emit(Event::DiffHunksToggled);
cx.emit(Event::Edited {
edited_buffer: None,
+ is_local: true,
});
}
}
@@ -171,12 +171,15 @@ fn test_excerpt_boundaries_and_clipping(cx: &mut App) {
&[
Event::Edited {
edited_buffer: None,
+ is_local: true,
},
Event::Edited {
edited_buffer: None,
+ is_local: true,
},
Event::Edited {
edited_buffer: None,
+ is_local: true,
}
]
);
@@ -4429,7 +4429,7 @@ impl LspStore {
cx: &mut Context<Self>,
) {
match event {
- language::BufferEvent::Edited => {
+ language::BufferEvent::Edited { .. } => {
self.on_buffer_edited(buffer, cx);
}
@@ -3636,11 +3636,11 @@ impl Project {
event: &BufferEvent,
cx: &mut Context<Self>,
) -> Option<()> {
- if matches!(event, BufferEvent::Edited | BufferEvent::Reloaded) {
+ if matches!(event, BufferEvent::Edited { .. } | BufferEvent::Reloaded) {
self.request_buffer_diff_recalculation(&buffer, cx);
}
- if matches!(event, BufferEvent::Edited) {
+ if matches!(event, BufferEvent::Edited { .. }) {
cx.emit(Event::BufferEdited);
}
@@ -5552,7 +5552,7 @@ async fn test_buffer_is_dirty(cx: &mut gpui::TestAppContext) {
assert_eq!(
*events.lock(),
&[
- language::BufferEvent::Edited,
+ language::BufferEvent::Edited { is_local: true },
language::BufferEvent::DirtyChanged
]
);
@@ -5581,9 +5581,9 @@ async fn test_buffer_is_dirty(cx: &mut gpui::TestAppContext) {
assert_eq!(
*events.lock(),
&[
- language::BufferEvent::Edited,
+ language::BufferEvent::Edited { is_local: true },
language::BufferEvent::DirtyChanged,
- language::BufferEvent::Edited,
+ language::BufferEvent::Edited { is_local: true },
],
);
events.lock().clear();
@@ -5598,7 +5598,7 @@ async fn test_buffer_is_dirty(cx: &mut gpui::TestAppContext) {
assert_eq!(
*events.lock(),
&[
- language::BufferEvent::Edited,
+ language::BufferEvent::Edited { is_local: true },
language::BufferEvent::DirtyChanged
]
);
@@ -5638,7 +5638,7 @@ async fn test_buffer_is_dirty(cx: &mut gpui::TestAppContext) {
assert_eq!(
mem::take(&mut *events.lock()),
&[
- language::BufferEvent::Edited,
+ language::BufferEvent::Edited { is_local: true },
language::BufferEvent::DirtyChanged
]
);
@@ -5653,7 +5653,7 @@ async fn test_buffer_is_dirty(cx: &mut gpui::TestAppContext) {
assert_eq!(
*events.lock(),
&[
- language::BufferEvent::Edited,
+ language::BufferEvent::Edited { is_local: true },
language::BufferEvent::DirtyChanged
]
);
@@ -182,7 +182,7 @@ impl SvgPreviewView {
buffer,
window,
move |this, _buffer, event: &BufferEvent, window, cx| match event {
- BufferEvent::Edited | BufferEvent::Saved => {
+ BufferEvent::Edited { .. } | BufferEvent::Saved => {
this.render_image(window, cx);
}
_ => {}
@@ -515,7 +515,7 @@ impl MarksState {
cx: &mut Context<Self>,
) {
let on_change = cx.subscribe(buffer_handle, move |this, buffer, event, cx| match event {
- BufferEvent::Edited => {
+ BufferEvent::Edited { .. } => {
if let Some(path) = this.path_for_buffer(&buffer, cx) {
this.serialize_buffer_marks(path, &buffer, cx);
}