squally-reporter 0.5.0 → 0.5.1

package/dist/index.js

@@ -640,10 +640,45 @@ function confirmReasonMessage(reason) {
 function artifactLabel(type) {
     return type === "screenshot" ? "Screenshot" : "Trace";
 }
+/**
+ * Wait, WITHOUT letting the process die during the wait.
+ *
+ * The timer is deliberately NOT unref'd, and that is the whole content of this
+ * function. An unref'd timer does not hold Node's event loop open, so a promise
+ * that only an unref'd timer can resolve is a promise the process may never
+ * wait for: if nothing else is pending, Node treats the loop as empty and exits
+ * THERE, with whatever `process.exitCode` happens to be - which is 0.
+ *
+ * That shipped in 0.5.0 and made a FAILING test suite report a GREEN CI job:
+ *
+ *   0.4.0  await new Promise((resolve) => setTimeout(resolve, EXIT_DRAIN_MS));
+ *   0.5.0  await delay(EXIT_DRAIN_MS);   // helper below, which unref'd
+ *
+ * Playwright computes the exit code only AFTER awaiting every reporter's
+ * onEnd - the runner multiplexer awaits `reporter.onEnd(result)` and the CLI
+ * then calls `gracefullyProcessExitDoNotHang(status === "passed" ? 0 : 1)`.
+ * Exiting during onEnd skips the line that would have set 1. Measured: the same
+ * 250 ms wait exits 0 when unref'd and 1 when not, on a suite with a failing
+ * test.
+ *
+ * EVERY caller is awaited from inside onEnd, directly or through
+ * drainAndComplete's retries, so every one of them needs this. There is no
+ * "this wait is unimportant" case: a wait nobody needs should not be awaited at
+ * all. The first fix for the bug above kept an opt-out for the retry backoffs
+ * and was still wrong - a server returning 503 on /complete reproduced the
+ * green-on-red exit through exactly that path (measured, 10.09.).
+ *
+ * Ref'ing costs nothing here: Playwright ends the process with `process.exit()`,
+ * which does not wait for pending timers, so a still-running backoff cannot
+ * delay anyone's CI.
+ *
+ * NOT to be confused with the two unref'd timers elsewhere in this file, both
+ * of which are correct: withDeadline's timer races a real promise, and the
+ * periodic flush timer is never awaited by anything.
+ */
 function delay(ms) {
     return new Promise((resolve) => {
-        const handle = setTimeout(resolve, ms);
-        handle.unref();
+        setTimeout(resolve, ms);
     });
 }
 // Retry-After per RFC 9110: either an integer number of seconds, or an
@@ -754,6 +789,9 @@ class SquallyReporter {
                 // See EXIT_DRAIN_MS - closing the dispatcher resolves before the
                 // underlying sockets are fully gone, and Playwright exits the process
                 // the moment onEnd() resolves.
+                // This wait exists precisely to keep the process alive while sockets
+                // finish closing - see delay(), and test/exit-code's failing-suite
+                // scenario, which is what catches it if the unref ever comes back.
                 await delay(EXIT_DRAIN_MS);
             }
         };

package/package.json

@@ -1,41 +1,41 @@
-{
-  "name": "squally-reporter",
-  "version": "0.5.0",
-  "description": "Playwright reporter that sends test results to your Squally dashboard.",
-  "author": "Squally <squally.dev@gmail.com>",
-  "keywords": [
-    "playwright",
-    "playwright-reporter",
-    "flaky-tests",
-    "test-results",
-    "ci"
-  ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "engines": {
-    "node": ">=22.19.0"
-  },
-  "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run build",
-    "prepare": "npm run build",
-    "test:unit": "node --test \"test/unit/**/*.test.js\"",
-    "test:exit-code": "node test/exit-code/run.mjs",
-    "test": "npm run build && npm run test:unit && npm run test:exit-code"
-  },
-  "peerDependencies": {
-    "@playwright/test": ">=1.30.0"
-  },
-  "devDependencies": {
-    "@playwright/test": "^1.48.0",
-    "@types/node": "^20.14.0",
-    "typescript": "^5.6.0"
-  },
-  "license": "MIT",
-  "dependencies": {
-    "undici": "^8.10.0"
-  }
-}
+{
+  "name": "squally-reporter",
+  "version": "0.5.1",
+  "description": "Playwright reporter that sends test results to your Squally dashboard.",
+  "author": "Squally <squally.dev@gmail.com>",
+  "keywords": [
+    "playwright",
+    "playwright-reporter",
+    "flaky-tests",
+    "test-results",
+    "ci"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22.19.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "prepare": "npm run build",
+    "test:unit": "node --test \"test/unit/**/*.test.js\"",
+    "test:exit-code": "node test/exit-code/run.mjs",
+    "test": "npm run build && npm run test:unit && npm run test:exit-code"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.30.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.48.0",
+    "@types/node": "^20.14.0",
+    "typescript": "^5.6.0"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "undici": "^8.10.0"
+  }
+}