squally-reporter 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -6,6 +6,7 @@ interface SquallyReporterOptions {
 export default class SquallyReporter implements Reporter {
     private apiUrl;
     private apiKey;
+    private enabled;
     private startedAt;
     private results;
     constructor(options?: SquallyReporterOptions);

package/dist/index.js

@@ -161,21 +161,38 @@ function formatConsoleOutput(result) {
 }
 class SquallyReporter {
     constructor(options = {}) {
+        this.apiUrl = "";
+        this.apiKey = "";
+        // Missing/invalid config must never take down the caller's whole test
+        // suite over just a reporting integration - see the constructor below.
+        // Every onXxx hook checks this first and no-ops if it's false.
+        this.enabled = false;
         this.startedAt = new Date();
         this.results = [];
         const apiUrl = options.apiUrl ?? process.env.SQUALLY_API_URL;
         const apiKey = options.apiKey ?? process.env.SQUALLY_API_KEY;
         if (!apiUrl || !apiKey) {
-            throw new Error("[squally-reporter] Missing config: set SQUALLY_API_URL and " +
-                "SQUALLY_API_KEY as env vars, or pass apiUrl/apiKey in playwright.config.ts");
+            // Deliberately NOT thrown - a missing/wrong Squally API key must
+            // only disable reporting to Squally, not fail the caller's entire
+            // CI pipeline before a single test has even run. Warn loudly
+            // instead and continue as a no-op reporter.
+            console.warn("[squally-reporter] no API key configured, skipping report - set " +
+                "SQUALLY_API_URL/SQUALLY_API_KEY as env vars, or pass apiUrl/apiKey " +
+                "in playwright.config.ts");
+            return;
         }
         this.apiUrl = apiUrl.replace(/\/$/, ""); // strip trailing slash if present
         this.apiKey = apiKey;
+        this.enabled = true;
     }
     onBegin(_config, _suite) {
+        if (!this.enabled)
+            return;
         this.startedAt = new Date();
     }
     onTestEnd(test, result) {
+        if (!this.enabled)
+            return;
         const error = result.errors[0];
         this.results.push({
             testName: test.titlePath().slice(1).join(" > "),
@@ -189,6 +206,15 @@ class SquallyReporter {
         });
     }
     async onEnd(result) {
+        if (!this.enabled)
+            return;
+        // A run with 0 test results is meaningless for Squally's flakiness
+        // calculation and would just be dashboard clutter - regardless of why
+        // there were none (npx playwright test --list, an empty testDir, a
+        // --grep filter that matched nothing). Bail out before building/
+        // sending anything.
+        if (this.results.length === 0)
+            return;
         const resolvedRevision = resolveTestedRevision();
         const payload = {
             branch: detectBranch(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squally-reporter",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Playwright reporter that sends test results to your Squally dashboard.",
   "author": "Squally <squally.dev@gmail.com>",
   "keywords": [