qunitx-cli 0.10.0 → 0.15.0

package/README.md

@@ -188,6 +188,13 @@ All CLI flags can also be set in `package.json` under the `qunitx` key, so you d
 
 CLI flags always override `package.json` values when both are present.
 
+### Environment variables
+
+| Variable         | Description                                                                                                   |
+|------------------|---------------------------------------------------------------------------------------------------------------|
+| `CHROME_BIN`     | Path to the Chrome/Chromium executable. Required on systems where Chrome is not on `PATH` (e.g. many CI environments). Set automatically when using `browser-actions/setup-chrome` in GitHub Actions. |
+| `QUNITX_BROWSER` | Browser engine to use (`chromium`, `firefox`, `webkit`). Equivalent to `--browser` on the CLI. Useful in CI matrix jobs. |
+
 If you do not provide any HTML template, qunitx falls back to its built-in `test/tests.html` boilerplate internally, so `qunitx init` is optional.
 
 You can also pass a custom HTML file on the CLI:

package/dist/cli.js

@@ -129,7 +129,13 @@ var init_early_chrome = __esm({
     openWatchMode = openFromArgv && watchFromArgv;
     earlyChromeProcRef = null;
     if (!openWatchMode) {
-      process.on("exit", () => earlyChromeProcRef?.kill());
+      process.on("exit", () => {
+        if (!earlyChromeProcRef) return;
+        try {
+          earlyChromeProcRef.kill("SIGKILL");
+        } catch {
+        }
+      });
     }
     perfLog("early-chrome.js: module evaluated");
     earlyBrowserPromise = isRunCommand && browserFromArgv === "chromium" ? findChrome().then((chromePath) => {
@@ -676,17 +682,38 @@ function setupWebServer(config, cachedContent) {
     socket.on("message", function message(data) {
       const { event, details, abort } = JSON.parse(data);
       if (event === "wsOpen") {
+        config._phase = "loading";
         config._onWsOpen?.();
       } else if (event === "connection") {
+        config._phase = "running";
         if (!config._groupMode) console.log("TAP version 13");
+        if (config.debug && config._groupMode) {
+          const allFiles = Object.keys(config.fsTree);
+          const relFiles = allFiles.map((f) => f.replace(`${config.projectRoot}/`, ""));
+          const shown = relFiles.slice(0, 2);
+          const rest = relFiles.length - shown.length;
+          const fileList = rest > 0 ? `${shown.join("  ")}  +${rest} more` : shown.join("  ");
+          console.log("#", blue(`\u2500\u2500 ${fileList} \u2500\u2500`));
+        }
         config._resetTestTimeout?.();
       } else if (event === "testEnd" && !abort) {
         if (details.status === "failed") {
           config.lastFailedTestFiles = config.lastRanTestFiles;
         }
+        if (config.debug && details.runtime > config.timeout * 0.8) {
+          console.log(
+            `# SLOW (${details.runtime.toFixed(0)}ms / ${config.timeout}ms timeout): ${details.fullName.join(" | ")}`
+          );
+        }
         config._resetTestTimeout?.();
         TAPDisplayTestResult(config.COUNTER, details);
       } else if (event === "done") {
+        config._phase = "done";
+        if (config.debug && config._groupMode) {
+          console.log(
+            `# group done: ${details.passed} passed, ${details.failed} failed (${details.runtime}ms)`
+          );
+        }
         if (typeof config._testRunDone === "function") {
           config._testRunDone();
           config._testRunDone = null;
@@ -695,10 +722,34 @@ function setupWebServer(config, cachedContent) {
     });
   });
   server.get("/tests.js", (_req, res) => {
+    const bytes = cachedContent.allTestCode?.length ?? null;
+    console.log(
+      `# [HTTPServer] GET /tests.js \u2192 ${bytes !== null ? `${bytes} bytes` : "NOT READY (allTestCode is null)"}`
+    );
+    if (bytes === null) {
+      res.writeHead(503, { "Content-Type": "application/javascript", "Cache-Control": "no-store" });
+      res.end(
+        'console.error("[qunitx] /tests.js requested before bundle was built \u2014 allTestCode is null");'
+      );
+      return;
+    }
+    config._onTestsJsServed?.();
     res.writeHead(200, { "Content-Type": "application/javascript", "Cache-Control": "no-store" });
     res.end(cachedContent.allTestCode);
   });
   server.get("/filtered-tests.js", (_req, res) => {
+    const bytes = cachedContent.filteredTestCode?.length ?? null;
+    console.log(
+      `# [HTTPServer] GET /filtered-tests.js \u2192 ${bytes !== null ? `${bytes} bytes` : "NOT READY (filteredTestCode is null)"}`
+    );
+    if (bytes === null) {
+      res.writeHead(503, { "Content-Type": "application/javascript", "Cache-Control": "no-store" });
+      res.end(
+        'console.error("[qunitx] /filtered-tests.js requested before bundle was built \u2014 filteredTestCode is null");'
+      );
+      return;
+    }
+    config._onTestsJsServed?.();
     res.writeHead(200, { "Content-Type": "application/javascript", "Cache-Control": "no-store" });
     res.end(cachedContent.filteredTestCode);
   });
@@ -936,6 +987,7 @@ var init_web_server = __esm({
     init_find_internal_assets_from_html();
     init_html_content_marker();
     init_display_test_result();
+    init_color();
     init_path_exists();
     init_http();
     fsPromise = fs7.promises;
@@ -1002,7 +1054,9 @@ async function setupBrowser(config, cachedContent, existingBrowser = null) {
     window.IS_PLAYWRIGHT = true;
   });
   page.on("console", async (msg) => {
-    if (!config.debug) return;
+    const type = msg.type();
+    const alwaysShow = type === "warning" || type === "error";
+    if (!alwaysShow && !config.debug) return;
     try {
       const values = await Promise.all(msg.args().map((arg) => arg.jsonValue()));
       console.log(...values);
@@ -1090,7 +1144,7 @@ async function runUserModule(modulePath, params, scriptPosition) {
     console.log("#", red(`QUnitX ${scriptPosition} script failed:`));
     console.trace(error);
     console.error(error);
-    return process.exit(1);
+    process.stdout.write("", () => process.exit(1));
   }
 }
 var init_run_user_module = __esm({
@@ -1121,23 +1175,31 @@ import esbuild from "esbuild";
 async function buildTestBundle(config, cachedContent) {
   const { projectRoot, output } = config;
   const allTestFilePaths = Object.keys(config.fsTree);
+  if (allTestFilePaths.length === 0) {
+    console.log("# [buildTestBundle] fsTree is empty \u2014 skipping build (no test files found)");
+    return;
+  }
+  const outfile = `${projectRoot}/${output}/tests.js`;
   await Promise.all([
-    esbuild.build({
-      stdin: {
-        contents: allTestFilePaths.map((f) => `import "${f}";`).join(""),
-        resolveDir: process.cwd()
+    buildWithOverlayfsRetry(
+      {
+        stdin: {
+          contents: allTestFilePaths.map((f) => `import "${f}";`).join(""),
+          resolveDir: process.cwd()
+        },
+        bundle: true,
+        logLevel: "error",
+        outfile,
+        keepNames: true,
+        sourcemap: config.debug ? "inline" : config.watch ? "linked" : false,
+        // Signal the runtime that all test modules are registered. The runtime's maybeStart()
+        // waits for both this event and the WebSocket 'open' event before calling QUnit.start().
+        // Dispatching from the bundle (rather than from a script onload attr) is reliable across
+        // all browsers and does not require changes to user test code.
+        footer: { js: 'window.dispatchEvent(new CustomEvent("qunitx:tests-ready"));' }
       },
-      bundle: true,
-      logLevel: "error",
-      outfile: `${projectRoot}/${output}/tests.js`,
-      keepNames: true,
-      sourcemap: config.debug ? "inline" : config.watch ? "linked" : false,
-      // Signal the runtime that all test modules are registered. The runtime's maybeStart()
-      // waits for both this event and the WebSocket 'open' event before calling QUnit.start().
-      // Dispatching from the bundle (rather than from a script onload attr) is reliable across
-      // all browsers and does not require changes to user test code.
-      footer: { js: 'window.dispatchEvent(new CustomEvent("qunitx:tests-ready"));' }
-    }),
+      outfile
+    ),
     Promise.all(
       cachedContent.htmlPathsToRunTests.map(async (htmlPath) => {
         const targetPath = `${config.projectRoot}/${config.output}${htmlPath}`;
@@ -1148,7 +1210,7 @@ async function buildTestBundle(config, cachedContent) {
       })
     )
   ]);
-  cachedContent.allTestCode = await fs8.readFile(`${projectRoot}/${output}/tests.js`);
+  cachedContent.allTestCode = await fs8.readFile(outfile);
 }
 async function runTestsInBrowser(config, cachedContent = {}, connections, targetTestFilesToFilter) {
   const { projectRoot, output } = config;
@@ -1162,6 +1224,9 @@ async function runTestsInBrowser(config, cachedContent = {}, connections, target
     if (!cachedContent.allTestCode) {
       await buildTestBundle(config, cachedContent);
     }
+    if (!cachedContent.allTestCode) {
+      return connections;
+    }
     if (runHasFilter) {
       const outputPath = `${projectRoot}/${output}/filtered-tests.js`;
       await buildFilteredTests(targetTestFilesToFilter, outputPath, config);
@@ -1204,17 +1269,42 @@ async function runTestsInBrowser(config, cachedContent = {}, connections, target
   return connections;
 }
 function buildFilteredTests(filteredTests, outputPath, config) {
-  return esbuild.build({
-    stdin: {
-      contents: filteredTests.map((f) => `import "${f}";`).join(""),
-      resolveDir: process.cwd()
+  return buildWithOverlayfsRetry(
+    {
+      stdin: {
+        contents: filteredTests.map((f) => `import "${f}";`).join(""),
+        resolveDir: process.cwd()
+      },
+      bundle: true,
+      logLevel: "error",
+      outfile: outputPath,
+      sourcemap: config.debug ? "inline" : config.watch ? "linked" : false,
+      footer: { js: 'window.dispatchEvent(new CustomEvent("qunitx:tests-ready"));' }
     },
-    bundle: true,
-    logLevel: "error",
-    outfile: outputPath,
-    sourcemap: config.debug ? "inline" : config.watch ? "linked" : false,
-    footer: { js: 'window.dispatchEvent(new CustomEvent("qunitx:tests-ready"));' }
-  });
+    outputPath
+  );
+}
+async function buildWithOverlayfsRetry(options, outfile) {
+  const RETRY_DELAY_MS = 100;
+  const MAX_RETRIES = 3;
+  const EMPTY_BUNDLE_THRESHOLD = 500;
+  let result = await esbuild.build(options);
+  for (let retry = 1; retry <= MAX_RETRIES; retry++) {
+    const bytes2 = (await fs8.stat(outfile)).size;
+    if (bytes2 >= EMPTY_BUNDLE_THRESHOLD) return result;
+    console.log(
+      `# [buildWithOverlayfsRetry] bundle is ${bytes2} bytes (< ${EMPTY_BUNDLE_THRESHOLD}) on attempt ${retry}/${MAX_RETRIES} \u2014 overlayfs flush race, retrying in ${RETRY_DELAY_MS}ms`
+    );
+    await new Promise((resolve) => setTimeout(resolve, RETRY_DELAY_MS));
+    result = await esbuild.build(options);
+  }
+  const bytes = (await fs8.stat(outfile)).size;
+  if (bytes < EMPTY_BUNDLE_THRESHOLD) {
+    console.log(
+      `# [buildWithOverlayfsRetry] bundle is ${bytes} bytes after ${MAX_RETRIES} retries \u2014 proceeding`
+    );
+  }
+  return result;
 }
 async function runTestInsideHTMLFile(filePath, { page, server, browser }, config) {
   let QUNIT_RESULT;
@@ -1233,6 +1323,10 @@ async function runTestInsideHTMLFile(filePath, { page, server, browser }, config
       clearTimeout(timeoutHandle);
       timeoutHandle = setTimeout(resolveTestRace, config.timeout * 3);
     };
+    config._onTestsJsServed = () => {
+      clearTimeout(timeoutHandle);
+      timeoutHandle = setTimeout(resolveTestRace, config.timeout * 4);
+    };
     config._resetTestTimeout = () => {
       wsConnected = true;
       clearTimeout(timeoutHandle);
@@ -1256,6 +1350,7 @@ async function runTestInsideHTMLFile(filePath, { page, server, browser }, config
   } finally {
     clearTimeout(timeoutHandle);
     config._onWsOpen = null;
+    config._onTestsJsServed = null;
     config._resetTestTimeout = null;
     config._testRunDone = null;
   }
@@ -1341,6 +1436,20 @@ function setupFileWatchers(testFileLookupPaths, config, onEventFunc, onFinishFun
           onFinishFunc
         );
       } catch {
+        await new Promise((resolve) => setTimeout(resolve, 50));
+        try {
+          const s = await stat(fullPath);
+          handleWatchEvent(
+            config,
+            extensions,
+            s.isDirectory() ? "addDir" : "add",
+            fullPath,
+            onEventFunc,
+            onFinishFunc
+          );
+          return;
+        } catch {
+        }
         if (!(config.fsTree && fullPath in config.fsTree)) return;
         handleWatchEvent(config, extensions, "unlink", fullPath, onEventFunc, onFinishFunc);
       }
@@ -1383,6 +1492,7 @@ function setupFileWatchers(testFileLookupPaths, config, onEventFunc, onFinishFun
 function handleWatchEvent(config, extensions, event, filePath, onEventFunc, onFinishFunc) {
   const isFileEvent = extensions.some((ext) => filePath.endsWith(`.${ext}`));
   if (!isFileEvent && event !== "unlinkDir") return;
+  if (event === "change" && config._building && config._justAddedFiles?.has(filePath)) return;
   mutateFSTree(config.fsTree, event, filePath);
   console.log(
     "#",
@@ -1395,6 +1505,7 @@ function handleWatchEvent(config, extensions, event, filePath, onEventFunc, onFi
   );
   if (!config._building) {
     config._building = true;
+    config._justAddedFiles = event === "add" ? /* @__PURE__ */ new Set([filePath]) : /* @__PURE__ */ new Set();
     const result = onEventFunc(event, filePath);
     if (!(result instanceof Promise)) {
       config._building = false;
@@ -1413,6 +1524,7 @@ function handleWatchEvent(config, extensions, event, filePath, onEventFunc, onFi
       }
     });
   } else {
+    if (event === "add") config._justAddedFiles?.add(filePath);
     config._pendingBuildTrigger = () => handleWatchEvent(config, extensions, event, filePath, onEventFunc, onFinishFunc);
   }
 }
@@ -1507,7 +1619,7 @@ function setupKeyboardEvents(config, cachedContent, connections) {
   });
 }
 function abortBrowserQUnit(_config, connections) {
-  connections.server.publish("abort", "abort");
+  connections.server.publish("abort");
 }
 var init_keyboard_events = __esm({
   "lib/setup/keyboard-events.ts"() {
@@ -1584,11 +1696,21 @@ async function run(config) {
           if (["change", "unlink", "unlinkDir"].includes(event)) {
             if (event === "change" && !(file in config.fsTree)) return;
             cachedContent.allTestCode = null;
+            if (config.debug) {
+              console.log(
+                `# Rerun triggered: ${event} \u2192 ${file.replace(`${config.projectRoot}/`, "")}`
+              );
+            }
             return await runTestsInBrowser(config, cachedContent, connections);
           }
+          if (config.debug) {
+            console.log(
+              `# Rerun triggered: ${event} \u2192 ${file.replace(`${config.projectRoot}/`, "")}`
+            );
+          }
           await runTestsInBrowser(config, cachedContent, connections, [file]);
         },
-        (_path, _event) => connections.server.publish("refresh", "refresh")
+        (_path, _event) => connections.server.publish("refresh")
       );
       await watcherReady;
     }
@@ -1604,10 +1726,14 @@ async function run(config) {
       fsTree: Object.fromEntries(groupFiles.map((f) => [f, config.fsTree[f]])),
       // Single group keeps the root output dir for backward-compatible file paths.
       output: groupCount === 1 ? config.output : `${config.output}/group-${i}`,
-      _groupMode: true
+      _groupMode: true,
+      _phase: "bundling"
     }));
     const groupCachedContents = groups.map(() => ({ ...cachedContent }));
     console.log("TAP version 13");
+    console.log(
+      `# Running ${allFiles.length} test file${allFiles.length === 1 ? "" : "s"} across ${groupCount} group${groupCount === 1 ? "" : "s"}`
+    );
     const [browser] = await Promise.all([
       launchBrowser(config),
       Promise.all(
@@ -1629,14 +1755,22 @@ async function run(config) {
     const groupResults = await Promise.allSettled(
       groupConfigs.map((groupConfig, i) => {
         const groupTimeout = new Promise((_, reject) => {
-          const t = setTimeout(
-            () => reject(new Error(`Group ${i} timed out after ${GROUP_TIMEOUT_MS}ms`)),
-            GROUP_TIMEOUT_MS
-          );
+          const t = setTimeout(() => {
+            const files = Object.keys(groupConfig.fsTree).map(
+              (f) => f.replace(`${groupConfig.projectRoot}/`, "")
+            );
+            reject(
+              new Error(
+                `Group ${i} timed out after ${GROUP_TIMEOUT_MS / 1e3}s in phase '${groupConfig._phase ?? "unknown"}'
+  Files: ${files.join(", ")}`
+              )
+            );
+          }, GROUP_TIMEOUT_MS);
           t.unref();
         });
         return Promise.race([
           (async () => {
+            groupConfig._phase = "connecting";
             const connections = await setupBrowser(groupConfig, groupCachedContents[i], browser);
             groupConfig.expressApp = connections.server;
             if (config.before) {
@@ -1794,7 +1928,7 @@ init_color();
 var package_default = {
   name: "qunitx-cli",
   type: "module",
-  version: "0.10.0",
+  version: "0.15.0",
   description: "Browser runner for QUnitx: run your qunitx tests in google-chrome",
   author: "Izel Nakri",
   license: "MIT",
@@ -1824,8 +1958,11 @@ var package_default = {
     "changelog:preview": "git-cliff",
     "changelog:update": "git-cliff --output CHANGELOG.md",
     postinstall: "PLAYWRIGHT_SKIP_DOWNLOAD=true deno install --allow-scripts=npm:playwright-core || true",
-    test: `node --experimental-strip-types test/setup.ts && FORCE_COLOR=0 node --experimental-strip-types --test --test-concurrency=$(node -p 'require("os").availableParallelism()') test/**/*-test.ts`,
-    "test:browser": `node --experimental-strip-types test/setup.ts && FORCE_COLOR=0 node --experimental-strip-types --test --test-concurrency=$(node -p 'require("os").availableParallelism()') test/flags/*-test.ts test/inputs/*-test.ts`,
+    test: "node --experimental-strip-types test/setup.ts && FORCE_COLOR=0 node --experimental-strip-types --test test/**/*-test.ts",
+    "test:debug": "node --experimental-strip-types test/setup.ts && QUNITX_DEBUG=1 node --experimental-strip-types --test test/**/*-test.ts",
+    dev: "node --experimental-strip-types test/setup.ts && node --experimental-strip-types --test --watch test/**/*-test.ts",
+    "test:browser": "node --experimental-strip-types test/setup.ts && FORCE_COLOR=0 node --experimental-strip-types --test test/flags/*-test.ts test/inputs/*-test.ts",
+    "test:release": "bash scripts/test-release.sh",
     "test:sanity-first": "./cli.ts test/helpers/failing-tests.js test/helpers/failing-tests.ts",
     "test:sanity-second": "./cli.ts test/helpers/passing-tests.js test/helpers/passing-tests.ts"
   },
@@ -1841,15 +1978,15 @@ var package_default = {
     url: "git+https://github.com/izelnakri/qunitx-cli.git"
   },
   dependencies: {
-    esbuild: "^0.27.3",
-    "playwright-core": "^1.58.2",
+    esbuild: "^0.28.0",
+    "playwright-core": "^1.59.1",
     ws: "^8.20.0"
   },
   devDependencies: {
     cors: "^2.8.6",
     express: "^5.2.1",
     "js-yaml": "^4.1.1",
-    prettier: "^3.8.1",
+    prettier: "^3.8.2",
     qunitx: "^1.2.1",
     typescript: "^6.0.2"
   },
@@ -2214,7 +2351,9 @@ async function setupConfig() {
     lastRanTestFiles: null,
     COUNTER: { testCount: 0, failCount: 0, skipCount: 0, passCount: 0, errorCount: 0 },
     _testRunDone: null,
-    _resetTestTimeout: null
+    _resetTestTimeout: null,
+    _onWsOpen: null,
+    _onTestsJsServed: null
   };
   config.htmlPaths = normalizeHTMLPaths(config.projectRoot, config.htmlPaths);
   config.fsTree = await buildFSTree(config.testFileLookupPaths, config);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qunitx-cli",
   "type": "module",
-  "version": "0.10.0",
+  "version": "0.15.0",
   "description": "Browser runner for QUnitx: run your qunitx tests in google-chrome",
   "author": "Izel Nakri",
   "license": "MIT",
@@ -31,8 +31,11 @@
     "changelog:preview": "git-cliff",
     "changelog:update": "git-cliff --output CHANGELOG.md",
     "postinstall": "PLAYWRIGHT_SKIP_DOWNLOAD=true deno install --allow-scripts=npm:playwright-core || true",
-    "test": "node --experimental-strip-types test/setup.ts && FORCE_COLOR=0 node --experimental-strip-types --test --test-concurrency=$(node -p 'require(\"os\").availableParallelism()') test/**/*-test.ts",
-    "test:browser": "node --experimental-strip-types test/setup.ts && FORCE_COLOR=0 node --experimental-strip-types --test --test-concurrency=$(node -p 'require(\"os\").availableParallelism()') test/flags/*-test.ts test/inputs/*-test.ts",
+    "test": "node --experimental-strip-types test/setup.ts && FORCE_COLOR=0 node --experimental-strip-types --test test/**/*-test.ts",
+    "test:debug": "node --experimental-strip-types test/setup.ts && QUNITX_DEBUG=1 node --experimental-strip-types --test test/**/*-test.ts",
+    "dev": "node --experimental-strip-types test/setup.ts && node --experimental-strip-types --test --watch test/**/*-test.ts",
+    "test:browser": "node --experimental-strip-types test/setup.ts && FORCE_COLOR=0 node --experimental-strip-types --test test/flags/*-test.ts test/inputs/*-test.ts",
+    "test:release": "bash scripts/test-release.sh",
     "test:sanity-first": "./cli.ts test/helpers/failing-tests.js test/helpers/failing-tests.ts",
     "test:sanity-second": "./cli.ts test/helpers/passing-tests.js test/helpers/passing-tests.ts"
   },
@@ -48,15 +51,15 @@
     "url": "git+https://github.com/izelnakri/qunitx-cli.git"
   },
   "dependencies": {
-    "esbuild": "^0.27.3",
-    "playwright-core": "^1.58.2",
+    "esbuild": "^0.28.0",
+    "playwright-core": "^1.59.1",
     "ws": "^8.20.0"
   },
   "devDependencies": {
     "cors": "^2.8.6",
     "express": "^5.2.1",
     "js-yaml": "^4.1.1",
-    "prettier": "^3.8.1",
+    "prettier": "^3.8.2",
     "qunitx": "^1.2.1",
     "typescript": "^6.0.2"
   },