nw-builder 4.4.2 → 4.5.0

package/src/get.js

@@ -1,26 +1,48 @@
-import { spawnSync } from "node:child_process";
-import { createWriteStream, existsSync } from "node:fs";
-import { mkdir, readdir, rm, rmdir } from "node:fs/promises";
-import { get as getRequest } from "node:https";
-import { resolve } from "node:path";
-import { arch as ARCH, platform as PLATFORM, exit as EXIT } from "node:process";
+import child_process from "node:child_process";
+import console from "node:console";
+import fs from "node:fs";
+import fsm from "node:fs/promises";
+import https from "node:https";
+import path from "node:path";
 
 import progress from "cli-progress";
-import compressing from "compressing";
+import tar from "tar";
+import unzipper from "unzipper";
 
-import { log } from "./log.js";
-import { ARCH_KV, PLATFORM_KV, replaceFfmpeg } from "./util.js";
+import util from "./util.js";
+
+/**
+ * @typedef {object} GetOptions
+ * @property {string | "latest" | "stable" | "lts"} [options.version = "latest"]                  Runtime version
+ * @property {"normal" | "sdk"}                     [options.flavor = "normal"]                   Build flavor
+ * @property {"linux" | "osx" | "win"}              [options.platform]                            Target platform
+ * @property {"ia32" | "x64" | "arm64"}             [options.arch]                                Target arch
+ * @property {string}                               [options.downloadUrl = "https://dl.nwjs.io"]  Download server
+ * @property {string}                               [options.cacheDir = "./cache"]                Cache directory
+ * @property {boolean}                              [options.cache = true]                        If false, remove cache and redownload.
+ * @property {boolean}                              [options.ffmpeg = false]                      If true, ffmpeg is not downloaded.
+ * @property {false | "gyp"}                        [options.nativeAddon = false]                 Rebuild native modules
+ */
 
 /**
- * _Note: This an internal function which is not called directly. Please see example usage below._
- *
  * Get binaries.
+ * 
+ * @async
+ * @function
+ * @param  {GetOptions}    options                  Get mode options
+ * @returns {Promise<void>}
  *
  * @example
  * // Minimal Usage (uses default values)
  * nwbuild({
  *   mode: "get",
  * });
+ * 
+ * // Use with nw module
+ * nwbuild({
+ *   mode: "get",
+ *   cacheDir: "./node_modules/nw" 
+ * });
  *
  * @example
  * // Unofficial macOS builds (upto v0.75.0)
@@ -54,293 +76,274 @@ import { ARCH_KV, PLATFORM_KV, replaceFfmpeg } from "./util.js";
  *   ffmpeg: true,
  * });
  *
- * @param  {object}                   options              Get mode options
- * @param  {string}                   options.version      NW.js runtime version. Defaults to "latest".
- * @param  {"normal" | "sdk"}         options.flavor       NW.js build flavor. Defaults to "normal".
- * @param  {"linux" | "osx" | "win"}  options.platform     Target platform. Defaults to host platform.
- * @param  {"ia32" | "x64" | "arm64"} options.arch         Target architecture. Defaults to host architecture.
- * @param  {string}                   options.downloadUrl  File server to download from. Defaults to "https://dl.nwjs.io". Set "https://npm.taobao.org/mirrors/nwjs" for China mirror or "https://cnpmjs.org/mirrors/nwjs/" for Singapore mirror.
- * @param  {string}                   options.cacheDir     Cache directory path. Defaults to "./cache"
- * @param  {boolean}                  options.cache        If false, remove cache before download. Defaults to true.
- * @param  {boolean}                  options.ffmpeg       If true, ffmpeg is not downloaded. Defaults to false.
- * @return {Promise<void>}
+ * @example
+ * // Node headers
+ * nwbuild({
+ *   mode: "get",
+ *   nativeAddon: "gyp",
+ * });
  */
-export async function get({
-  version = "latest",
-  flavor = "normal",
-  platform = PLATFORM_KV[PLATFORM],
-  arch = ARCH_KV[ARCH],
-  downloadUrl = "https://dl.nwjs.io",
-  cacheDir = "./cache",
-  cache = true,
-  ffmpeg = false,
-}) {
-  await get_nwjs({
-    version,
-    flavor,
-    platform,
-    arch,
-    downloadUrl,
-    cacheDir,
-    cache,
-  });
-  if (ffmpeg === true) {
-    await get_ffmpeg({
-      version,
-      flavor,
-      platform,
-      arch,
-      downloadUrl,
-      cacheDir,
-      cache,
-    });
+async function get(options) {
+  await getNwjs(options);
+  if (options.ffmpeg === true) {
+    await getFfmpeg(options);
+  }
+  if (options.nativeAddon === "gyp") {
+    await getNodeHeaders(options);
   }
 }
 
-/**
- * Note: This an internal function which is not called directly. Please see example usage below.
- *
- * Get NW.js binaries
- *
- * @param  {object}                   options              Get mode options
- * @param  {string}                   options.version      NW.js runtime version. Defaults to "latest".
- * @param  {"normal" | "sdk"}         options.flavor       NW.js build flavor. Defaults to "normal".
- * @param  {"linux" | "osx" | "win"}  options.platform     Target platform. Defaults to host platform.
- * @param  {"ia32" | "x64" | "arm64"} options.arch         Target architecture. Defaults to host architecture.
- * @param  {string}                   options.downloadUrl  File server to download from. Defaults to "https://dl.nwjs.io". Set "https://npm.taobao.org/mirrors/nwjs" for China mirror or "https://cnpmjs.org/mirrors/nwjs/" for Singapore mirror.
- * @param  {string}                   options.cacheDir     Cache directory path. Defaults to "./cache"
- * @param  {boolean}                  options.cache        If false, remove cache before download. Defaults to true.
- * @return {Promise<void>}
- */
-async function get_nwjs({
-  version = "latest",
-  flavor = "normal",
-  platform = PLATFORM_KV[PLATFORM],
-  arch = ARCH_KV[ARCH],
-  downloadUrl = "https://dl.nwjs.io",
-  cacheDir = "./cache",
-  cache = true,
-}) {
-  log.debug(`Start getting binaries`);
-  let nwCached = true;
-  const nwDir = resolve(
-    cacheDir,
-    `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
-  );
-  let out = undefined;
-  let url = undefined;
+const getNwjs = async (options) => {
   const bar = new progress.SingleBar({}, progress.Presets.rect);
-
-  // Set download url and destination.
-  if (
-    downloadUrl === "https://dl.nwjs.io" ||
-    downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
-    downloadUrl === "https://npmmirror.com/mirrors/nwjs"
-  ) {
-    url = `${downloadUrl}/v${version}/nwjs${
-      flavor === "sdk" ? "-sdk" : ""
-    }-v${version}-${platform}-${arch}.${
-      platform === "linux" ? "tar.gz" : "zip"
-    }`;
-    out = resolve(cacheDir, `nw.${platform === "linux" ? "tgz" : "zip"}`);
-  }
-
+  const out = path.resolve(
+    options.cacheDir,
+    `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}.${options.platform === "linux" ? "tar.gz" : "zip"
+    }`,
+  );
   // If options.cache is false, remove cache.
-  if (cache === false) {
-    log.debug(`Removing existing binaries`);
-    rmdir(nwDir, { recursive: true, force: true });
+  if (options.cache === false) {
+    await fsm.rm(out, {
+      recursive: true,
+      force: true,
+    });
   }
 
-  // Check if cache exists.
-  try {
-    await readdir(nwDir);
-    log.debug(`Found existing NW.js binaries`);
-  } catch (error) {
-    log.debug(`No existing binaries`);
-    nwCached = false;
+  if (fs.existsSync(out) === true) {
+    await fsm.rm(
+      path.resolve(
+        options.cacheDir,
+        `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`,
+      ),
+      { recursive: true, force: true },
+    );
+    if (options.platform === "linux") {
+      await tar.extract({
+        file: out,
+        C: options.cacheDir
+      });
+    } else {
+      fs.createReadStream(out)
+        .pipe(unzipper.Extract({ path: options.cacheDir }));
+    }
+    return;
   }
 
-  // If not cached, then download.
-  if (nwCached === false) {
-    log.debug(`Downloading binaries`);
-    await mkdir(nwDir, { recursive: true });
-
-    const stream = createWriteStream(out);
-    const request = new Promise((resolve, reject) => {
-      getRequest(url, (response) => {
-        log.debug(`Response from ${url}`);
-        // For GitHub releases and mirrors, we need to follow the redirect.
-        if (
-          downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
-          downloadUrl === "https://npmmirror.com/mirrors/nwjs"
-        ) {
-          url = response.headers.location;
-        }
-
-        getRequest(url, (response) => {
-          log.debug(`Response from ${url}`);
-          let chunks = 0;
-          bar.start(Number(response.headers["content-length"]), 0);
-          response.on("data", async (chunk) => {
-            chunks += chunk.length;
-            bar.increment();
-            bar.update(chunks);
-          });
-
-          response.on("error", (error) => {
-            reject(error);
-          });
-
-          response.on("end", () => {
-            log.debug(`Binary fully downloaded`);
-            bar.stop();
-            if (platform === "linux") {
-              compressing.tgz.uncompress(out, cacheDir).then(() => resolve());
-            } else if (platform === "osx") {
-              //TODO: compressing package does not restore symlinks on some macOS (eg: circleCI)
-              const exec = function (cmd) {
-                log.debug(cmd);
-                const result = spawnSync(cmd, {
-                  shell: true,
-                  stdio: "inherit",
-                });
-                if (result.status !== 0) {
-                  log.debug(`Command failed with status ${result.status}`);
-                  if (result.error) console.log(result.error);
-                  EXIT(1);
-                }
-                return resolve();
-              };
-              exec(`unzip -o "${out}" -d "${cacheDir}"`);
-            } else {
-              compressing.zip.uncompress(out, cacheDir).then(() => resolve());
-            }
-          });
-
-          response.pipe(stream);
+  const stream = fs.createWriteStream(out);
+  const request = new Promise((res, rej) => {
+    let url = "";
+
+    // Set download url and destination.
+    if (
+      options.downloadUrl === "https://dl.nwjs.io" ||
+      options.downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
+      options.downloadUrl === "https://npmmirror.com/mirrors/nwjs"
+    ) {
+      url = `${options.downloadUrl}/v${options.version}/nwjs${options.flavor === "sdk" ? "-sdk" : ""
+        }-v${options.version}-${options.platform}-${options.arch}.${options.platform === "linux" ? "tar.gz" : "zip"
+        }`;
+    }
+
+    https.get(url, (response) => {
+      // For GitHub releases and mirrors, we need to follow the redirect.
+      if (
+        options.downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
+        options.downloadUrl === "https://npmmirror.com/mirrors/nwjs"
+      ) {
+        url = response.headers.location;
+      }
+
+      https.get(url, (response) => {
+        let chunks = 0;
+        bar.start(Number(response.headers["content-length"]), 0);
+        response.on("data", (chunk) => {
+          chunks += chunk.length;
+          bar.increment();
+          bar.update(chunks);
         });
 
         response.on("error", (error) => {
-          reject(error);
+          rej(error);
         });
+
+        response.on("end", () => {
+          bar.stop();
+          res();
+        });
+
+        response.pipe(stream);
       });
-    });
 
-    // Remove compressed file after download and decompress.
-    return request.then(async () => {
-      log.debug(`Binary decompressed starting removal`);
+      response.on("error", (error) => {
+        rej(error);
+      });
+    });
+  });
 
-      await rm(
-        resolve(cacheDir, `nw.${platform === "linux" ? "tgz" : "zip"}`),
-        { recursive: true, force: true },
-      );
-      log.debug(`Binary zip removed`);
+  await request;
+  await fsm.rm(
+    path.resolve(
+      options.cacheDir,
+      `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`,
+    ),
+    { recursive: true, force: true },
+  );
+  if (options.platform === "linux") {
+    await tar.extract({
+      file: out,
+      C: options.cacheDir
     });
+  } else {
+    fs.createReadStream(out)
+      .pipe(unzipper.Extract({ path: options.cacheDir }));
   }
 }
 
-/**
- *
- * Note: This an internal function which is not called directly. Please see example usage below.
- *
- * Get FFmpeg binary.
- *
- * @param  {object}                   options           Get mode options
- * @param  {string}                   options.version   NW.js runtime version. Defaults to "latest".
- * @param  {"normal" | "sdk"}         options.flavor    NW.js build flavor. Defaults to "normal".
- * @param  {"linux" | "osx" | "win"}  options.platform  Target platform. Defaults to host platform.
- * @param  {"ia32" | "x64" | "arm64"} options.arch      Target architecture. Defaults to host architecture.
- * @param  {string}                   options.cacheDir  Cache directory path. Defaults to "./cache"
- * @param  {boolean}                  options.cache     If false, remove cache before download. Defaults to true.
- * @return {Promise<void>}
- */
-async function get_ffmpeg({
-  version = "latest",
-  flavor = "normal",
-  platform = PLATFORM_KV[PLATFORM],
-  arch = ARCH_KV[ARCH],
-  cacheDir = "./cache",
-  cache = true,
-}) {
-  log.debug(`Start getting binaries`);
-  const nwDir = resolve(
-    cacheDir,
-    `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
+
+const getFfmpeg = async (options) => {
+  const nwDir = path.resolve(
+    options.cacheDir,
+    `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`,
   );
   const bar = new progress.SingleBar({}, progress.Presets.rect);
 
   // If options.ffmpeg is true, then download ffmpeg.
-  const downloadUrl =
-    "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download";
-  let url = `${downloadUrl}/${version}/${version}-${platform}-${arch}.zip`;
-  const out = resolve(cacheDir, `ffmpeg-v${version}-${platform}-${arch}.zip`);
+  options.downloadUrl = "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download";
+  let url = `${options.downloadUrl}/${options.version}/${options.version}-${options.platform}-${options.arch}.zip`;
+  const out = path.resolve(options.cacheDir, `ffmpeg-v${options.version}-${options.platform}-${options.arch}.zip`);
 
   // If options.cache is false, remove cache.
-  if (cache === false) {
-    log.debug(`Removing existing binaries`);
-    await rm(out, {
+  if (options.cache === false) {
+    await fsm.rm(out, {
       recursive: true,
       force: true,
     });
-    log.debug(`FFMPEG zip cache removed`);
   }
 
   // Check if cache exists.
-  if (existsSync(out) === true) {
-    log.debug(`Found existing FFMPEG cache`);
-    await compressing.zip.uncompress(out, nwDir);
+  if (fs.existsSync(out) === true) {
+    fs.createReadStream(out)
+      .pipe(unzipper.Extract({ path: nwDir }));
     return;
   }
 
-  log.debug(`Downloading FFMPEG`);
-  const stream = createWriteStream(out);
-  const request = new Promise((resolve, reject) => {
-    getRequest(url, (response) => {
-      log.debug(`Response from ${url}`);
+  const stream = fs.createWriteStream(out);
+  const request = new Promise((res, rej) => {
+    https.get(url, (response) => {
       // For GitHub releases and mirrors, we need to follow the redirect.
       url = response.headers.location;
 
-      getRequest(url, (response) => {
-        log.debug(`Response from ${url}`);
+      https.get(url, (response) => {
         let chunks = 0;
         bar.start(Number(response.headers["content-length"]), 0);
-        response.on("data", async (chunk) => {
+        response.on("data", (chunk) => {
           chunks += chunk.length;
           bar.increment();
           bar.update(chunks);
         });
 
         response.on("error", (error) => {
-          reject(error);
+          rej(error);
         });
 
         response.on("end", () => {
-          log.debug(`FFMPEG fully downloaded`);
           bar.stop();
-          resolve();
+          res();
         });
 
         response.pipe(stream);
       });
 
       response.on("error", (error) => {
-        reject(error);
+        rej(error);
       });
     });
   });
 
   // Remove compressed file after download and decompress.
-  return request
-    .then(async () => await compressing.zip.uncompress(out, nwDir))
-    .then(async () => await replaceFfmpeg(platform, nwDir))
-    .then(async () => {
-      if (cache === false) {
-        log.debug(`Removing FFMPEG zip cache`);
-        await rm(out, {
-          recursive: true,
-          force: true,
-        });
-        log.debug(`FFMPEG zip cache removed`);
-      }
+  await request;
+  fs.createReadStream(out)
+    .pipe(unzipper.Extract({ path: nwDir }));
+  await util.replaceFfmpeg(options.platform, nwDir);
+}
+
+const getNodeHeaders = async (options) => {
+  const bar = new progress.SingleBar({}, progress.Presets.rect);
+  const out = path.resolve(
+    options.cacheDir,
+    `headers-v${options.version}-${options.platform}-${options.arch}.tar.gz`,
+  );
+
+  // If options.cache is false, remove cache.
+  if (options.cache === false) {
+    await fsm.rm(out, {
+      recursive: true,
+      force: true,
     });
+  }
+
+  if (fs.existsSync(out) === true) {
+    await tar.extract({
+      file: out,
+      C: options.cacheDir
+    });
+    await fsm.rm(path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`), {
+      recursive: true,
+      force: true,
+    });
+    await fsm.rename(
+      path.resolve(options.cacheDir, "node"),
+      path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`),
+    );
+
+    child_process.exec(
+      "patch " +
+      path.resolve(
+        options.cacheDir,
+        `node-v${options.version}-${options.platform}-${options.arch}`,
+        "common.gypi",
+      ) +
+      " " +
+      path.resolve("..", "..", "patches", "node_header.patch"),
+      (error) => {
+        console.error(error);
+      },
+    );
+  }
+
+  const stream = fs.createWriteStream(out);
+  const request = new Promise((res, rej) => {
+    const url = `${options.downloadUrl}/v${options.version}/nw-headers-v${options.version}.tar.gz`;
+    https.get(url, (response) => {
+      let chunks = 0;
+      bar.start(Number(response.headers["content-length"]), 0);
+      response.on("data", (chunk) => {
+        chunks += chunk.length;
+        bar.increment();
+        bar.update(chunks);
+      });
+
+      response.on("error", (error) => {
+        rej(error);
+      });
+
+      response.on("end", () => {
+        bar.stop();
+        res();
+      });
+
+      response.pipe(stream);
+    });
+  });
+
+  await request;
+  await tar.extract({
+    file: out,
+    C: options.cacheDir
+  });
+  await fsm.rename(
+    path.resolve(options.cacheDir, "node"),
+    path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`),
+  );
 }
+
+export default get;