@kinora/vitest-reporter 0.5.0 → 0.6.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 { Reporter, TestModule, Vitest } from "vitest/node";
 type IncludeTests = 'browser' | 'all';
 export interface KinoraVitestReporterOptions {
@@ -28,6 +28,18 @@ export interface KinoraVitestReporterOptions {
    * tell the legs apart. `false` uploads each shard as its own run.
    */
   groupKey?: string | false;
+  /**
+   * Post/update a summary comment on the GitHub PR (uses the job's GITHUB_TOKEN; needs
+   * `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?: 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. `label` distinguishes matrix legs, defaulting to the `prComment` one.
+   */
+  prStatus?: PrStatusOption;
 }
 export default class KinoraVitestReporter implements Reporter {
   private readonly options;
@@ -37,5 +49,6 @@ export default class KinoraVitestReporter implements Reporter {
   onInit(vitest: Vitest): void;
   onTestRunStart(): void;
   onTestRunEnd(modules: ReadonlyArray<TestModule>): Promise<void>;
+  private maybePostToPr;
 }
 export {};

package/dist/index.mjs

@@ -1,6 +1,7 @@
+import { readFileSync } from "node:fs";
 import { readFile } from "node:fs/promises";
 import process from "node:process";
-import { DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, MAX_A11Y_NODES, MAX_A11Y_VIOLATIONS, STORY_ANNOTATION, artifactsToUpload, axeViolations, createIngestClient, describeRetry, detectCiEnv, makeTestKey, resolveShardGroup, stripAnsi, uploadArtifacts } from "@kinora/core";
+import { DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, MAX_A11Y_NODES, MAX_A11Y_VIOLATIONS, STORY_ANNOTATION, artifactsToUpload, axeViolations, createIngestClient, describeRetry, detectCiEnv, flakyTestsOf, makeTestKey, postToPr, prLegLabel, resolvePrContext, resolvePrReportOptions, resolveShardGroup, stripAnsi, uploadArtifacts } from "@kinora/core";
 // src/convert.ts
 function identity(test) {
 	const file = test.module.relativeModuleId;
@@ -203,7 +204,11 @@ var KinoraVitestReporter = class {
 			return;
 		}
 		const { tests, skippedNodeTests } = toNormTests(modules, this.options.include);
-		const group = this.shard && this.options.groupKey !== false ? resolveShardGroup(process.env, { groupKey: this.options.groupKey }) : void 0;
+		const prOptions = resolvePrReportOptions(this.options.prComment, this.options.prStatus);
+		const group = this.shard && this.options.groupKey !== false ? resolveShardGroup(process.env, {
+			groupKey: this.options.groupKey,
+			leg: prLegLabel(prOptions)
+		}) : void 0;
 		if (!tests.length) {
 			if (!group) {
 				console.warn(skippedNodeTests ? `[kinora] nothing uploaded: no browser tests in this run (${skippedNodeTests} Node tests left out). Set include: 'all' to upload Node tests too.` : "[kinora] nothing uploaded: no tests ran");
@@ -234,6 +239,7 @@ var KinoraVitestReporter = class {
 			const client = createIngestClient({
 				baseUrl: url,
 				token,
+				regression: !!(prOptions.comment || prOptions.status),
 				onRetry: (info) => console.warn(`[kinora] ${describeRetry(info)}`)
 			});
 			const res = await client.uploadRun(payload);
@@ -242,10 +248,42 @@ var KinoraVitestReporter = class {
 				onFailed: (a, err) => console.warn(`[kinora] ${a.name} upload failed for ${a.testKey}:`, err instanceof Error ? err.message : err)
 			});
 			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.maybePostToPr(prOptions, 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);
 		}
 	}
+	async maybePostToPr(opts, payload, res) {
+		if (!opts.comment && !opts.status) return;
+		if (this.shard && !res.shardProgress) return;
+		const ctx = resolvePrContext(process.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 { KinoraVitestReporter as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kinora/vitest-reporter",
   "type": "module",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Vitest reporter that uploads browser-mode and Storybook test results to a kinora server",
   "author": "Joris Gallot",
   "license": "MIT",
@@ -37,7 +37,7 @@
     "vitest": ">=4.1.12"
   },
   "dependencies": {
-    "@kinora/core": "0.16.0"
+    "@kinora/core": "0.18.0"
   },
   "devDependencies": {
     "@types/node": "^26.6.6",