test-analytics-reporter 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 vijayravindran90
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,101 @@
+# test-analytics-reporter
+
+A Playwright test reporter that sends test results to the Test Analytics Dashboard.
+
+## Installation
+
+```bash
+npm install test-analytics-reporter
+```
+
+## Usage
+
+Add the reporter to your `playwright.config.ts`:
+
+```typescript
+import { defineConfig, devices } from '@playwright/test';
+
+export default defineConfig({
+  testDir: './tests',
+  reporter: [
+    ['html'],
+    [
+      'test-analytics-reporter',
+      {
+        backendUrl: process.env.ANALYTICS_API_URL || 'http://localhost:3001/api',
+        projectId: process.env.PROJECT_ID || 'default-project',
+        projectName: process.env.PROJECT_NAME || 'Default Project',
+        apiKey: process.env.API_KEY,
+        enabled: true,
+      },
+    ],
+  ],
+  use: {
+    baseURL: 'http://localhost:3000',
+  },
+});
+```
+
+## Environment Variables
+
+- `ANALYTICS_API_URL` - The Test Analytics API endpoint (default: `http://localhost:3001/api`)
+- `PROJECT_ID` - Your project ID in the analytics dashboard
+- `PROJECT_NAME` - Display name for your project
+- `API_KEY` - Optional API key for authentication
+
+## Configuration
+
+### Reporter Options
+
+```typescript
+{
+  backendUrl: string;      // Test Analytics API URL
+  projectId: string;       // Project identifier
+  projectName?: string;    // Project display name
+  apiKey?: string;         // Optional API key
+  enabled?: boolean;       // Enable/disable reporter (default: true)
+}
+```
+
+## How It Works
+
+1. Runs your Playwright tests
+2. Collects test results and metrics
+3. Sends data to Test Analytics Dashboard
+4. Displays pass rate, failure rate, flakiness, and performance metrics
+
+## Example GitHub Actions Usage
+
+```yaml
+name: Run Tests with Analytics
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - run: npm ci
+      - run: npm install @reporter/test-analytics-reporter
+      - run: npx playwright install --with-deps
+
+      - name: Run Playwright Tests
+        run: npx playwright test
+        env:
+          ANALYTICS_API_URL: ${{ secrets.ANALYTICS_API_URL }}
+          PROJECT_ID: ${{ secrets.PROJECT_ID }}
+          PROJECT_NAME: 'My Project'
+```
+
+## License
+
+MIT
+
+## Support
+
+For issues and feature requests, visit: https://github.com/vijayravindran90/Test-analytics

package/dist/reporter.d.ts

@@ -0,0 +1,25 @@
+import { Reporter, TestCase, TestResult, FullConfig } from '@playwright/test/reporter';
+interface ReporterConfig {
+    backendUrl: string;
+    projectId: string;
+    projectName: string;
+    apiKey?: string;
+    enabled?: boolean;
+    batchSize?: number;
+}
+declare class PlaywrightAnalyticsReporter implements Reporter {
+    private config;
+    private testResults;
+    private startTime;
+    private testRetries;
+    private testStartTimes;
+    constructor(config: ReporterConfig);
+    onBegin(config: FullConfig): Promise<void>;
+    onTestBegin(test: TestCase): Promise<void>;
+    onTestEnd(test: TestCase, result: TestResult): Promise<void>;
+    onEnd(): Promise<void>;
+    private sendTestResults;
+    private generateTestId;
+    private mapPlaywrightStatus;
+}
+export default PlaywrightAnalyticsReporter;

package/dist/reporter.js

@@ -0,0 +1,117 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const uuid_1 = require("uuid");
+class PlaywrightAnalyticsReporter {
+    constructor(config) {
+        this.testResults = [];
+        this.startTime = new Date();
+        this.testRetries = new Map();
+        this.testStartTimes = new Map();
+        this.config = {
+            batchSize: 50,
+            enabled: true,
+            ...config,
+        };
+    }
+    async onBegin(config) {
+        if (this.config.enabled) {
+            console.log(`[Analytics] Starting test run for project: ${this.config.projectName}`);
+        }
+    }
+    async onTestBegin(test) {
+        const testId = this.generateTestId(test);
+        this.testStartTimes.set(testId, new Date());
+        this.testRetries.set(testId, 0);
+    }
+    async onTestEnd(test, result) {
+        if (!this.config.enabled)
+            return;
+        const testId = this.generateTestId(test);
+        const startTime = this.testStartTimes.get(testId) || new Date();
+        const endTime = new Date();
+        const duration = endTime.getTime() - startTime.getTime();
+        const retries = this.testRetries.get(testId) || 0;
+        this.testRetries.set(testId, retries + 1);
+        // Map Playwright status to our status format
+        const status = this.mapPlaywrightStatus(result.status);
+        const testAnalyticsResult = {
+            id: (0, uuid_1.v4)(),
+            projectId: this.config.projectId,
+            projectName: this.config.projectName,
+            testId,
+            testName: test.title,
+            status,
+            duration,
+            retries: result.retry,
+            flakyAttempts: result.retry > 0 ? result.retry : 0,
+            startTime,
+            endTime,
+            error: result.error?.message || undefined,
+            tags: [],
+            browser: 'unknown',
+            os: 'unknown',
+            environment: process.env.TEST_ENV || 'unknown',
+            buildId: process.env.CI_BUILD_ID || process.env.GITHUB_RUN_ID,
+            branchName: process.env.CI_COMMIT_BRANCH || process.env.GITHUB_REF_NAME || 'unknown',
+            commitHash: process.env.CI_COMMIT_SHA || process.env.GITHUB_SHA,
+            author: process.env.CI_COMMIT_AUTHOR || process.env.GITHUB_ACTOR,
+        };
+        this.testResults.push(testAnalyticsResult);
+        // Send batch if we've reached batch size
+        if (this.testResults.length >= (this.config.batchSize || 50)) {
+            await this.sendTestResults();
+        }
+    }
+    async onEnd() {
+        if (!this.config.enabled)
+            return;
+        // Send remaining results
+        if (this.testResults.length > 0) {
+            await this.sendTestResults();
+        }
+        console.log(`[Analytics] Test run completed. Results sent to ${this.config.backendUrl}`);
+    }
+    async sendTestResults() {
+        if (this.testResults.length === 0)
+            return;
+        try {
+            const headers = {
+                'Content-Type': 'application/json',
+            };
+            if (this.config.apiKey) {
+                headers['Authorization'] = `Bearer ${this.config.apiKey}`;
+            }
+            await axios_1.default.post(`${this.config.backendUrl}/tests/batch`, {
+                results: this.testResults,
+                projectId: this.config.projectId,
+                projectName: this.config.projectName,
+                timestamp: new Date(),
+            }, { headers });
+            console.log(`[Analytics] Sent ${this.testResults.length} test results`);
+            this.testResults = [];
+        }
+        catch (error) {
+            console.error('[Analytics] Failed to send test results:', error);
+            // Don't throw - we don't want failed analytics to break tests
+        }
+    }
+    generateTestId(test) {
+        return `${test.location?.file || 'unknown'}::${test.title}`;
+    }
+    mapPlaywrightStatus(status) {
+        const statusMap = {
+            passed: 'PASSED',
+            failed: 'FAILED',
+            timedOut: 'TIMEOUT',
+            skipped: 'SKIPPED',
+            interrupted: 'FAILED',
+        };
+        return statusMap[status] || 'FAILED';
+    }
+}
+exports.default = PlaywrightAnalyticsReporter;
+//# sourceMappingURL=reporter.js.map

package/dist/reporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporter.js","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":";;;;;AACA,kDAA0B;AAC1B,+BAAoC;AAYpC,MAAM,2BAA2B;IAO/B,YAAY,MAAsB;QAL1B,gBAAW,GAA0B,EAAE,CAAC;QACxC,cAAS,GAAS,IAAI,IAAI,EAAE,CAAC;QAC7B,gBAAW,GAAwB,IAAI,GAAG,EAAE,CAAC;QAC7C,mBAAc,GAAsB,IAAI,GAAG,EAAE,CAAC;QAGpD,IAAI,CAAC,MAAM,GAAG;YACZ,SAAS,EAAE,EAAE;YACb,OAAO,EAAE,IAAI;YACb,GAAG,MAAM;SACV,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAkB;QAC9B,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO,CAAC,GAAG,CAAC,8CAA8C,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAc;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAc,EAAE,MAAkB;QAChD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QAEjC,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QAChE,MAAM,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;QAEzD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;QAE1C,6CAA6C;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAEvD,MAAM,mBAAmB,GAAwB;YAC/C,EAAE,EAAE,IAAA,SAAM,GAAE;YACZ,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS;YAChC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW;YACpC,MAAM;YACN,QAAQ,EAAE,IAAI,CAAC,KAAK;YACpB,MAAM;YACN,QAAQ;YACR,OAAO,EAAE,MAAM,CAAC,KAAK;YACrB,aAAa,EAAE,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClD,SAAS;YACT,OAAO;YACP,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,IAAI,SAAS;YACzC,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,SAAS;YAClB,EAAE,EAAE,SAAS;YACb,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,SAAS;YAC9C,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa;YAC7D,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,SAAS;YACpF,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU;YAC/D,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY;SACjE,CAAC;QAEF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE3C,yCAAyC;QACzC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC;YAC7D,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QAEjC,yBAAyB;QACzB,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC/B,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,mDAAmD,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEO,KAAK,CAAC,eAAe;QAC3B,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAE1C,IAAI,CAAC;YACH,MAAM,OAAO,GAA2B;gBACtC,cAAc,EAAE,kBAAkB;aACnC,CAAC;YAEF,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACvB,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAC5D,CAAC;YAED,MAAM,eAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,cAAc,EAAE;gBACxD,OAAO,EAAE,IAAI,CAAC,WAAW;gBACzB,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS;gBAChC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW;gBACpC,SAAS,EAAE,IAAI,IAAI,EAAE;aACtB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAEhB,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,CAAC,WAAW,CAAC,MAAM,eAAe,CAAC,CAAC;YACxE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC;YACjE,8DAA8D;QAChE,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,IAAc;QACnC,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;IAC9D,CAAC;IAEO,mBAAmB,CACzB,MAAoE;QAEpE,MAAM,SAAS,GAAkD;YAC/D,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,SAAS;YACnB,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,QAAQ;SACtB,CAAC;QACF,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC;IACvC,CAAC;CACF;AAED,kBAAe,2BAA2B,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "test-analytics-reporter",
+  "version": "1.0.0",
+  "description": "Playwright test reporter for sending results to Test Analytics Dashboard",
+  "main": "dist/reporter.js",
+  "types": "dist/reporter.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vijayravindran90/Test-analytics.git",
+    "directory": "packages/reporter"
+  },
+  "keywords": [
+    "playwright",
+    "test",
+    "testing",
+    "reporter",
+    "analytics",
+    "dashboard",
+    "ci-cd",
+    "automated-testing"
+  ],
+  "author": "vijayravindran90",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/vijayravindran90/Test-analytics/issues"
+  },
+  "homepage": "https://github.com/vijayravindran90/Test-analytics#readme",
+  "dependencies": {
+    "@playwright/test": "^1.40.0",
+    "axios": "^1.6.0",
+    "test-analytics-shared": "file:../shared",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/uuid": "^9.0.0",
+    "typescript": "^5.3.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}