mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-04 18:58:04 +00:00
Keep track of deleted cell for reorder change request (#12575)
## Summary This PR fixes a bug where the server wouldn't retain the cell content in case of a reorder change request. As mentioned in https://github.com/astral-sh/ruff/issues/12573#issuecomment-2257819298, this change request is modeled as (a) remove these cell URIs and (b) add these cell URIs. The cell content isn't provided. But, the way we've modeled the `NotebookCell` (it contains the underlying `TextDocument`), we need to keep track of the deleted cells to get the content. This is not an ideal solution and a better long term solution would be to model it as per the spec but that is a big structural change and will affect multiple parts of the server. Modeling as per the spec would also avoid bugs like https://github.com/astral-sh/ruff/pull/11864. For context, that model would add complexity per https://github.com/astral-sh/ruff/pull/11206#discussion_r1600165481. fixes: #12573 ## Test Plan This video shows the before and after the bug is fixed: https://github.com/user-attachments/assets/2fcad4b5-f9af-4776-8640-4cd1fa16e325
This commit is contained in:
parent
3169d408fa
commit
f3c14a4276
2 changed files with 25 additions and 2 deletions
|
@ -114,10 +114,20 @@ impl NotebookDocument {
|
|||
let start = structure.array.start as usize;
|
||||
let delete = structure.array.delete_count as usize;
|
||||
|
||||
// This is required because of the way the `NotebookCell` is modelled. We include
|
||||
// the `TextDocument` within the `NotebookCell` so when it's deleted, the
|
||||
// corresponding `TextDocument` is removed as well. But, when cells are
|
||||
// re-oredered, the change request doesn't provide the actual contents of the cell.
|
||||
// Instead, it only provides that (a) these cell URIs were removed, and (b) these
|
||||
// cell URIs were added.
|
||||
// https://github.com/astral-sh/ruff/issues/12573
|
||||
let mut deleted_cells = FxHashMap::default();
|
||||
|
||||
// First, delete the cells and remove them from the index.
|
||||
if delete > 0 {
|
||||
for cell in self.cells.drain(start..start + delete) {
|
||||
self.cell_index.remove(&cell.url);
|
||||
deleted_cells.insert(cell.url, cell.document);
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -125,8 +135,17 @@ impl NotebookDocument {
|
|||
// provide the actual contents of the cells, so we'll initialize them with empty
|
||||
// contents.
|
||||
for cell in structure.array.cells.into_iter().flatten().rev() {
|
||||
self.cells
|
||||
.insert(start, NotebookCell::new(cell, String::new(), 0));
|
||||
if let Some(text_document) = deleted_cells.remove(&cell.document) {
|
||||
let version = text_document.version();
|
||||
self.cells.push(NotebookCell::new(
|
||||
cell,
|
||||
text_document.into_contents(),
|
||||
version,
|
||||
));
|
||||
} else {
|
||||
self.cells
|
||||
.insert(start, NotebookCell::new(cell, String::new(), 0));
|
||||
}
|
||||
}
|
||||
|
||||
// Third, register the new cells in the index and update existing ones that came
|
||||
|
|
|
@ -32,6 +32,10 @@ impl TextDocument {
|
|||
}
|
||||
}
|
||||
|
||||
pub fn into_contents(self) -> String {
|
||||
self.contents
|
||||
}
|
||||
|
||||
pub fn contents(&self) -> &str {
|
||||
&self.contents
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue