@qualflare/playwright 0.1.0 → 0.2.0

package/README.md

@@ -105,6 +105,12 @@ Every option has an environment-variable override, and everything has a sensible
 [`docs/CONFIGURATION.md`](./docs/CONFIGURATION.md). There is no `token` option: this reporter makes
 no requests, so it has no credential.
 
+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 test time — the reporter makes no requests — 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
 
 - **Traces are not uploaded.** Playwright traces are `application/zip`, which Qualflare's attachment
@@ -113,9 +119,9 @@ no requests, so it has no credential.
 - **`pw:api` and `fixture` steps are filtered out by default** (`includeApiSteps`) — a single
   browser test emits hundreds, which buries the steps you actually wrote. A *failed* one is always
   kept.
-- **`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 it 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.
 - **`merge-reports` mode is not supported** in v0.1.0 — use the `outputDir` flow above rather than
   Playwright's `blob` reporter.
 

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { ReporterDescription } from '@playwright/test';
-import { L as LinkType, C as CasePriority, Q as QualflarePlaywrightOptions } from './resolve-config-CSjXFl7v.cjs';
-export { A as Attachment, a as Case, b as CaseStatus, c as Collect, F as FrameworkCategory, d as Label, e as Link, M as Metadata, N as NanosecondDuration, P as Parameter, f as Platform, R as ResolvedReporterConfig, S as Step, g as Suite } from './resolve-config-CSjXFl7v.cjs';
+import { L as LinkType, C as CasePriority, Q as QualflarePlaywrightOptions } from './resolve-config-CQe-oDpg.cjs';
+export { A as Attachment, a as Case, b as CaseStatus, c as Collect, F as FrameworkCategory, d as Label, e as Link, M as Metadata, N as NanosecondDuration, P as Parameter, f as Platform, R as ResolvedReporterConfig, S as Step, g as Suite } from './resolve-config-CQe-oDpg.cjs';
 
 /**
  * Author-facing metadata API. Import it in a spec and annotate tests with

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { ReporterDescription } from '@playwright/test';
-import { L as LinkType, C as CasePriority, Q as QualflarePlaywrightOptions } from './resolve-config-CSjXFl7v.js';
-export { A as Attachment, a as Case, b as CaseStatus, c as Collect, F as FrameworkCategory, d as Label, e as Link, M as Metadata, N as NanosecondDuration, P as Parameter, f as Platform, R as ResolvedReporterConfig, S as Step, g as Suite } from './resolve-config-CSjXFl7v.js';
+import { L as LinkType, C as CasePriority, Q as QualflarePlaywrightOptions } from './resolve-config-CQe-oDpg.js';
+export { A as Attachment, a as Case, b as CaseStatus, c as Collect, F as FrameworkCategory, d as Label, e as Link, M as Metadata, N as NanosecondDuration, P as Parameter, f as Platform, R as ResolvedReporterConfig, S as Step, g as Suite } from './resolve-config-CQe-oDpg.js';
 
 /**
  * Author-facing metadata API. Import it in a spec and annotate tests with

package/dist/reporter/index.cjs

@@ -35,10 +35,13 @@ __export(reporter_exports, {
 module.exports = __toCommonJS(reporter_exports);
 
 // src/reporter/reporter.ts
-var import_node_crypto2 = require("crypto");
+var import_node_crypto3 = require("crypto");
 var fs3 = __toESM(require("fs"), 1);
 var path3 = __toESM(require("path"), 1);
 
+// 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;
@@ -68,6 +71,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 ?? "");
@@ -78,6 +82,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)
   },
@@ -85,6 +90,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)
   },
@@ -92,6 +98,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;
@@ -107,6 +114,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
@@ -116,6 +124,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;
@@ -131,6 +140,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) {
@@ -152,6 +162,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) {
@@ -241,6 +253,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
@@ -260,6 +273,7 @@ function resolveConfig(options, deps = {}) {
     ciBuildNumber,
     ciRunUrl,
     ciPrNumber,
+    runId,
     attachScreenshots: options.attachScreenshots ?? envBool("QUALFLARE_ATTACH_SCREENSHOTS") ?? true,
     includeApiSteps: options.includeApiSteps ?? envBool("QUALFLARE_INCLUDE_API_STEPS") ?? false,
     maxAttachmentBytes: options.maxAttachmentBytes ?? envInt("QUALFLARE_MAX_ATTACHMENT_BYTES") ?? 15e5,
@@ -295,7 +309,7 @@ var fs2 = __toESM(require("fs"), 1);
 // src/reporter/video-writer.ts
 var fs = __toESM(require("fs"), 1);
 var path = __toESM(require("path"), 1);
-var import_node_crypto = require("crypto");
+var import_node_crypto2 = require("crypto");
 var VIDEO_MIME_TYPES_BY_EXTENSION = {
   ".mp4": "video/mp4",
   ".webm": "video/webm",
@@ -321,7 +335,7 @@ function copyVideoAttachment(filePath, outputDir, maxVideoBytes) {
     );
     return void 0;
   }
-  const localVideoPath = `${(0, import_node_crypto.randomUUID)()}${ext}`;
+  const localVideoPath = `${(0, import_node_crypto2.randomUUID)()}${ext}`;
   try {
     fs.mkdirSync(outputDir, { recursive: true });
     fs.copyFileSync(filePath, path.join(outputDir, localVideoPath));
@@ -722,7 +736,7 @@ function buildCase(test, config, attachmentsByResult, budget) {
 var os = __toESM(require("os"), 1);
 
 // src/config/version.ts
-var PACKAGE_VERSION = "0.1.0";
+var PACKAGE_VERSION = "0.2.0";
 
 // src/reporter/collect-builder.ts
 function resolveOs(config) {
@@ -751,7 +765,8 @@ function buildCollectPayload(suites, config, browsers = []) {
     metadata: {
       version: PACKAGE_VERSION,
       timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      cliName: "qualflare-playwright"
+      cliName: "qualflare-playwright",
+      runId: config.runId
     },
     properties: config.properties,
     suites,
@@ -901,7 +916,7 @@ var QualflareReporter = class {
     }
     const outputDir = this.resolveOutputDir(config.outputDir);
     fs3.mkdirSync(outputDir, { recursive: true });
-    const outputPath = path3.join(outputDir, `${(0, import_node_crypto2.randomUUID)()}.json`);
+    const outputPath = path3.join(outputDir, `${(0, import_node_crypto3.randomUUID)()}.json`);
     fs3.writeFileSync(outputPath, JSON.stringify(collect));
     logger.info(`wrote Collect payload to ${outputPath} \u2014 run \`qualflare-cli collect ${outputDir}\` to upload it.`);
   }