feat: allow custom makensis and logging

packages/app-builder-lib/src/binDownload.ts

@@ -10,6 +10,11 @@ export function download(url: string, output: string, checksum?: string | null):
   return executeAppBuilder(args) as Promise<any>
 }
 
+export function getBinFromCustomLoc(name: string, version: string, binariesLocUrl: string, checksum: string): Promise<string> {
+  const dirName = `${name}-${version}`
+  return getBin(dirName, binariesLocUrl, checksum)
+}
+
 export function getBinFromUrl(name: string, version: string, checksum: string): Promise<string> {
   const dirName = `${name}-${version}`
   let url: string

packages/app-builder-lib/src/targets/nsis/NsisTarget.ts

@@ -23,7 +23,7 @@ import { addCustomMessageFileInclude, createAddLangsMacro, LangConfigurator } fr
 import { computeLicensePage } from "./nsisLicense"
 import { NsisOptions, PortableOptions } from "./nsisOptions"
 import { NsisScriptGenerator } from "./nsisScriptGenerator"
-import { AppPackageHelper, nsisTemplatesDir, NSIS_PATH, UninstallerReader } from "./nsisUtil"
+import { AppPackageHelper, nsisTemplatesDir, NSIS_PATH, UninstallerReader, NsisTargetOptions } from "./nsisUtil"
 
 const debug = _debug("electron-builder:nsis")
 
@@ -62,6 +62,8 @@ export class NsisTarget extends Target {
     if (deps != null && deps["electron-squirrel-startup"] != null) {
       log.warn('"electron-squirrel-startup" dependency is not required for NSIS')
     }
+
+    NsisTargetOptions.resolve(this.options)
   }
 
   build(appOutDir: string, arch: Arch) {
@@ -189,6 +191,9 @@ export class NsisTarget extends Target {
 
       APP_PACKAGE_NAME: appInfo.name,
     }
+    if (options.debugLogging) {
+      defines.ENABLE_LOGGING = null
+    }
     if (uninstallAppKey !== guid) {
       defines.UNINSTALL_REGISTRY_KEY_2 = `Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\${guid}`
     }

packages/app-builder-lib/src/targets/nsis/nsisOptions.ts

@@ -1,6 +1,28 @@
 import { TargetSpecificOptions } from "../../core"
 import { CommonWindowsInstallerConfiguration } from "../.."
 
+interface CustomNsisBinary {
+  /**
+   * @private
+   * @default https://github.com/electron-userland/electron-builder-binaries/releases/download
+   */
+
+  readonly url?: string | null
+
+  /**
+   * @private
+   * @default o+YZsXHp8LNihhuk7JsCDhdIgx0MKKK+1b3sGD+4zX5djZULe4/4QMcAsfQ+0r+a8FnwBt7BVBHkIkJHjKQ0sg==
+   */
+
+  readonly checksum?: string | null
+
+  /**
+   * @private
+   * @default 3.0.4.2
+   */
+
+  readonly version?: string | null
+}
 export interface CommonNsisOptions {
   /**
    * Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).
@@ -24,6 +46,19 @@ export interface CommonNsisOptions {
    * @default false
    */
   readonly useZip?: boolean
+
+  /**
+   * @private
+   */
+  readonly customNsisBinary?: CustomNsisBinary | null
+
+  /**
+   * Whether or not to enable NSIS logging for debugging
+   * Note: Requires a debug-enabled NSIS build
+   * https://github.com/electron-userland/electron-builder/issues/5119#issuecomment-811353612
+   * @private
+   */
+  readonly debugLogging?: boolean | null
 }
 
 export interface NsisOptions extends CommonNsisOptions, CommonWindowsInstallerConfiguration, TargetSpecificOptions {

packages/app-builder-lib/src/targets/nsis/nsisUtil.ts

@@ -1,22 +1,41 @@
 import { Arch, log } from "builder-util"
 import { PackageFileInfo } from "builder-util-runtime"
-import { getBinFromUrl } from "../../binDownload"
+import { getBinFromUrl, getBinFromCustomLoc } from "../../binDownload"
 import { copyFile } from "builder-util/out/fs"
 import * as path from "path"
 import { getTemplatePath } from "../../util/pathManager"
 import { NsisTarget } from "./NsisTarget"
 import * as fs from "fs/promises"
 import * as zlib from "zlib"
+import { NsisOptions } from "./nsisOptions"
 
 export const nsisTemplatesDir = getTemplatePath("nsis")
 
+export const NsisTargetOptions = (() => {
+  let _resolve: (options: NsisOptions) => any
+  const promise = new Promise<NsisOptions>(resolve => (_resolve = resolve))
+  return {
+    then: (callback: (options: NsisOptions) => any): Promise<string> => promise.then(callback),
+    resolve: (options: NsisOptions): any => _resolve(options),
+  }
+})()
+
 export const NSIS_PATH = () => {
   const custom = process.env.ELECTRON_BUILDER_NSIS_DIR
   if (custom != null && custom.length > 0) {
     return Promise.resolve(custom.trim())
   }
-  // noinspection SpellCheckingInspection
-  return getBinFromUrl("nsis", "3.0.4.1", "VKMiizYdmNdJOWpRGz4trl4lD++BvYP2irAXpMilheUP0pc93iKlWAoP843Vlraj8YG19CVn0j+dCo/hURz9+Q==")
+  return NsisTargetOptions.then((options: NsisOptions) => {
+    if (options.customNsisBinary) {
+      const { checksum, url, version } = options.customNsisBinary
+      if (checksum && url) {
+        const binaryVersion = version || checksum.substr(0, 8)
+        return getBinFromCustomLoc("nsis", binaryVersion, url, checksum)
+      }
+    }
+    // noinspection SpellCheckingInspection
+    return getBinFromUrl("nsis", "3.0.4.2", "o+YZsXHp8LNihhuk7JsCDhdIgx0MKKK+1b3sGD+4zX5djZULe4/4QMcAsfQ+0r+a8FnwBt7BVBHkIkJHjKQ0sg==")
+  })
 }
 
 export class AppPackageHelper {

packages/app-builder-lib/templates/nsis/common.nsh

@@ -10,6 +10,7 @@ SpaceTexts none
 FileBufSize 64
 Name "${PRODUCT_NAME}"
 
+!define ENABLE_LOGGING
 !define APP_EXECUTABLE_FILENAME "${PRODUCT_FILENAME}.exe"
 !define UNINSTALL_FILENAME "Uninstall ${PRODUCT_FILENAME}.exe"
 
@@ -99,3 +100,17 @@ Name "${PRODUCT_NAME}"
 
   ${StdUtils.ExecShellAsUser} $0 "$launchLink" "open" "$startAppArgs"
 !macroend
+
+!define LogSet "!insertmacro LogSetMacro"
+!macro LogSetMacro SETTING
+  !ifdef ENABLE_LOGGING
+    LogSet ${SETTING}
+  !endif
+!macroend
+
+!define LogText "!insertmacro LogTextMacro"
+!macro LogTextMacro INPUT_TEXT
+  !ifdef ENABLE_LOGGING
+    LogText ${INPUT_TEXT}
+  !endif
+!macroend

packages/app-builder-lib/templates/nsis/installer.nsi

@@ -40,6 +40,9 @@ Var oldMenuDirectory
 !endif
 
 Function .onInit
+  SetOutPath $INSTDIR
+  ${LogSet} on
+
   !ifmacrodef preInit
     !insertmacro preInit
   !endif

packages/app-builder-lib/templates/nsis/uninstaller.nsh

@@ -1,4 +1,7 @@
 Function un.onInit
+  SetOutPath $INSTDIR
+  ${LogSet} on
+
   !insertmacro check64BitAndSetRegView
 
   ${IfNot} ${Silent}

test/src/BuildTest.ts

@@ -367,11 +367,8 @@ test.ifDevOrLinuxCi(
         files: [
           // test ignore pattern for node_modules defined as file set filter
           {
-            filter: [
-              "!node_modules/napi-build-utils/napi-build-utils-1.0.0.tgz",
-              "!node_modules/node-abi/*"
-            ]
-          }
+            filter: ["!node_modules/napi-build-utils/napi-build-utils-1.0.0.tgz", "!node_modules/node-abi/*"],
+          },
         ],
       },
     },

test/src/ignoreTest.ts

@@ -114,7 +114,7 @@ test.ifDevOrLinuxCi(
       targets: Platform.LINUX.createTarget(DIR_TARGET),
       config: {
         asar: false,
-        includeSubNodeModules: false  //  defaults to false too
+        includeSubNodeModules: false, //  defaults to false too
       },
     },
     {
@@ -148,7 +148,7 @@ test.ifDevOrLinuxCi(
       targets: Platform.LINUX.createTarget(DIR_TARGET),
       config: {
         asar: false,
-        includeSubNodeModules: true
+        includeSubNodeModules: true,
       },
     },
     {
@@ -182,10 +182,7 @@ test.ifDevOrLinuxCi(
       targets: Platform.LINUX.createTarget(DIR_TARGET),
       config: {
         asar: false,
-        files: [
-          "**/*",
-          "*/submodule-1-test/node_modules/**",
-        ],
+        files: ["**/*", "*/submodule-1-test/node_modules/**"],
       },
     },
     {
@@ -205,7 +202,9 @@ test.ifDevOrLinuxCi(
       packed: context => {
         return Promise.all([
           assertThat(path.join(context.getResources(Platform.LINUX, archFromString(process.arch)), "app", "node_modules", "submodule-1-test", "node_modules")).isDirectory(),
-          assertThat(path.join(context.getResources(Platform.LINUX, archFromString(process.arch)), "app", "node_modules", "submodule-1-test", "node_modules", "package.json")).isFile(),
+          assertThat(
+            path.join(context.getResources(Platform.LINUX, archFromString(process.arch)), "app", "node_modules", "submodule-1-test", "node_modules", "package.json")
+          ).isFile(),
           assertThat(path.join(context.getResources(Platform.LINUX, archFromString(process.arch)), "app", "node_modules", "submodule-2-test", "node_modules")).doesNotExist(),
         ])
       },