@kinora/reporter 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,76 @@
+# @kinora/reporter
+
+Playwright reporter that uploads your test results to a [kinora](https://github.com/joris-gallot/kinora) server: pass rates, trends, flaky tests, and the full Playwright trace for failures, across projects and over time.
+
+It runs on `onEnd`, posts the normalized run, then uploads the trace.zip for each failed/flaky test that has one. Upload never fails your test run.
+
+## Install
+
+```bash
+npm i -D @kinora/reporter
+# or: pnpm add -D @kinora/reporter
+```
+
+`@playwright/test` (>=1.40) is a peer dependency.
+
+## Usage
+
+Add it to `playwright.config.ts`:
+
+```ts
+import { defineConfig } from '@playwright/test'
+
+export default defineConfig({
+  reporter: [['@kinora/reporter', { project: { slug: 'web-app' } }]],
+  // enable tracing so failures upload a trace
+  use: { trace: 'on-first-retry' },
+})
+```
+
+The server URL and token come from the environment (keep the token out of the config file):
+
+```bash
+KINORA_URL=https://kinora.example.com KINORA_TOKEN=<project-token> npx playwright test
+```
+
+Create a project API token in the kinora dashboard (Settings → API tokens).
+
+## Options
+
+```ts
+[
+  '@kinora/reporter',
+  {
+    project: { slug: 'web-app', name: 'Web App' },
+  },
+]
+```
+
+| Option    | Type                                 | Default                | Description                                |
+| --------- | ------------------------------------ | ---------------------- | ------------------------------------------ |
+| `project` | `{ slug: string, name?: string }`    | required               | Target project. `name` defaults to `slug`. |
+| `url`     | `string`                             | env `KINORA_URL`       | kinora server base URL.                    |
+| `token`   | `string`                             | env `KINORA_TOKEN`     | Project API token. Prefer the env var.     |
+| `git`     | `{ sha?, branch? }`                  | auto on GitHub Actions | Git metadata for the run.                  |
+| `ci`      | `{ provider?, runUrl?, runNumber? }` | auto on GitHub Actions | CI metadata for the run.                   |
+
+On GitHub Actions, `git` and `ci` are filled from the standard `GITHUB_*` env vars. Pass them explicitly on other CI providers.
+
+## CI example (GitHub Actions)
+
+```yaml
+- run: npx playwright test
+  env:
+    KINORA_URL: ${{ vars.KINORA_URL }}
+    KINORA_TOKEN: ${{ secrets.KINORA_TOKEN }}
+```
+
+## Notes
+
+- If `KINORA_URL` or `KINORA_TOKEN` is missing, the reporter logs a warning and skips the upload, so local runs aren't affected.
+- Traces are uploaded only for tests that produced one, so enable `trace` in your Playwright config (`on-first-retry`, `retain-on-failure`, etc.).
+- Cross-run test identity is the file + title path + Playwright project name, so history stays stable as long as those don't change.
+
+## License
+
+MIT

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { readFile } from "node:fs/promises";
 import process from "node:process";
-import { createIngestClient, isTraceAttachment, makeTestKey } from "@kinora/core";
+import { IngestError, createIngestClient, isTraceAttachment, makeTestKey } from "@kinora/core";
 //#region src/index.ts
 function identity(test) {
 	let file = "";
@@ -143,7 +143,8 @@ var KinoraReporter = class {
 			}
 			console.log(`[kinora] uploaded ${res.tests} tests + ${traces} traces (run ${res.runId})`);
 		} catch (err) {
-			console.error(`[kinora] upload failed:`, err instanceof Error ? err.message : 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/reporter",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Playwright reporter that uploads test results to a kinora server",
   "author": "Joris Gallot",
   "license": "MIT",
@@ -32,21 +32,20 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "tsdown",
-    "typecheck": "tsc --noEmit",
-    "prepublishOnly": "tsdown"
-  },
   "peerDependencies": {
     "@playwright/test": ">=1.40.0"
   },
   "dependencies": {
-    "@kinora/core": "workspace:*"
+    "@kinora/core": "0.0.2"
   },
   "devDependencies": {
     "@playwright/test": "^1.60.0",
     "@types/node": "^24.12.3",
     "tsdown": "^0.22.2",
     "typescript": "~6.0.2"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit"
   }
-}
+}