Merge upstream/main and adapt API test to project handles

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: andrewbranch

.github/workflows/ci.yml

@@ -2,11 +2,11 @@ name: CI
 
 on:
   push:
-    branches: [main, main-ts7, ts7-release, 'release-*']
+    branches: [main, main-ts7, ts7-release, 'release-*', 'weswigham/*']
   pull_request:
-    branches: [main, main-ts7, ts7-release, 'release-*']
+    branches: [main, main-ts7, ts7-release, 'release-*', 'weswigham/*']
   merge_group:
-    branches: [main, main-ts7, ts7-release, 'release-*']
+    branches: [main, main-ts7, ts7-release, 'release-*', 'weswigham/*']
 
 permissions:
   contents: read

.github/workflows/create-cherry-pick-pr.yml

@@ -66,11 +66,13 @@ jobs:
         run: git switch --detach "origin/$TARGET_BRANCH"
       - run: npm ci
       - uses: azure/login@a641126d1b8aa4d1fa005f4f92df94a3a4c4c906 # v3.1.0
+        if: ${{ !cancelled() }}
         with:
           client-id: ${{ vars.AZURE_CLIENT_ID }}
           tenant-id: ${{ vars.AZURE_TENANT_ID }}
           subscription-id: ${{ vars.AZURE_SUBSCRIPTION_ID }}
       - name: Create GitHub App token
+        if: ${{ !cancelled() }}
         id: app-token
         uses: microsoft/create-github-app-token-via-key-vault@5ba0d436e9c3cac52feff4d1f2f66f9698ce4a2d # v1
         with:

.github/workflows/new-release-branch.yaml

@@ -95,7 +95,6 @@ jobs:
           PACKAGE_VERSION: ${{ inputs.package_version }}
         run: |
           set -euo pipefail
-          git diff --check
           mapfile -t changedFiles < <(git diff --name-only)
           expectedFiles=("Herebyfile.mjs" "tsc/internal/core/version.go")
           if [ "${changedFiles[*]}" != "${expectedFiles[*]}" ]; then
@@ -108,11 +107,13 @@ jobs:
           git config core.hooksPath /dev/null
           git commit -m "Bump version to $PACKAGE_VERSION"
       - uses: azure/login@a641126d1b8aa4d1fa005f4f92df94a3a4c4c906 # v3.1.0
+        if: ${{ !cancelled() }}
         with:
           client-id: ${{ vars.AZURE_CLIENT_ID }}
           tenant-id: ${{ vars.AZURE_TENANT_ID }}
           subscription-id: ${{ vars.AZURE_SUBSCRIPTION_ID }}
       - name: Create GitHub App token
+        if: ${{ !cancelled() }}
         id: app-token
         uses: microsoft/create-github-app-token-via-key-vault@5ba0d436e9c3cac52feff4d1f2f66f9698ce4a2d # v1
         with:
@@ -121,6 +122,7 @@ jobs:
           owner: microsoft
           repositories: TypeScript
           permission-contents: write
+          permission-issues: write
       - name: Configure git for GitHub App token
         env:
           GITHUB_APP_TOKEN: ${{ steps.app-token.outputs.token }}

.github/workflows/set-version.yaml

@@ -110,7 +110,6 @@ jobs:
           PACKAGE_VERSION: ${{ inputs.package_version }}
         run: |
           set -euo pipefail
-          git diff --check
           mapfile -t changedFiles < <(git diff --name-only)
           expectedFiles=("Herebyfile.mjs" "tsc/internal/core/version.go")
           for changedFile in "${changedFiles[@]}"; do
@@ -125,11 +124,13 @@ jobs:
           git config core.hooksPath /dev/null
           git commit -m "Bump version to $PACKAGE_VERSION"
       - uses: azure/login@a641126d1b8aa4d1fa005f4f92df94a3a4c4c906 # v3.1.0
+        if: ${{ !cancelled() }}
         with:
           client-id: ${{ vars.AZURE_CLIENT_ID }}
           tenant-id: ${{ vars.AZURE_TENANT_ID }}
           subscription-id: ${{ vars.AZURE_SUBSCRIPTION_ID }}
       - name: Create GitHub App token
+        if: ${{ !cancelled() }}
         id: app-token
         uses: microsoft/create-github-app-token-via-key-vault@5ba0d436e9c3cac52feff4d1f2f66f9698ce4a2d # v1
         with:
@@ -138,6 +139,7 @@ jobs:
           owner: microsoft
           repositories: TypeScript
           permission-contents: write
+          permission-issues: write
       - name: Configure git for GitHub App token
         if: steps.configure.outputs.changed == 'true'
         env:

.github/workflows/sync-branch.yaml

@@ -109,18 +109,19 @@ jobs:
       - name: Verify clean merge
         run: |
           set -euo pipefail
-          git diff --check
           if ! git diff --quiet || ! git diff --cached --quiet; then
             echo "Validation modified the worktree; refusing to push the merge." >&2
             git status --short
             exit 1
           fi
       - uses: azure/login@a641126d1b8aa4d1fa005f4f92df94a3a4c4c906 # v3.1.0
+        if: ${{ !cancelled() }}
         with:
           client-id: ${{ vars.AZURE_CLIENT_ID }}
           tenant-id: ${{ vars.AZURE_TENANT_ID }}
           subscription-id: ${{ vars.AZURE_SUBSCRIPTION_ID }}
       - name: Create GitHub App token
+        if: ${{ !cancelled() }}
         id: app-token
         uses: microsoft/create-github-app-token-via-key-vault@5ba0d436e9c3cac52feff4d1f2f66f9698ce4a2d # v1
         with:
@@ -129,6 +130,7 @@ jobs:
           owner: microsoft
           repositories: TypeScript
           permission-contents: write
+          permission-issues: write
       - name: Configure git for GitHub App token
         env:
           GITHUB_APP_TOKEN: ${{ steps.app-token.outputs.token }}

packages/typescript/src/api/async/api.ts

@@ -839,8 +839,8 @@ export class API<FromLSP extends boolean = false> implements FormatDiagnosticsHo
      *
      * Fetching the snapshot issues a lightweight request to the server to
      * retrieve its timing collection. Collection must be enabled via the
-     * `collectTiming` option; when it is not, the returned snapshot has
-     * `enabled: false` and zeroed totals.
+     * `collectTiming` option or `TS_API_TIMING_DIR` environment variable; when
+     * it is not, the returned snapshot has `enabled: false` and zeroed totals.
      */
     getTimingInfo(): Promise<TimingInfo> {
         return this.client.getTimingInfo();

packages/typescript/src/api/async/client.ts

@@ -43,6 +43,7 @@ import {
     TimingCollector,
     type TimingInfo,
 } from "../timing.ts";
+import { TimingDump } from "../timingDump.ts";
 
 export type { ClientOptions, ClientSocketOptions, ClientSpawnOptions };
 
@@ -59,16 +60,22 @@ export class Client {
     private closed = false;
     private connecting: Promise<void> | undefined;
     private timing: TimingCollector | undefined;
+    private timingDump: TimingDump | undefined;
+    private closing: Promise<void> | undefined;
     private batchedRequests: { method: APIRequest["method"]; params: APIRequest["params"]; resolve: (value: unknown) => void; reject: (reason?: any) => void; }[] = [];
     private nextBatch: NodeJS.Immediate | "manual" | undefined;
 
     constructor(options: ClientOptions) {
+        this.timingDump = TimingDump.fromEnvironment("async", isSpawnOptions(options) ? "spawn" : "socket");
+        if (this.timingDump || isSpawnOptions(options) && options.collectTiming) {
+            this.timing = new TimingCollector();
+        }
+        if (this.timingDump && isSpawnOptions(options)) {
+            options = { ...options, collectTiming: true };
+        }
         this.options = options;
         if (isSpawnOptions(options)) {
             configureFileSystemCallbacks(options.fs);
-            if (options.collectTiming) {
-                this.timing = new TimingCollector();
-            }
         }
     }
 
@@ -401,26 +408,52 @@ export class Client {
         return this.connection.sendRequest(requestType, undefined);
     }
 
-    async close(): Promise<void> {
+    close(): Promise<void> {
+        return this.closing ??= this.closeWorker();
+    }
+
+    private async closeWorker(): Promise<void> {
         await this.connecting?.catch(() => {}); // if connection is still in-progress, wait for it to finish before closing the connection
         this.closed = true;
-        if (this.connection) {
-            this.connection.dispose();
-            this.connection = undefined;
-        }
-        if (this.socket) {
-            this.socket.destroy();
-            this.socket = undefined;
+        try {
+            if (this.timingDump && this.timing) {
+                const local = this.timing.getInfo();
+                let server: ServerTimingInfo | undefined;
+                let serverTimingError: string | undefined;
+                const connection = this.connection;
+                // Closing alone does not reject pending JSON-RPC requests.
+                const onClose = connection?.onClose(() => connection.dispose());
+                try {
+                    if (this.connected) server = await this.fetchServerTiming();
+                }
+                catch (error) {
+                    serverTimingError = String(error);
+                }
+                finally {
+                    onClose?.dispose();
+                }
+                this.timingDump.write(local, server, serverTimingError);
+            }
         }
-        if (this.process) {
-            // Close stdin to unblock the server's read loop, allowing it to exit cleanly.
-            // The server is blocked on stdin.Read(), so just sending SIGTERM would deadlock:
-            // - Node won't exit while child is alive
-            // - Child can't process SIGTERM while blocked on read
-            // - Read won't error until stdin is closed
-            this.process.stdin?.end();
-            this.process = undefined;
+        finally {
+            if (this.connection) {
+                this.connection.dispose();
+                this.connection = undefined;
+            }
+            if (this.socket) {
+                this.socket.destroy();
+                this.socket = undefined;
+            }
+            if (this.process) {
+                // Close stdin to unblock the server's read loop, allowing it to exit cleanly.
+                // The server is blocked on stdin.Read(), so just sending SIGTERM would deadlock:
+                // - Node won't exit while child is alive
+                // - Child can't process SIGTERM while blocked on read
+                // - Read won't error until stdin is closed
+                this.process.stdin?.end();
+                this.process = undefined;
+            }
+            this.connected = false;
         }
-        this.connected = false;
     }
 }

packages/typescript/src/api/options.ts

@@ -33,6 +33,9 @@ export interface ClientSpawnOptions {
      * measures its own per-request processing time; both are combined (along
      * with an estimated transport overhead) in the snapshot returned by
      * {@link API.getTimingInfo}.
+     * Setting `TS_API_TIMING_DIR` to a nonempty output directory also enables
+     * collection, even when this option is false, and writes a JSON snapshot
+     * when the API is closed.
      */
     collectTiming?: boolean | undefined;
 }

packages/typescript/src/api/sync/api.ts

@@ -1344,8 +1344,8 @@ export class API<FromLSP extends boolean = false> implements FormatDiagnosticsHo
      *
      * Fetching the snapshot issues a lightweight request to the server to
      * retrieve its timing collection. Collection must be enabled via the
-     * `collectTiming` option; when it is not, the returned snapshot has
-     * `enabled: false` and zeroed totals.
+     * `collectTiming` option or `TS_API_TIMING_DIR` environment variable; when
+     * it is not, the returned snapshot has `enabled: false` and zeroed totals.
      */
     get getTimingInfo(): {
         (): TimingInfo;

packages/typescript/src/api/sync/client.ts

@@ -25,20 +25,27 @@ import {
     TimingCollector,
     type TimingInfo,
 } from "../timing.ts";
+import { TimingDump } from "../timingDump.ts";
 
 export type { ClientOptions, ClientSocketOptions, ClientSpawnOptions };
 
 export class Client {
     private channel: SyncRpcChannel;
     private encoder = new TextEncoder();
     private timing: TimingCollector | undefined;
+    private timingDump: TimingDump | undefined;
+    private closed = false;
     private maxResponseBytesPerPage: number | undefined;
 
     constructor(options: ClientOptions) {
         if (!isSpawnOptions(options)) {
             throw new Error("Socket connections are not yet supported in the sync client");
         }
 
+        this.timingDump = TimingDump.fromEnvironment("sync", "spawn");
+        if (this.timingDump) {
+            options = { ...options, collectTiming: true };
+        }
         const args = getAPIProcessArgs(options, false);
         this.maxResponseBytesPerPage = options.maxResponseBytesPerPage;
 
@@ -184,6 +191,24 @@ export class Client {
     }
 
     close(): void {
-        this.channel.close();
+        if (this.closed) return;
+        this.closed = true;
+        try {
+            if (this.timingDump && this.timing) {
+                const local = this.timing.getInfo();
+                let server: ServerTimingInfo | undefined;
+                let serverTimingError: string | undefined;
+                try {
+                    server = JSON.parse(this.channel.requestSync("getServerTiming", "")) as ServerTimingInfo;
+                }
+                catch (error) {
+                    serverTimingError = String(error);
+                }
+                this.timingDump.write(local, server, serverTimingError);
+            }
+        }
+        finally {
+            this.channel.close();
+        }
     }
 }