nw-builder 4.5.2 → 4.5.4

package/src/util.js

@@ -1,15 +1,19 @@
 import console from "node:console";
-import fsm from "node:fs/promises";
+import fs from "node:fs";
 import https from "node:https";
 import path from "node:path";
+import process from "node:process";
+import stream from "node:stream";
 
 import * as GlobModule from "glob";
+import semver from "semver";
+import yauzl from "yauzl-promise";
 
 /**
  * Get manifest (array of NW release metadata) from URL
  *
  * @param  {string}                       manifestUrl  Url to manifest
- * @return {Promise <object | undefined>}
+ * @returns {Promise<object | undefined>} - Manifest object
  */
 function getManifest(manifestUrl) {
   let chunks = undefined;
@@ -44,7 +48,7 @@ function getManifest(manifestUrl) {
  * @param  {string} arch         NW architecture
  * @param  {string} cacheDir     Directory to store NW binaries
  * @param  {string} manifestUrl  Url to manifest
- * @return {object}              Version specific release info
+ * @returns {object}              Version specific release info
  */
 async function getReleaseInfo(
   version,
@@ -64,10 +68,10 @@ async function getReleaseInfo(
   try {
     const data = await getManifest(manifestUrl);
     if (data !== undefined) {
-      await fsm.writeFile(manifestPath, data.slice(9));
+      await fs.promises.writeFile(manifestPath, data.slice(9));
     }
 
-    let manifest = JSON.parse(await fsm.readFile(manifestPath));
+    let manifest = JSON.parse(await fs.promises.readFile(manifestPath));
     if (version === "latest" || version === "stable" || version === "lts") {
       // Remove leading "v" from version string
       version = manifest[version].slice(1);
@@ -120,7 +124,7 @@ const replaceFfmpeg = async (platform, nwDir) => {
   const src = path.resolve(nwDir, ffmpegFile);
   if (platform === "linux") {
     const dest = path.resolve(nwDir, "lib", ffmpegFile);
-    await fsm.copyFile(src, dest);
+    await fs.promises.copyFile(src, dest);
   } else if (platform === "win") {
     // don't do anything for windows because the extracted file is already in the correct path
     // await copyFile(src, path.resolve(nwDir, ffmpegFile));
@@ -137,7 +141,7 @@ const replaceFfmpeg = async (platform, nwDir) => {
     );
 
     try {
-      await fsm.copyFile(src, dest);
+      await fs.promises.copyFile(src, dest);
     } catch (e) {
       //some versions of node/macOS complain about destination being a file, and others complain when it is only a directory.
       //the only thing I can think to do is to try both
@@ -150,11 +154,23 @@ const replaceFfmpeg = async (platform, nwDir) => {
         "Versions",
         "Current",
       );
-      await fsm.copyFile(src, dest);
+      await fs.promises.copyFile(src, dest);
     }
   }
 };
 
+/**
+ * Glob files
+ * 
+ * @async
+ * @function
+ * 
+ * @param {object} options - glob file options
+ * @param {string | string[]} options.srcDir - app src dir
+ * @param {boolean} options.glob - glob flag
+ * @returns {Promise<string[]>} - Returns array of file paths
+ 
+ */
 async function globFiles({
   srcDir,
   glob,
@@ -173,27 +189,321 @@ async function globFiles({
   return files;
 }
 
+/**
+ * @async
+ * @function
+ * @param {object} options - node manifest options
+ * @param {string | string []} options.srcDir - src dir
+ * @param {boolean} options.glob - glob flag
+ * @returns {object} - Node manifest
+ */
 async function getNodeManifest({
   srcDir, glob
 }) {
   let manifest;
   let files;
   if (glob) {
-    files = await globFiles({srcDir, glob});
+    files = await globFiles({ srcDir, glob });
     for (const file of files) {
       if (path.basename(file) === "package.json" && manifest === undefined) {
-        manifest = JSON.parse(await fsm.readFile(file));
+        manifest = JSON.parse(await fs.promises.readFile(file));
       }
     }
   } else {
-    manifest = JSON.parse(await fsm.readFile(path.resolve(srcDir, "package.json")));
+    manifest = JSON.parse(await fs.promises.readFile(path.resolve(srcDir, "package.json")));
   }
 
   if (manifest === undefined) {
     throw new Error("package.json not found in srcDir file glob patterns.");
   }
-  
+
   return manifest;
 }
 
-export default { getReleaseInfo, PLATFORM_KV, ARCH_KV, EXE_NAME, replaceFfmpeg, globFiles, getNodeManifest };
+/**
+ * Parse options
+ *
+ * @param  {import("../../index.js").Options} options  Options
+ * @param  {object}                           pkg      Package.json as JSON
+ * @returns {Promise<object>}                          Options
+ */
+export const parse = async (options, pkg) => {
+  options = options ?? {};
+  options.mode = options.mode ?? "build";
+
+  options.version = options.version ?? "latest";
+  options.flavor = options.flavor ?? "normal";
+  options.platform = options.platform ?? PLATFORM_KV[process.platform];
+  options.arch = options.arch ?? ARCH_KV[process.arch];
+  options.downloadUrl = options.downloadUrl ?? "https://dl.nwjs.io";
+  options.manifestUrl = options.manifestUrl ?? "https://nwjs.io/versions";
+  options.cacheDir = options.cacheDir ?? "./cache";
+  options.cache = options.cache ?? true;
+  options.ffmpeg = options.ffmpeg ?? false;
+  options.logLevel = options.logLevel ?? "info";
+
+  if (options.mode === "get") {
+    return { ...options };
+  }
+
+  options.argv = options.argv ?? [];
+  options.glob = options.glob ?? true;
+  options.srcDir = options.srcDir ?? (options.glob ? "./*" : ".");
+
+  if (options.mode === "run") {
+    return { ...options };
+  }
+
+  options.outDir = path.resolve(options.outDir ?? "./out");
+  options.zip = options.zip ?? false;
+
+  options.managedManifest = options.managedManifest ?? false;
+  options.nativeAddon = options.nativeAddon ?? false;
+
+  options.app = options.app ?? {};
+  options.app.name = options.app.name ?? pkg.name;
+  options.app.icon = options.app.icon ?? undefined;
+
+  // TODO(#737): move this out
+  if (options.platform === "linux") {
+    // linux desktop entry file configurations options
+    options.app.genericName = options.app.genericName ?? undefined;
+    options.app.noDisplay = options.app.noDisplay ?? undefined;
+    options.app.comment = options.app.comment ?? undefined;
+    options.app.hidden = options.app.hidden ?? undefined;
+    options.app.onlyShowIn = options.app.onlyShowIn ?? undefined;
+    options.app.notShowIn = options.app.notShowIn ?? undefined;
+    options.app.dBusActivatable = options.app.dBusActivatable ?? undefined;
+    options.app.tryExec = options.app.tryExec ?? undefined;
+    options.app.exec = options.app.name ?? undefined;
+    options.app.path = options.app.path ?? undefined;
+    options.app.terminal = options.app.terminal ?? undefined;
+    options.app.actions = options.app.actions ?? undefined;
+    options.app.mimeType = options.app.mimeType ?? undefined;
+    options.app.categories = options.app.categories ?? undefined;
+    options.app.implements = options.app.implements ?? undefined;
+    options.app.keywords = options.app.keywords ?? undefined;
+    options.app.startupNotify = options.app.startupNotify ?? undefined;
+    options.app.startupWMClass = options.app.startupWMClass ?? undefined;
+    options.app.prefersNonDefaultGPU =
+      options.app.prefersNonDefaultGPU ?? undefined;
+    options.app.singleMainWindow = options.app.singleMainWindow ?? undefined;
+  }
+  if (options.platform === "win") {
+    // windows configuration options
+    options.app.version = options.app.version ?? pkg.version;
+    options.app.comments = options.app.comments ?? undefined;
+    options.app.company = options.app.company ?? pkg.author;
+    options.app.fileDescription =
+      options.app.fileDescription ?? pkg.description;
+    options.app.fileVersion = options.app.fileVersion ?? pkg.version;
+    options.app.internalName = options.app.internalName ?? pkg.name;
+    options.app.legalCopyright = options.app.legalCopyright ?? undefined;
+    options.app.legalTrademark = options.app.legalTrademark ?? undefined;
+    options.app.originalFilename = options.app.originalFilename ?? pkg.name;
+    options.app.privateBuild = options.app.privateBuild ?? undefined;
+    options.app.productName = options.app.productName ?? pkg.name;
+    options.app.productVersion = options.app.productVersion ?? pkg.version;
+    options.app.specialBuild = options.app.specialBuild ?? undefined;
+  }
+
+  if (options.platform === "osx") {
+    options.app.LSApplicationCategoryType =
+      options.app.LSApplicationCategoryType ?? undefined;
+    options.app.CFBundleIdentifier =
+      options.app.CFBundleIdentifier ?? options.app.name;
+    options.app.CFBundleName = options.app.CFBundleName ?? pkg.name;
+    options.app.CFBundleDisplayName =
+      options.app.CFBundleDisplayName ?? pkg.name;
+    options.app.CFBundleSpokenName = options.app.CFBundleSpokenName ?? pkg.name;
+    options.app.CFBundleShortVersionString =
+      options.app.CFBundleVersion ?? pkg.version;
+    options.app.CFBundleVersion =
+      options.app.CFBundleShortVersionString ?? pkg.version;
+    options.app.NSHumanReadableCopyright =
+      options.app.NSHumanReadableCopyright ?? undefined;
+  }
+
+  return { ...options };
+};
+
+/**
+ * Validate options
+ *
+ * @param  {import("../index.js").Options} options      Options
+ * @param  {object}                        releaseInfo  Version specific NW release info
+ * @returns {Promise<undefined>}                         Return undefined if options are valid
+ * @throws {Error}                                         Throw error if options are invalid
+ */
+export const validate = async (options, releaseInfo) => {
+  if (!["get", "run", "build"].includes(options.mode)) {
+    throw new Error(
+      `Unknown mode ${options.mode}. Expected "get", "run" or "build".`,
+    );
+  }
+  if (typeof releaseInfo === "undefined") {
+    throw new Error(
+      "Either the specific version info does not exist or the version manifest itself does not exist. In case of the latter, please check your internet connection and try again later.",
+    );
+  }
+  if (!releaseInfo.flavors.includes(options.flavor)) {
+    throw new Error(
+      `${options.flavor} flavor is not supported by this download server.`,
+    );
+  }
+  if (
+    options.platform &&
+    options.arch &&
+    !releaseInfo.files.includes(`${options.platform}-${options.arch}`)
+  ) {
+    throw new Error(
+      `Platform ${options.platform} and architecture ${options.arch} is not supported by this download server.`,
+    );
+  }
+  // if (typeof options.cacheDir !== "string") {
+  //   throw new Error("Expected options.cacheDir to be a string. Got " + typeof options.cacheDir);
+  // }
+  if (typeof options.cache !== "boolean") {
+    return new Error(
+      "Expected options.cache to be a boolean. Got " + typeof options.cache,
+    );
+  }
+  if (typeof options.ffmpeg !== "boolean") {
+    return new Error(
+      "Expected options.ffmpeg to be a boolean. Got " + typeof options.ffmpeg,
+    );
+  }
+
+  if (
+    options.logLevel !== "error" &&
+    options.logLevel !== "warn" &&
+    options.logLevel !== "info" &&
+    options.logLevel !== "debug"
+  ) {
+    throw new Error(
+      "Expected options.logLevel to be 'error', 'warn', 'info' or 'debug'. Got " +
+      options.logLevel,
+    );
+  }
+
+  if (options.mode === "get") {
+    return undefined;
+  }
+  if (Array.isArray(options.argv)) {
+    return new Error(
+      "Expected options.argv to be an array. Got " + typeof options.argv,
+    );
+  }
+  if (typeof options.glob !== "boolean") {
+    return new Error(
+      "Expected options.glob to be a boolean. Got " + typeof options.glob,
+    );
+  }
+
+  if (options.srcDir) {
+    await fs.promises.readdir(options.srcDir);
+  }
+
+  if (options.mode === "run") {
+    return undefined;
+  }
+
+  if (options.outDir) {
+    await fs.promises.readdir(options.outDir);
+  }
+
+  if (
+    typeof options.managedManifest !== "boolean" &&
+    typeof options.managedManifest !== "object" &&
+    typeof options.managedManifest !== "string"
+  ) {
+    return new Error(
+      "Expected options.managedManifest to be a boolean, object or string. Got " +
+      typeof options.managedManifest,
+    );
+  }
+
+  if (typeof options.managedManifest === "object") {
+    if (options.managedManifest.name === undefined) {
+      return new Error("Expected NW.js Manifest to have a `name` property.");
+    }
+    if (options.managedManifest.main === undefined) {
+      return new Error("Expected NW.js Manifest to have a `main` property.");
+    }
+  }
+
+  if (typeof options.nativeAddon !== "boolean") {
+    if (typeof options.nativeAddon !== "boolean" && typeof options.nativeAddon !== "string") {
+      return new Error("Expected options.nativeAddon to be a boolean or string type. Got " + typeof options.nativeAddon);
+    }
+
+    if (semver.parse(options.version).minor >= "83" && options.nativeAddon !== false) {
+      return new Error("Native addons are not supported for NW.js v0.82.0 and below");
+    }
+  }
+
+  // TODO: Validate app options
+  return undefined;
+};
+
+/**
+ * Get path to various NW specific file paths.
+ * 
+ * @async
+ * @function
+ * 
+ * @param {"chromedriver"} type - NW specific file or directory
+ * @param {object} options - nwbuild options
+ * @returns {string} - Path to chromedriver
+ * @throws {Error}
+ */
+async function getPath(type, options) {
+  if (type === "chromedriver") {
+    return path.resolve(
+      options.cacheDir,
+      `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform
+      }-${options.arch}`,
+      `chromedriver${options.platform === "win" ? ".exe" : ""}`,
+    );
+  } else {
+    throw new Error("Invalid type. Expected `chromedriver` but got ", type);
+  }
+}
+
+/**
+ * Wrapper for unzipping using `yauzl-promise`.
+ * 
+ * @async
+ * @function
+ * @param {string} nwZip - file path to .zip file
+ * @param {string} cacheDir - directory to unzip in
+ */
+async function unzip(nwZip, cacheDir) {
+  const zip = await yauzl.open(nwZip, {
+    supportMacArchive: false
+  });
+  try {
+    for await (const entry of zip) {
+      const fullEntryPath = path.resolve(cacheDir, entry.filename);
+
+      if (entry.filename.endsWith("/")) {
+        // Create directory
+        await fs.promises.mkdir(fullEntryPath, { recursive: true });
+      } else {
+        // Create the file's directory first, if it doesn't exist
+        const directory = path.dirname(fullEntryPath);
+        await fs.promises.mkdir(directory, { recursive: true });
+
+        const readStream = await entry.openReadStream();
+        const writeStream = fs.createWriteStream(fullEntryPath);
+        await stream.promises.pipeline(readStream, writeStream);
+      }
+    }
+  } catch (e) {
+    console.error(e);
+  } finally {
+    await zip.close();
+  }
+}
+
+export default { getReleaseInfo, getPath, PLATFORM_KV, ARCH_KV, EXE_NAME, replaceFfmpeg, globFiles, getNodeManifest, parse, unzip, validate };

package/patches/node_header.patch

@@ -1,4 +0,0 @@
-68c68
-<     'v8_host_byteorder': '<!(python -c "import sys; print sys.byteorder")',
----
->     'v8_host_byteorder': '<!(python3 -c "import sys; print(sys.byteorder)")',

package/src/util/parse.js

@@ -1,112 +0,0 @@
-import { resolve } from "node:path";
-import { arch, platform } from "node:process";
-
-import util from "../util.js";
-
-/**
- * Parse options
- *
- * @param  {import("../../index.js").Options} options  Options
- * @param  {object}                           pkg      Package.json as JSON
- * @return {Promise<object>}                           Options
- */
-export const parse = async (options, pkg) => {
-  options = options ?? {};
-  options.mode = options.mode ?? "build";
-
-  options.version = options.version ?? "latest";
-  options.flavor = options.flavor ?? "normal";
-  options.platform = options.platform ?? util.PLATFORM_KV[platform];
-  options.arch = options.arch ?? util.ARCH_KV[arch];
-  options.downloadUrl = options.downloadUrl ?? "https://dl.nwjs.io";
-  options.manifestUrl = options.manifestUrl ?? "https://nwjs.io/versions";
-  options.cacheDir = options.cacheDir ?? "./cache";
-  options.cache = options.cache ?? true;
-  options.ffmpeg = options.ffmpeg ?? false;
-  options.logLevel = options.logLevel ?? "info";
-
-  if (options.mode === "get") {
-    return { ...options };
-  }
-
-  options.argv = options.argv ?? [];
-  options.glob = options.glob ?? true;
-  options.srcDir = options.srcDir ?? (options.glob ? "./*" : ".");
-
-  if (options.mode === "run") {
-    return { ...options };
-  }
-
-  options.outDir = resolve(options.outDir ?? "./out");
-  options.zip = options.zip ?? false;
-
-  options.managedManifest = options.managedManifest ?? false;
-  // Node Native addons are disabled for now. See https://github.com/nwutils/nw-builder/pull/993
-  options.nativeAddon = false;
-
-  options.app = options.app ?? {};
-  options.app.name = options.app.name ?? pkg.name;
-  options.app.icon = options.app.icon ?? undefined;
-
-  // TODO(#737): move this out
-  if (options.platform === "linux") {
-    // linux desktop entry file configurations options
-    options.app.genericName = options.app.genericName ?? undefined;
-    options.app.noDisplay = options.app.noDisplay ?? undefined;
-    options.app.comment = options.app.comment ?? undefined;
-    options.app.hidden = options.app.hidden ?? undefined;
-    options.app.onlyShowIn = options.app.onlyShowIn ?? undefined;
-    options.app.notShowIn = options.app.notShowIn ?? undefined;
-    options.app.dBusActivatable = options.app.dBusActivatable ?? undefined;
-    options.app.tryExec = options.app.tryExec ?? undefined;
-    options.app.exec = options.app.name ?? undefined;
-    options.app.path = options.app.path ?? undefined;
-    options.app.terminal = options.app.terminal ?? undefined;
-    options.app.actions = options.app.actions ?? undefined;
-    options.app.mimeType = options.app.mimeType ?? undefined;
-    options.app.categories = options.app.categories ?? undefined;
-    options.app.implements = options.app.implements ?? undefined;
-    options.app.keywords = options.app.keywords ?? undefined;
-    options.app.startupNotify = options.app.startupNotify ?? undefined;
-    options.app.startupWMClass = options.app.startupWMClass ?? undefined;
-    options.app.prefersNonDefaultGPU =
-      options.app.prefersNonDefaultGPU ?? undefined;
-    options.app.singleMainWindow = options.app.singleMainWindow ?? undefined;
-  }
-  if (options.platform === "win") {
-    // windows configuration options
-    options.app.version = options.app.version ?? pkg.version;
-    options.app.comments = options.app.comments ?? undefined;
-    options.app.company = options.app.company ?? pkg.author;
-    options.app.fileDescription =
-      options.app.fileDescription ?? pkg.description;
-    options.app.fileVersion = options.app.fileVersion ?? pkg.version;
-    options.app.internalName = options.app.internalName ?? pkg.name;
-    options.app.legalCopyright = options.app.legalCopyright ?? undefined;
-    options.app.legalTrademark = options.app.legalTrademark ?? undefined;
-    options.app.originalFilename = options.app.originalFilename ?? pkg.name;
-    options.app.privateBuild = options.app.privateBuild ?? undefined;
-    options.app.productName = options.app.productName ?? pkg.name;
-    options.app.productVersion = options.app.productVersion ?? pkg.version;
-    options.app.specialBuild = options.app.specialBuild ?? undefined;
-  }
-
-  if (options.platform === "osx") {
-    options.app.LSApplicationCategoryType =
-      options.app.LSApplicationCategoryType ?? undefined;
-    options.app.CFBundleIdentifier =
-      options.app.CFBundleIdentifier ?? options.app.name;
-    options.app.CFBundleName = options.app.CFBundleName ?? pkg.name;
-    options.app.CFBundleDisplayName =
-      options.app.CFBundleDisplayName ?? pkg.name;
-    options.app.CFBundleSpokenName = options.app.CFBundleSpokenName ?? pkg.name;
-    options.app.CFBundleShortVersionString =
-      options.app.CFBundleVersion ?? pkg.version;
-    options.app.CFBundleVersion =
-      options.app.CFBundleShortVersionString ?? pkg.version;
-    options.app.NSHumanReadableCopyright =
-      options.app.NSHumanReadableCopyright ?? undefined;
-  }
-
-  return { ...options };
-};

package/src/util/validate.js

@@ -1,117 +0,0 @@
-import { readdir } from "node:fs/promises";
-
-/**
- * Validate options
- *
- * @param  {import("../index.js").Options} options      Options
- * @param  {object}                        releaseInfo  Version specific NW release info
- * @return {Promise<undefined>}                         Return undefined if options are valid
- * @throws {Error}                                         Throw error if options are invalid
- */
-export const validate = async (options, releaseInfo) => {
-  if (!["get", "run", "build"].includes(options.mode)) {
-    throw new Error(
-      `Unknown mode ${options.mode}. Expected "get", "run" or "build".`,
-    );
-  }
-  if (typeof releaseInfo === "undefined") {
-    throw new Error(
-      "Either the specific version info does not exist or the version manifest itself does not exist. In case of the latter, please check your internet connection and try again later.",
-    );
-  }
-  if (!releaseInfo.flavors.includes(options.flavor)) {
-    throw new Error(
-      `${options.flavor} flavor is not supported by this download server.`,
-    );
-  }
-  if (
-    options.platform &&
-    options.arch &&
-    !releaseInfo.files.includes(`${options.platform}-${options.arch}`)
-  ) {
-    throw new Error(
-      `Platform ${options.platform} and architecture ${options.arch} is not supported by this download server.`,
-    );
-  }
-  // if (typeof options.cacheDir !== "string") {
-  //   throw new Error("Expected options.cacheDir to be a string. Got " + typeof options.cacheDir);
-  // }
-  if (typeof options.cache !== "boolean") {
-    return new Error(
-      "Expected options.cache to be a boolean. Got " + typeof options.cache,
-    );
-  }
-  if (typeof options.ffmpeg !== "boolean") {
-    return new Error(
-      "Expected options.ffmpeg to be a boolean. Got " + typeof options.ffmpeg,
-    );
-  }
-
-  if (
-    options.logLevel !== "error" &&
-    options.logLevel !== "warn" &&
-    options.logLevel !== "info" &&
-    options.logLevel !== "debug"
-  ) {
-    throw new Error(
-      "Expected options.logLevel to be 'error', 'warn', 'info' or 'debug'. Got " +
-        options.logLevel,
-    );
-  }
-
-  if (options.mode === "get") {
-    return undefined;
-  }
-  if (Array.isArray(options.argv)) {
-    return new Error(
-      "Expected options.argv to be an array. Got " + typeof options.argv,
-    );
-  }
-  if (typeof options.glob !== "boolean") {
-    return new Error(
-      "Expected options.glob to be a boolean. Got " + typeof options.glob,
-    );
-  }
-
-  if (options.srcDir) {
-    await readdir(options.srcDir);
-  }
-
-  if (options.mode === "run") {
-    return undefined;
-  }
-
-  if (options.outDir) {
-    await readdir(options.outDir);
-  }
-
-  if (
-    typeof options.managedManifest !== "boolean" &&
-    typeof options.managedManifest !== "object" &&
-    typeof options.managedManifest !== "string"
-  ) {
-    return new Error(
-      "Expected options.managedManifest to be a boolean, object or string. Got " +
-        typeof options.managedManifest,
-    );
-  }
-
-  if (typeof options.managedManifest === "object") {
-    if (options.managedManifest.name === undefined) {
-      return new Error(
-        "Expected NW.js Manifest to be a boolean. Got " +
-          typeof options.nativeAddon,
-      );
-    }
-    if (options.managedManifest.main === undefined) {
-      return new Error("Expected NW.js Manifest to have a `main` property.");
-    }
-  }
-
-  if (typeof options.nativeAddon !== "boolean") {
-    return new Error("Expected options.nativeAddon to have a `name` property.");
-  }
-
-  // TODO: Validate app options
-  return undefined;
-};