Merge branch 'master' into typesVersions

Author: rbuckton

Gulpfile.js

@@ -26,7 +26,7 @@ const exec = require("./scripts/build/exec");
 const browserify = require("./scripts/build/browserify");
 const prepend = require("./scripts/build/prepend");
 const { removeSourceMaps } = require("./scripts/build/sourcemaps");
-const { CancellationTokenSource, CancelError, delay, Semaphore } = require("prex");
+const { CancellationTokenSource, CancelError, delay, Semaphore } = require("prex"); 
 const { libraryTargets, generateLibs } = require("./scripts/build/lib");
 const { runConsoleTests, cleanTestDirs, writeTestConfigFile, refBaseline, localBaseline, refRwcBaseline, localRwcBaseline } = require("./scripts/build/tests");
 
@@ -533,34 +533,39 @@ gulp.task(
     ["watch-diagnostics", "watch-lib"].concat(useCompilerDeps),
     () => project.watch(tsserverProject, { typescript: useCompiler }));
 
-gulp.task(
-    "watch-local",
-    /*help*/ false,
-    ["watch-lib", "watch-tsc", "watch-services", "watch-server"]);
-
 gulp.task(
     "watch-runner",
     /*help*/ false,
     useCompilerDeps,
     () => project.watch(testRunnerProject, { typescript: useCompiler }));
 
-const watchPatterns = [
-    runJs,
-    typescriptDts,
-    tsserverlibraryDts
-];
+gulp.task(
+    "watch-local",
+    "Watches for changes to projects in src/ (but does not execute tests).",
+    ["watch-lib", "watch-tsc", "watch-services", "watch-server", "watch-runner", "watch-lssl"]);
 
 gulp.task(
     "watch",
-    "Watches for changes to the build inputs for built/local/run.js, then executes runtests-parallel.",
+    "Watches for changes to the build inputs for built/local/run.js, then runs tests.",
     ["build-rules", "watch-runner", "watch-services", "watch-lssl"],
     () => {
-        const runTestsSemaphore = new Semaphore(1);
-        const fn = async () => {
+        const sem = new Semaphore(1);
+
+        gulp.watch([runJs, typescriptDts, tsserverlibraryDts], () => {
+            runTests();
+        });
+
+        // NOTE: gulp.watch is far too slow when watching tests/cases/**/* as it first enumerates *every* file
+        const testFilePattern = /(\.ts|[\\/]tsconfig\.json)$/;
+        fs.watch("tests/cases", { recursive: true }, (_, file) => {
+            if (testFilePattern.test(file)) runTests();
+        });
+
+        async function runTests() {
             try {
                 // Ensure only one instance of the test runner is running at any given time.
-                if (runTestsSemaphore.count > 0) {
-                    await runTestsSemaphore.wait();
+                if (sem.count > 0) {
+                    await sem.wait();
                     try {
                         // Wait for any concurrent recompilations to complete...
                         try {
@@ -576,20 +581,20 @@ gulp.task(
                         }
 
                         // cancel any pending or active test run if a new recompilation is triggered
-                        const runTestsSource = new CancellationTokenSource();
+                        const source = new CancellationTokenSource();
                         project.waitForWorkToStart().then(() => {
-                            runTestsSource.cancel();
+                            source.cancel();
                         });
 
                         if (cmdLineOptions.tests || cmdLineOptions.failed) {
-                            await runConsoleTests(runJs, "mocha-fivemat-progress-reporter", /*runInParallel*/ false, /*watchMode*/ true, runTestsSource.token);
+                            await runConsoleTests(runJs, "mocha-fivemat-progress-reporter", /*runInParallel*/ false, /*watchMode*/ true, source.token);
                         }
                         else {
-                            await runConsoleTests(runJs, "min", /*runInParallel*/ true, /*watchMode*/ true, runTestsSource.token);
+                            await runConsoleTests(runJs, "min", /*runInParallel*/ true, /*watchMode*/ true, source.token);
                         }
                     }
                     finally {
-                        runTestsSemaphore.release();
+                        sem.release();
                     }
                 }
             }
@@ -602,14 +607,6 @@ gulp.task(
                 }
             }
         };
-
-        gulp.watch(watchPatterns, (e) => fn());
-
-        // NOTE: gulp.watch is far too slow when watching tests/cases/**/* as it first enumerates *every* file
-        const testFilePattern = /(\.ts|[\\/]tsconfig\.json)$/;
-        fs.watch("tests/cases", { recursive: true }, (_, file) => {
-            if (testFilePattern.test(file)) fn();
-        });
     });
 
 gulp.task("clean-built", /*help*/ false, [`clean:${diagnosticInformationMapTs}`], () => del(["built"]));

scripts/build/exec.js

@@ -3,7 +3,7 @@ const cp = require("child_process");
 const log = require("fancy-log"); // was `require("gulp-util").log (see https://github.com/gulpjs/gulp-util)
 const isWin = /^win/.test(process.platform);
 const chalk = require("./chalk");
-const { CancelError } = require("prex");
+const { CancellationToken, CancelError } = require("prex");
 
 module.exports = exec;
 
@@ -19,33 +19,32 @@ module.exports = exec;
  */
 function exec(cmd, args, options = {}) {
     return /**@type {Promise<{exitCode: number}>}*/(new Promise((resolve, reject) => {
-        if (options.cancelToken) {
-            options.cancelToken.throwIfCancellationRequested();
-        }
-    
-        log(`> ${chalk.green(cmd)} ${args.join(" ")}`);
+        const { ignoreExitCode, cancelToken = CancellationToken.none } = options;
+        cancelToken.throwIfCancellationRequested();
+
         // TODO (weswig): Update child_process types to add windowsVerbatimArguments to the type definition
         const subshellFlag = isWin ? "/c" : "-c";
         const command = isWin ? [possiblyQuote(cmd), ...args] : [`${cmd} ${args.join(" ")}`];
-        const ex = cp.spawn(isWin ? "cmd" : "/bin/sh", [subshellFlag, ...command], { stdio: "inherit", windowsVerbatimArguments: true });
-        const subscription = options.cancelToken && options.cancelToken.register(() => {
+        
+        log(`> ${chalk.green(cmd)} ${args.join(" ")}`);
+        const proc = cp.spawn(isWin ? "cmd" : "/bin/sh", [subshellFlag, ...command], { stdio: "inherit", windowsVerbatimArguments: true });
+        const registration = cancelToken.register(() => {
             log(`${chalk.red("killing")} '${chalk.green(cmd)} ${args.join(" ")}'...`);
-            ex.kill("SIGINT");
-            ex.kill("SIGTERM");
-            ex.kill();
+            proc.kill("SIGINT");
+            proc.kill("SIGTERM");
             reject(new CancelError());
         });
-        ex.on("exit", exitCode => {
-            if (subscription) subscription.unregister();
-            if (exitCode === 0 || options.ignoreExitCode) {
+        proc.on("exit", exitCode => {
+            registration.unregister();
+            if (exitCode === 0 || ignoreExitCode) {
                 resolve({ exitCode });
             }
             else {
                 reject(new Error(`Process exited with code: ${exitCode}`));
             }
         });
-        ex.on("error", error => {
-            if (subscription) subscription.unregister();
+        proc.on("error", error => {
+            registration.unregister();
             reject(error);
         });
     }));

scripts/build/project.js

@@ -16,9 +16,9 @@ const needsUpdate = require("./needsUpdate");
 const mkdirp = require("./mkdirp");
 const prettyTime = require("pretty-hrtime");
 const { reportDiagnostics } = require("./diagnostics");
-const { CountdownEvent, Pulsar } = require("prex");
+const { CountdownEvent, ManualResetEvent } = require("prex");
 
-const workStartedEvent = new Pulsar();
+const workStartedEvent = new ManualResetEvent();
 const countdown = new CountdownEvent(0);
 
 class CompilationGulp extends gulp.Gulp {
@@ -30,7 +30,8 @@ class CompilationGulp extends gulp.Gulp {
         child.on("task_start", e => {
             if (countdown.remainingCount === 0) {
                 countdown.reset(1);
-                workStartedEvent.pulseAll();
+                workStartedEvent.set();
+                workStartedEvent.reset();
             }
             else {
                 countdown.add();

scripts/build/tests.js

@@ -8,6 +8,7 @@ const mkdirP = require("./mkdirp");
 const cmdLineOptions = require("./options");
 const exec = require("./exec");
 const log = require("fancy-log"); // was `require("gulp-util").log (see https://github.com/gulpjs/gulp-util)
+const { CancellationToken } = require("prex");
 const mochaJs = require.resolve("mocha/bin/_mocha");
 
 exports.localBaseline = "tests/baselines/local/";
@@ -23,7 +24,7 @@ exports.localTest262Baseline = "internal/baselines/test262/local";
  * @param {boolean} watchMode
  * @param {import("prex").CancellationToken} [cancelToken]
  */
-async function runConsoleTests(runJs, defaultReporter, runInParallel, watchMode, cancelToken) {
+async function runConsoleTests(runJs, defaultReporter, runInParallel, watchMode, cancelToken = CancellationToken.none) {
     let testTimeout = cmdLineOptions.timeout;
     let tests = cmdLineOptions.tests;
     const lintFlag = cmdLineOptions.lint;
@@ -37,7 +38,7 @@ async function runConsoleTests(runJs, defaultReporter, runInParallel, watchMode,
     const keepFailed = cmdLineOptions.keepFailed;
     if (!cmdLineOptions.dirty) {
         await cleanTestDirs();
-        if (cancelToken) cancelToken.throwIfCancellationRequested();
+        cancelToken.throwIfCancellationRequested();
     }
 
     if (fs.existsSync(testConfigFile)) {