@qualflare/playwright 0.1.0

package/dist/resolve-config-CSjXFl7v.d.ts

@@ -0,0 +1,292 @@
+/**
+ * The Qualflare `/api/v1/collect` wire contract.
+ *
+ * These interfaces mirror `api-service/internal/core/domain/launch/launch.go`
+ * field-for-field (JSON key names, optionality, and string-union values) as
+ * verified against the live, deployed source. Do not add, rename, or change
+ * the optionality of a field here without re-verifying against that file —
+ * a mismatch either 400s the request or silently drops data server-side.
+ *
+ * Kept identical to `@qualflare/cypress`'s copy of this file — the two
+ * packages report to the same backend, so this file should stay in sync
+ * across both.
+ */
+/** Every `duration` field in this contract is a raw integer number of
+ * NANOSECONDS, with no unit marker on the wire. Playwright reports
+ * `{seconds, nanos}` — convert directly to nanoseconds (see `./duration.ts`)
+ * before assigning into one of these fields. */
+type NanosecondDuration = number;
+type Platform = 'android' | 'ios' | 'desktop' | 'web' | 'api';
+type CaseStatus = 'passed' | 'failed' | 'skipped' | 'error' | 'timeout' | 'aborted' | 'pending';
+/**
+ * The server's oneof accepts a value named after any of the ~23 frameworks it
+ * auto-detects (e.g. "playwright"), not just the six coarse buckets below — a
+ * suite's category is meant to say exactly which tool produced it, which is
+ * what lets the UI show that tool's own logo. This reporter only ever emits
+ * 'playwright' (see suite-builder.ts), so that's the only
+ * tool-specific value listed here; the six buckets remain for backward
+ * compatibility / servers that haven't been upgraded.
+ */
+type FrameworkCategory = 'playwright' | 'unit' | 'bdd' | 'e2e' | 'api' | 'security' | 'generic';
+type CasePriority = 'low' | 'medium' | 'high' | 'critical';
+type LinkType = 'issue' | 'tms' | 'custom';
+interface Metadata {
+    version: string;
+    timestamp: string;
+    cliName: string;
+}
+interface Label {
+    /** Required, max 128 chars. Allure-style arbitrary label name — epic/feature/story/owner/severity
+     * are just conventional names, not separate fields. */
+    name: string;
+    /** Required, max 512 chars. */
+    value: string;
+}
+interface Link {
+    /** Required. A small, server-owned closed taxonomy — not open text. */
+    type: LinkType;
+    /** Optional, max 255 chars. */
+    name?: string;
+    /** Required, must be a valid URL, max 2048 chars. */
+    url: string;
+}
+interface Parameter {
+    name: string;
+    value?: string;
+    /** Display hint ONLY — the server does not redact this value. Do not treat
+     * this as real secret protection. */
+    masked?: boolean;
+}
+interface Step {
+    name: string;
+    keyword?: string;
+    /** Reuses the Case status vocabulary. */
+    status: CaseStatus | string;
+    /** NANOSECONDS — see `NanosecondDuration`. */
+    duration: NanosecondDuration;
+    error?: string;
+    location?: string;
+    /** 0-based index into the SAME Case's `steps[]` array identifying this
+     * step's parent, for nested/hierarchical steps. Omit for a root step.
+     * The server drops an out-of-range or cycle-forming value to root rather
+     * than rejecting the request — but a well-behaved client shouldn't rely
+     * on that. Server caps total steps per case at 1000. */
+    parentIndex?: number;
+    /** Server caps at 50 parameters per step. */
+    parameters?: Parameter[];
+}
+interface Attachment {
+    /** Required, max 255 chars. */
+    name: string;
+    /** Optional, max 1024 chars — informational only, never fetched server-side. */
+    path?: string;
+    /** Optional, max 255 chars. */
+    mimeType?: string;
+    /** Base64-encoded content, max 2,097,152 characters (~1.5MB decoded binary).
+     * Mutually exclusive with `storageKey` — used for small inline attachments. */
+    content?: string;
+    /** R2 object key from a prior `POST /api/v1/attachments/upload-url` call —
+     * mutually exclusive with `content`. Used for attachments too large to
+     * inline (video); if both are set, `storageKey` wins server-side. Max 1024
+     * chars. */
+    storageKey?: string;
+    /** Set when this is a video the reporter copied into the same output
+     * directory as the report file, rather than uploading it itself —
+     * `qualflare-cli` resolves this into a real `storageKey` at collect time.
+     * Relative to the report file's own directory. Never sent to `/collect`
+     * directly; mutually exclusive with `content`/`storageKey`. */
+    localVideoPath?: string;
+    /** Byte size of the object at `storageKey`. Ignored when `storageKey` is
+     * unset. */
+    fileSize?: number;
+    /** 0-based index into the Case's `steps[]` this attachment belongs to.
+     * Omit for a case-level (not step-level) attachment. */
+    stepIndex?: number;
+}
+interface Case {
+    /** Required. A stable per-test identifier used for flaky-history matching
+     * across separate runs — must stay the same for what a human would call
+     * "the same test" across renames you want tracked together. */
+    id: string;
+    /** Required, 1-255 chars. */
+    name: string;
+    /** Max 255 chars. */
+    className?: string;
+    /** Max 10000 chars. */
+    description?: string;
+    status: CaseStatus;
+    /** NANOSECONDS — see `NanosecondDuration`. */
+    duration: NanosecondDuration;
+    retryCount?: number;
+    isFlaky?: boolean;
+    /** Truncated server-side at 65536 runes, never validation-rejected — send
+     * the full error/stack text, don't pre-truncate. */
+    error?: string;
+    /** Unrecognized values are silently normalized/dropped server-side, never
+     * rejects the request. */
+    priority?: CasePriority;
+    /** Max 64 items, each max 255 chars. */
+    tags?: string[];
+    properties?: Record<string, string>;
+    /** Max 50 items. */
+    attachments?: Attachment[];
+    /** Server caps at 1000 items and truncates individual fields — never
+     * validation-rejected, send freely. */
+    steps?: Step[];
+    /** Not validated; the server drops an out-of-range value rather than
+     * rejecting the request. */
+    shardIndex?: number;
+    /** RFC3339. */
+    startedAt?: string;
+    /** Max 100 items. */
+    labels?: Label[];
+    /** Max 20 items. */
+    links?: Link[];
+}
+interface Suite {
+    /** Required, 1-255 chars. One Suite per Playwright spec file. */
+    name: string;
+    category?: FrameworkCategory;
+    assertions?: number;
+    /** NANOSECONDS — see `NanosecondDuration`. */
+    duration: NanosecondDuration;
+    /** RFC3339. */
+    timestamp?: string;
+    /** Max 64 chars. Per-suite override of the launch-level `browser` — omit
+     * to inherit the launch value. */
+    browser?: string;
+    /** Max 64 chars. Per-suite override of the launch-level `os`. */
+    os?: string;
+    properties?: Record<string, string>;
+    /** Max 5000 items. */
+    cases: Case[];
+}
+interface Collect {
+    /** Required, 1-100 chars. */
+    framework: string;
+    platform: Platform;
+    /** Required, 1-100 chars. */
+    os: string;
+    /** Max 64 chars. */
+    browser: string;
+    /** ALWAYS present as value-or-null on the wire — never omit this key. */
+    branch: string | null;
+    /** ALWAYS present as value-or-null on the wire — never omit this key. */
+    commit: string | null;
+    /** Required, 1-100 chars. Must already exist server-side (404 if not) —
+     * every project seeds `development`/`staging`/`production`/`qa` by
+     * default. */
+    environment: string;
+    /** Required, BCP47 (e.g. "en-US"). */
+    language: string;
+    /** ALWAYS present as value-or-null on the wire — never omit this key. */
+    milestone: number | null;
+    metadata: Metadata | null;
+    properties?: Record<string, string>;
+    /** Max 2000 items. */
+    suites: Suite[];
+    /** Max 64 chars. Free text, no enum — an unrecognized CI provider must
+     * never reject the request. */
+    ciProvider?: string;
+    /** Max 128 chars. */
+    ciBuildNumber?: string;
+    /** Must be a valid URL, max 2048 chars. */
+    ciRunUrl?: string;
+    /** Must be >= 1. */
+    ciPrNumber?: number;
+}
+
+/** Options for the reporter, passed as the second element of its entry in
+ * `playwright.config.ts`'s `reporter` array:
+ * `['@qualflare/playwright/reporter', { ... }]`. Every field here also has an
+ * environment-variable override — see the precedence table in
+ * `docs/CONFIGURATION.md`. */
+interface QualflarePlaywrightOptions {
+    environment?: string;
+    language?: string;
+    milestone?: number | null;
+    branch?: string | null;
+    commit?: string | null;
+    platform?: Platform;
+    framework?: string;
+    os?: string;
+    browser?: string;
+    properties?: Record<string, string>;
+    /** Max 64 chars. Free text, no enum — an unrecognized CI provider must
+     * never be rejected. Auto-detected via `ci-detect.ts` when omitted. */
+    ciProvider?: string;
+    ciBuildNumber?: string;
+    ciRunUrl?: string;
+    ciPrNumber?: number;
+    attachScreenshots?: boolean;
+    /** Include Playwright's runner-internal steps — `pw:api` (every
+     * `page.click()`, `locator.fill()`, ...) and `fixture` (the implicit
+     * `browser`/`context`/`page` setup every browser test opens with) — as
+     * reported Steps.
+     *
+     * Off by default: a single browser test routinely produces hundreds of
+     * them, which buries the user-authored `test.step()`/`expect` boundaries
+     * that are actually legible in a report and blows through
+     * MAX_STEPS_PER_TEST_ATTEMPT on noise. A step that FAILED is always kept
+     * regardless of this setting, since a failing API call or fixture is
+     * usually the single most useful line in the trace. */
+    includeApiSteps?: boolean;
+    maxAttachmentBytes?: number;
+    maxTotalAttachmentBytes?: number;
+    /** Per-video byte cap, checked before the file is written. Default 50MB,
+     * matching the server's own hard cap. */
+    maxVideoBytes?: number;
+    debug?: boolean;
+    /** `false` fully disables accumulation/upload (a complete no-op) but the
+     * reporter still no-ops cleanly rather than throwing. */
+    enabled?: boolean;
+    /** Directory `onEnd()` writes this process's report file (and any
+     * video attachments) into. Default `./qualflare-results`. Always active —
+     * this reporter never uploads anything itself; `qualflare-cli` reads
+     * whatever ends up in this directory. Every JSON file this process writes
+     * is uniquely named, so multiple shards can safely share one `outputDir`
+     * without colliding — see docs/LIMITATIONS.md. */
+    outputDir?: string;
+    /** This process's 0-based position among parallel shards of the same CI
+     * run, stamped onto every case it reports. Purely a label: `qualflare-cli`
+     * merges by "every file in the directory", not by this value, so an
+     * unset shardIndex costs attribution, never correctness.
+     *
+     * Auto-detected, in order: `QUALFLARE_SHARD_INDEX`, then Playwright's own
+     * `--shard i/N`, which it exposes to reporters as `FullConfig.shard`
+     * ({ current, total }). Playwright's `current` is 1-BASED, so the reporter
+     * converts it before passing it here as `deps.detectedShardIndex`.
+     *
+     * This is the one place Playwright is markedly better than its siblings:
+     * Cypress has no shard concept at all, and cucumber-js hides its `--shard`
+     * from formatters entirely (forcing an argv scrape). Here the runner just
+     * tells us. */
+    shardIndex?: number;
+}
+interface ResolvedReporterConfig {
+    environment: string;
+    language: string;
+    milestone: number | null;
+    branch: string | null;
+    commit: string | null;
+    platform: Platform;
+    framework: string;
+    os?: string;
+    browser?: string;
+    properties?: Record<string, string>;
+    ciProvider?: string;
+    ciBuildNumber?: string;
+    ciRunUrl?: string;
+    ciPrNumber?: number;
+    attachScreenshots: boolean;
+    includeApiSteps: boolean;
+    maxAttachmentBytes: number;
+    maxTotalAttachmentBytes: number;
+    maxVideoBytes: number;
+    debug: boolean;
+    enabled: boolean;
+    outputDir: string;
+    shardIndex?: number;
+}
+
+export type { Attachment as A, CasePriority as C, FrameworkCategory as F, LinkType as L, Metadata as M, NanosecondDuration as N, Parameter as P, QualflarePlaywrightOptions as Q, ResolvedReporterConfig as R, Step as S, Case as a, CaseStatus as b, Collect as c, Label as d, Link as e, Platform as f, Suite as g };

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@qualflare/playwright",
+  "version": "0.1.0",
+  "description": "Native Playwright reporter for the Qualflare test-management platform.",
+  "keywords": [
+    "qualflare",
+    "playwright",
+    "playwright-reporter",
+    "test-reporter",
+    "e2e",
+    "test-results",
+    "flaky-tests",
+    "test-reporting"
+  ],
+  "homepage": "https://qualflare.com",
+  "bugs": {
+    "url": "https://github.com/Qualflare/qualflare-playwright/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Qualflare/qualflare-playwright.git"
+  },
+  "license": "Apache-2.0",
+  "author": "Qualflare",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./reporter": {
+      "types": "./dist/reporter/index.d.ts",
+      "import": "./dist/reporter/index.js",
+      "require": "./dist/reporter/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.40.0"
+  },
+  "dependencies": {
+    "ci-info": "^4.0.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.56.0",
+    "@types/node": "^18.19.50",
+    "eslint": "^9.9.1",
+    "execa": "^9.3.1",
+    "prettier": "^3.3.3",
+    "tsup": "^8.2.4",
+    "typescript": "^5.6.2",
+    "typescript-eslint": "^8.5.0",
+    "vitest": "^2.0.5"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "test": "vitest run test/unit",
+    "test:integration": "vitest run test/integration --pool=forks --testTimeout=120000",
+    "test:all": "npm run test && npm run test:integration",
+    "prepublishOnly": "npm run build"
+  }
+}