playwright-notion-reporter 1.0.0

package/README.md

@@ -0,0 +1,131 @@
+# playwright-notion-reporter
+
+A [Playwright reporter](https://playwright.dev/docs/test-reporters) that creates a row in a Notion database after each test run with pass/fail counts, flaky test detection, and optional metadata columns.
+
+## Installation
+
+```bash
+npm install playwright-notion-reporter
+```
+
+## Notion setup
+
+1. Create a [Notion integration](https://www.notion.so/my-integrations) and copy the **Internal Integration Secret**.
+2. Create a database for test runs and share it with your integration.
+3. Copy the database ID from the database URL (`https://notion.so/{workspace}/{database_id}?v=...`).
+
+Your database needs properties that match the column names you configure below. The reporter writes these property types automatically:
+
+| Config key | Notion property type | Description |
+|---|---|---|
+| `passed`, `failed`, `skipped`, `flaky`, `total` | Number | Test counts |
+| `duration` (optional) | Number | Total run duration in seconds |
+| `status` (optional) | Select | `Passed` or `Failed` — create both options in Notion |
+| `columns` entries | Depends on `type` | See [Custom columns](#custom-columns) |
+
+Property names must match your Notion column names exactly.
+
+## Usage
+
+Add the reporter to `playwright.config.ts`:
+
+```ts
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  reporter: [
+    ['list'],
+    [
+      'playwright-notion-reporter',
+      {
+        apiKey: process.env.NOTION_API_KEY!,
+        databaseId: process.env.NOTION_DATABASE_ID!,
+        statusColumns: {
+          passed: 'Passed',
+          failed: 'Failed',
+          skipped: 'Skipped',
+          flaky: 'Flaky',
+          total: 'Total',
+          duration: 'Duration',
+          status: 'Status',
+        },
+        columns: [
+          {
+            column_name: 'Branch',
+            value: process.env.GITHUB_REF_NAME,
+            type: 'rich_text',
+          },
+          {
+            column_name: 'Run URL',
+            value: process.env.GITHUB_SERVER_URL
+              ? `${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`
+              : undefined,
+            type: 'url',
+          },
+        ],
+      },
+    ],
+  ],
+});
+```
+
+Store secrets in environment variables — never commit your Notion API key.
+
+If `apiKey` or `databaseId` is missing, the reporter logs a message and skips the Notion request without failing the test run.
+
+## Configuration
+
+### `NotionReporterOptions`
+
+| Option | Type | Required | Description |
+|---|---|---|---|
+| `apiKey` | `string` | Yes | Notion integration token |
+| `databaseId` | `string` | Yes | Target Notion database ID |
+| `statusColumns` | `NotionStatusColumns` | Yes | Maps computed values to Notion property names |
+| `columns` | `NotionColumn[]` | No | Extra metadata columns; skipped when `value` is empty |
+
+### `statusColumns`
+
+| Key | Required | Notion type | Description |
+|---|---|---|---|
+| `passed` | Yes | Number | Tests that passed on the first attempt |
+| `failed` | Yes | Number | Tests that failed, timed out, or were interrupted |
+| `skipped` | Yes | Number | Skipped tests |
+| `flaky` | Yes | Number | Tests that passed after at least one retry |
+| `total` | Yes | Number | Sum of passed, failed, skipped, and flaky |
+| `duration` | No | Number | Run duration in seconds |
+| `status` | No | Select | Overall outcome: `Passed` or `Failed` |
+
+### Custom columns
+
+Each entry in `columns` has:
+
+| Field | Type | Description |
+|---|---|---|
+| `column_name` | `string` | Notion property name |
+| `value` | `string \| undefined` | Value to write; omitted when falsy |
+| `type` | `NotionPropertyType` | Defaults to `rich_text` |
+
+Supported `type` values: `title`, `rich_text`, `select`, `date`, `url`.
+
+## How counts are computed
+
+- **Passed** — final attempt status is `passed` with no retries.
+- **Flaky** — final attempt status is `passed` after one or more retries.
+- **Failed** — final attempt status is `failed`, `timedOut`, or `interrupted`.
+- **Skipped** — final attempt status is `skipped`.
+
+Only the last attempt per test is counted.
+
+## Development
+
+```bash
+git clone <repo-url>
+cd playwright-notion-reporter
+npm install
+npm run build
+```
+
+## License
+
+ISC

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import type { FullConfig, FullResult, Reporter, Suite, TestCase, TestResult } from '@playwright/test/reporter';
+export type NotionPropertyType = 'title' | 'rich_text' | 'select' | 'date' | 'url';
+export interface NotionColumn {
+    column_name: string;
+    value: string | undefined;
+    /** Notion property type. Defaults to 'rich_text'. */
+    type?: NotionPropertyType;
+}
+/** Column names for values the reporter computes automatically. */
+export interface NotionStatusColumns {
+    passed: string;
+    failed: string;
+    skipped: string;
+    flaky: string;
+    total: string;
+    /** Column for total run duration in seconds. */
+    duration?: string;
+    /** Column for overall run outcome. Written as a select with value 'Passed' or 'Failed'. */
+    status?: string;
+}
+export interface NotionReporterOptions {
+    /** Notion integration token passed from reporter config. */
+    apiKey: string;
+    /** Notion database ID passed from reporter config. */
+    databaseId: string;
+    /** Column names for the values the reporter computes. */
+    statusColumns: NotionStatusColumns;
+    /** Free-form metadata columns. Skipped when value is empty. */
+    columns?: NotionColumn[];
+}
+declare class NotionReporter implements Reporter {
+    private readonly options;
+    private readonly apiKey;
+    private readonly databaseId;
+    private startTime;
+    private attempts;
+    constructor(options: NotionReporterOptions);
+    onBegin(_config: FullConfig, _suite: Suite): void;
+    onTestEnd(test: TestCase, result: TestResult): void;
+    onEnd(result: FullResult): Promise<void>;
+    printsToStdio(): boolean;
+}
+export default NotionReporter;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,UAAU,EACX,MAAM,2BAA2B,CAAC;AAKnC,MAAM,MAAM,kBAAkB,GAC1B,OAAO,GACP,WAAW,GACX,QAAQ,GACR,MAAM,GACN,KAAK,CAAC;AAEV,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,qDAAqD;IACrD,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED,mEAAmE;AACnE,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2FAA2F;IAC3F,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,aAAa,EAAE,mBAAmB,CAAC;IACnC,+DAA+D;IAC/D,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;CAC1B;AAyBD,cAAM,cAAe,YAAW,QAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwB;IAChD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,QAAQ,CAAkC;gBAEtC,OAAO,EAAE,qBAAqB;IAM1C,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,GAAG,IAAI;IAIjD,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI;IAK7C,KAAK,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAgG9C,aAAa,IAAI,OAAO;CAGzB;AAED,eAAe,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const NOTION_API_VERSION = '2026-03-11';
+const FETCH_TIMEOUT_MS = 10000;
+function toNotionProperty(value, type = 'rich_text') {
+    switch (type) {
+        case 'title':
+            return { title: [{ text: { content: value } }] };
+        case 'select':
+            return { select: { name: value } };
+        case 'date':
+            return { date: { start: value } };
+        case 'url':
+            return { url: value };
+        default:
+            return { rich_text: [{ text: { content: value } }] };
+    }
+}
+class NotionReporter {
+    constructor(options) {
+        this.startTime = 0;
+        this.attempts = new Map();
+        this.options = options;
+        this.apiKey = options.apiKey;
+        this.databaseId = options.databaseId;
+    }
+    onBegin(_config, _suite) {
+        this.startTime = Date.now();
+    }
+    onTestEnd(test, result) {
+        // Always overwrite so only the last attempt per test is counted
+        this.attempts.set(test.id, { status: result.status, retry: result.retry });
+    }
+    async onEnd(result) {
+        const { apiKey, databaseId } = this;
+        if (!apiKey || !databaseId) {
+            console.log('[NotionReporter] Skipped: apiKey or databaseId not provided in reporter config.');
+            return;
+        }
+        const duration = Math.round((Date.now() - this.startTime) / 1000);
+        const counts = { passed: 0, failed: 0, skipped: 0, flaky: 0 };
+        for (const attempt of this.attempts.values()) {
+            if (attempt.status === 'passed' && attempt.retry > 0) {
+                counts.flaky++;
+            }
+            else if (attempt.status === 'passed') {
+                counts.passed++;
+            }
+            else if (attempt.status === 'failed' ||
+                attempt.status === 'timedOut' ||
+                attempt.status === 'interrupted') {
+                counts.failed++;
+            }
+            else if (attempt.status === 'skipped') {
+                counts.skipped++;
+            }
+        }
+        const total = counts.passed + counts.failed + counts.skipped + counts.flaky;
+        const runStatus = result.status === 'passed' ? 'Passed' : 'Failed';
+        const col = this.options.statusColumns;
+        const properties = {
+            [col.passed]: { number: counts.passed },
+            [col.failed]: { number: counts.failed },
+            [col.skipped]: { number: counts.skipped },
+            [col.flaky]: { number: counts.flaky },
+            [col.total]: { number: total },
+        };
+        if (col.duration)
+            properties[col.duration] = { number: duration };
+        if (col.status)
+            properties[col.status] = { select: { name: runStatus } };
+        for (const column of this.options.columns ?? []) {
+            if (column.value) {
+                properties[column.column_name] = toNotionProperty(column.value, column.type);
+            }
+        }
+        const abort = new AbortController();
+        const timer = setTimeout(() => abort.abort(), FETCH_TIMEOUT_MS);
+        try {
+            const response = await fetch('https://api.notion.com/v1/pages', {
+                method: 'POST',
+                headers: {
+                    Authorization: `Bearer ${apiKey}`,
+                    'Content-Type': 'application/json',
+                    'Notion-Version': NOTION_API_VERSION,
+                },
+                body: JSON.stringify({
+                    parent: { database_id: databaseId },
+                    properties,
+                }),
+                signal: abort.signal,
+            });
+            if (!response.ok) {
+                const text = await response.text();
+                console.error(`[NotionReporter] Failed to create Notion record: ${response.status} ${text}`);
+            }
+            else {
+                console.log(`[NotionReporter] Test run recorded in Notion ` +
+                    `(${runStatus}: ${counts.passed} passed, ${counts.failed} failed, ` +
+                    `${counts.skipped} skipped, ${counts.flaky} flaky — ${total} total).`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error && error.name === 'AbortError') {
+                console.error(`[NotionReporter] Request timed out after ${FETCH_TIMEOUT_MS / 1000}s.`);
+            }
+            else {
+                console.error('[NotionReporter] Error posting to Notion:', error);
+            }
+        }
+        finally {
+            clearTimeout(timer);
+        }
+    }
+    printsToStdio() {
+        return true;
+    }
+}
+exports.default = NotionReporter;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AASA,MAAM,kBAAkB,GAAG,YAAY,CAAC;AACxC,MAAM,gBAAgB,GAAG,KAAM,CAAC;AA6ChC,SAAS,gBAAgB,CACvB,KAAa,EACb,OAA2B,WAAW;IAEtC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO;YACV,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC;QACnD,KAAK,QAAQ;YACX,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACrC,KAAK,MAAM;YACT,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC;QACpC,KAAK,KAAK;YACR,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QACxB;YACE,OAAO,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC;IACzD,CAAC;AACH,CAAC;AAED,MAAM,cAAc;IAOlB,YAAY,OAA8B;QAHlC,cAAS,GAAG,CAAC,CAAC;QACd,aAAQ,GAAG,IAAI,GAAG,EAAuB,CAAC;QAGhD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACvC,CAAC;IAED,OAAO,CAAC,OAAmB,EAAE,MAAa;QACxC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC9B,CAAC;IAED,SAAS,CAAC,IAAc,EAAE,MAAkB;QAC1C,gEAAgE;QAChE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAAkB;QAC5B,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAEpC,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3B,OAAO,CAAC,GAAG,CACT,iFAAiF,CAClF,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;QAClE,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QAE9D,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;YAC7C,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;gBACrD,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,CAAC;iBAAM,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACvC,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,CAAC;iBAAM,IACL,OAAO,CAAC,MAAM,KAAK,QAAQ;gBAC3B,OAAO,CAAC,MAAM,KAAK,UAAU;gBAC7B,OAAO,CAAC,MAAM,KAAK,aAAa,EAChC,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,CAAC;iBAAM,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACxC,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;QAC5E,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QACnE,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;QAEvC,MAAM,UAAU,GAA4B;YAC1C,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;YACvC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;YACvC,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE;YACzC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE;YACrC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;SAC/B,CAAC;QAEF,IAAI,GAAG,CAAC,QAAQ;YAAE,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAClE,IAAI,GAAG,CAAC,MAAM;YAAE,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC;QAEzE,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;YAChD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAC/C,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,IAAI,CACZ,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,gBAAgB,CAAC,CAAC;QAEhE,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,iCAAiC,EAAE;gBAC9D,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,MAAM,EAAE;oBACjC,cAAc,EAAE,kBAAkB;oBAClC,gBAAgB,EAAE,kBAAkB;iBACrC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,MAAM,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE;oBACnC,UAAU;iBACX,CAAC;gBACF,MAAM,EAAE,KAAK,CAAC,MAAM;aACrB,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACnC,OAAO,CAAC,KAAK,CACX,oDAAoD,QAAQ,CAAC,MAAM,IAAI,IAAI,EAAE,CAC9E,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CACT,+CAA+C;oBAC7C,IAAI,SAAS,KAAK,MAAM,CAAC,MAAM,YAAY,MAAM,CAAC,MAAM,WAAW;oBACnE,GAAG,MAAM,CAAC,OAAO,aAAa,MAAM,CAAC,KAAK,YAAY,KAAK,UAAU,CACxE,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBAC1D,OAAO,CAAC,KAAK,CACX,4CAA4C,gBAAgB,GAAG,IAAI,IAAI,CACxE,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,KAAK,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,kBAAe,cAAc,CAAC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "playwright-notion-reporter",
+  "version": "1.0.0",
+  "description": "Playwright reporter that records test run results to a Notion database",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "playwright",
+    "notion",
+    "reporter",
+    "testing"
+  ],
+  "author": "Iana Hilario <icd.hilario@gmail.com>",
+  "license": "ISC",
+  "peerDependencies": {
+    "@playwright/test": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.52.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4"
+  }
+}