More baselining for timeouts that make furture changes easier (microsoft#53579)

Author: sheetalkamat

src/compiler/sys.ts

@@ -286,7 +286,7 @@ function createDynamicPriorityPollingWatchFile(host: {
         return queue;
     }
 
-    function pollPollingIntervalQueue(queue: PollingIntervalQueue) {
+    function pollPollingIntervalQueue(_timeoutType: string, queue: PollingIntervalQueue) {
         queue.pollIndex = pollQueue(queue, queue.pollingInterval, queue.pollIndex, pollingChunkSize[queue.pollingInterval]);
         // Set the next polling index and timeout
         if (queue.length) {
@@ -298,12 +298,12 @@ function createDynamicPriorityPollingWatchFile(host: {
         }
     }
 
-    function pollLowPollingIntervalQueue(queue: PollingIntervalQueue) {
+    function pollLowPollingIntervalQueue(_timeoutType: string, queue: PollingIntervalQueue) {
         // Always poll complete list of changedFilesInLastPoll
         pollQueue(changedFilesInLastPoll, PollingInterval.Low, /*pollIndex*/ 0, changedFilesInLastPoll.length);
 
         // Finally do the actual polling of the queue
-        pollPollingIntervalQueue(queue);
+        pollPollingIntervalQueue(_timeoutType, queue);
         // Schedule poll if there are files in changedFilesInLastPoll but no files in the actual queue
         // as pollPollingIntervalQueue wont schedule for next poll
         if (!queue.pollScheduled && changedFilesInLastPoll.length) {
@@ -374,7 +374,7 @@ function createDynamicPriorityPollingWatchFile(host: {
     }
 
     function scheduleNextPoll(pollingInterval: PollingInterval) {
-        pollingIntervalQueue(pollingInterval).pollScheduled = host.setTimeout(pollingInterval === PollingInterval.Low ? pollLowPollingIntervalQueue : pollPollingIntervalQueue, pollingInterval, pollingIntervalQueue(pollingInterval));
+        pollingIntervalQueue(pollingInterval).pollScheduled = host.setTimeout(pollingInterval === PollingInterval.Low ? pollLowPollingIntervalQueue : pollPollingIntervalQueue, pollingInterval, pollingInterval === PollingInterval.Low ? "pollLowPollingIntervalQueue" : "pollPollingIntervalQueue", pollingIntervalQueue(pollingInterval));
     }
 }
 
@@ -465,7 +465,7 @@ function createFixedChunkSizePollingWatchFile(host: {
 
     function scheduleNextPoll() {
         if (!watchedFiles.length || pollScheduled) return;
-        pollScheduled = host.setTimeout(pollQueue, PollingInterval.High);
+        pollScheduled = host.setTimeout(pollQueue, PollingInterval.High, "pollQueue");
     }
 }
 
@@ -713,7 +713,7 @@ function createDirectoryWatcherSupportingRecursive({
             clearTimeout(timerToUpdateChildWatches);
             timerToUpdateChildWatches = undefined;
         }
-        timerToUpdateChildWatches = setTimeout(onTimerToUpdateChildWatches, 1000);
+        timerToUpdateChildWatches = setTimeout(onTimerToUpdateChildWatches, 1000, "timerToUpdateChildWatches");
     }
 
     function onTimerToUpdateChildWatches() {

src/compiler/tsbuildPublic.ts

@@ -2258,10 +2258,10 @@ function scheduleBuildInvalidatedProject<T extends BuilderProgram>(state: Soluti
     if (state.timerToBuildInvalidatedProject) {
         hostWithWatch.clearTimeout(state.timerToBuildInvalidatedProject);
     }
-    state.timerToBuildInvalidatedProject = hostWithWatch.setTimeout(buildNextInvalidatedProject, time, state, changeDetected);
+    state.timerToBuildInvalidatedProject = hostWithWatch.setTimeout(buildNextInvalidatedProject, time, "timerToBuildInvalidatedProject", state, changeDetected);
 }
 
-function buildNextInvalidatedProject<T extends BuilderProgram>(state: SolutionBuilderState<T>, changeDetected: boolean) {
+function buildNextInvalidatedProject<T extends BuilderProgram>(_timeoutType: string, state: SolutionBuilderState<T>, changeDetected: boolean) {
     performance.mark("SolutionBuilder::beforeBuild");
     const buildOrder = buildNextInvalidatedProjectWorker(state, changeDetected);
     performance.mark("SolutionBuilder::afterBuild");

src/compiler/watchPublic.ts

@@ -803,7 +803,7 @@ export function createWatchProgram<T extends BuilderProgram>(host: WatchCompiler
         }
         const pending = clearInvalidateResolutionsOfFailedLookupLocations();
         writeLog(`Scheduling invalidateFailedLookup${pending ? ", Cancelled earlier one" : ""}`);
-        timerToInvalidateFailedLookupResolutions = host.setTimeout(invalidateResolutionsOfFailedLookup, 250);
+        timerToInvalidateFailedLookupResolutions = host.setTimeout(invalidateResolutionsOfFailedLookup, 250, "timerToInvalidateFailedLookupResolutions");
     }
 
     function invalidateResolutionsOfFailedLookup() {
@@ -825,7 +825,7 @@ export function createWatchProgram<T extends BuilderProgram>(host: WatchCompiler
             host.clearTimeout(timerToUpdateProgram);
         }
         writeLog("Scheduling update");
-        timerToUpdateProgram = host.setTimeout(updateProgramWithWatchStatus, 250);
+        timerToUpdateProgram = host.setTimeout(updateProgramWithWatchStatus, 250, "timerToUpdateProgram");
     }
 
     function scheduleProgramReload() {

src/server/session.ts

@@ -329,8 +329,8 @@ export function formatMessage<T extends protocol.Message>(msg: T, logger: Logger
  * Allows to schedule next step in multistep operation
  */
 interface NextStep {
-    immediate(action: () => void): void;
-    delay(ms: number, action: () => void): void;
+    immediate(actionType: string, action: () => void): void;
+    delay(actionType: string, ms: number, action: () => void): void;
 }
 
 /**
@@ -371,22 +371,22 @@ class MultistepOperation implements NextStep {
         this.setImmediateId(undefined);
     }
 
-    public immediate(action: () => void) {
+    public immediate(actionType: string, action: () => void) {
         const requestId = this.requestId!;
         Debug.assert(requestId === this.operationHost.getCurrentRequestId(), "immediate: incorrect request id");
         this.setImmediateId(this.operationHost.getServerHost().setImmediate(() => {
             this.immediateId = undefined;
             this.operationHost.executeWithRequestId(requestId, () => this.executeAction(action));
-        }));
+        }, actionType));
     }
 
-    public delay(ms: number, action: () => void) {
+    public delay(actionType: string, ms: number, action: () => void) {
         const requestId = this.requestId!;
         Debug.assert(requestId === this.operationHost.getCurrentRequestId(), "delay: incorrect request id");
         this.setTimerHandle(this.operationHost.getServerHost().setTimeout(() => {
             this.timerHandle = undefined;
             this.operationHost.executeWithRequestId(requestId, () => this.executeAction(action));
-        }, ms));
+        }, ms, actionType));
     }
 
     private executeAction(action: (next: NextStep) => void) {
@@ -1271,7 +1271,7 @@ export class Session<TMessage = string> implements EventSender {
         const goNext = () => {
             index++;
             if (checkList.length > index) {
-                next.delay(followMs, checkOne);
+                next.delay("checkOne", followMs, checkOne);
             }
         };
         const checkOne = () => {
@@ -1308,7 +1308,7 @@ export class Session<TMessage = string> implements EventSender {
                 goNext();
                 return;
             }
-            next.immediate(() => {
+            next.immediate("semanticCheck", () => {
                 this.semanticCheck(fileName, project);
                 if (this.changeSeq !== seq) {
                     return;
@@ -1318,15 +1318,15 @@ export class Session<TMessage = string> implements EventSender {
                     goNext();
                     return;
                 }
-                next.immediate(() => {
+                next.immediate("suggestionCheck", () => {
                     this.suggestionCheck(fileName, project);
                     goNext();
                 });
             });
         };
 
         if (checkList.length > index && this.changeSeq === seq) {
-            next.delay(ms, checkOne);
+            next.delay("checkOne", ms, checkOne);
         }
     }
 

src/server/utilities.ts

@@ -34,7 +34,7 @@ export class ThrottledOperations {
             this.host.clearTimeout(pendingTimeout);
         }
         // schedule new operation, pass arguments
-        this.pendingTimeouts.set(operationId, this.host.setTimeout(ThrottledOperations.run, delay, this, operationId, cb));
+        this.pendingTimeouts.set(operationId, this.host.setTimeout(ThrottledOperations.run, delay, operationId, this, cb));
         if (this.logger) {
             this.logger.info(`Scheduled: ${operationId}${pendingTimeout ? ", Cancelled earlier one" : ""}`);
         }
@@ -47,7 +47,7 @@ export class ThrottledOperations {
         return this.pendingTimeouts.delete(operationId);
     }
 
-    private static run(self: ThrottledOperations, operationId: string, cb: () => void) {
+    private static run(operationId: string, self: ThrottledOperations, cb: () => void) {
         perfLogger?.logStartScheduledOperation(operationId);
         self.pendingTimeouts.delete(operationId);
         if (self.logger) {

src/testRunner/unittests/tsbuildWatch/configFileErrors.ts

@@ -3,14 +3,9 @@ import { verifyTscWatch } from "../tscWatch/helpers";
 import {
     createWatchedSystem,
     libFile,
-    TestServerHost,
 } from "../virtualFileSystemWithWatch";
 
 describe("unittests:: tsbuildWatch:: watchMode:: configFileErrors:: reports syntax errors in config file", () => {
-    function build(sys: TestServerHost) {
-        sys.checkTimeoutQueueLengthAndRun(1); // build the project
-        sys.checkTimeoutQueueLength(0);
-    }
     verifyTscWatch({
         scenario: "configFileErrors",
         subScenario: "reports syntax errors in config file",
@@ -41,25 +36,25 @@ describe("unittests:: tsbuildWatch:: watchMode:: configFileErrors:: reports synt
                 caption: "reports syntax errors after change to config file",
                 edit: sys => sys.replaceFileText(`/user/username/projects/myproject/tsconfig.json`, ",", `,
         "declaration": true,`),
-                timeouts: build,
+                timeouts: sys => sys.runQueuedTimeoutCallbacks(), // build the project
             },
             {
                 caption: "reports syntax errors after change to ts file",
                 edit: sys => sys.replaceFileText(`/user/username/projects/myproject/a.ts`, "foo", "fooBar"),
-                timeouts: build,
+                timeouts: sys => sys.runQueuedTimeoutCallbacks(), // build the project
             },
             {
                 caption: "reports error when there is no change to tsconfig file",
                 edit: sys => sys.replaceFileText(`/user/username/projects/myproject/tsconfig.json`, "", ""),
-                timeouts: build,
+                timeouts: sys => sys.runQueuedTimeoutCallbacks(), // build the project
             },
             {
                 caption: "builds after fixing config file errors",
                 edit: sys => sys.writeFile(`/user/username/projects/myproject/tsconfig.json`, JSON.stringify({
                     compilerOptions: { composite: true, declaration: true },
                     files: ["a.ts", "b.ts"]
                 })),
-                timeouts: build,
+                timeouts: sys => sys.runQueuedTimeoutCallbacks(), // build the project
             }
         ]
     });

src/testRunner/unittests/tsbuildWatch/demo.ts

@@ -55,9 +55,8 @@ describe("unittests:: tsbuildWatch:: watchMode:: with demo project", () => {
                 caption: "Fix error",
                 edit: sys => sys.writeFile(coreFiles[0].path, coreFiles[0].content),
                 timeouts: sys => {
-                    sys.checkTimeoutQueueLengthAndRun(1); // build core
-                    sys.checkTimeoutQueueLengthAndRun(1); // build animals, zoo and solution
-                    sys.checkTimeoutQueueLength(0);
+                    sys.runQueuedTimeoutCallbacks(); // build core
+                    sys.runQueuedTimeoutCallbacks(); // build animals, zoo and solution
                 },
             }
         ]
@@ -80,10 +79,7 @@ ${coreFiles[1].content}`);
 import * as A from '../animals';
 ${coreFiles[1].content}`),
                 // build core
-                timeouts: sys => {
-                    sys.checkTimeoutQueueLengthAndRun(1);
-                    sys.checkTimeoutQueueLength(0);
-                },
+                timeouts: sys => sys.runQueuedTimeoutCallbacks(),
             }
         ]
     });

src/testRunner/unittests/tsbuildWatch/moduleResolution.ts

@@ -50,10 +50,7 @@ describe("unittests:: tsbuildWatch:: watchMode:: moduleResolution", () => {
             {
                 caption: "Append text",
                 edit: sys => sys.appendFile(`/user/username/projects/myproject/project1/index.ts`, "const bar = 10;"),
-                timeouts: sys => {
-                    sys.checkTimeoutQueueLengthAndRun(1); // build project1 and solution
-                    sys.checkTimeoutQueueLength(0);
-                }
+                timeouts: sys => sys.runQueuedTimeoutCallbacks(), // build project1 and solution
             },
         ]
     });

src/testRunner/unittests/tsbuildWatch/noEmit.ts

@@ -24,19 +24,13 @@ describe("unittests:: tsbuildWatch:: watchMode:: with noEmit", () => {
                 caption: "No change",
                 edit: sys => sys.writeFile(`/user/username/projects/myproject/a.js`, sys.readFile(`/user/username/projects/myproject/a.js`)!),
                 // build project
-                timeouts: sys => {
-                    sys.checkTimeoutQueueLengthAndRun(1);
-                    sys.checkTimeoutQueueLength(0);
-                },
+                timeouts: sys => sys.runQueuedTimeoutCallbacks(),
             },
             {
                 caption: "change",
                 edit: sys => sys.writeFile(`/user/username/projects/myproject/a.js`, "const x = 10;"),
                 // build project
-                timeouts: sys => {
-                    sys.checkTimeoutQueueLengthAndRun(1);
-                    sys.checkTimeoutQueueLength(0);
-                },
+                timeouts: sys => sys.runQueuedTimeoutCallbacks(),
             },
         ],
         baselineIncremental: true

src/testRunner/unittests/tsbuildWatch/noEmitOnError.ts

@@ -15,21 +15,15 @@ describe("unittests:: tsbuildWatch:: watchMode:: with noEmitOnError", () => {
             caption,
             edit: sys => sys.writeFile(`/user/username/projects/noEmitOnError/src/main.ts`, content),
             // build project
-            timeouts: sys => {
-                sys.checkTimeoutQueueLengthAndRun(1);
-                sys.checkTimeoutQueueLength(0);
-            },
+            timeouts: sys => sys.runQueuedTimeoutCallbacks(),
         };
     }
 
     const noChange: TscWatchCompileChange = {
         caption: "No change",
         edit: sys => sys.writeFile(`/user/username/projects/noEmitOnError/src/main.ts`, sys.readFile(`/user/username/projects/noEmitOnError/src/main.ts`)!),
         // build project
-        timeouts: sys => {
-            sys.checkTimeoutQueueLengthAndRun(1);
-            sys.checkTimeoutQueueLength(0);
-        },
+        timeouts: sys => sys.runQueuedTimeoutCallbacks(),
     };
     verifyTscWatch({
         scenario: "noEmitOnError",