zarro 1.99.5 → 1.100.1

package/gulp-tasks/build.js

@@ -14,9 +14,10 @@ const
   log = requireModule("log"),
   resolveMasks = requireModule("resolve-masks"),
   logConfig = requireModule("log-config"),
+  tryDo = requireModule("try-do"),
   msbuild = require("gulp-msbuild");
 
-gulp.task("prebuild", ["nuget-restore"]);
+gulp.task("prebuild", ["nuget-restore", "clean"]);
 
 const myTasks = ["build"],
   myVars = [
@@ -48,28 +49,12 @@ gulp.task(
 gulp.task("quick-build", "Quick build without pre-cursors", tryBuild);
 
 async function tryBuild() {
-  let totalAttempts = env.resolveNumber("BUILD_RETRIES") + 1;
-  if (totalAttempts < 0) {
-    totalAttempts = 1;
-  }
-  const totalRetries = totalAttempts - 1;
-  let retryCount = 0;
-
-  while (totalAttempts-- > 0) {
-    try {
-      await build();
-    } catch (e) {
-      if (totalAttempts > 0) {
-        console.error(chalk.red(`Build fails: ${e}`));
-        console.log(chalk.green(`Retrying (${++retryCount} / ${totalRetries })`));
-      } else {
-        if (totalRetries < 1) {
-          console.log(chalk.magentaBright(`Build fails! If the error looks transient, I suggest setting the environment variable 'BUILD_RETRIES' to some number > 0 🔨.`));
-        }
-        throw e;
-      }
-    }
-  }
+  return tryDo(
+    build,
+    env.resolveNumber("BUILD_RETRIES"),
+    e => console.error(chalk.red(`Build fails: ${e}`)),
+    () => console.log(chalk.magentaBright(`Build fails! If the error looks transient, I suggest setting the environment variable 'BUILD_RETRIES' to some number > 0 🔨.`))
+  );
 }
 
 async function build() {
@@ -100,11 +85,6 @@ function buildForNetCore(solutions) {
   }
   return promisifyStream(
     solutions
-      .pipe(
-        dotnetClean({
-          configuration
-        })
-      )
       .pipe(
         dotnetBuild({
           verbosity: env.resolve("BUILD_VERBOSITY"),
@@ -139,11 +119,18 @@ function buildAsStream(solutions) {
     nologo: false,
     logCommand: true,
     nodeReuse: env.resolveFlag("BUILD_MSBUILD_NODE_REUSE"),
-    maxcpucount: env.resolveNumber("BUILD_MAX_CPU_COUNT")
+    maxcpucount: env.resolveNumber("BUILD_MAX_CPU_COUNT"),
   };
 
   if (env.resolveFlag("BUILD_SHOW_INFO")) {
-    logConfig(config, {
+    const
+      buildRetries = env.resolveNumber("BUILD_RETRIES"),
+      retryMessage = buildRetries > 0 ? `yes (${buildRetries})` : `no`;
+
+    logConfig({
+      ...config,
+      buildRetries: retryMessage
+    }, {
       toolsVersion: "Tools version",
       targets: "Build targets",
       configuration: "Build configuration",
@@ -154,6 +141,7 @@ function buildAsStream(solutions) {
       architecture: "Build architecture",
       nodeReuse: "Re-use MSBUILD nodes",
       maxcpucount: "Max CPUs to use for build",
+      buildRetries: "Retry builds"
     });
   }
   return solutions

package/gulp-tasks/clean.js

@@ -1,37 +1,55 @@
-const gulp = requireModule("gulp"),
-  msbuild = require("gulp-msbuild"),
-  env = requireModule("env");
-
-const myVars = [
-  "BUILD_TOOLSVERSION",
-  "BUILD_CONFIGURATION",
-  "BUILD_VERBOSITY",
-  "BUILD_MAX_CPU_COUNT",
-  "BUILD_FAIL_ON_ERROR",
-  "BUILD_PLATFORM",
-  "BUILD_ARCHITECTURE",
-  "BUILD_MSBUILD_NODE_REUSE"
-];
-env.associate(myVars, "clean");
-
-gulp.task(
-  "clean",
-  "Invokes the 'Clean' target on all solutions in the tree",
-  function() {
-    return gulp.src("**/*.sln").pipe(
-      msbuild({
-        toolsVersion: env.resolve("BUILD_TOOLSVERSION"),
-        targets: ["Clean"],
-        configuration: env.resolve("BUILD_CONFIGURATION"),
-        stdout: true,
-        logCommand: true,
-        errorOnFail: env.resolveFlag("BUILD_FAIL_ON_ERROR"),
-        solutionPlatform: env.resolve("BUILD_PLATFORM"),
-        architecture: env.resolve("BUILD_ARCHITECTURE"),
-        verbosity: env.resolve("BUILD_VERBOSITY"),
-        nodeReuse: env.resolveFlag("BUILD_MSBUILD_NODE_REUSE"),
-        maxcpucount: env.resolveNumber("BUILD_MAX_CPU_COUNT")
-      })
-    );
-  }
-);
+const
+  gulp = requireModule("gulp"),
+  promisifyStream = requireModule("promisify-stream"),
+  tryDo = requireModule("try-do"),
+  msbuild = require("gulp-msbuild"),
+  env = requireModule("env");
+const chalk = require("ansi-colors");
+
+const myVars = [
+  "BUILD_TOOLSVERSION",
+  "BUILD_CONFIGURATION",
+  "BUILD_VERBOSITY",
+  "BUILD_MAX_CPU_COUNT",
+  "BUILD_FAIL_ON_ERROR",
+  "BUILD_PLATFORM",
+  "BUILD_ARCHITECTURE",
+  "BUILD_MSBUILD_NODE_REUSE",
+  "BUILD_RETRIES"
+];
+env.associate(myVars, "clean");
+
+gulp.task(
+  "clean",
+  "Invokes the 'Clean' target on all solutions in the tree",
+  tryClean
+);
+
+function tryClean() {
+  tryDo(
+    clean,
+    env.resolveNumber("BUILD_RETRIES"),
+    e => console.error(chalk.red(`Clean fails: ${e}`))
+  );
+}
+
+function clean() {
+  return promisifyStream(
+    gulp.src("**/*.sln")
+      .pipe(
+        msbuild({
+          toolsVersion: env.resolve("BUILD_TOOLSVERSION"),
+          targets: [ "Clean" ],
+          configuration: env.resolve("BUILD_CONFIGURATION"),
+          stdout: true,
+          logCommand: true,
+          errorOnFail: env.resolveFlag("BUILD_FAIL_ON_ERROR"),
+          solutionPlatform: env.resolve("BUILD_PLATFORM"),
+          architecture: env.resolve("BUILD_ARCHITECTURE"),
+          verbosity: env.resolve("BUILD_VERBOSITY"),
+          nodeReuse: env.resolveFlag("BUILD_MSBUILD_NODE_REUSE"),
+          maxcpucount: env.resolveNumber("BUILD_MAX_CPU_COUNT")
+        })
+      )
+  );
+}

package/gulp-tasks/modules/register-environment-variables.js

@@ -187,7 +187,7 @@ module.exports = function _env(env) {
   env.register({
     name: "BUILD_TARGETS",
     help: "Targets to invoke msbuild with",
-    default: "Clean,Build"
+    default: "Build"
   });
 
   env.register({
@@ -525,7 +525,7 @@ module.exports = function _env(env) {
   env.register({
     name: "BUILD_RETRIES",
     help: "Retry the build again up to this many times on failure (work around transient errors on build host)",
-    default: "1"
+    default: "0"
   });
 
   debug("-- env registration complete --");

package/gulp-tasks/modules/try-do.js

@@ -0,0 +1,51 @@
+"use strict";
+(function () {
+    const env = requireModule("env"), chalk = require("ansi-colors");
+    async function tryDo(logic, retries, onTransientError, onFinalFailure) {
+        // always attempt at least once
+        const requestedRetries = typeof retries === "string"
+            ? env.resolveNumber(retries)
+            : retries;
+        let totalAttempts = requestedRetries + 1;
+        if (totalAttempts < 0) {
+            totalAttempts = 1;
+        }
+        let retryCount = 0;
+        while (totalAttempts-- > 0) {
+            try {
+                await logic();
+            }
+            catch (e) {
+                if (totalAttempts > 0) {
+                    if (onTransientError) {
+                        onTransientError(e);
+                    }
+                    else {
+                        console.log(chalk.red(`Error: ${e.message || e.toString()}`));
+                    }
+                    console.log(chalk.green(`Retrying (${++retryCount} / ${retries})`));
+                }
+                else {
+                    if (retries < 1) {
+                        if (onFinalFailure) {
+                            await onFinalFailure();
+                        }
+                        else {
+                            console.log(chalk.magentaBright(`Failed after ${totalAttempts} attempts`));
+                            if (typeof retries === "string") {
+                                if (process.env[retries] === undefined) {
+                                    console.info(chalk.yellow(`If the error looks transient, try setting the '${retries}' environment variable.`));
+                                }
+                                else {
+                                    console.info(chalk.yellow(`If the error looks transient, try setting the '${retries}' environment variable to a larger value (currently: ${process.env[retries]})`));
+                                }
+                            }
+                        }
+                    }
+                    throw e;
+                }
+            }
+        }
+    }
+    module.exports = tryDo;
+})();

package/gulp-tasks/modules/try-do.ts

@@ -0,0 +1,56 @@
+(function() {
+  const
+    env = requireModule<Env>("env"),
+    chalk = require("ansi-colors");
+
+  async function tryDo(
+    logic: AsyncVoidVoid,
+    retries: number | string,
+    onTransientError: ErrorReporter,
+    onFinalFailure: VoidVoid
+  ): Promise<void> {
+    // always attempt at least once
+    const requestedRetries = typeof retries === "string"
+      ? env.resolveNumber(retries)
+      : retries;
+    let totalAttempts = requestedRetries + 1;
+    if (totalAttempts < 0) {
+      totalAttempts = 1;
+    }
+
+    let retryCount = 0;
+
+    while (totalAttempts-- > 0) {
+      try {
+        await logic();
+      } catch (e) {
+        if (totalAttempts > 0) {
+          if (onTransientError) {
+            onTransientError(e)
+          } else {
+            console.log(chalk.red(`Error: ${ e.message || e.toString() }`));
+          }
+          console.log(chalk.green(`Retrying (${ ++retryCount } / ${ retries })`));
+        } else {
+          if (retries < 1) {
+            if (onFinalFailure) {
+              await onFinalFailure()
+            } else {
+              console.log(chalk.magentaBright(`Failed after ${ totalAttempts } attempts`));
+              if (typeof retries === "string") {
+                if (process.env[retries] === undefined) {
+                  console.info(chalk.yellow(`If the error looks transient, try setting the '${retries}' environment variable.`));
+                } else {
+                  console.info(chalk.yellow(`If the error looks transient, try setting the '${retries}' environment variable to a larger value (currently: ${process.env[retries]})`));
+                }
+              }
+            }
+          }
+          throw e;
+        }
+      }
+    }
+  }
+
+  module.exports = tryDo;
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zarro",
-  "version": "1.99.5",
+  "version": "1.100.1",
   "description": "Some glue to make gulp easier, perhaps even zero- or close-to-zero-conf",
   "bin": {
     "zarro": "./index.js"