@kinora/vitest-reporter 0.1.0 → 0.3.0

package/README.md

@@ -37,6 +37,13 @@ Create an API token in the kinora dashboard (Settings → Workspace). Self-hosti
 
 Only browser tests are uploaded by default: Node unit tests are usually thousands of fast tests with no trace, and would eat your plan's monthly result quota. Upload them too with `include: 'all'`.
 
+## Accessibility
+
+With Storybook's a11y addon, each story's check is uploaded too: the rules broken, their impact
+and the elements they hit, ranked by component on the Components page. Use the addon's `todo`
+mode to keep the impact: in `error` mode, Storybook drops the check when the story fails and
+kinora reads the violations from the failure instead.
+
 ## Documentation
 
 **https://docs.kinora.dev/guides/vitest/**

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import { Reporter, TestModule, Vitest } from "vitest/node";
 type IncludeTests = 'browser' | 'all';
 //#endregion
 //#region src/index.d.ts
-interface KinoraVitestReporterOptions {
+export interface KinoraVitestReporterOptions {
   /** kinora server base URL. Defaults to env KINORA_URL, then the hosted cloud. Set for self-host. */
   url?: string;
   /** Project API token. Defaults to env KINORA_TOKEN (keep it out of the config file). */
@@ -24,14 +24,22 @@ interface KinoraVitestReporterOptions {
    * plan's monthly result quota with large unit suites.
    */
   include?: IncludeTests;
+  /**
+   * Sharded runs (`--shard`): the uploads of every shard of a CI run are assembled into a single
+   * kinora run. Shards are grouped by this key, defaulting to env KINORA_GROUP_KEY, then the CI run
+   * (GITHUB_RUN_ID / CI_PIPELINE_ID). Set it when a matrix runs the sharded suite once per leg, to
+   * tell the legs apart. `false` uploads each shard as its own run.
+   */
+  groupKey?: string | false;
 }
-declare class KinoraVitestReporter implements Reporter {
+export default class KinoraVitestReporter implements Reporter {
   private readonly options;
   private startedAt;
+  private shard;
   constructor(options: KinoraVitestReporterOptions);
   onInit(vitest: Vitest): void;
   onTestRunStart(): void;
   onTestRunEnd(modules: ReadonlyArray<TestModule>): Promise<void>;
 }
 //#endregion
-export { KinoraVitestReporterOptions, KinoraVitestReporter as default };
+export {};

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { readFile } from "node:fs/promises";
 import process from "node:process";
-import { DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, STORY_ANNOTATION, createIngestClient, detectCiEnv, isUploadableAttachment, makeTestKey, stripAnsi } from "@kinora/core";
+import { DEFAULT_KINORA_URL, DEFAULT_UPLOAD_ATTACHMENTS, IngestError, MAX_A11Y_NODES, MAX_A11Y_VIOLATIONS, STORY_ANNOTATION, axeViolations, createIngestClient, detectCiEnv, isUploadableAttachment, makeTestKey, resolveShardGroup, stripAnsi } from "@kinora/core";
 //#region src/convert.ts
 function identity(test) {
 	const file = test.module.relativeModuleId;
@@ -28,6 +28,49 @@ function storyOf(test, titlePath) {
 	if (!meta.componentName) return meta.storyId.replace("--", "/");
 	return `${meta.componentName}/${titlePath[1]}`;
 }
+const MAX_TEXT = 300;
+const truncate = (s) => s.length > MAX_TEXT ? `${s.slice(0, MAX_TEXT)}…` : s;
+const AXE_FAILURE = /Expected the HTML found at \$\('(.+?)'\) to have no violations:[\s\S]*?Received:\s*"(.+?) \(([\w-]+)\)"[\s\S]*?more information on this issue here:\s*(https:\/\/\S+)/g;
+function a11yFromError(test) {
+	const message = test.result().errors?.find((e) => e.message.includes("toHaveNoViolations"))?.message;
+	if (!message) return void 0;
+	const byRule = /* @__PURE__ */ new Map();
+	for (const [, target, help, id, helpUrl] of stripAnsi(message).matchAll(AXE_FAILURE)) {
+		const v = byRule.get(id) ?? {
+			id,
+			help: truncate(help),
+			helpUrl,
+			nodes: [],
+			nodeCount: 0
+		};
+		if (v.nodes.length < MAX_A11Y_NODES) v.nodes.push(truncate(target));
+		v.nodeCount++;
+		byRule.set(id, v);
+	}
+	return byRule.size ? {
+		status: "failed",
+		violations: [...byRule.values()].slice(0, MAX_A11Y_VIOLATIONS)
+	} : void 0;
+}
+function a11yOf(test) {
+	const report = test.meta().reports?.find((r) => r.type === "a11y");
+	const status = report?.status;
+	if (status !== "passed" && status !== "warning" && status !== "failed") return a11yFromError(test);
+	const result = report?.result ?? {};
+	if (result.error) {
+		const { message } = result.error;
+		const text = typeof message === "string" ? message : typeof result.error === "string" ? result.error : "The accessibility check failed.";
+		return {
+			status: "failed",
+			violations: [],
+			error: truncate(text)
+		};
+	}
+	return {
+		status,
+		violations: axeViolations(result.violations)
+	};
+}
 function slug(name) {
 	return name.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "") || "screenshot";
 }
@@ -75,6 +118,7 @@ function toNormTest(test) {
 	const { file, titlePath, projectName } = identity(test);
 	const diagnostic = test.diagnostic();
 	const story = storyOf(test, titlePath);
+	const a11y = a11yOf(test);
 	return {
 		testKey: makeTestKey(file, titlePath, projectName),
 		title: test.name,
@@ -99,7 +143,8 @@ function toNormTest(test) {
 			message: cleanMessage(e.message),
 			stack: e.stack
 		})),
-		attachments: attachmentsOf(test)
+		attachments: attachmentsOf(test),
+		...a11y && { a11y }
 	};
 }
 function toNormTests(modules, include = "browser") {
@@ -134,11 +179,17 @@ function countsOf(tests) {
 var KinoraVitestReporter = class {
 	options;
 	startedAt = /* @__PURE__ */ new Date();
+	shard;
 	constructor(options) {
 		this.options = options;
 	}
 	onInit(vitest) {
 		this.startedAt = /* @__PURE__ */ new Date();
+		const shard = vitest.config.shard;
+		this.shard = shard ? {
+			current: shard.index,
+			total: shard.count
+		} : void 0;
 		vitest.config.includeTaskLocation = true;
 		for (const project of vitest.projects) project.config.includeTaskLocation = true;
 	}
@@ -153,9 +204,13 @@ 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;
 		if (!tests.length) {
-			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");
-			return;
+			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");
+				return;
+			}
+			console.warn("[kinora] no tests to upload in this shard: filling its slot so the run can complete");
 		}
 		const detected = detectCiEnv(process.env);
 		const payload = {
@@ -168,7 +223,11 @@ var KinoraVitestReporter = class {
 				duration: Date.now() - this.startedAt.getTime(),
 				counts: countsOf(tests),
 				git: this.options.git ?? detected.git,
-				ci: this.options.ci ?? detected.ci
+				ci: this.options.ci ?? detected.ci,
+				...this.shard && group && {
+					...group,
+					shard: this.shard
+				}
 			},
 			tests
 		};
@@ -195,7 +254,7 @@ var KinoraVitestReporter = class {
 					console.warn(`[kinora] ${a.name} upload failed for ${t.testKey}:`, err instanceof Error ? err.message : err);
 				}
 			}
-			console.log(`[kinora] uploaded ${res.tests} tests + ${artifacts} artifacts (run ${res.runId})`);
+			console.log(`[kinora] uploaded ${res.tests} tests + ${artifacts} artifacts (run ${res.runId}${res.shardProgress ? `, ${res.shardProgress.landed} of ${res.shardProgress.total} shards` : ""})`);
 		} 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);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kinora/vitest-reporter",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Vitest reporter that uploads browser-mode and Storybook test results to a kinora server",
   "author": "Joris Gallot",
   "license": "MIT",
@@ -28,23 +28,23 @@
     "dist"
   ],
   "engines": {
-    "node": ">=20"
+    "node": ">=20.20.2"
   },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
-    "vitest": ">=4.1.0"
+    "vitest": ">=4.1.12"
   },
   "dependencies": {
-    "@kinora/core": "0.7.0"
+    "@kinora/core": "0.13.0"
   },
   "devDependencies": {
-    "@types/node": "^26.5.1",
-    "@vitest/coverage-v8": "^5.0.3",
-    "tsdown": "^0.22.14",
+    "@types/node": "^26.6.5",
+    "@vitest/coverage-v8": "^5.0.5",
+    "tsdown": "^0.23.1",
     "typescript": "~6.0.3",
-    "vitest": "^5.0.3"
+    "vitest": "^5.0.5"
   },
   "scripts": {
     "build": "tsdown",