Skip to content

[api] Stop dropping dispose Promises in the async API #64584

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 6 commits into from
Oct 6, 2026
Merged

[api] Stop dropping dispose Promises in the async API #64584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b11cfba
Don’t drop dispose promises, make all disposables AsyncDisposable in …
andrewbranch Oct 2, 2026
18e401d
Attach `await using` suggestion to diagnostic for using `using` on an…
andrewbranch Oct 2, 2026
2936ffc
Merge branch 'main' into api-async-disposables
andrewbranch Oct 2, 2026
38866b5
Merge branch 'main' into api-async-disposables
andrewbranch Oct 3, 2026
0b21503
Merge branch 'main' into api-async-disposables
andrewbranch Oct 6, 2026
ae4c8ea
Fix test after merge
andrewbranch Oct 6, 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
12 changes: 6 additions & 6 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 @@ -1133,8 +1133,8 @@ export class Snapshot {
return this.projectMap.get(data.id);
}

[globalThis.Symbol.dispose](): void {
void this.dispose();
[globalThis.Symbol.asyncDispose](): Promise<void> { // @sync: [globalThis.Symbol.dispose](): void {
return this.dispose(); // @sync: this.dispose();
}
dispose(): Promise<void> {
return this.disposePromise ??= this.disposeWorker();
Expand Down Expand Up @@ -1731,8 +1731,8 @@ export class Program<Id extends ProjectId = ProjectId> implements FormatDiagnost
this.ownedSnapshot = snapshot;
}

[globalThis.Symbol.dispose](): void {
void this.dispose();
[globalThis.Symbol.asyncDispose](): Promise<void> { // @sync: [globalThis.Symbol.dispose](): void {
return this.dispose(); // @sync: this.dispose();
}

dispose(): Promise<void> {
Expand Down Expand Up @@ -2175,8 +2175,8 @@ export class BuildOrchestrator {
this.onDispose = onDispose;
}

[globalThis.Symbol.dispose](): void {
void this.dispose();
[globalThis.Symbol.asyncDispose](): Promise<void> { // @sync: [globalThis.Symbol.dispose](): void {
return this.dispose(); // @sync: this.dispose();
}
dispose(): Promise<void> {
return this.disposePromise ??= this.disposeWorker();
Expand Down
6 changes: 3 additions & 3 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 @@ -1793,7 +1793,7 @@ export class Snapshot {
}

[globalThis.Symbol.dispose](): void {
void this.dispose();
this.dispose();
}
get dispose(): {
(): void;
Expand Down Expand Up @@ -2924,7 +2924,7 @@ export class Program<Id extends ProjectId = ProjectId> implements FormatDiagnost
}

[globalThis.Symbol.dispose](): void {
void this.dispose();
this.dispose();
}

get dispose(): {
Expand Down Expand Up @@ -3936,7 +3936,7 @@ export class BuildOrchestrator {
}

[globalThis.Symbol.dispose](): void {
void this.dispose();
this.dispose();
}
get dispose(): {
(): void;
Expand Down
56 changes: 28 additions & 28 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 @@ -151,9 +151,9 @@ import {
const concurrency = areTestsFiltered();

describe("API", { concurrency }, () => {
test("getCurrentLanguageServerSnapshot is LSP-only", () => {
test("getCurrentLanguageServerSnapshot is LSP-only", async () => {
if (!!false) {
const standalone = new API();
await using standalone = new API();
// @ts-expect-error The standalone API has no canonical language server state.
void standalone.getCurrentLanguageServerSnapshot();

Expand Down Expand Up @@ -729,7 +729,7 @@ describe("API", { concurrency }, () => {
"/src/index.ts": `export const value: string = 1;`,
});

const program = await api.createProgram(["/src/index.ts"], { noLib: true, strict: true });
await using program = await api.createProgram(["/src/index.ts"], { noLib: true, strict: true });

assert.deepEqual(program.getCompilerOptions(), { noLib: true, strict: true });
assert.deepEqual(await program.getSourceFileNames(), ["/src/index.ts"]);
Expand Down Expand Up @@ -1617,7 +1617,7 @@ describe("BuildOrchestrator", () => {
const { api: disposableApi } = spawnAPIWithFS({ ...files });
await using api = disposableApi;
const options = await api.parseCommandLine([]);
const orchestrator = await api.createBuildOrchestrator(
await using orchestrator = await api.createBuildOrchestrator(
["/a/tsconfig.json"],
{ cwd: "/", ...options },
);
Expand Down Expand Up @@ -3272,11 +3272,11 @@ describe("Snapshot disposal", { concurrency }, () => {
assert.ok(snapshot.isDisposed());
});

test("api.close waits for disposal started by using", async () => {
test("api.close waits for disposal started by await using", async () => {
Comment thread
andrewbranch marked this conversation as resolved.
const api = spawnAPI();
let snapshot: Snapshot;
{
using disposableSnapshot = await api.createSnapshot({ openProject: "/tsconfig.json" });
await using disposableSnapshot = await api.createSnapshot({ openProject: "/tsconfig.json" });
snapshot = disposableSnapshot;
}
assert.ok(snapshot.isDisposed());
Expand Down Expand Up @@ -4994,7 +4994,7 @@ describe("readFile callback semantics", { concurrency }, () => {
const callbacks: FileSystemCallbacks = { ...fs, realpath };
await using api = new API({ cwd: "/", fs: callbacks });

using snapshot = await api.createSnapshot({ openProject: "/tsconfig.json" });
await using snapshot = await api.createSnapshot({ openProject: "/tsconfig.json" });
assert.ok(
(await snapshot.getConfiguredProject("/tsconfig.json")!.program.getSourceFileNames())
.includes(toRootedFilePath("/node_modules/pkg/index.d.ts", undefined)),
Expand Down Expand Up @@ -5212,7 +5212,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
fs,
});

using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/tsconfig.json",
fileSystem: {
kind: "full",
Expand All @@ -5237,7 +5237,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
await using api = new API({
cwd: fileURLToPath(new URL("../../../../", import.meta.url).toString()),
});
using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/tsconfig.json",
fileSystem: createFileSystemWithLib(Object.entries({
"/tsconfig.json": JSON.stringify({ compilerOptions: { strict: true }, files: ["src/main.ts"] }),
Expand Down Expand Up @@ -5269,7 +5269,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
cwd: fileURLToPath(new URL("../../../../", import.meta.url).toString()),
collectTiming: true,
});
using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openFiles: files.map(([document]) => document),
fileSystem: createFileSystem(files),
});
Expand Down Expand Up @@ -5311,7 +5311,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
fs,
});

using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/tsconfig.json",
fileSystem: {
kind: "layer",
Expand Down Expand Up @@ -5344,7 +5344,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
}),
});

using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/tsconfig.json",
fileSystem: createFileSystemLayer([
["/tsconfig.json", JSON.stringify({ compilerOptions: { noLib: true }, include: ["src/**/*.ts"] })],
Expand Down Expand Up @@ -5377,7 +5377,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
},
});

using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/project/tsconfig.json",
fileSystem: {
kind: "full",
Expand Down Expand Up @@ -5418,7 +5418,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
},
});

using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/project/tsconfig.json",
fileSystem: {
kind: "full",
Expand All @@ -5444,7 +5444,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
await using api = new API({
cwd: fileURLToPath(new URL("../../../../", import.meta.url).toString()),
});
using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/tsconfig.json",
fileSystem: createFileSystem(Object.entries({
"/tsconfig.json": JSON.stringify({
Expand All @@ -5458,7 +5458,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
})),
});

using updated = await snapshot.update({
await using updated = await snapshot.update({
ensurePrograms: true,
fileSystem: createFileSystemLayer(
Object.entries({
Expand All @@ -5476,10 +5476,10 @@ describe("updateSnapshot file systems", { concurrency }, () => {
assert.equal((await project.program.getSourceFile("/src/added.ts"))?.text, `export const added = true;`);
assert.equal(await project.program.getSourceFile("/src/remove.ts"), undefined);
assert.equal(await project.program.getSourceFile("/src/removed/gone.ts"), undefined);
using fork = await snapshot.update({ ensurePrograms: true });
await using fork = await snapshot.update({ ensurePrograms: true });
assert.equal((await fork.getConfiguredProject("/tsconfig.json")!.program.getSourceFile("/src/change.ts"))?.text, `export const version = "old";`);

using updatedAgain = await updated.update({
await using updatedAgain = await updated.update({
ensurePrograms: true,
fileSystem: createFileSystemLayer(
Object.entries({
Expand Down Expand Up @@ -5536,8 +5536,8 @@ describe("updateSnapshot file systems", { concurrency }, () => {
cwd: fileURLToPath(new URL("../../../../", import.meta.url).toString()),
fs: host,
});
using snapshot = await api.createSnapshot();
using replaced = await snapshot.update({
await using snapshot = await api.createSnapshot();
await using replaced = await snapshot.update({
ensurePrograms: true,
openProject: "/tsconfig.json",
fileSystem: createFileSystem([
Expand All @@ -5554,7 +5554,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
await using api = new API({
cwd: fileURLToPath(new URL("../../../../", import.meta.url).toString()),
});
using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/tsconfig.json",
fileSystem: createFileSystem(
Object.entries({
Expand All @@ -5571,7 +5571,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
),
});

using updated = await snapshot.update({
await using updated = await snapshot.update({
ensurePrograms: true,
fileSystem: createFileSystemLayer(
Object.entries({
Expand Down Expand Up @@ -5606,7 +5606,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
removeFile: serverFS.useOS,
},
});
using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/tsconfig.json",
fileSystem: createFileSystem(Object.entries({
"/tsconfig.json": JSON.stringify({ compilerOptions: { noLib: true, outDir: "/out", rootDir: "/src" }, files: ["src/main.ts"] }),
Expand All @@ -5624,7 +5624,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
});
assert.deepEqual(hostWrites, []);

using updated = await snapshot.update({ fileSystem: result.fileSystem!, openFiles: ["/out/main.js"] });
await using updated = await snapshot.update({ fileSystem: result.fileSystem!, openFiles: ["/out/main.js"] });
const outputProject = await updated.getDefaultProjectForFile("/out/main.js");
assert.equal((await updated.getConfiguredProject("/tsconfig.json")!.program.getSourceFile("/src/main.ts"))?.text, `export const value: number = 1;`);
assert.equal((await outputProject?.program.getSourceFile("/out/main.js"))?.text, `export const value = 1;\n`);
Expand All @@ -5636,7 +5636,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
cwd: fileURLToPath(new URL("../../../../", import.meta.url).toString()),
fs: host,
});
using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/tsconfig.json",
fileSystem: createFileSystemLayer(Object.entries({
"/tsconfig.json": JSON.stringify({ compilerOptions: { noLib: true, outDir: "/out", rootDir: "/src" }, files: ["src/main.ts"] }),
Expand Down Expand Up @@ -5676,7 +5676,7 @@ describe("updateSnapshot file systems", { concurrency }, () => {
},
});

using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/project/tsconfig.json",
fileSystem: {
kind: "full",
Expand Down Expand Up @@ -5711,14 +5711,14 @@ describe("updateSnapshot file systems", { concurrency }, () => {
cwd: fileURLToPath(new URL("../../../../", import.meta.url).toString()),
fs: host,
});
using snapshot = await api.createSnapshot({
await using snapshot = await api.createSnapshot({
openProject: "/project/tsconfig.json",
fileSystem: createFileSystem([
["/project/tsconfig.json", JSON.stringify({ compilerOptions: { noLib: true, moduleResolution: "node" }, files: ["index.ts"] })],
["/project/index.ts", `import { value } from "pkg"; export { value };`],
]),
});
using updated = await snapshot.update({
await using updated = await snapshot.update({
ensurePrograms: true,
fileSystem: createFileSystemLayer([], {
symlinks: {
Expand Down
8 changes: 4 additions & 4 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 @@ -161,7 +161,7 @@ const concurrency = areTestsFiltered();
describe("API", { concurrency }, () => {
test("getCurrentLanguageServerSnapshot is LSP-only", () => {
if (!!false) {
const standalone = new API();
using standalone = new API();
// @ts-expect-error The standalone API has no canonical language server state.
void standalone.getCurrentLanguageServerSnapshot();

Expand Down Expand Up @@ -716,7 +716,7 @@ describe("API", { concurrency }, () => {
"/src/index.ts": `export const value: string = 1;`,
});

const program = api.createProgram(["/src/index.ts"], { noLib: true, strict: true });
using program = api.createProgram(["/src/index.ts"], { noLib: true, strict: true });

assert.deepEqual(program.getCompilerOptions(), { noLib: true, strict: true });
assert.deepEqual(program.getSourceFileNames(), ["/src/index.ts"]);
Expand Down Expand Up @@ -1483,7 +1483,7 @@ describe("BuildOrchestrator", () => {
const { api: disposableApi } = spawnAPIWithFS({ ...files });
using api = disposableApi;
const options = api.parseCommandLine([]);
const orchestrator = api.createBuildOrchestrator(
using orchestrator = api.createBuildOrchestrator(
["/a/tsconfig.json"],
{ cwd: "/", ...options },
);
Expand Down Expand Up @@ -3130,7 +3130,7 @@ describe("Snapshot disposal", { concurrency }, () => {
assert.ok(snapshot.isDisposed());
});

test("api.close waits for disposal started by using", () => {
test("api.close waits for disposal started by await using", () => {
const api = spawnAPI();
let snapshot: Snapshot;
{
Expand Down
13 changes: 11 additions & 2 deletions tsc/internal/checker/checker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6098,8 +6098,17 @@ func (c *Checker) checkVariableLikeDeclaration(node *ast.Node) {
globalDisposableType := c.getGlobalDisposableType()
if globalDisposableType != c.emptyObjectType {
optionalDisposableType := c.getUnionType([]*Type{globalDisposableType, c.nullType, c.undefinedType})
c.checkTypeAssignableTo(c.widenTypeForVariableLikeDeclaration(initializerType, node, false), optionalDisposableType, initializer,
diagnostics.The_initializer_of_a_using_declaration_must_be_either_an_object_with_a_Symbol_dispose_method_or_be_null_or_undefined)
widenedInitializerType := c.widenTypeForVariableLikeDeclaration(initializerType, node, false)
var diags []*ast.Diagnostic
if !c.checkTypeAssignableToEx(widenedInitializerType, optionalDisposableType, initializer,
diagnostics.The_initializer_of_a_using_declaration_must_be_either_an_object_with_a_Symbol_dispose_method_or_be_null_or_undefined, &diags) {
globalAsyncDisposableType := c.getGlobalAsyncDisposableType()
optionalAsyncDisposableType := c.getUnionType([]*Type{globalAsyncDisposableType, c.nullType, c.undefinedType})
if globalAsyncDisposableType != c.emptyObjectType && c.isTypeAssignableTo(widenedInitializerType, optionalAsyncDisposableType) {
diags[0].AddMessageChain(ast.NewDiagnosticChain(nil, diagnostics.This_initializer_has_a_Symbol_asyncDispose_method_Did_you_mean_to_use_await_using))

@jakebailey Jake Bailey (jakebailey) Oct 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to be checking if we're in an async function first?

(This feels a bit lint-y in general though)

@andrewbranch Andrew Branch (andrewbranch) Oct 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to be checking if we're in an async function first?

IMO no, because if the first thing I do in a callback is using something() and I discover it's an async disposable, I'm just going to make my callback async right away. The lack of async isn't a reliable indicator of intent.

(This feels a bit lint-y in general though)

How so? To be clear, this code doesn't add any new errors. All it does is change the error message from "That doesn't support using" to "That doesn't support using, but it does support await using."

@jakebailey Jake Bailey (jakebailey) Oct 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohhhh my bad 😄

}
c.addDiagnostic(diags[0])
}
}
}
}
Expand Down
1 change: 1 addition & 0 deletions tsc/internal/diagnostics/diagnosticMessages.generated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1949,6 +1949,7 @@
"Source_phase_imports_are_only_supported_when_the_module_option_is_set_to_esnext_nodenext_or_preserve_18113": "Source phase imports are only supported when the '--module' option is set to 'esnext', 'nodenext', or 'preserve'.",
"Optional_chaining_cannot_be_used_with_import_source_18114": "Optional chaining cannot be used with 'import.source'.",
"Source_phase_imports_are_not_allowed_on_statements_that_compile_to_CommonJS_require_calls_18115": "Source phase imports are not allowed on statements that compile to CommonJS 'require' calls.",
"This_initializer_has_a_Symbol_asyncDispose_method_Did_you_mean_to_use_await_using_18116": "This initializer has a '[Symbol.asyncDispose]()' method. Did you mean to use 'await using'?",
"nodenext_if_module_is_nodenext_node16_if_module_is_node16_or_node18_otherwise_bundler_69010": "`nodenext` if `module` is `nodenext`; `node16` if `module` is `node16` or `node18`; otherwise, `bundler`.",
"File_is_a_CommonJS_module_it_may_be_converted_to_an_ES_module_80001": "File is a CommonJS module; it may be converted to an ES module.",
"This_constructor_function_may_be_converted_to_a_class_declaration_80002": "This constructor function may be converted to a class declaration.",
Expand Down
4 changes: 4 additions & 0 deletions tsc/internal/diagnostics/diagnosticMessages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8915,5 +8915,9 @@
"Source phase imports are not allowed on statements that compile to CommonJS 'require' calls.": {
"category": "Error",
"code": 18115
},
"This initializer has a '[Symbol.asyncDispose]()' method. Did you mean to use 'await using'?": {
"category": "Error",
"code": 18116
}
}
Loading
Loading