@kinora/reporter 0.15.0 → 0.16.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { AttachmentKind, CiMeta, GitMeta } from "@kinora/core";
+import { AttachmentKind, CiMeta, GitMeta, PrCommentOption, PrStatusOption } from "@kinora/core";
 import { FullConfig, FullResult, Reporter, Suite } from "@playwright/test/reporter";
 export interface KinoraReporterOptions {
   /** kinora server base URL. Defaults to env KINORA_URL, then the hosted cloud. Set for self-host. */
@@ -17,10 +17,14 @@ export interface KinoraReporterOptions {
    * `permissions: pull-requests: write`) or the GitLab MR (needs a GITLAB_TOKEN CI variable with
    * the `api` scope). `label` distinguishes matrix legs sharing one PR.
    */
-  prComment?: boolean | {
-    label?: string;
-    policy?: 'always' | 'on-failure';
-  };
+  prComment?: PrCommentOption;
+  /**
+   * Set a `kinora / <project>` commit status on the GitHub PR (needs `permissions: statuses: write`)
+   * or the GitLab MR pipeline (GITLAB_TOKEN with the Developer role): red only for tests newly
+   * failing vs the base branch, so branch protection or "Pipelines must succeed" can require it.
+   * `label` distinguishes matrix legs, defaulting to the `prComment` one.
+   */
+  prStatus?: PrStatusOption;
   /**
    * Which attachment kinds to upload. Defaults to `['trace', 'snapshot']` (`snapshot` = the images
    * of a failed screenshot assertion, shown as a comparison). Add `'video'` / `'screenshot'`
@@ -43,6 +47,6 @@ export default class KinoraReporter implements Reporter {
   onBegin(config: FullConfig, suite: Suite): void;
   onEnd(result: FullResult): Promise<void>;
   private shard;
-  private prCommentLabel;
-  private maybePostPrComment;
+  private prOptions;
+  private maybePostToPr;
 }

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { readFileSync, statSync } from "node:fs";
 import { readFile } from "node:fs/promises";
 import process from "node:process";
-import { DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, a11yFromScans, artifactsToUpload, createIngestClient, describeRetry, detectCiEnv, effectiveAttachments, flakyTestsOf, makeTestKey, parseAxeScan, postPrComment, resolvePrContext, resolveShardGroup, shardFromEnv, uploadArtifacts } from "@kinora/core";
+import { DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, a11yFromScans, artifactsToUpload, createIngestClient, describeRetry, detectCiEnv, effectiveAttachments, flakyTestsOf, makeTestKey, parseAxeScan, postToPr, prLegLabel, resolvePrContext, resolvePrReportOptions, resolveShardGroup, shardFromEnv, uploadArtifacts } from "@kinora/core";
 // src/index.ts
 function identity(test) {
 	let file = "";
@@ -107,7 +107,7 @@ var KinoraReporter = class {
 		const shard = this.shard();
 		const group = shard && this.options.groupKey !== false ? resolveShardGroup(process.env, {
 			groupKey: this.options.groupKey,
-			leg: this.prCommentLabel()
+			leg: prLegLabel(this.prOptions())
 		}) : void 0;
 		const baseUrls = [...new Set((this.config?.projects ?? []).flatMap((p) => p.use.baseURL ? [p.use.baseURL] : []))];
 		const payload = {
@@ -137,7 +137,7 @@ var KinoraReporter = class {
 			const client = createIngestClient({
 				baseUrl: url,
 				token,
-				regression: !!this.options.prComment,
+				regression: !!(this.options.prComment || this.options.prStatus),
 				onRetry: (info) => console.warn(`[kinora] ${describeRetry(info)}`)
 			});
 			const res = await client.uploadRun(payload);
@@ -147,7 +147,7 @@ var KinoraReporter = class {
 			});
 			console.log(`[kinora] uploaded ${res.tests} tests + ${artifacts} artifacts (run ${res.runId}${res.shardProgress ? `, ${res.shardProgress.landed} of ${res.shardProgress.total} shards` : ""})`);
 			if (res.incident) console.warn(`[kinora] environment incident, not counted: ${res.incident.reason}`);
-			await this.maybePostPrComment(payload, res);
+			await this.maybePostToPr(payload, res);
 		} catch (err) {
 			if (err instanceof IngestError && err.status === 402) console.warn(`[kinora] ${err.message}`);
 			else console.error(`[kinora] upload failed:`, err instanceof Error ? err.message : err);
@@ -156,49 +156,44 @@ var KinoraReporter = class {
 	shard() {
 		return this.config?.shard ?? shardFromEnv(process.env);
 	}
-	prCommentLabel() {
-		const opt = this.options.prComment;
-		return typeof opt === "object" ? opt.label : void 0;
+	prOptions() {
+		return resolvePrReportOptions(this.options.prComment, this.options.prStatus);
 	}
-	async maybePostPrComment(payload, res) {
-		if (!this.options.prComment) return;
-		const opt = this.options.prComment;
-		const label = this.prCommentLabel();
-		const policy = typeof opt === "object" ? opt.policy : void 0;
+	async maybePostToPr(payload, res) {
+		const opts = this.prOptions();
+		if (!opts.comment && !opts.status) return;
 		const grouped = !!payload.run.groupKey;
 		if (grouped && !res.shardProgress) return;
-		try {
-			const env = this.shard() && !grouped ? {
-				...process.env,
-				__KINORA_IS_SHARD: "1"
-			} : process.env;
-			const ctx = resolvePrContext(env, (p) => {
-				try {
-					return readFileSync(p, "utf8");
-				} catch {
-					return;
-				}
-			});
-			if (!ctx) return;
-			const outcome = await postPrComment(ctx, {
-				projectSlug: payload.project.slug,
-				projectName: payload.project.name,
-				label,
-				runUrl: res.runUrl,
-				ciRunUrl: payload.run.ci?.runUrl,
-				counts: res.counts ?? payload.run.counts,
-				regression: res.regression,
-				flaky: res.flaky ?? flakyTestsOf(payload.tests),
-				...res.shardProgress && { shards: {
-					runId: res.runId,
-					...res.shardProgress
-				} },
-				...res.incident && { incident: res.incident }
-			}, policy ?? "always");
-			if (outcome !== "skipped") console.warn(`[kinora] PR comment ${outcome}`);
-		} catch (err) {
-			console.warn("[kinora] PR comment failed:", err instanceof Error ? err.message : err);
-		}
+		const env = this.shard() && !grouped ? {
+			...process.env,
+			__KINORA_IS_SHARD: "1"
+		} : process.env;
+		const ctx = resolvePrContext(env, (p) => {
+			try {
+				return readFileSync(p, "utf8");
+			} catch {
+				return;
+			}
+		});
+		if (!ctx) return;
+		await postToPr(ctx, opts, {
+			projectSlug: payload.project.slug,
+			projectName: payload.project.name,
+			runUrl: res.runUrl,
+			ciRunUrl: payload.run.ci?.runUrl,
+			counts: res.counts ?? payload.run.counts,
+			regression: res.regression,
+			flaky: res.flaky ?? flakyTestsOf(payload.tests),
+			baseBranch: payload.run.git?.baseBranch,
+			...res.shardProgress && { shards: {
+				runId: res.runId,
+				...res.shardProgress
+			} },
+			...res.incident && { incident: res.incident }
+		}, {
+			info: (m) => console.warn(`[kinora] ${m}`),
+			warn: (m) => console.warn(`[kinora] ${m}`)
+		});
 	}
 };
 export { KinoraReporter as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kinora/reporter",
   "type": "module",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Playwright reporter that uploads test results to a kinora server",
   "author": "Joris Gallot",
   "license": "MIT",
@@ -45,7 +45,7 @@
     }
   },
   "dependencies": {
-    "@kinora/core": "0.17.0"
+    "@kinora/core": "0.18.0"
   },
   "devDependencies": {
     "@axe-core/playwright": "^4.14.0",