feat(util): support local files for options.manifestUrl (#1494)

ayushmanchhabra · web-flow · commit 5d77ea197fae · 2026-01-03T14:32:12.000+05:30
Fixes: #1490
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -3,7 +3,7 @@ name: e2e
 on:
   pull_request:
     branches:
-    - main
+      - main
 
 permissions:
   contents: read
@@ -18,9 +18,9 @@ jobs:
     strategy:
       matrix:
         os:
-        - macos-15
-        - ubuntu-24.04
-        - windows-2025
+          - macos-15
+          - ubuntu-24.04
+          - windows-2025
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -36,8 +36,19 @@ jobs:
         run: npm ci
       - name: Check for linting errors
         run: npm run lint
-      - name: Run tests
+      - name: Run tests with coverage
         run: npm run test:cov
+        env:
+          CI: true
+      - name: Upload coverage artifact
+        if: always()
+        uses: actions/upload-artifact@v6.0.0
+        with:
+          name: coverage-${{ matrix.os }}
+          path: coverage
       - name: Report Coverage
         if: always()
-        uses:  davelosert/vitest-coverage-report-action@v2.9.0
+        uses: davelosert/vitest-coverage-report-action@v2.9.0
+        with:
+          name: Vitest Coverage (${{ matrix.os }})
+          json-summary-path: coverage/coverage-summary.json
diff --git a/README.md b/README.md
@@ -194,7 +194,7 @@ Options
 | platform | `"linux" \| "osx" \| "win"` | | Host platform |
 | arch | `"ia32" \| "x64" \| "arm64"` | | Host architecture |
 | downloadUrl | `"https://dl.nwjs.io" \| "https://npm.taobao.org/mirrors/nwjs" \| https://npmmirror.com/mirrors/nwjs \| "https://github.com/corwin-of-amber/nw.js/releases/"` | `"https://dl.nwjs.io"` | Download server. Supports file systems too (for example `file:///home/localghost/nwjs_mirror`) |
-| manifestUrl | `"https://nwjs.io/versions.json" \| "https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json"` | `"https://nwjs.io/versions.json"` | Versions manifest |
+| manifestUrl | `"https://nwjs.io/versions.json" \| "https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json"` | `"https://nwjs.io/versions.json"` | Versions manifest URI, gotten via https or local file |
 | cacheDir | `string` | `"./cache"` | Directory to cache NW binaries |
 | cache | `boolean` | `true`| If true the existing cache is used. Otherwise it removes and redownloads it. |
 | ffmpeg | `boolean` | `false`| If true the chromium ffmpeg is replaced by community version with proprietary codecs. |
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -77,7 +77,7 @@
     "yauzl-promise": "^4.0.0"
   },
   "volta": {
-    "node": "24.9.0",
-    "npm": "11.6.4"
+    "node": "25.2.1",
+    "npm": "11.7.0"
   }
 }
diff --git a/src/bld.js b/src/bld.js
@@ -89,7 +89,7 @@ import setOsxConfig from './bld/osx.js';
  * @property {"normal" | "sdk"}                     [flavor = "normal"]                         Build flavor
  * @property {"linux" | "osx" | "win"}              [platform]                                  Target platform
  * @property {"ia32" | "x64" | "arm64"}             [arch]                                      Target arch
- * @property {string}                               [manifestUrl = "https://nwjs.io/versions.json"]  Manifest URL
+ * @property {string}                               [manifestUrl = "https://nwjs.io/versions.json"] Versions manifest URI, https or file path
  * @property {string}                               [srcDir = "./src"]                          Source directory
  * @property {string}                               [cacheDir = "./cache"]                      Cache directory
  * @property {string}                               [outDir = "./out"]                          Out directory
diff --git a/src/cli.js b/src/cli.js
@@ -14,7 +14,7 @@ program
   .option('--platform <string>', 'NW.js supported platform', util.PLATFORM_KV[process.platform])
   .option('--arch <string>', 'NW.js supported architecture', util.ARCH_KV[process.arch])
   .option('--downloadUrl <string>', 'NW.js download server', 'https://dl.nwjs.io')
-  .option('--manifestUrl <string>', 'NW.js version info', 'https://nwjs.io/versions.json')
+  .option('--manifestUrl <string>', 'NW.js versions manifest URI', 'https://nwjs.io/versions.json')
   .option('--cacheDir <string>', 'Cache NW.js binaries', './cache')
   .option('--outDir <string>', 'NW.js build artifacts', './out')
   .option('--app <object>', 'Platform specific app metadata. Refer to docs for more info', {})
diff --git a/src/index.js b/src/index.js
@@ -16,7 +16,7 @@ import util from './util.js';
  * @property {"linux" | "osx" | "win"}             platform                                  Host platform
  * @property {"ia32" | "x64" | "arm64"}            arch                                      Host architecture
  * @property {"https://dl.nwjs.io" | string}       [downloadUrl="https://dl.nwjs.io"]        Download server
- * @property {"https://nwjs.io/versions.json" | string} [manifestUrl="https://nwjs.io/versions.json"]  Versions manifest
+ * @property {"https://nwjs.io/versions.json" | string} [manifestUrl="https://nwjs.io/versions.json"] Versions manifest URI, https or file path
  * @property {"./cache" | string}                  [cacheDir="./cache"]                      Directory to cache NW binaries
  * @property {"./" | string}                       [srcDir="./"]                             File paths to application code
  * @property {"./out" | string}                    [outDir="./out"]                          Directory to store build artifacts
diff --git a/src/util.js b/src/util.js
@@ -3,17 +3,23 @@ import fs from 'node:fs';
 import https from 'node:https';
 import path from 'node:path';
 import process from 'node:process';
+import url from 'node:url';
 
 import * as GlobModule from 'glob';
 
 /**
  * Get manifest (array of NW release metadata) from URL.
- * @param  {string}                      manifestUrl  Url to manifest
- * @returns {Promise<string>}              - Manifest object
+ * @param  {string}                      manifestUrl  Versions manifest URI, https or file path
+ * @returns {string} - Manifest object
  */
 function getManifest(manifestUrl) {
   let chunks = '';
 
+  if (manifestUrl.startsWith('file://')) {
+    const filePath = url.fileURLToPath(manifestUrl);
+    return fs.readFileSync(filePath, 'utf-8');
+  }
+
   return new Promise((resolve) => {
     const req = https.get(manifestUrl, (response) => {
       response.on('data', (chunk) => {
@@ -42,8 +48,8 @@ function getManifest(manifestUrl) {
  * @param  {string} platform     NW platform
  * @param  {string} arch         NW architecture
  * @param  {string} cacheDir     Directory to store NW binaries
- * @param  {string} manifestUrl  Url to manifest
- * @returns {object}              Version specific release info
+ * @param  {string} manifestUrl  Versions manifest URI, https or file path
+ * @returns {Promise<object>}    Version specific release info
  */
 async function getReleaseInfo(
   version,
@@ -343,8 +349,8 @@ export const validate = async (options, releaseInfo) => {
   if (typeof options.downloadUrl === 'string' && !options.downloadUrl.startsWith('http') && !options.downloadUrl.startsWith('file')) {
     throw new Error('Expected options.downloadUrl to be a string and starts with `http` or `file`.');
   }
-  if (typeof options.manifestUrl === 'string' && !options.manifestUrl.startsWith('http') && !options.manifestUrl.startsWith('file')) {
-    throw new Error('Expected options.manifestUrl to be a string and starts with `http` or `file`.');
+  if (typeof options.manifestUrl === 'string' && !options.manifestUrl.startsWith('https') && !options.manifestUrl.startsWith('file')) {
+    throw new Error('Expected options.manifestUrl to be a string and starts with `https` or `file`.');
   }
   if (typeof options.cacheDir !== 'string') {
     throw new Error('Expected options.cacheDir to be a string. Got ' + typeof options.cacheDir);
@@ -425,15 +431,15 @@ export const validate = async (options, releaseInfo) => {
   }
 
   if (typeof options.nativeAddon !== 'boolean') {
-      throw new Error('Expected options.nativeAddon to be a boolean. Got ' + typeof options.nativeAddon);
+    throw new Error('Expected options.nativeAddon to be a boolean. Got ' + typeof options.nativeAddon);
   }
 
   if (typeof options.zip !== 'boolean' &
-      options.zip !== 'zip' &&
-      options.zip !== 'tar' &&
-      options.zip !== 'tgz') {
-      throw new Error('Expected options.zip to be a boolean, `zip`, `tar` or `tgz`. Got ' + typeof options.zip);
-    }
+    options.zip !== 'zip' &&
+    options.zip !== 'tar' &&
+    options.zip !== 'tgz') {
+    throw new Error('Expected options.zip to be a boolean, `zip`, `tar` or `tgz`. Got ' + typeof options.zip);
+  }
 
   if (options.platform === 'linux') {
     if (options.app.name && typeof options.app.name !== 'string') {
@@ -664,4 +670,4 @@ function log(severity, logLevel, message) {
   return stdout;
 }
 
-export default { fileExists, getReleaseInfo, getPath, PLATFORM_KV, ARCH_KV, EXE_NAME, globFiles, getNodeManifest, parse, validate, log };
+export default { fileExists, getReleaseInfo, getManifest, getPath, PLATFORM_KV, ARCH_KV, EXE_NAME, globFiles, getNodeManifest, parse, validate, log };
diff --git a/tests/fixtures/util/getManifest_manifest.json b/tests/fixtures/util/getManifest_manifest.json
@@ -0,0 +1,28 @@
+{
+    "latest": "v0.106.1",
+    "stable": "v0.106.1",
+    "lts": "v0.14.7",
+    "versions": [
+        {
+            "version": "v0.106.1",
+            "date": "2025/12/26",
+            "files": [
+                "win-x64",
+                "win-ia32",
+                "win-arm64",
+                "linux-x64",
+                "linux-ia32",
+                "osx-x64",
+                "osx-arm64"
+            ],
+            "flavors": [
+                "normal",
+                "sdk"
+            ],
+            "components": {
+                "node": "25.2.1",
+                "chromium": "143.0.7499.170"
+            }
+        }
+    ]
+}
diff --git a/tests/specs/node.test.js b/tests/specs/node.test.js
@@ -20,6 +20,6 @@ describe('get/node', function () {
       '0.106.0',
       './tests/fixtures'
     );
-    expect(util.fileExists(nodeFile)).resolves.toBe(true);
+    await expect(util.fileExists(nodeFile)).resolves.toBe(true);
   });
 });
diff --git a/tests/specs/nw.test.js b/tests/specs/nw.test.js
@@ -18,12 +18,12 @@ describe('get/nw', function () {
   it('downloades a NW.js Linux tarball or Windows/MacOS zip', { timeout: Infinity }, async function () {
     nwFile = await nw(
       'https://dl.nwjs.io',
-      '0.83.0',
+      '0.106.0',
       'sdk',
       util.PLATFORM_KV[process.platform],
       util.ARCH_KV[process.arch],
       './tests/fixtures'
     );
-    expect(util.fileExists(nwFile)).resolves.toBe(true);
+    await expect(util.fileExists(nwFile)).resolves.toBe(true);
   });
 });
diff --git a/tests/specs/util.test.js b/tests/specs/util.test.js
@@ -73,3 +73,10 @@ describe('util/parse', function () {
     expect(newOptions.app.icon).toBe('.');
   });
 });
+
+describe('util/getManifest', function () {
+  it('parses local file correctly', async function () {
+    const localManifestFile = JSON.parse(await util.getManifest(`file:///${process.cwd()}/tests/fixtures/util/getManifest_manifest.json`));
+    expect(localManifestFile).toHaveProperty('latest', 'v0.106.1');
+  });
+});
diff --git a/vitest.config.js b/vitest.config.js
@@ -1,11 +1,12 @@
-import { defineConfig } from 'vitest/config'
+import { defineConfig } from 'vitest/config';
 
 export default defineConfig({
   test: {
     coverage: {
       provider: 'v8',
+      all: true,
+      include: ['src/**/*.js'],
       reporter: ['json', 'json-summary'],
-      reportOnFailure: true,
-    }
-  }
+    },
+  },
 });

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@`
`77`	`77`	`"yauzl-promise": "^4.0.0"`
`78`	`78`	`},`
`79`	`79`	`"volta": {`
`80`		`- "node": "24.9.0",`
`81`		`- "npm": "11.6.4"`
	`80`	`+ "node": "25.2.1",`
	`81`	`+ "npm": "11.7.0"`
`82`	`82`	`}`
`83`	`83`	`}`