@isummation/kasauti-playwright-reporter 0.2.0

package/README.md

@@ -0,0 +1,17 @@
+# @isummation/kasauti-playwright-reporter
+
+Sends Playwright results to [Kasauti](https://gitlab.isummation.com/isummation-product/kasauti), with the screenshots, videos and traces Playwright keeps and anything tests attach. No dependencies.
+
+```bash
+npm install -D @isummation/kasauti-playwright-reporter   # needs access to the @isummation npm org
+```
+
+```ts
+// playwright.config.ts
+reporter: [['list'], ['@isummation/kasauti-playwright-reporter', { project: 'SHOP' }]],
+use: { screenshot: 'only-on-failure', video: 'retain-on-failure', trace: 'retain-on-failure' },
+```
+
+Tag tests with case keys (`test('pays by card @SHOP-12', …)`); untagged tests become draft cases on first run. Set `KASAUTI_URL` and `KASAUTI_TOKEN`; optional `KASAUTI_RUN_TITLE`, `KASAUTI_ENV`, `KASAUTI_RUN`. Without a token it does nothing. Files over 20 MB are skipped.
+
+Full guide: `docs/using-kasauti-in-your-project.md` in the Kasauti repository.

package/index.mjs

@@ -0,0 +1,115 @@
+// Playwright → Kasauti reporter. Zero dependencies.
+//
+//   // playwright.config.ts
+//   reporter: [['list'], ['@isummation/kasauti-playwright-reporter', { project: 'DEMO' }]]
+//
+// Link a test to an existing case with a tag in the title (`test('login works @DEMO-12', ...)`)
+// or an annotation ({ type: 'kasauti', description: 'DEMO-12' }). Untagged tests are matched by
+// suite path + title and auto-created as draft automated cases on first run.
+// Env: KASAUTI_URL, KASAUTI_TOKEN, KASAUTI_PROJECT, KASAUTI_RUN (report into an existing run), KASAUTI_RUN_TITLE.
+import { readFileSync, statSync } from 'node:fs';
+import { basename } from 'node:path';
+
+const STATUS = { passed: 'passed', failed: 'failed', timedOut: 'failed', interrupted: 'blocked', skipped: 'skipped' };
+const MAX_ATTACHMENT = 20 * 1024 * 1024; // the API's per-file limit
+const MAX_BATCH = 20 * 1024 * 1024; // base64 per request, under the API's 30 MB body limit
+
+export default class KasautiReporter {
+  constructor(opts = {}) {
+    this.url = (opts.url ?? process.env.KASAUTI_URL ?? 'http://localhost:3001').replace(/\/$/, '');
+    this.token = opts.token ?? process.env.KASAUTI_TOKEN;
+    this.project = opts.project ?? process.env.KASAUTI_PROJECT;
+    this.run = opts.run ?? process.env.KASAUTI_RUN;
+    this.title = opts.title ?? process.env.KASAUTI_RUN_TITLE ?? `Playwright ${new Date().toISOString().slice(0, 16).replace('T', ' ')}`;
+    this.results = [];
+  }
+
+  async api(method, path, body) {
+    const res = await fetch(this.url + path, { method, headers: { authorization: `Bearer ${this.token}`, 'content-type': 'application/json' }, body: body && JSON.stringify(body) });
+    if (!res.ok) throw new Error(`Kasauti ${method} ${path} → ${res.status}: ${await res.text()}`);
+    return res.json();
+  }
+
+  onBegin() {
+    if (!this.token || !this.project) {
+      console.warn('[kasauti] KASAUTI_TOKEN and project are required; reporting disabled');
+      this.disabled = true;
+    }
+  }
+
+  onTestEnd(test, result) {
+    if (this.disabled) return;
+    // only the final attempt counts
+    if (result.status !== 'passed' && result.retry < test.retries && result.status !== 'skipped') return;
+    const tag = test.annotations.find((a) => a.type === 'kasauti')?.description ?? / @([A-Z][A-Z0-9]{1,9}-\d+)\b/.exec(test.title)?.[1];
+    const [, , ...path] = test.titlePath(); // drop root + project; keep file > describe... > title
+    const title = path.pop().replace(/ @[A-Z][A-Z0-9]{1,9}-\d+\b/g, '').trim();
+    this.results.push({
+      ...(tag ? { case: tag } : { title, suite: path.join('/') }),
+      status: STATUS[result.status] ?? 'invalid',
+      durationMs: result.duration,
+      comment: result.errors?.map((e) => stripAnsi(e.message ?? '')).join('\n\n') || undefined,
+      stacktrace: result.errors?.map((e) => frames(stripAnsi(e.stack ?? ''))).filter(Boolean).join('\n\n') || undefined,
+      attachments: fit(result.attachments.flatMap(file).slice(0, 10)),
+    });
+  }
+
+  async onEnd() {
+    if (this.disabled || !this.results.length) return;
+    try {
+      const run = this.run ?? (await this.api('POST', '/runs', { project: this.project, title: this.title, source: 'automation', environment: process.env.KASAUTI_ENV })).key;
+      for (const results of batches(this.results)) await this.api('POST', `/k/${run}/results/bulk`, { results });
+      if (!this.run) await this.api('POST', `/k/${run}/complete`);
+      console.log(`[kasauti] ${this.results.length} results → ${this.url}/k/${run}`);
+    } catch (e) {
+      console.error('[kasauti]', e.message);
+    }
+  }
+
+  printsToStdio() {
+    return false;
+  }
+}
+
+// Screenshots, videos and traces Playwright recorded (use: { screenshot, video, trace }), plus anything a test
+// attached itself: testInfo.attach('cart', { body: await page.screenshot(), contentType: 'image/png' }).
+function file(a) {
+  const body = a.body ?? (a.path && statSync(a.path, { throwIfNoEntry: false })?.isFile() ? readFileSync(a.path) : null);
+  if (!body) return [];
+  if (body.length > MAX_ATTACHMENT) {
+    console.warn(`[kasauti] skipped ${a.name} (${(body.length / 1048576).toFixed(1)} MB; the limit is 20 MB)`);
+    return [];
+  }
+  const kind = a.contentType.startsWith('image/') ? 'screenshot' : a.contentType.startsWith('video/') ? 'video' : a.name === 'trace' ? 'trace' : 'file';
+  const ext = { 'image/png': '.png', 'image/jpeg': '.jpg', 'video/webm': '.webm', 'text/plain': '.txt', 'application/json': '.json' }[a.contentType] ?? '';
+  return [{ kind, filename: a.path ? basename(a.path) : a.name + (a.name.includes('.') ? '' : ext), mime: a.contentType, base64: body.toString('base64') }];
+}
+
+// One result's files go in one request, so they must fit one: keep the earliest ones (failure screenshot first).
+function fit(files) {
+  let size = 0;
+  return files.filter((f) => {
+    if (size + f.base64.length > MAX_BATCH) return void console.warn(`[kasauti] skipped ${f.filename}: this result's files are over 20 MB`);
+    size += f.base64.length;
+    return true;
+  });
+}
+
+// At most 100 results and MAX_BATCH of files per request: one failing suite with videos can be hundreds of MB.
+function* batches(results) {
+  let batch = [], size = 0;
+  for (const r of results) {
+    const n = r.attachments.reduce((t, a) => t + a.base64.length, 0);
+    if (batch.length && (batch.length === 100 || size + n > MAX_BATCH)) {
+      yield batch;
+      (batch = []), (size = 0);
+    }
+    batch.push(r);
+    size += n;
+  }
+  if (batch.length) yield batch;
+}
+
+const stripAnsi = (s) => s.replace(/\u001b\[[0-9;]*m/g, '');
+// A stack starts with the error message, which already goes in the comment: keep only the frames.
+const frames = (stack) => stack.split('\n').filter((l) => /^\s+at /.test(l)).join('\n');

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@isummation/kasauti-playwright-reporter",
+  "version": "0.2.0",
+  "description": "Send Playwright results, with screenshots, videos and traces, to Kasauti",
+  "type": "module",
+  "main": "./index.mjs",
+  "exports": "./index.mjs",
+  "files": [
+    "index.mjs",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.40"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.isummation.com:isummation-product/kasauti.git",
+    "directory": "packages/playwright-reporter"
+  },
+  "publishConfig": {
+    "access": "restricted",
+    "registry": "https://registry.npmjs.org/"
+  }
+}