@kinora/reporter 0.1.3 → 0.2.0

package/README.md

@@ -51,11 +51,37 @@ Create an API token in the kinora dashboard (Settings → Workspace). Self-hosti
 | `project` | `{ slug: string, name?: string }`    | required                     | Target project. `name` defaults to `slug`. |
 | `url`     | `string`                             | env `KINORA_URL`, then cloud | kinora server base URL. Set for self-host. |
 | `token`   | `string`                             | env `KINORA_TOKEN`           | Project API token. Prefer the env var.     |
-| `git`     | `{ sha?, branch?, repoUrl? }`        | auto on GitHub Actions       | Git metadata. `repoUrl` links a sha to its commit. |
+| `git`     | `{ sha?, branch?, baseBranch?, repoUrl? }` | auto on GitHub Actions | Git metadata. `repoUrl` links a sha to its commit; `baseBranch` powers "regression vs base" in the PR comment. |
 | `ci`      | `{ provider?, runUrl?, runNumber? }` | auto on GitHub Actions       | CI metadata for the run.                   |
+| `prComment` | `boolean \| { label?, policy? }`   | off                          | Post/update a summary comment on the GitHub PR (see below). |
 
 On GitHub Actions, `git` and `ci` are filled from the standard `GITHUB_*` env vars (including the repo URL, so shas link to their commit in the dashboard). Pass them explicitly on other CI providers.
 
+## GitHub PR comment
+
+On a `pull_request` run, the reporter can post (and keep updating) a summary comment on the PR: pass/fail counts, tests newly failing vs the base branch, and a link to the run. It uses the job's ambient `GITHUB_TOKEN`, so no credentials are stored in kinora.
+
+```ts
+reporter: [['@kinora/reporter', { project: { slug: 'web-app' }, prComment: true }]]
+```
+
+The workflow must grant write access to PRs:
+
+```yaml
+# in your workflow job:
+permissions:
+  pull-requests: write # required for the PR comment
+steps:
+  - run: npx playwright test
+    env:
+      KINORA_TOKEN: ${{ secrets.KINORA_TOKEN }}
+```
+
+- Same-repo PRs only: `GITHUB_TOKEN` is read-only on fork PRs, so the comment is skipped there.
+- Shard your run with `merge-reports` (blob report) so one merged run posts one comment; per-shard runs are skipped.
+- Matrix builds sharing a PR: set `prComment: { label: 'node20' }` so each leg keeps its own comment.
+- `policy: 'on-failure'` skips the comment on green runs (default posts always).
+
 ## CI example (GitHub Actions)
 
 ```yaml

package/dist/index.d.mts

@@ -14,6 +14,14 @@ interface KinoraReporterOptions {
   };
   git?: GitMeta;
   ci?: CiMeta;
+  /**
+   * Post/update a summary comment on the GitHub PR (uses the job's GITHUB_TOKEN; needs
+   * `permissions: pull-requests: write`). `label` distinguishes matrix legs sharing one PR.
+   */
+  prComment?: boolean | {
+    label?: string;
+    policy?: 'always' | 'on-failure';
+  };
 }
 declare class KinoraReporter implements Reporter {
   private readonly options;
@@ -22,6 +30,7 @@ declare class KinoraReporter implements Reporter {
   constructor(options: KinoraReporterOptions);
   onBegin(config: FullConfig, suite: Suite): void;
   onEnd(result: FullResult): Promise<void>;
+  private maybePostPrComment;
 }
 //#endregion
 export { KinoraReporterOptions, KinoraReporter as default };

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, IngestError, createIngestClient, effectiveAttachments, isTraceAttachment, makeTestKey } from "@kinora/core";
+import { DEFAULT_KINORA_URL, IngestError, createIngestClient, effectiveAttachments, isTraceAttachment, makeTestKey, postPrComment, resolvePrContext } from "@kinora/core";
 //#region src/index.ts
 function identity(test) {
 	let file = "";
@@ -70,12 +71,14 @@ function countsOf(tests) {
 function detectGit() {
 	const sha = process.env.GITHUB_SHA;
 	const branch = process.env.GITHUB_REF_NAME;
+	const baseBranch = process.env.GITHUB_BASE_REF || void 0;
 	const { GITHUB_SERVER_URL, GITHUB_REPOSITORY } = process.env;
 	const repoUrl = GITHUB_SERVER_URL && GITHUB_REPOSITORY ? `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}` : void 0;
 	if (!sha && !branch && !repoUrl) return void 0;
 	return {
 		sha,
 		branch,
+		baseBranch,
 		repoUrl
 	};
 }
@@ -125,7 +128,8 @@ var KinoraReporter = class {
 		try {
 			const client = createIngestClient({
 				baseUrl: url,
-				token
+				token,
+				regression: !!this.options.prComment
 			});
 			const res = await client.uploadRun(payload);
 			let traces = 0;
@@ -145,11 +149,43 @@ var KinoraReporter = class {
 				}
 			}
 			console.log(`[kinora] uploaded ${res.tests} tests + ${traces} traces (run ${res.runId})`);
+			await this.maybePostPrComment(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 maybePostPrComment(payload, res) {
+		if (!this.options.prComment) return;
+		const opt = this.options.prComment;
+		const label = typeof opt === "object" ? opt.label : void 0;
+		const policy = typeof opt === "object" ? opt.policy : void 0;
+		try {
+			const ctx = resolvePrContext(this.config?.shard ? {
+				...process.env,
+				__KINORA_IS_SHARD: "1"
+			} : process.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: payload.run.counts,
+				regression: res.regression
+			}, 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);
+		}
+	}
 };
 //#endregion
 export { KinoraReporter as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kinora/reporter",
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Playwright reporter that uploads test results to a kinora server",
   "author": "Joris Gallot",
   "license": "MIT",
@@ -36,16 +36,19 @@
     "@playwright/test": ">=1.40.0"
   },
   "dependencies": {
-    "@kinora/core": "0.1.3"
+    "@kinora/core": "0.2.0"
   },
   "devDependencies": {
     "@playwright/test": "^1.61.0",
     "@types/node": "^26.0.0",
+    "@vitest/coverage-v8": "^4.1.9",
     "tsdown": "^0.22.3",
-    "typescript": "~6.0.3"
+    "typescript": "~6.0.3",
+    "vitest": "^4.1.9"
   },
   "scripts": {
     "build": "tsdown",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --coverage"
   }
 }