Skip to content

Preserve snapshot identity across no-op updates #64373

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
Andrew Branch (andrewbranch) merged 2 commits into from
Sep 21, 2026
+76 −0
Merged

Preserve snapshot identity across no-op updates #64373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fdcd2ee
Preserve snapshot identity across no-op updates
andrewbranch Sep 21, 2026
c5bc1f3
Add missing release
andrewbranch Sep 21, 2026
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
4 changes: 4 additions & 0 deletions packages/typescript/src/api/async/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,10 @@ export class API<FromLSP extends boolean = false> implements FormatDiagnosticsHo
snapshot: baseSnapshot.id,
changes: toCreateSnapshotRequest(params),
});
if (data.snapshot === baseSnapshot.id) {
await this.client.apiRequest("release", { snapshot: data.snapshot });
return baseSnapshot;
}
Comment thread
andrewbranch marked this conversation as resolved.
this.sourceFileCache.retainForSnapshot(data.snapshot, baseSnapshot.id, data.changes);
const snapshot = new Snapshot(
data,
Expand Down
8 changes: 8 additions & 0 deletions packages/typescript/src/api/sync/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,10 @@ export class API<FromLSP extends boolean = false> implements FormatDiagnosticsHo
snapshot: baseSnapshot.id,
changes: toCreateSnapshotRequest(params),
});
if (data.snapshot === baseSnapshot.id) {
owner.client.apiRequest("release", { snapshot: data.snapshot });
return baseSnapshot;
}
Comment thread
andrewbranch marked this conversation as resolved.
owner.sourceFileCache.retainForSnapshot(data.snapshot, baseSnapshot.id, data.changes);
const snapshot = new Snapshot(
data,
Expand Down Expand Up @@ -666,6 +670,10 @@ export class API<FromLSP extends boolean = false> implements FormatDiagnosticsHo
snapshot: baseSnapshot.id,
changes: toCreateSnapshotRequest(params),
});
if (data.snapshot === baseSnapshot.id) {
yield* apiRequest("release", { snapshot: data.snapshot });
return baseSnapshot;
}
owner.sourceFileCache.retainForSnapshot(data.snapshot, baseSnapshot.id, data.changes);
const snapshot = new Snapshot(
data,
Expand Down
32 changes: 32 additions & 0 deletions packages/typescript/test/async/api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,38 @@ describe("API", () => {
assert.equal("openedFiles" in empty.operation, false);
});

test("snapshot.update preserves identity when the server returns the same snapshot", async () => {
await using api = spawnAPI();
const snapshot = await api.createSnapshot();
const client = (api as unknown as {
client: { apiRequest(method: string, params: unknown): Promise<unknown>; };
}).client;
const apiRequest = client.apiRequest.bind(client);
let duplicateReference = false;
client.apiRequest = async (method, params) => {
if (
method === "release"
&& typeof params === "object"
&& params !== null
&& "snapshot" in params
&& params.snapshot === snapshot.id
&& duplicateReference
) {
duplicateReference = false;
return true;
}
const response = await apiRequest(method, params);
if (method !== "updateSnapshot" || typeof response !== "object" || response === null) return response;
if (!("snapshot" in response) || typeof response.snapshot !== "number") return response;
await apiRequest("release", { snapshot: response.snapshot });
duplicateReference = true;
return { ...response, snapshot: snapshot.id };
};

assert.strictEqual(await snapshot.update({}), snapshot);
assert.equal(duplicateReference, false);
});

test("snapshot.update reconfigures a synthetic program", async () => {
await using api = spawnAPI({
"/src/a.ts": `export const a = 1;`,
Expand Down
32 changes: 32 additions & 0 deletions packages/typescript/test/sync/api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,38 @@ describe("API", () => {
assert.equal("openedFiles" in empty.operation, false);
});

test("snapshot.update preserves identity when the server returns the same snapshot", () => {
using api = spawnAPI();
const snapshot = api.createSnapshot();
const client = (api as unknown as {
client: { apiRequest(method: string, params: unknown): unknown; };
}).client;
const apiRequest = client.apiRequest.bind(client);
let duplicateReference = false;
client.apiRequest = (method, params) => {
if (
method === "release"
&& typeof params === "object"
&& params !== null
&& "snapshot" in params
&& params.snapshot === snapshot.id
&& duplicateReference
) {
duplicateReference = false;
return true;
}
const response = apiRequest(method, params);
if (method !== "updateSnapshot" || typeof response !== "object" || response === null) return response;
if (!("snapshot" in response) || typeof response.snapshot !== "number") return response;
apiRequest("release", { snapshot: response.snapshot });
duplicateReference = true;
return { ...response, snapshot: snapshot.id };
};

assert.strictEqual(snapshot.update({}), snapshot);
assert.equal(duplicateReference, false);
});

test("snapshot.update reconfigures a synthetic program", () => {
using api = spawnAPI({
"/src/a.ts": `export const a = 1;`,
Expand Down
Loading