@qualflare/cucumberjs 0.2.0 → 0.4.0

package/README.md

@@ -106,11 +106,17 @@ Every option can be set either as a `formatOptions` entry or via a `QUALFLARE_*`
 variable. Full table, precedence rules, and auto-detection behavior (git branch/commit, CI
 provider/build/PR) 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
 
-- **`outputDir` is merged blindly** — `qf collect` uploads every report file it finds, with no
-  run-identity check, so a directory left over from a previous run is silently merged into the
-  current one. Clear or freshly create `outputDir` at the start of each run.
+- **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.
 - **`shardIndex` is best-effort** — cucumber-js routes its own `--shard` flag somewhere a formatter
   cannot read, so it is recovered from `QUALFLARE_SHARD_INDEX` or by scanning `process.argv`. It is
   only an attribution label; merging never depends on it. See

package/dist/formatter/index.cjs

@@ -35,16 +35,21 @@ __export(formatter_exports, {
 module.exports = __toCommonJS(formatter_exports);
 
 // src/formatter/formatter.ts
-var import_node_crypto2 = require("crypto");
+var import_node_crypto3 = require("crypto");
 var fs3 = __toESM(require("fs"), 1);
 var path4 = __toESM(require("path"), 1);
 var import_cucumber = require("@cucumber/cucumber");
 
+// src/config/resolve-config.ts
+var import_node_crypto = require("crypto");
+
 // src/shared/constants.ts
 var RESERVED_MESSAGE_MEDIA_TYPE = "application/vnd.qualflare.message+json";
 var MAX_SUITES_PER_LAUNCH = 2e3;
 var MAX_CASES_PER_SUITE = 5e3;
 var MAX_TAGS_PER_CASE = 64;
+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;
 
@@ -65,6 +70,7 @@ var PROVIDERS = [
     detect: (env) => env.GITHUB_ACTIONS === "true",
     providerName: "GitHub Actions",
     buildNumber: (env) => nonEmpty(env.GITHUB_RUN_NUMBER),
+    runId: (env) => nonEmpty(env.GITHUB_RUN_ID),
     runUrl: (env) => env.GITHUB_SERVER_URL && env.GITHUB_REPOSITORY && env.GITHUB_RUN_ID ? `${env.GITHUB_SERVER_URL}/${env.GITHUB_REPOSITORY}/actions/runs/${env.GITHUB_RUN_ID}` : void 0,
     prNumber: (env) => {
       const match = /^refs\/pull\/(\d+)\/merge$/.exec(env.GITHUB_REF ?? "");
@@ -75,6 +81,7 @@ var PROVIDERS = [
     detect: (env) => env.GITLAB_CI === "true",
     providerName: "GitLab CI",
     buildNumber: (env) => nonEmpty(env.CI_PIPELINE_IID),
+    runId: (env) => nonEmpty(env.CI_PIPELINE_ID),
     runUrl: (env) => nonEmpty(env.CI_PIPELINE_URL),
     prNumber: (env) => parsePositiveInt(env.CI_MERGE_REQUEST_IID)
   },
@@ -82,6 +89,7 @@ var PROVIDERS = [
     detect: (env) => env.CIRCLECI === "true",
     providerName: "CircleCI",
     buildNumber: (env) => nonEmpty(env.CIRCLE_BUILD_NUM),
+    runId: (env) => nonEmpty(env.CIRCLE_WORKFLOW_ID ?? env.CIRCLE_BUILD_NUM),
     runUrl: (env) => nonEmpty(env.CIRCLE_BUILD_URL),
     prNumber: (env) => parsePositiveInt(env.CIRCLE_PR_NUMBER)
   },
@@ -89,6 +97,7 @@ var PROVIDERS = [
     detect: (env) => env.BUILDKITE === "true",
     providerName: "Buildkite",
     buildNumber: (env) => nonEmpty(env.BUILDKITE_BUILD_NUMBER),
+    runId: (env) => nonEmpty(env.BUILDKITE_BUILD_ID),
     runUrl: (env) => nonEmpty(env.BUILDKITE_BUILD_URL),
     prNumber: (env) => {
       const raw = env.BUILDKITE_PULL_REQUEST;
@@ -104,6 +113,7 @@ var PROVIDERS = [
     detect: (env) => Boolean(env.JENKINS_URL),
     providerName: "Jenkins",
     buildNumber: (env) => nonEmpty(env.BUILD_NUMBER),
+    runId: (env) => nonEmpty(env.BUILD_TAG ?? env.BUILD_NUMBER),
     runUrl: (env) => nonEmpty(env.BUILD_URL)
     // Jenkins has no standardized PR-number env var across its many PR
     // plugins (Multibranch, GitHub Branch Source, etc.) — deliberately
@@ -113,6 +123,7 @@ var PROVIDERS = [
     detect: (env) => env.TF_BUILD === "True" || env.TF_BUILD === "true",
     providerName: "Azure Pipelines",
     buildNumber: (env) => nonEmpty(env.BUILD_BUILDID),
+    runId: (env) => nonEmpty(env.BUILD_BUILDID),
     runUrl: (env) => {
       const collectionUri = env.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI;
       const project = env.SYSTEM_TEAMPROJECT;
@@ -128,6 +139,7 @@ var PROVIDERS = [
     detect: (env) => Boolean(env.BITBUCKET_BUILD_NUMBER),
     providerName: "Bitbucket Pipelines",
     buildNumber: (env) => nonEmpty(env.BITBUCKET_BUILD_NUMBER),
+    runId: (env) => nonEmpty(env.BITBUCKET_BUILD_NUMBER),
     runUrl: (env) => {
       const origin = env.BITBUCKET_GIT_HTTP_ORIGIN;
       if (!origin) {
@@ -149,6 +161,8 @@ function detectCi(env = process.env) {
     if (runUrl !== void 0) result.ciRunUrl = runUrl;
     const prNumber = provider.prNumber?.(env);
     if (prNumber !== void 0) result.ciPrNumber = prNumber;
+    const runId = provider.runId?.(env);
+    if (runId !== void 0) result.ciRunId = runId;
     return result;
   }
   if (ciInfo.name) {
@@ -256,6 +270,7 @@ function resolveConfig(options, deps = {}) {
   const ciBuildNumber = options.ciBuildNumber ?? detectedCi.ciBuildNumber;
   const ciRunUrl = options.ciRunUrl ?? detectedCi.ciRunUrl;
   const ciPrNumber = options.ciPrNumber ?? detectedCi.ciPrNumber;
+  const runId = options.runId ?? firstEnv2("QUALFLARE_RUN_ID") ?? detectedCi.ciRunId ?? (0, import_node_crypto.randomUUID)();
   return {
     // `||` (truthy check), not `??`, for these three REQUIRED-non-empty wire
     // fields — an explicit `''` option must not silently win over the
@@ -275,6 +290,7 @@ function resolveConfig(options, deps = {}) {
     ciBuildNumber,
     ciRunUrl,
     ciPrNumber,
+    runId,
     attachScreenshots: options.attachScreenshots ?? envBool("QUALFLARE_ATTACH_SCREENSHOTS") ?? true,
     includeStepHooks: options.includeStepHooks ?? envBool("QUALFLARE_INCLUDE_STEP_HOOKS") ?? false,
     maxAttachmentBytes: options.maxAttachmentBytes ?? envInt("QUALFLARE_MAX_ATTACHMENT_BYTES") ?? 15e5,
@@ -308,8 +324,8 @@ var logger = {
 var fs2 = __toESM(require("fs"), 1);
 var path2 = __toESM(require("path"), 1);
 
-// src/formatter/video-uploader.ts
-var import_node_crypto = require("crypto");
+// src/formatter/video-writer.ts
+var import_node_crypto2 = require("crypto");
 var fs = __toESM(require("fs"), 1);
 var path = __toESM(require("path"), 1);
 var VIDEO_MIME_TYPES_BY_EXTENSION = {
@@ -338,7 +354,7 @@ function writeVideoAttachment(pending, outputDir, maxVideoBytes) {
     logger.warn(`skipping video attachment "${pending.name}": unsupported video format.`);
     return void 0;
   }
-  const localVideoPath = `${(0, import_node_crypto.randomUUID)()}${resolved.extension}`;
+  const localVideoPath = `${(0, import_node_crypto2.randomUUID)()}${resolved.extension}`;
   const destination = path.join(outputDir, localVideoPath);
   if (pending.path !== void 0) {
     let fileSize;
@@ -512,6 +528,18 @@ function messageDurationToNs(duration) {
   return total > 0 ? Math.round(total) : 0;
 }
 
+// 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/formatter/case-builder.ts
 function combineSteps(realSteps, manualSteps) {
   if (realSteps.length === 0 && manualSteps.length === 0) {
@@ -530,6 +558,26 @@ function combineSteps(realSteps, manualSteps) {
   });
   return [...realSteps, ...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: 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");
@@ -538,11 +586,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,
@@ -582,6 +632,7 @@ function buildCase(uri, pickle, collapsed, gherkin) {
     duration: collapsed.duration,
     retryCount: collapsed.retryCount || void 0,
     isFlaky: collapsed.isFlaky || void 0,
+    attempts: collapsed.attempts,
     error: collapsed.error,
     tags: tags.length > 0 ? tags : void 0,
     steps: collapsed.steps,
@@ -987,7 +1038,7 @@ function timestampMs(ts) {
 var os = __toESM(require("os"), 1);
 
 // src/config/version.ts
-var PACKAGE_VERSION = "0.2.0";
+var PACKAGE_VERSION = "0.4.0";
 
 // src/formatter/collect-builder.ts
 function resolveOs(config) {
@@ -1010,7 +1061,8 @@ function buildCollectPayload(suites, config) {
     metadata: {
       version: PACKAGE_VERSION,
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      cliName: "qualflare-cucumberjs"
+      cliName: "qualflare-cucumberjs",
+      runId: config.runId
     },
     properties: config.properties,
     suites,
@@ -1343,7 +1395,7 @@ var QualflareCucumberFormatter = class extends import_cucumber.Formatter {
       }
     }
     fs3.mkdirSync(this.config.outputDir, { recursive: true });
-    const outputPath = path4.join(this.config.outputDir, `${(0, import_node_crypto2.randomUUID)()}.json`);
+    const outputPath = path4.join(this.config.outputDir, `${(0, import_node_crypto3.randomUUID)()}.json`);
     fs3.writeFileSync(outputPath, JSON.stringify(payload));
     logger.info(
       `wrote Collect payload to ${outputPath} \u2014 run \`qualflare-cli collect ${this.config.outputDir}\` to upload it.`