simplify and expand test suite

Author: Hweinstock

packages/core/src/shared/utilities/pollingSet.ts

@@ -49,4 +49,9 @@ export class PollingSet<T> extends Set<T> {
         this.add(id)
         this.pollTimer = this.pollTimer ?? globals.clock.setInterval(() => this.poll(), this.interval)
     }
+
+    public override clear(): void {
+        this.pollTimer = undefined
+        super.clear()
+    }
 }

packages/core/src/shared/utilities/processUtils.ts

@@ -62,13 +62,14 @@ export interface ChildProcessResult {
     signal?: string
 }
 
-interface Tracker<T> {
+interface Tracker<P, T> {
     add(item: T): void
-    delete(item: T): void
+    delete(id: P): void
     has(item: T): boolean
     size(): number
     cleanUp(): void
     monitor(): void | Promise<void>
+    clear(): void
 }
 
 export const eof = Symbol('EOF')
@@ -78,9 +79,9 @@ export interface ProcessStats {
     cpu: number
     elapsed: number
 }
-export class ChildProcessTracker implements Tracker<ChildProcess> {
-    static pollingInterval: number = 10000
-    static thresholds: ProcessStats = {
+export class ChildProcessTracker implements Tracker<number, ChildProcess> {
+    static readonly pollingInterval: number = 10000
+    static readonly thresholds: ProcessStats = {
         memory: 100 * 1024 * 1024, // 100 MB
         cpu: 50,
         elapsed: 30 * 1000, // 30 seconds
@@ -94,10 +95,10 @@ export class ChildProcessTracker implements Tracker<ChildProcess> {
 
     public cleanUp() {
         const terminatedProcesses = Array.from(this.#pids.values()).filter(
-            (pid: number) => !this.#pids.has(pid) || this.#processByPid.get(pid)?.stopped
+            (pid: number) => this.#processByPid.get(pid)?.stopped
         )
         for (const pid of terminatedProcesses) {
-            this.#pids.delete(pid)
+            this.delete(pid)
         }
     }
 
@@ -134,10 +135,9 @@ export class ChildProcessTracker implements Tracker<ChildProcess> {
         this.#pids.start(pid)
     }
 
-    public delete(childProcess: ChildProcess) {
-        const pid = childProcess.pid()
-        this.#processByPid.delete(pid)
-        this.#pids.delete(pid)
+    public delete(childProcessId: number) {
+        this.#processByPid.delete(childProcessId)
+        this.#pids.delete(childProcessId)
     }
 
     public size() {
@@ -156,6 +156,11 @@ export class ChildProcessTracker implements Tracker<ChildProcess> {
             elapsed: stats.elapsed,
         }
     }
+
+    public clear() {
+        this.#pids.clear()
+        this.#processByPid.clear()
+    }
 }
 
 /**
@@ -165,7 +170,7 @@ export class ChildProcessTracker implements Tracker<ChildProcess> {
  * - call and await run to get the results (pass or fail)
  */
 export class ChildProcess {
-    static #runningProcesses: Tracker<ChildProcess> = new ChildProcessTracker()
+    static #runningProcesses: Tracker<number, ChildProcess> = new ChildProcessTracker()
     #childProcess: proc.ChildProcess | undefined
     #processErrors: Error[] = []
     #processResult: ChildProcessResult | undefined
@@ -416,7 +421,7 @@ export class ChildProcess {
 
         const dispose = () => {
             timeoutListener?.dispose()
-            ChildProcess.#runningProcesses.delete(this)
+            ChildProcess.#runningProcesses.delete(this.pid())
         }
 
         process.on('exit', dispose)

packages/core/src/test/shared/utilities/processUtils.test.ts

@@ -6,6 +6,7 @@
 import assert from 'assert'
 import * as os from 'os'
 import * as path from 'path'
+import * as sinon from 'sinon'
 import { makeTemporaryToolkitFolder, tryRemoveFolder } from '../../../shared/filesystemUtilities'
 import { ChildProcess, ChildProcessTracker, eof, ProcessStats } from '../../../shared/utilities/processUtils'
 import { sleep } from '../../../shared/utilities/timeoutUtils'
@@ -14,7 +15,6 @@ import { fs } from '../../../shared'
 import * as FakeTimers from '@sinonjs/fake-timers'
 import { installFakeClock } from '../../testUtil'
 import { isWin } from '../../../shared/vscode/env'
-import Sinon from 'sinon'
 import { assertLogsContain } from '../../globalSetup.test'
 
 describe('ChildProcess', async function () {
@@ -368,6 +368,14 @@ describe('ChildProcessTracker', function () {
         tracker = new ChildProcessTracker()
     })
 
+    afterEach(function () {
+        tracker.clear()
+    })
+
+    after(function () {
+        clock.uninstall()
+    })
+
     it(`removes stopped processes every ${ChildProcessTracker.pollingInterval / 1000} seconds`, async function () {
         // Start a 'sleep' command, check it only removes after we stop it.
         const childProcess = new ChildProcess(getSleepCmd(), ['90'])
@@ -388,30 +396,24 @@ describe('ChildProcessTracker', function () {
         const childProcess2 = new ChildProcess(getSleepCmd(), ['90'])
         childProcess1.run().catch(() => assert.fail('sleep command threw an error'))
         childProcess2.run().catch(() => assert.fail('sleep command threw an error'))
-
         tracker.add(childProcess1)
         tracker.add(childProcess2)
 
         assert.strictEqual(tracker.has(childProcess1), true, 'Missing first process')
         assert.strictEqual(tracker.has(childProcess2), true, 'Missing second process')
-        assert.strictEqual(tracker.size(), 2)
 
         childProcess1.stop()
-        await clock.tickAsync(ChildProcessTracker.pollingInterval + 1)
+        await clock.tickAsync(ChildProcessTracker.pollingInterval)
         assert.strictEqual(tracker.has(childProcess2), true, 'first process was not removed after stopping it')
         assert.strictEqual(tracker.size(), 1)
-
-        childProcess2.stop()
-        await clock.tickAsync(ChildProcessTracker.pollingInterval + 1)
-        assert.strictEqual(tracker.size(), 0, 'second process was not removed after stopping it')
     })
 
     it('logs a warning message when system usage exceeds threshold', async function () {
         const childProcess = new ChildProcess(getSleepCmd(), ['90'])
         childProcess.run().catch(() => assert.fail('sleep command threw an error'))
         tracker.add(childProcess)
 
-        const usageMock = Sinon.stub(ChildProcessTracker.prototype, 'getUsage')
+        const usageMock = sinon.stub(ChildProcessTracker.prototype, 'getUsage')
         const highCpu: ProcessStats = {
             cpu: ChildProcessTracker.thresholds.cpu + 1,
             memory: 0,
@@ -442,6 +444,6 @@ describe('ChildProcessTracker', function () {
         await clock.tickAsync(ChildProcessTracker.pollingInterval)
         assertLogsContain('exceeded time threshold', false, 'warn')
 
-        usageMock.restore()
+        sinon.restore()
     })
 })