fix: Asar: true failing on Windows for electron-builder 5.x

Closes #482

Author: develar

src/asarUtil.ts

@@ -0,0 +1,96 @@
+import { AsarFileInfo, listPackage, statFile, AsarOptions, AsarFileMetadata, createPackageFromFiles } from "asar"
+import { statOrNull } from "./util"
+import { Glob } from "glob"
+import { lstat, remove } from "fs-extra-p"
+import { Promise as BluebirdPromise } from "bluebird"
+import * as path from "path"
+
+//noinspection JSUnusedLocalSymbols
+const __awaiter = require("./awaiter")
+
+export async function createAsarArchive(src: string, resourcesPath: string, options: AsarOptions): Promise<any> {
+  // dot: true as in the asar by default by we use glob default - do not copy hidden files
+  let glob: Glob | null = null
+  const files = (await new BluebirdPromise<Array<string>>((resolve, reject) => {
+    glob = new Glob("**/*", {
+      cwd: src,
+    }, (error, matches) => {
+      if (error == null) {
+        resolve(matches)
+      }
+      else {
+        reject(error)
+      }
+    })
+  })).map(it => path.join(src, it))
+
+  const metadata: { [key: string]: AsarFileMetadata; } = {}
+
+  // https://github.com/electron-userland/electron-builder/issues/482#issuecomment-225100630
+  const stats = await BluebirdPromise.map(files, it => {
+    const systemIndependentPath = process.platform === "win32" ? it.replace(/\\/g, "/") : it
+    if (glob!.symlinks[systemIndependentPath]) {
+      // asar doesn't use stat for link
+      metadata[it] = {
+        type: "link",
+      }
+      return null
+    }
+
+    const cachedType = glob!.cache[systemIndependentPath]
+    if (cachedType == null || cachedType === "FILE") {
+      const stat = glob!.statCache[systemIndependentPath]
+      return stat == null ? lstat(it) : <any>stat
+    }
+    else {
+      // asar doesn't use stat for dir
+      metadata[it] = {
+        type: "directory",
+      }
+    }
+    return null
+  })
+
+  for (let i = 0, n = files.length; i < n; i++) {
+    const stat = stats[i]
+    if (stat != null) {
+      metadata[files[i]] = {
+        type: stat.isFile() ? "file" : (stat.isDirectory() ? "directory" : "link"),
+        stat: stat,
+      }
+    }
+  }
+
+  await BluebirdPromise.promisify(createPackageFromFiles)(src, path.join(resourcesPath, "app.asar"), files, metadata, options)
+  await remove(src)
+}
+
+export async function checkFileInPackage(asarFile: string, relativeFile: string) {
+  let stat: AsarFileInfo | null
+  try {
+    stat = statFile(asarFile, relativeFile)
+  }
+  catch (e) {
+    const fileStat = await statOrNull(asarFile)
+    if (fileStat == null) {
+      throw new Error(`File "${asarFile}" does not exist. Seems like a wrong configuration.`)
+    }
+
+    try {
+      listPackage(asarFile)
+    }
+    catch (e) {
+      throw new Error(`File "${asarFile}" is corrupted: ${e}`)
+    }
+
+    // asar throws error on access to undefined object (info.link)
+    stat = null
+  }
+
+  if (stat == null) {
+    throw new Error(`Application entry file "${relativeFile}" in the "${asarFile}" does not exist. Seems like a wrong configuration.`)
+  }
+  if (stat.size === 0) {
+    throw new Error(`Application entry file "${relativeFile}" in the "${asarFile}" is corrupted: size 0`)
+  }
+}

src/osxPackager.ts

@@ -62,6 +62,9 @@ export default class OsXPackager extends PlatformPackager<OsXBuildOptions> {
   private static async findIdentity(certType: CertType, name?: string | null): Promise<string | null> {
     let identity = process.env.CSC_NAME || name
     if (isEmptyOrSpaces(identity)) {
+      if (process.env.CSC_IDENTITY_AUTO_DISCOVERY === "false") {
+        return null
+      }
       return await findIdentity(certType)
     }
     else {

src/platformPackager.ts

@@ -4,13 +4,13 @@ import EventEmitter = NodeJS.EventEmitter
 import { Promise as BluebirdPromise } from "bluebird"
 import * as path from "path"
 import { pack, ElectronPackagerOptions, userIgnoreFilter } from "electron-packager-tf"
-import { readdir, copy, unlink, lstat, remove, realpath } from "fs-extra-p"
+import { readdir, copy, unlink, remove, realpath } from "fs-extra-p"
 import { statOrNull, use, warn, log, exec } from "./util"
 import { Packager } from "./packager"
-import { listPackage, statFile, AsarFileMetadata, createPackageFromFiles, AsarOptions } from "asar"
+import { AsarOptions } from "asar"
 import { archiveApp } from "./targets/archive"
-import { Glob } from "glob"
 import { Minimatch } from "minimatch"
+import { checkFileInPackage, createAsarArchive } from "./asarUtil"
 import deepAssign = require("deep-assign")
 
 //noinspection JSUnusedLocalSymbols
@@ -200,7 +200,7 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
       }
 
       if (asarOptions != null) {
-        await this.createAsarArchive(appPath, resourcesPath, asarOptions)
+        await createAsarArchive(appPath, resourcesPath, asarOptions)
       }
     }
     await pack(options)
@@ -289,58 +289,6 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     }
   }
 
-  private async createAsarArchive(src: string, resourcesPath: string, options: AsarOptions): Promise<any> {
-    // dot: true as in the asar by default by we use glob default - do not copy hidden files
-    let glob: Glob | null = null
-    const files = (await new BluebirdPromise<Array<string>>((resolve, reject) => {
-      glob = new Glob("**/*", {
-        cwd: src,
-      }, (error, matches) => {
-        if (error == null) {
-          resolve(matches)
-        }
-        else {
-          reject(error)
-        }
-      })
-    })).map(it => path.join(src, it))
-
-    const metadata: { [key: string]: AsarFileMetadata; } = {}
-
-    const stats = await BluebirdPromise.map(files, it => {
-      if (glob!.symlinks[it]) {
-        // asar doesn't use stat for link
-        metadata[it] = {
-          type: "link",
-        }
-      }
-      else if (glob!.cache[it] === "FILE") {
-        const stat = glob!.statCache[it]
-        return stat == null ? lstat(it) : <any>stat
-      }
-      else {
-        // asar doesn't use stat for dir
-        metadata[it] = {
-          type: "directory",
-        }
-      }
-      return null
-    })
-
-    for (let i = 0, n = files.length; i < n; i++) {
-      const stat = stats[i]
-      if (stat != null) {
-        metadata[files[i]] = {
-          type: "file",
-          stat: stat,
-        }
-      }
-    }
-
-    await BluebirdPromise.promisify(createPackageFromFiles)(src, path.join(resourcesPath, "app.asar"), files, metadata, options)
-    await remove(src)
-  }
-
   private expandPattern(pattern: string, arch: Arch): string {
     return pattern
       .replace(/\$\{arch}/g, Arch[arch])
@@ -406,33 +354,19 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     return path.join(appOutDir, `${this.appName}.app`, "Contents", "Resources")
   }
 
-  private async statFileInPackage(resourcesDir: string, packageFile: string, isAsar: boolean): Promise<any> {
-    const relativeFile = path.relative(this.info.appDir, path.resolve(this.info.appDir, packageFile))
+  private async checkFileInPackage(resourcesDir: string, file: string, isAsar: boolean) {
+    const relativeFile = path.relative(this.info.appDir, path.resolve(this.info.appDir, file))
     if (isAsar) {
-      try {
-        return statFile(path.join(resourcesDir, "app.asar"), relativeFile) != null
-      }
-      catch (e) {
-        const asarFile = path.join(resourcesDir, "app.asar")
-        const fileStat = await statOrNull(asarFile)
-        if (fileStat == null) {
-          throw new Error(`File "${asarFile}" does not exist. Seems like a wrong configuration.`)
-        }
-
-        try {
-          listPackage(asarFile)
-        }
-        catch (e) {
-          throw new Error(`File "${asarFile}" is corrupted: ${e}`)
-        }
-
-        // asar throws error on access to undefined object (info.link)
-        return false
-      }
+      await checkFileInPackage(path.join(resourcesDir, "app.asar"), relativeFile)
     }
     else {
       const outStat = await statOrNull(path.join(resourcesDir, "app", relativeFile))
-      return outStat != null && outStat.isFile()
+      if (outStat == null) {
+        throw new Error(`Application entry file "${relativeFile}" does not exist. Seems like a wrong configuration.`)
+      }
+      else if (!outStat.isFile()) {
+        throw new Error(`Application entry file "${relativeFile}" is not a file. Seems like a wrong configuration.`)
+      }
     }
   }
 
@@ -446,12 +380,8 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
       throw new Error(`Output directory "${appOutDir}" is not a directory. Seems like a wrong configuration.`)
     }
 
-    const resourcesDir = this.getResourcesDir(appOutDir)
     const mainFile = this.metadata.main || "index.js"
-    const mainFileExists = await this.statFileInPackage(resourcesDir, mainFile, isAsar)
-    if (!mainFileExists) {
-      throw new Error(`Application entry file ${mainFile} could not be found in package. Seems like a wrong configuration.`)
-    }
+    await this.checkFileInPackage(this.getResourcesDir(appOutDir), mainFile, isAsar)
   }
 
   protected async archiveApp(format: string, appOutDir: string, outFile: string): Promise<any> {

test/src/BuildTest.ts

@@ -94,7 +94,7 @@ test("invalid main in the app package.json", t => t.throws(assertPack("test-app"
   tempDirCreated: projectDir => modifyPackageJson(projectDir, data => {
     data.main = "main.js"
   }, true)
-}), "Application entry file main.js could not be found in package. Seems like a wrong configuration."))
+}), /Application entry file "main.js" in the /))
 
 test("invalid main in the app package.json (no asar)", t => t.throws(assertPack("test-app", allPlatforms(false), {
   tempDirCreated: projectDir => {
@@ -107,7 +107,7 @@ test("invalid main in the app package.json (no asar)", t => t.throws(assertPack(
       })
     ])
   }
-}), "Application entry file main.js could not be found in package. Seems like a wrong configuration."))
+}), `Application entry file "main.js" does not exist. Seems like a wrong configuration.`))
 
 test("main in the app package.json (no asar)", () => assertPack("test-app", allPlatforms(false), {
   tempDirCreated: projectDir => {

test/src/helpers/runTests.ts

@@ -155,6 +155,7 @@ function runTests(): BluebirdPromise<any> {
     env: Object.assign({}, process.env, {
       NODE_PATH: path.join(testNodeModules, "electron-builder"),
       SKIP_WIN: skipWin,
+      CSC_IDENTITY_AUTO_DISCOVERY: "false",
     }),
     shell: process.platform === "win32",
     stdio: "inherit"

tsconfig.json

@@ -57,6 +57,7 @@
     "node_modules/7zip-bin/index.d.ts",
     "node_modules/fs-extra-p/bluebird.d.ts",
     "node_modules/electron-osx-sign-tf/index.d.ts",
+    "src/asarUtil.ts",
     "src/awaiter.ts",
     "src/build-cli.ts",
     "src/builder.ts",

typings/asar.d.ts

@@ -1,7 +1,7 @@
 declare module "asar" {
   import { Stats } from "fs"
 
-  interface Info {
+  interface AsarFileInfo {
     offset: number
     size: number
   }
@@ -19,7 +19,7 @@ declare module "asar" {
   export function listPackage(archive: string): Array<string>
 
   // followLinks defaults to true
-  export function statFile(archive: string, filename: string, followLinks?: boolean): Info | null
+  export function statFile(archive: string, filename: string, followLinks?: boolean): AsarFileInfo | null
 
   export function createPackageFromFiles(src: string, dest: string, filenames: Array<string>, metadata: { [key: string]: AsarFileMetadata;}, options: AsarOptions, callback: (error?: Error) => void): void
 }