nw-builder 3.8.3-beta.1 → 3.8.4

package/.github/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [3.8.4] - 2022-09-20
+
+### Changed
+
+- Refactor download function
+
+## [3.8.3-beta.1]
+
+### Changed
+
+- Check for first instance of `package.json`
+
 ## [3.8.3] - 2022-08-26
 
 ### Changed

package/README.md

@@ -32,6 +32,10 @@ Using pnpm:
 pnpm add nw-builder
 ```
 
+## Usage
+
+Check out the the demo under `/test/demo` directory for examples of module usage. For CLI, type in `nwbuild --help` in your terminal.
+
 ## API Reference
 
 > Stay up to date via the [Changelog](https://github.com/nwjs-community/nw-builder/blob/master/.github/CHANGELOG.md).

package/bin/nwbuild.cjs

@@ -149,4 +149,4 @@ if (cli.mode === "build") {
   nw.build();
 } else {
   nw.run();
-}
+}

package/lib/index.cjs

@@ -1,3 +1,4 @@
+const { existsSync } = require("node:fs");
 var _ = require("lodash");
 var inherits = require("inherits");
 var EventEmitter = require("events").EventEmitter;
@@ -11,6 +12,7 @@ var spawn = require("child_process").spawn;
 var semver = require("semver");
 var platformOverrides = require("./platformOverrides.cjs");
 var deprecate = require("deprecate");
+const { install } = require("nw-install");
 
 const {
   checkCache,
@@ -23,20 +25,6 @@ const {
 var NwVersions = require("./versions.cjs");
 var Version = require("./Version.cjs");
 var Utils = require("./utils.cjs");
-var Downloader = require("./downloader.cjs");
-// var platforms = require("./platforms.cjs");
-
-var pkg = require("../package.json");
-
-(async () => {
-  let updateNotifier = undefined;
-  try {
-    updateNotifier = await import("update-notifier");
-    updateNotifier.default({ pkg }).notify();
-  } catch (e) {
-    console.error(e);
-  }
-})();
 
 // We inherit from EventEmitter for logging
 inherits(NwBuilder, EventEmitter);
@@ -325,74 +313,35 @@ NwBuilder.prototype.platformFilesForVersion = function () {
   return Promise.resolve();
 };
 
-NwBuilder.prototype.downloadNwjs = function () {
-  var self = this,
-    downloads = [];
-
-  this._forEachPlatform(function (name, platform) {
-    self.setPlatformCacheDirectory(
-      name,
-      platform,
-      self._version.version,
-      self._version.flavor,
-    );
-    platform.url = self._version.platforms[name + "-" + self._version.flavor];
-
-    // Ensure that there is a cache folder
-    if (self.options.forceDownload) {
-      fs.removeSync(platform.cache);
-    }
-
-    fs.mkdirpSync(platform.cache);
-    self.emit(
-      "log",
-      "Create cache folder in " +
-        path.resolve(
-          self.options.cacheDir,
-          self._version.version + "-" + self._version.flavor,
-        ),
-    );
-
+NwBuilder.prototype.downloadNwjs = async function () {
+  let options = this.options;
+  for await (let osName of options.platforms) {
+    let plat = osName.slice(0, osName.length - 2);
+    let arch =
+      osName.slice(osName.length - 2, osName.length) === "32" ? "ia32" : "x64";
+    this._platforms[osName].url =
+      this._version.platforms[osName + "-" + this._version.flavor];
+    this._platforms[
+      osName
+    ].cache = `${this.options.cacheDir}/${this.options.version}-${this.options.flavor}/${osName}/nwjs-${this.options.flavor}-v${this.options.version}-${plat}-${arch}`;
     if (
-      !self.isPlatformCached(
-        name,
-        platform,
-        self._version.version,
-        self._version.flavor,
-      )
+      options.forceDownload === true ||
+      existsSync(
+        `${this.options.cacheDir}/${this.options.version}-${this.options.flavor}/${osName}/nwjs-${this.options.flavor}-v${this.options.version}-${plat}-${arch}`,
+      ) === false
     ) {
-      downloads.push(
-        Downloader.downloadAndUnpack(platform.cache, platform.url).catch(
-          function (err) {
-            if (err.statusCode === 404) {
-              self.emit(
-                "log",
-                "ERROR: The version " +
-                  self._version.version +
-                  " (" +
-                  self._version.flavor +
-                  ") does not have a corresponding build posted at " +
-                  self.options.downloadUrl +
-                  ". Please choose a version from that list.",
-              );
-            } else {
-              self.emit("log", err.msg);
-            }
-
-            return Promise.reject("Unable to download NWjs.");
-          },
-        ),
+      await install(
+        this.options.version,
+        this.options.flavor,
+        plat,
+        arch,
+        "https://nwjs.io",
+        "https://dl.nwjs.io",
+        `${this.options.cacheDir}/${this.options.version}-${this.options.flavor}/${osName}`,
+        `nwjs-${this.options.flavor}-v${this.options.version}-${plat}-${arch}`,
       );
-      self.emit("log", "Downloading: " + platform.url);
-    } else {
-      self.emit("log", "Using cache for: " + name);
     }
-  });
-
-  return Promise.all(downloads).then(function (data) {
-    Downloader.clearProgressbar();
-    return data;
-  });
+  }
 };
 
 NwBuilder.prototype.buildGypModules = function () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "3.8.3-beta.1",
+  "version": "3.8.4",
   "description": "Build NW.js desktop applications for Mac, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -10,10 +10,6 @@
   "author": "Steffen Müller <steffen@mllrsohn.com>",
   "license": "MIT",
   "main": "./lib/index.cjs",
-  "exports": {
-    "import": "./src/api/nwbuild.js",
-    "require": "./lib/index.cjs"
-  },
   "type": "module",
   "homepage": "https://github.com/nwutils/nw-builder",
   "repository": {
@@ -25,14 +21,12 @@
     "lint": "eslint ./bin/**.cjs ./lib/**.cjs ./src/**.js",
     "test": "npm run test:unit && tape './test/*.cjs'",
     "test:unit": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-    "demo:cjs": "cd ./test/demo && npm run start:cjs",
-    "demo:esm": "cd ./test/demo && npm run start:esm",
+    "demo": "cd ./test/demo && npm run start",
     "demo:cli": "nwbuild ./** --mode=build --platforms=linux32, linux64 --version=0.67.1",
     "build": "esbuild src/index.js --bundle --minify --platform=node --outfile=./dist/index.cjs"
   },
   "devDependencies": {
     "decompress-zip": "^0.3.3",
-    "eol": "^0.9.1",
     "esbuild": "^0.15.2",
     "eslint": "^8.18.0",
     "eslint-config-tjw-jsdoc": "^1.0.3",
@@ -48,11 +42,10 @@
   "dependencies": {
     "archiver": "^5.3.1",
     "deprecate": "^1.1.1",
-    "extract-zip": "^2.0.1",
     "graceful-fs-extra": "^2.0.0",
-    "graceful-ncp": "^3.0.0",
     "inherits": "^2.0.4",
     "lodash": "^4.17.21",
+    "nw-install": "^0.3.3",
     "plist": "^3.0.5",
     "progress": "^2.0.3",
     "rcedit": "^3.0.1",
@@ -61,10 +54,8 @@
     "rimraf": "^3.0.2",
     "semver": "^7.3.7",
     "simple-glob": "^0.2.0",
-    "tar-fs": "^2.1.1",
     "temp": "^0.9.4",
     "thenify": "^3.3.1",
-    "update-notifier": "^6.0.2",
     "winresourcer": "^0.9.0",
     "yargs": "^17.5.1"
   },

package/test/demo/index.cjs

@@ -2,13 +2,15 @@ const NwBuilder = require("../../lib/index.cjs");
 
 const nw = new NwBuilder({
   files: "./**",
-  version: "0.67.1"
+  version: "0.67.1",
+  platforms: ["linux64"],
 });
 
-nw.run()
-.then((msg) => {
-  console.log(msg);
-})
-.catch((error) => {
-  console.log(error)
-});
+// Replace `build` with `run` to run the application instead
+nw.build()
+  .then((msg) => {
+    console.log(msg);
+  })
+  .catch((error) => {
+    console.log(error);
+  });

package/test/demo/package.json

@@ -5,8 +5,7 @@
   "main": "./index.html",
   "type": "module",
   "scripts": {
-    "start:cjs": "node ./index.cjs",
-    "start:esm": "node ./index.js"
+    "start": "node ./index.cjs"
   },
   "window": {
     "title": "NW.js Demo",

package/lib/downloader.cjs

@@ -1,176 +0,0 @@
-var request = require("request");
-var progress = require("progress");
-var fs = require("fs");
-var path = require("path");
-var zlib = require("zlib");
-var tar = require("tar-fs");
-var temp = require("temp");
-var ncp = require("graceful-ncp").ncp;
-var rimraf = require("rimraf");
-var extract = require("extract-zip");
-
-// Automatically track and cleanup files at exit
-temp.track();
-var isWin = /^win/.test(process.platform);
-
-// one progressbar for all downloads
-var bar;
-
-module.exports = {
-  clearProgressbar: function () {
-    bar && bar.terminate();
-    bar = null;
-  },
-  downloadAndUnpack: function (cachepath, url) {
-    var extension = path.extname(url),
-      self = this,
-      rq = request(url),
-      len,
-      stream;
-
-    function format(statusCode) {
-      return statusCode + ": " + require("http").STATUS_CODES[statusCode];
-    }
-
-    return new Promise(function (resolve, reject) {
-      rq.proxy = true;
-      rq.on("error", function (err) {
-        bar && bar.terminate();
-        reject(err);
-      });
-      rq.on("response", function (res) {
-        len = parseInt(res.headers["content-length"], 10);
-        if (res.statusCode !== 200) {
-          reject({
-            statusCode: res.statusCode,
-            msg: "Recieved status code " + format(res.statusCode),
-          });
-        } else if (len) {
-          if (!bar) {
-            bar = new progress("  downloading [:bar] :percent :etas", {
-              complete: "=",
-              incomplete: "-",
-              width: 20,
-              total: len,
-            });
-          } else {
-            bar.total += len;
-          }
-        }
-      });
-      rq.on("data", function (chunk) {
-        len && bar && bar.tick(chunk.length);
-      });
-
-      if (extension === ".zip") {
-        rq.on("response", function (res) {
-          if (res.statusCode !== 200) return;
-          stream = temp.createWriteStream();
-
-          stream.on("finish", function () {
-            self
-              .extractZip(stream.path, cachepath)
-              .then(self.stripRootFolder)
-              .then(function (files) {
-                resolve(files);
-              });
-          });
-
-          rq.pipe(stream);
-        });
-      } else if (extension === ".gz") {
-        rq.on("response", function (res) {
-          if (res.statusCode !== 200) return;
-          self
-            .extractTar(res, cachepath)
-            .then(self.stripRootFolder)
-            .then(function (files) {
-              resolve(files);
-            });
-        });
-      }
-    });
-  },
-  extractTar: function (tarstream, destination) {
-    var gunzip = zlib.createGunzip(),
-      files = [];
-
-    return new Promise(function (resolve, reject) {
-      tarstream
-        .pipe(gunzip)
-        .on("error", function (err) {
-          reject(err);
-        })
-        .pipe(
-          tar.extract(destination, {
-            umask: isWin ? false : 0,
-            map: function (header) {
-              files.push({ path: path.basename(header.name) });
-              return header;
-            },
-          }),
-        )
-        .on("finish", function () {
-          resolve({ files: files, destination: destination });
-        });
-    });
-  },
-  extractZip: function (zipfile, destination) {
-    var files = [];
-
-    var onEntry = function (entry) {
-      files.push({
-        mode: entry.externalFileAttributes >>> 16,
-        path: entry.fileName,
-      });
-    };
-
-    return new Promise(function (resolve, reject) {
-      extract(zipfile, { dir: destination, onEntry: onEntry })
-        .catch(reject)
-        .then(function () {
-          // Setup chmodSync to fix permissions
-          files.forEach(function (file) {
-            fs.chmodSync(path.join(destination, file.path), file.mode);
-          });
-          resolve({ files, destination });
-        });
-    });
-  },
-  stripRootFolder: function (extracted) {
-    var files = extracted.files,
-      destination = extracted.destination,
-      rootFiles = fs.readdirSync(destination),
-      fromDir = path.join(
-        destination,
-        rootFiles.length === 1 ? rootFiles[0] : "",
-      );
-
-    // strip out root folder if it exists
-    if (rootFiles.length === 1 && fs.statSync(fromDir).isDirectory()) {
-      // strip folder from files
-      for (var i = 0; i < files.length; i++) {
-        var file = files[i];
-        file.path = path.relative(rootFiles[0], file.path);
-        if (file.path === "") {
-          files.splice(i, 1);
-          i--;
-        }
-      }
-
-      return new Promise(function (resolve, reject) {
-        // move stripped folder to destination
-        ncp(fromDir, destination, function (err) {
-          if (err) {
-            return reject();
-          } else
-            rimraf(fromDir, function () {
-              resolve(files);
-            });
-        });
-      });
-    } else {
-      return Promise.resolve(files);
-    }
-  },
-};

package/src/api/nwbuild.js

@@ -1,7 +0,0 @@
-const nwbuild = () => {
-    console.log("test if esm import works");
-};
-
-export {
-    nwbuild,
-};

package/test/demo/index.js

@@ -1,5 +0,0 @@
-import { nwbuild } from "../../src/api/nwbuild.js";
-
-nwbuild();
-
-export {};

package/test/downloader.cjs

@@ -1,131 +0,0 @@
-var test = require("tape"),
-  nock = require("nock"),
-  temp = require("temp"),
-  path = require("path"),
-  fs = require("fs");
-
-temp.track();
-
-var downloader = require("../lib/downloader.cjs");
-var fixturesZip = "./test/fixtures/test.zip";
-var fixturesZipStrip = "./test/fixtures/test-strip.zip";
-var fixturesTar = "./test/fixtures/test.tar.gz";
-var isWindows = process.platform === "win32";
-
-test("downloadAndUnpack: zip", function (t) {
-  t.plan(isWindows ? 3 : 6);
-  nock("https://amazon.s3.nw.com")
-    .get("/test.zip")
-    .replyWithFile(200, fixturesZip);
-  temp.mkdir("tmpcache", function (err, dirPath) {
-    downloader
-      .downloadAndUnpack(dirPath, "https://amazon.s3.nw.com/test.zip")
-      .then(function (files) {
-        files.forEach(function (file) {
-          t.ok(
-            fs.existsSync(path.join(dirPath, file.path)),
-            file.path + " unpacked",
-          );
-        });
-
-        if (!isWindows) {
-          t.ok(
-            fs.statSync(path.join(dirPath, "file1")).mode.toString(8) == 100444,
-            "444 file permission",
-          );
-          t.ok(
-            fs.statSync(path.join(dirPath, "file2")).mode.toString(8) == 100666,
-            "666 file permission",
-          );
-          t.ok(
-            fs.statSync(path.join(dirPath, "file3")).mode.toString(8) == 100644,
-            "644 file permission",
-          ); // DOES NOT WORK ON WINDOWS
-        }
-      });
-  });
-});
-
-test("downloadAndUnpack: zip+strip", function (t) {
-  t.plan(isWindows ? 3 : 6);
-  nock("https://amazon.s3.nw.com")
-    .get("/test-strip.zip")
-    .replyWithFile(200, fixturesZipStrip);
-  temp.mkdir("tmpcache", function (err, dirPath) {
-    downloader
-      .downloadAndUnpack(dirPath, "https://amazon.s3.nw.com/test-strip.zip")
-      .then(function (files) {
-        files.forEach(function (file) {
-          t.ok(
-            fs.existsSync(path.join(dirPath, file.path)),
-            file.path + " unpacked",
-          );
-        });
-
-        if (!isWindows) {
-          t.ok(
-            fs.statSync(path.join(dirPath, "file1")).mode.toString(8) == 100444,
-            "444 file permission",
-          );
-          t.ok(
-            fs.statSync(path.join(dirPath, "file2")).mode.toString(8) == 100666,
-            "666 file permission",
-          );
-          t.ok(
-            fs.statSync(path.join(dirPath, "file3")).mode.toString(8) == 100644,
-            "644 file permission",
-          ); // DOES NOT WORK ON WINDOWS
-        }
-      });
-  });
-});
-
-test("downloadAndUnpack: tar", function (t) {
-  t.plan(isWindows ? 3 : 6);
-  nock("https://amazon.s3.nw.com")
-    .get("/test.tar.gz")
-    .replyWithFile(200, fixturesTar);
-  temp.mkdir("tmpcache", function (err, dirPath) {
-    downloader
-      .downloadAndUnpack(dirPath, "https://amazon.s3.nw.com/test.tar.gz")
-      .then(function (files) {
-        files.forEach(function (file) {
-          t.ok(
-            fs.existsSync(path.join(dirPath, file.path)),
-            file.path + " unpacked",
-          );
-        });
-
-        if (!isWindows) {
-          t.ok(
-            fs.statSync(path.join(dirPath, "file1")).mode.toString(8) == 100444,
-            "444 file permission",
-          ); // DOES NOT WORK ON WINDOWS
-          t.ok(
-            fs.statSync(path.join(dirPath, "file2")).mode.toString(8) == 100666,
-            "666 file permission",
-          );
-          t.ok(
-            fs.statSync(path.join(dirPath, "file3")).mode.toString(8) == 100644,
-            "644 file permission",
-          ); // DOES NOT WORK ON WINDOWS
-        }
-      });
-  });
-});
-
-test("Should throw an error if you try to download a file that is not available", function (t) {
-  t.plan(2);
-  nock("https://doesnot.com").get("/exist.zip").reply(404);
-  downloader
-    .downloadAndUnpack("/", "https://doesnot.com/exist.zip")
-    .catch(function (err) {
-      t.equal(err.statusCode, 404, err.msg);
-    });
-  nock("https://doesnot.com").get("/exist.tar").reply(404);
-  downloader
-    .downloadAndUnpack("/", "https://doesnot.com/exist.tar")
-    .catch(function (err) {
-      t.equal(err.statusCode, 404, err.msg);
-    });
-});