fix: make error output in case of app-builder failure more clear

Author: develar

package.json

@@ -29,10 +29,10 @@
   "////": "All typings are added into root `package.json` to avoid duplication errors in the IDE compiler (several `node.d.ts` files).",
   "dependencies": {
     "7zip-bin": "~3.1.0",
-    "app-builder-bin": "1.3.1",
+    "app-builder-bin": "1.3.3",
     "archiver": "^2.1.1",
     "async-exit-hook": "^2.0.1",
-    "aws-sdk": "^2.192.0",
+    "aws-sdk": "^2.196.0",
     "bluebird-lst": "^1.0.5",
     "chalk": "^2.3.0",
     "chromium-pickle-js": "^0.2.0",
@@ -94,15 +94,15 @@
     "gitbook-plugin-edit-link": "^2.0.2",
     "gitbook-plugin-github": "^2.0.0",
     "gitbook-plugin-github-buttons": "^3.0.0",
-    "globby": "^7.1.1",
-    "jest-cli": "^22.2.2",
+    "globby": "^8.0.0",
+    "jest-cli": "^22.3.0",
     "jest-junit": "^3.6.0",
     "jsdoc-to-markdown": "^4.0.1",
     "path-sort": "^0.1.0",
     "ts-babel": "^4.1.8",
     "ts-jsdoc": "^3.0.0",
     "tslint": "^5.9.1",
-    "typescript": "2.7.0-rc",
+    "typescript": "2.7.2",
     "v8-compile-cache": "^1.1.2",
     "whitespace": "^2.1.0",
     "worker-farm": "^1.5.2"

packages/builder-util/package.json

@@ -11,7 +11,7 @@
     "out"
   ],
   "dependencies": {
-    "app-builder-bin": "1.3.1",
+    "app-builder-bin": "1.3.3",
     "temp-file": "^3.1.1",
     "fs-extra-p": "^4.5.0",
     "is-ci": "^1.1.0",

packages/builder-util/src/binDownload.ts

@@ -1,6 +1,4 @@
-import { path7za } from "7zip-bin"
-import { appBuilderPath } from "app-builder-bin"
-import { spawn } from "./util"
+import { executeAppBuilder } from "./util"
 
 const versionToPromise = new Map<string, Promise<string>>()
 
@@ -9,7 +7,7 @@ export function download(url: string, output: string, checksum?: string | null):
   if (checksum != null) {
     args.push("--sha512", checksum)
   }
-  return spawn(appBuilderPath, args)
+  return executeAppBuilder(args) as Promise<any>
 }
 
 export function getBinFromGithub(name: string, version: string, checksum: string): Promise<string> {
@@ -35,11 +33,5 @@ function doGetBin(name: string, url: string, checksum: string): Promise<string>
     args.push("--sha512", checksum)
   }
 
-  return spawn(appBuilderPath, args, {
-    env: {
-      ...process.env,
-      SZA_PATH: path7za,
-    },
-    stdio: ["ignore", "pipe", process.stdout]
-  })
+  return executeAppBuilder(args)
 }

packages/builder-util/src/util.ts

@@ -1,4 +1,5 @@
-import BluebirdPromise from "bluebird-lst"
+import { path7za } from "7zip-bin"
+import { appBuilderPath } from "app-builder-bin"
 import { safeStringifyJson } from "builder-util-runtime"
 import chalk from "chalk"
 import { ChildProcess, execFile, ExecFileOptions, spawn as _spawn, SpawnOptions } from "child_process"
@@ -83,7 +84,7 @@ export function exec(file: string, args?: Array<string> | null, options?: ExecFi
     log.debug(logFields, "executing")
   }
 
-  return new BluebirdPromise<string>((resolve, reject) => {
+  return new Promise<string>((resolve, reject) => {
     execFile(file, args, {
     ...options,
     maxBuffer: 10 * 1024 * 1024,
@@ -139,6 +140,22 @@ export interface ExtraSpawnOptions {
   isPipeInput?: boolean
 }
 
+function logSpawn(command: string, args: Array<string>, options: SpawnOptions) {
+  // use general debug.enabled to log spawn, because it doesn't produce a lot of output (the only line), but important in any case
+  if (!log.isDebugEnabled) {
+    return
+  }
+
+  const argsString = args.join(" ")
+  const logFields: any = {
+    command: command + " " + (command === "docker" ? argsString : removePassword(argsString)),
+  }
+  if (options != null && options.cwd != null) {
+    logFields.cwd = options.cwd
+  }
+  log.debug(logFields, "spawning")
+}
+
 export function doSpawn(command: string, args: Array<string>, options?: SpawnOptions, extraOptions?: ExtraSpawnOptions): ChildProcess {
   if (options == null) {
     options = {}
@@ -152,19 +169,7 @@ export function doSpawn(command: string, args: Array<string>, options?: SpawnOpt
     options.stdio = [extraOptions != null && extraOptions.isPipeInput ? "pipe" : "ignore", isDebugEnabled ? "inherit" : "pipe", isDebugEnabled ? "inherit" : "pipe"]
   }
 
-  // use general debug.enabled to log spawn, because it doesn't produce a lot of output (the only line), but important in any case
-  if (log.isDebugEnabled) {
-    const argsString = args.join(" ")
-    const logFields: any = {
-      command,
-      args: command === "docker" ? argsString : removePassword(argsString),
-    }
-    if (options != null && options.cwd != null) {
-      logFields.cwd = options.cwd
-    }
-    log.debug(logFields, "spawning")
-  }
-
+  logSpawn(command, args, options)
   try {
     return _spawn(command, args, options)
   }
@@ -176,7 +181,7 @@ export function doSpawn(command: string, args: Array<string>, options?: SpawnOpt
 export function spawnAndWrite(command: string, args: Array<string>, data: string, options?: SpawnOptions, isDebugEnabled: boolean = false) {
   const childProcess = doSpawn(command, args, options, {isPipeInput: true, isDebugEnabled})
   const timeout = setTimeout(() => childProcess.kill(), 4 * 60 * 1000)
-  return new BluebirdPromise<any>((resolve, reject) => {
+  return new Promise<any>((resolve, reject) => {
     handleProcess("close", childProcess, command, false, () => {
       try {
         clearTimeout(timeout)
@@ -198,7 +203,7 @@ export function spawnAndWrite(command: string, args: Array<string>, data: string
 }
 
 export function spawn(command: string, args?: Array<string> | null, options?: SpawnOptions, extraOptions?: ExtraSpawnOptions): Promise<any> {
-  return new BluebirdPromise<any>((resolve, reject) => {
+  return new Promise<any>((resolve, reject) => {
     const isCollectOutput = options != null && (options.stdio === "pipe" || (Array.isArray(options.stdio) && options.stdio.length === 3 && options.stdio[1] === "pipe"))
     handleProcess("close", doSpawn(command, args || [], options, extraOptions), command, isCollectOutput, resolve, reject)
   })
@@ -344,4 +349,17 @@ export class InvalidConfigurationError extends Error {
 
     (this as any).code = code
   }
-}
+}
+
+export function executeAppBuilder(args: Array<string>): Promise<string> {
+  return new Promise<string>((resolve, reject) => {
+    const command = appBuilderPath
+    handleProcess("close", doSpawn(command, args, {
+      env: {
+        ...process.env,
+        SZA_PATH: path7za,
+      },
+      stdio: ["ignore", "pipe", "inherit"]
+    }), command, true, resolve, reject)
+  })
+}

packages/electron-builder-lib/package.json

@@ -42,7 +42,7 @@
   "homepage": "https://github.com/electron-userland/electron-builder",
   "dependencies": {
     "7zip-bin": "~3.1.0",
-    "app-builder-bin": "1.3.1",
+    "app-builder-bin": "1.3.3",
     "async-exit-hook": "^2.0.1",
     "bluebird-lst": "^1.0.5",
     "chromium-pickle-js": "^0.2.0",

packages/electron-builder-lib/src/codeSign.ts

@@ -1,4 +1,3 @@
-import { appBuilderPath } from "app-builder-bin"
 import BluebirdPromise from "bluebird-lst"
 import { exec, InvalidConfigurationError, isEmptyOrSpaces, isEnvTrue, isMacOsSierra, isPullRequest, log, TmpDir } from "builder-util"
 import { copyFile, statOrNull, unlinkIfExists } from "builder-util/out/fs"
@@ -107,7 +106,7 @@ export async function downloadCertificate(urlOrBase64: string, tmpDir: TmpDir, c
     if (isUrl || urlOrBase64.length > 2048 || urlOrBase64.endsWith("=")) {
       const tempFile = await tmpDir.getTempFile({suffix: ".p12"})
       if (isUrl) {
-        await download(appBuilderPath, urlOrBase64, tempFile)
+        await download(urlOrBase64, tempFile)
       }
       else {
         await outputFile(tempFile, Buffer.from(urlOrBase64, "base64"))
@@ -263,7 +262,7 @@ async function getValidIdentities(keychain?: string | null): Promise<Array<strin
   if (result == null || keychain != null) {
     // https://github.com/electron-userland/electron-builder/issues/481
     // https://github.com/electron-userland/electron-builder/issues/535
-    result = BluebirdPromise.all<Array<string>>([
+    result = Promise.all<Array<string>>([
       exec("security", addKeychain(["find-identity", "-v"]))
         .then(it => it.trim().split("\n").filter(it => {
           for (const prefix of appleCertificatePrefixes) {
@@ -353,7 +352,7 @@ export function findIdentity(certType: CertType, qualifier?: string | null, keyc
       return _findIdentity(certType, null, keychain)
     }
     else {
-      return BluebirdPromise.resolve(null)
+      return Promise.resolve(null)
     }
   }
   else {

packages/electron-builder-lib/src/platformPackager.ts

@@ -1,6 +1,5 @@
-import { appBuilderPath } from "app-builder-bin"
 import BluebirdPromise from "bluebird-lst"
-import { Arch, asArray, AsyncTaskManager, debug, DebugLogger, exec, getArchSuffix, InvalidConfigurationError, isEmptyOrSpaces, log, deepAssign } from "builder-util"
+import { Arch, asArray, AsyncTaskManager, debug, DebugLogger, executeAppBuilder, getArchSuffix, InvalidConfigurationError, isEmptyOrSpaces, log, deepAssign } from "builder-util"
 import { PackageBuilder } from "builder-util/out/api"
 import { statOrNull, unlinkIfExists } from "builder-util/out/fs"
 import { orIfFileNotExist } from "builder-util/out/promise"
@@ -582,25 +581,18 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
 
   // convert if need, validate size (it is a reason why tool is called even if file has target extension (already specified as foo.icns for example))
   async resolveIcon(sources: Array<string>, outputFormat: IconFormat): Promise<Array<IconInfo>> {
-    const arg = [
+    const args = [
       "icon",
       "--format", outputFormat,
-      "--root", this.buildResourcesDir, "--root", this.projectDir,
+      "--root", this.buildResourcesDir,
+      "--root", this.projectDir,
+      "--out", path.resolve(this.projectDir, this.config.directories!!.output!!, `.icon-${outputFormat}`),
     ]
     for (const source of sources) {
-      arg.push("--input", source)
+      args.push("--input", source)
     }
 
-    const rawResult = await exec(appBuilderPath, arg, {
-      cwd: this.projectDir,
-      env: {
-        ...process.env,
-        // command creates temp dir amd cannot delete it automatically since result files located in and it is our responsibility remove it after use,
-        // so, we just set TMPDIR to tempDirManager.rootTempDir and tempDirManager in any case will delete rootTempDir on exit
-        TMPDIR: await this.info.tempDirManager.rootTempDir,
-      },
-    })
-
+    const rawResult = await executeAppBuilder(args)
     let result: IconConvertResult
     try {
       result = JSON.parse(rawResult)

packages/electron-builder-lib/src/targets/AppImageTarget.ts

@@ -1,7 +1,5 @@
-import { path7za } from "7zip-bin"
-import { appBuilderPath } from "app-builder-bin"
 import BluebirdPromise from "bluebird-lst"
-import { Arch, log, serializeToYaml, isEnvTrue, spawn } from "builder-util"
+import { Arch, serializeToYaml, executeAppBuilder } from "builder-util"
 import { UUID } from "builder-util-runtime"
 import { copyOrLinkFile, unlinkIfExists } from "builder-util/out/fs"
 import * as ejs from "ejs"
@@ -13,7 +11,6 @@ import { Target } from "../core"
 import { LinuxPackager } from "../linuxPackager"
 import { getAppUpdatePublishConfiguration } from "../publish/PublishManager"
 import { getTemplatePath } from "../util/pathManager"
-import { appendBlockmap } from "./differentialUpdateInfoBuilder"
 import { LinuxTargetHelper } from "./LinuxTargetHelper"
 import { createStageDir } from "./targetUtil"
 
@@ -83,25 +80,15 @@ export default class AppImageTarget extends Target {
     if (packager.compression === "maximum") {
       args.push("--compression", "xz")
     }
-    if (log.isDebugEnabled && !isEnvTrue(process.env.ELECTRON_BUILDER_REMOVE_STAGE_EVEN_IF_DEBUG)) {
-      args.push("--no-remove-stage")
-    }
-    await spawn(appBuilderPath, args, {
-      env: {
-        ...process.env,
-        SZA_PATH: path7za,
-      },
-    })
 
-    const updateInfo = await appendBlockmap(artifactPath)
     packager.info.dispatchArtifactCreated({
       file: artifactPath,
       safeArtifactName: packager.computeSafeArtifactName(artifactName, "AppImage", arch, false),
       target: this,
       arch,
       packager,
       isWriteUpdateInfo: true,
-      updateInfo,
+      updateInfo: JSON.parse(await executeAppBuilder(args)),
     })
   }
 

packages/electron-builder-lib/src/targets/differentialUpdateInfoBuilder.ts

@@ -1,5 +1,4 @@
-import { appBuilderPath } from "app-builder-bin"
-import { exec, log } from "builder-util"
+import { log, executeAppBuilder } from "builder-util"
 import { BlockMapDataHolder, PackageFileInfo } from "builder-util-runtime"
 import * as path from "path"
 import { Target } from "../core"
@@ -61,13 +60,13 @@ export function configureDifferentialAwareArchiveOptions(archiveOptions: Archive
 
 export async function appendBlockmap(file: string): Promise<BlockMapDataHolder> {
   log.info({file: log.filePath(file)}, "building embedded block map")
-  return JSON.parse(await exec(appBuilderPath, ["blockmap", "--input", file, "--compression", "deflate"]))
+  return JSON.parse(await executeAppBuilder(["blockmap", "--input", file, "--compression", "deflate"]))
 }
 
 export async function createBlockmap(file: string, target: Target, packager: PlatformPackager<any>, safeArtifactName: string | null): Promise<BlockMapDataHolder> {
   const blockMapFile = `${file}${BLOCK_MAP_FILE_SUFFIX}`
   log.info({blockMapFile: log.filePath(blockMapFile)}, "building block map")
-  const updateInfo: BlockMapDataHolder = JSON.parse(await exec(appBuilderPath, ["blockmap", "--input", file, "--output", blockMapFile]))
+  const updateInfo: BlockMapDataHolder = JSON.parse(await executeAppBuilder(["blockmap", "--input", file, "--output", blockMapFile]))
   packager.info.dispatchArtifactCreated({
     file: blockMapFile,
     safeArtifactName: safeArtifactName == null ? null : `${safeArtifactName}${BLOCK_MAP_FILE_SUFFIX}`,

packages/electron-builder-lib/src/targets/snap.ts

@@ -1,6 +1,4 @@
-import { path7za } from "7zip-bin"
-import { appBuilderPath } from "app-builder-bin"
-import { isEnvTrue, Arch, replaceDefault as _replaceDefault, serializeToYaml, spawn, toLinuxArchString, log } from "builder-util"
+import { Arch, replaceDefault as _replaceDefault, serializeToYaml, executeAppBuilder, toLinuxArchString } from "builder-util"
 import { outputFile } from "fs-extra-p"
 import * as path from "path"
 import { SnapOptions } from ".."
@@ -150,10 +148,6 @@ export default class SnapTarget extends Target {
 
     await outputFile(path.join(snapMetaDir, this.isUseTemplateApp ? "snap.yaml" : "snapcraft.yaml"), serializeToYaml(snap))
 
-    if (log.isDebugEnabled && !isEnvTrue(process.env.ELECTRON_BUILDER_REMOVE_STAGE_EVEN_IF_DEBUG)) {
-      args.push("--no-remove-stage")
-    }
-
     const hooksDir = await packager.getResource(options.hooks, "snap-hooks")
     if (hooksDir != null) {
       args.push("--hooks", hooksDir)
@@ -166,14 +160,7 @@ export default class SnapTarget extends Target {
         "--template-sha512", SNAP_TEMPLATE_SHA512,
       )
     }
-
-    await spawn(appBuilderPath, args, {
-      env: {
-        ...process.env,
-        SZA_PATH: path7za,
-      },
-      stdio: ["ignore", "inherit", "inherit"]
-    })
+    await executeAppBuilder(args)
     packager.dispatchArtifactCreated(artifactPath, this, arch)
   }
 }