Skip to content

fix(lsp): Fix logic for coalescing pending changes + clear script names cache when file is closed #23517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 23, 2024
Merged

fix(lsp): Fix logic for coalescing pending changes + clear script names cache when file is closed #23517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee3876a
Clear script file names cache on close
nathanwhit Apr 23, 2024
e59f896
Fix change coalescing logic
nathanwhit Apr 23, 2024
e954274
Add test
nathanwhit Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 108 additions & 6 deletions cli/lsp/tsc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ impl std::fmt::Debug for TsServer {
}
}

#[derive(Debug, Clone, Copy)]
#[derive(Debug, Clone, Copy, PartialEq)]
#[repr(u8)]
pub enum ChangeKind {
Opened = 0,
Expand All @@ -258,6 +258,7 @@ impl Serialize for ChangeKind {
}
}

#[derive(Debug, PartialEq)]
pub struct PendingChange {
pub modified_scripts: Vec<(String, ChangeKind)>,
pub project_version: usize,
Expand Down Expand Up @@ -288,21 +289,42 @@ impl PendingChange {
modified_scripts: Vec<(String, ChangeKind)>,
config_changed: bool,
) {
use ChangeKind::*;
self.project_version = self.project_version.max(new_version);
self.config_changed |= config_changed;
for (spec, new) in modified_scripts {
if let Some((_, current)) =
self.modified_scripts.iter_mut().find(|(s, _)| s == &spec)
{
// already a pending change for this specifier,
// coalesce the change kinds
match (*current, new) {
(_, ChangeKind::Closed) => {
*current = ChangeKind::Closed;
(_, Closed) => {
*current = Closed;
}
(ChangeKind::Opened, ChangeKind::Modified) => {
*current = ChangeKind::Modified;
(Opened | Closed, Opened) => {
*current = Opened;
}
(Modified, Opened) => {
lsp_warn!("Unexpected change from Modified -> Opened");
*current = Opened;
}
(Opened, Modified) => {
// Opening may change the set of files in the project
*current = Opened;
}
(Closed, Modified) => {
lsp_warn!("Unexpected change from Closed -> Modifed");
// Shouldn't happen, but if it does treat it as closed
// since it's "stronger" than modifying an open doc
*current = Closed;
}
(Modified, Modified) => {
// no change
}
_ => {}
}
} else {
self.modified_scripts.push((spec, new));
}
}
}
Expand Down Expand Up @@ -5930,4 +5952,84 @@ mod tests {
))]
);
}

#[test]
fn coalesce_pending_change() {
use ChangeKind::*;
fn change<S: AsRef<str>>(
project_version: usize,
scripts: impl IntoIterator<Item = (S, ChangeKind)>,
config_changed: bool,
) -> PendingChange {
PendingChange {
project_version,
modified_scripts: scripts
.into_iter()
.map(|(s, c)| (s.as_ref().into(), c))
.collect(),
config_changed,
}
}
let cases = [
(
// start
change(1, [("file:///a.ts", Closed)], false),
// new
change(2, Some(("file:///b.ts", Opened)), false),
// expected
change(
2,
[("file:///a.ts", Closed), ("file:///b.ts", Opened)],
false,
),
),
(
// start
change(
1,
[("file:///a.ts", Closed), ("file:///b.ts", Opened)],
false,
),
// new
change(
2,
// a gets closed then reopened, b gets opened then closed
[("file:///a.ts", Opened), ("file:///b.ts", Closed)],
false,
),
// expected
change(
2,
[("file:///a.ts", Opened), ("file:///b.ts", Closed)],
false,
),
),
(
change(
1,
[("file:///a.ts", Opened), ("file:///b.ts", Modified)],
false,
),
// new
change(
2,
// a gets opened then modified, b gets modified then closed
[("file:///a.ts", Opened), ("file:///b.ts", Closed)],
false,
),
// expected
change(
2,
[("file:///a.ts", Opened), ("file:///b.ts", Closed)],
false,
),
),
];

for (start, new, expected) in cases {
let mut pending = start;
pending.coalesce(new.project_version, new.modified_scripts, false);
assert_eq!(pending, expected);
}
}
}
7 changes: 5 additions & 2 deletions cli/tsc/99_main_compiler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1100,15 +1100,18 @@ delete Object.prototype.__proto__;
projectVersionCache = newProjectVersion;

let opened = false;
let closed = false;
for (const { 0: script, 1: changeKind } of changedScripts) {
if (changeKind == ChangeKind.Opened) {
if (changeKind === ChangeKind.Opened) {
opened = true;
} else if (changeKind === ChangeKind.Closed) {
closed = true;
}
scriptVersionCache.delete(script);
sourceTextCache.delete(script);
}

if (configChanged || opened) {
if (configChanged || opened || closed) {
scriptFileNamesCache = undefined;
}
}
Expand Down