@qualflare/cypress 0.2.0 → 0.4.0

package/README.md

@@ -26,6 +26,9 @@ exercised in CI against a real `cypress run`; majors newer than that are unteste
 refused — please [open an issue](https://github.com/Qualflare/qualflare-cypress/issues) if
 one misbehaves.
 
+(Contributors: the repo itself now develops against Cypress 15, which requires Node `>=20.1`.
+The `>=18` floor above is the *consumer* requirement and still holds for Cypress 12–14.)
+
 ## Quickstart
 
 ```ts
@@ -67,9 +70,8 @@ qf my-project collect ./qualflare-results
 ```
 
 That's it — suite/test results, retries, and automatic-on-failure screenshots show up as one Launch
-once `qualflare-cli collect` runs. [`examples/basic/`](./examples/basic) has a runnable project, but
-its own instructions still describe the old direct-upload/`QUALFLARE_TOKEN` setup and haven't been
-updated for the `outputDir` model yet — follow the steps above instead, not that example's README.
+once `qualflare-cli collect` runs. [`examples/basic/`](./examples/basic) has a runnable project
+demonstrating the same flow end to end, including the `qualflare.*` metadata API.
 
 ## Enriching your tests
 
@@ -101,12 +103,21 @@ Every option can be set either as a plugin option (`qualflareCypress(on, config,
 `QUALFLARE_*` environment variable. Full table, precedence rules, and auto-detection behavior (git
 branch/commit, CI provider/build/PR, browser/OS) in [`docs/CONFIGURATION.md`](./docs/CONFIGURATION.md).
 
+One option is worth calling out because it fails late: `environment` is matched against the
+environment's **uid (slug)**, not its display name, so **Staging** in the UI is `staging` here. A
+wrong value cannot fail at run time — this package makes no network calls — so the run succeeds and
+`collect` 404s afterwards. See
+[the note in the configuration docs](./docs/CONFIGURATION.md#environment-is-matched-by-uid-not-display-name).
+
 ## Known limitations
 
 - **Sharded CI runs merge automatically, but only at collect time** — point every shard's
   `cypress run` at the same shared `outputDir`; `qualflare-cli collect` merges every report file it
   finds there into one Launch, no extra flag needed (see
   [`docs/LIMITATIONS.md`](./docs/LIMITATIONS.md)).
+- **A stale `outputDir` is refused, not merged** — each report carries a `runId`, and `qf collect`
+  errors rather than merging files from two different runs. Needs `@qualflare/cli` v0.1.19+; older
+  CLIs merge as before.
 - **Command-log step nesting is two levels only** (Cypress's own API limit) — `qualflare.step()`
   supports arbitrary nesting depth.
 

package/dist/index.cjs

@@ -45,6 +45,8 @@ var MAX_LABELS_PER_CASE = 100;
 var MAX_LINKS_PER_CASE = 20;
 var MAX_TAGS_PER_CASE = 64;
 var MAX_TAG_LENGTH = 255;
+var MAX_ATTEMPTS_PER_CASE = 50;
+var MAX_ATTEMPT_MESSAGE_RUNES = 8192;
 var MAX_VIDEO_UPLOAD_BYTES = 50 * 1024 * 1024;
 var MAX_STEPS_PER_TEST_ATTEMPT = 300;
 
@@ -298,6 +300,18 @@ function registerCommandLogListener(buffer) {
   });
 }
 
+// src/shared/text.ts
+function truncateRunes(value, maxRunes) {
+  if (value.length <= maxRunes) {
+    return value;
+  }
+  const runes = Array.from(value);
+  if (runes.length <= maxRunes) {
+    return value;
+  }
+  return runes.slice(0, maxRunes).join("");
+}
+
 // src/browser/case-builder.ts
 function combineSteps(autoSteps, manualSteps) {
   const auto = autoSteps ?? [];
@@ -314,6 +328,26 @@ function combineSteps(autoSteps, manualSteps) {
   });
   return [...auto, ...offsetManual];
 }
+function buildAttempts(attempts) {
+  if (attempts.length < 2) {
+    return void 0;
+  }
+  let kept = attempts;
+  if (attempts.length > MAX_ATTEMPTS_PER_CASE) {
+    kept = [...attempts.slice(0, MAX_ATTEMPTS_PER_CASE - 1), attempts[attempts.length - 1]];
+  }
+  return kept.map((a, i) => {
+    const attempt = {
+      attempt: i + 1,
+      status: a.status,
+      duration: msToNs(a.duration)
+    };
+    if (a.error) {
+      attempt.message = truncateRunes(a.error, MAX_ATTEMPT_MESSAGE_RUNES);
+    }
+    return attempt;
+  });
+}
 function collapseAttempts(attempts) {
   if (attempts.length === 0) {
     throw new Error("collapseAttempts: at least one attempt is required");
@@ -322,11 +356,13 @@ function collapseAttempts(attempts) {
   const retryCount = attempts.length - 1;
   const isFlaky = retryCount > 0 && final.status === "passed" && attempts.some((a) => a.status !== "passed");
   const duration = attempts.reduce((sum, a) => sum + a.duration, 0);
+  const attemptHistory = buildAttempts(attempts);
   return {
     status: final.status,
     duration,
     retryCount,
     isFlaky,
+    ...attemptHistory ? { attempts: attemptHistory } : {},
     error: final.status === "passed" ? void 0 : final.error,
     steps: combineSteps(final.steps, final.manualSteps),
     labels: final.labels,
@@ -353,6 +389,8 @@ function flushCase(test, attempts) {
     duration: msToNs(collapsed.duration),
     retryCount: collapsed.retryCount,
     isFlaky: collapsed.isFlaky,
+    // Already nanoseconds — collapseAttempts converts, unlike `duration` above.
+    attempts: collapsed.attempts,
     error: collapsed.error,
     steps: collapsed.steps,
     // qualflare.* author-facing metadata API calls (labels/links/tags/