testlens-playwright-reporter 0.2.8 → 0.2.9

package/README.md

@@ -0,0 +1,87 @@
+# TestLens Playwright Reporter
+
+A Playwright reporter for [TestLens](https://testlens.qa-path.com) - real-time test monitoring dashboard.
+
+## Features
+
+- 🚀 **Real-time streaming** - Watch test results as they happen in the dashboard
+- 📸 **Artifact support** - Shows screenshots, videos, and traces
+- 🔄 **Retry tracking** - Monitor test retries and identify flaky tests
+- ⚡ **Cross-platform** - Works on Windows, macOS, and Linux
+
+## Installation
+
+```bash
+npm install testlens-playwright-reporter
+```
+
+## Configuration
+
+### TypeScript (`playwright.config.ts`)
+
+```typescript
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  use: {
+    // Enable these for better debugging and artifact capture
+    screenshot: 'on',
+    video: 'on',
+    trace: 'on',
+  },
+  reporter: [
+    ['testlens-playwright-reporter', {
+      apiKey: 'your-api-key-here',
+    }]
+  ],
+});
+```
+
+### JavaScript (`playwright.config.js`)
+
+```javascript
+const { defineConfig } = require('@playwright/test');
+
+module.exports = defineConfig({
+  use: {
+    // Enable these for better debugging and artifact capture
+    screenshot: 'on',
+    video: 'on',
+    trace: 'on',
+  },
+  reporter: [
+    ['testlens-playwright-reporter', {
+      apiKey: 'your-api-key-here',
+    }]
+  ],
+});
+```
+
+> 💡 **Tip:** Keep `screenshot`, `video`, and `trace` set to `'on'` for better debugging experience. TestLens automatically uploads these artifacts for failed tests, making it easier to identify issues.
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `apiKey` | `string` | **Required** | Your TestLens API key |
+
+## Artifacts
+
+TestLens automatically captures and uploads:
+
+| Artifact | Description |
+|----------|-------------|
+| **Screenshots** | Visual snapshots of test failures |
+| **Videos** | Full video recording of test execution |
+| **Traces** | Playwright trace files for step-by-step debugging |
+
+These artifacts are viewable directly in the TestLens dashboard for easy debugging.
+
+## Requirements
+
+- Node.js >= 16.0.0
+- Playwright >= 1.40.0
+
+## License
+
+MIT License

package/index.js

@@ -250,7 +250,73 @@ class TestLensReporter {
 
   async onTestEnd(test, result) {
     const testId = this.getTestId(test);
-    const testData = this.testMap.get(testId);
+    let testData = this.testMap.get(testId);
+
+    console.log(`[TestLens] onTestEnd called for test: ${test.title}, status: ${result.status}, testData exists: ${!!testData}`);
+
+    // For skipped tests, onTestBegin might not be called, so we need to create the test data here
+    if (!testData) {
+      console.log(`[TestLens] Creating test data for skipped/uncreated test: ${test.title}`);
+      // Create spec data if not exists (skipped tests might not have spec data either)
+      const specPath = test.location.file;
+      const specKey = `${specPath}-${test.parent.title}`;
+      
+      if (!this.specMap.has(specKey)) {
+        const specData = {
+          filePath: path.relative(process.cwd(), specPath),
+          testSuiteName: test.parent.title,
+          tags: this.extractTags(test),
+          startTime: new Date().toISOString(),
+          status: 'skipped'
+        };
+        this.specMap.set(specKey, specData);
+
+        // Send spec start event to API
+        await this.sendToApi({
+          type: 'specStart',
+          runId: this.runId,
+          timestamp: new Date().toISOString(),
+          spec: specData
+        });
+      }
+
+      // Create test data for skipped test
+      testData = {
+        id: testId,
+        name: test.title,
+        status: 'skipped',
+        originalStatus: 'skipped',
+        duration: 0,
+        startTime: new Date().toISOString(),
+        endTime: new Date().toISOString(),
+        errorMessages: [],
+        errors: [],
+        retryAttempts: test.retries,
+        currentRetry: 0,
+        annotations: test.annotations.map(ann => ({
+          type: ann.type,
+          description: ann.description
+        })),
+        projectName: test.parent.project()?.name || 'default',
+        workerIndex: result.workerIndex,
+        parallelIndex: result.parallelIndex,
+        location: {
+          file: path.relative(process.cwd(), test.location.file),
+          line: test.location.line,
+          column: test.location.column
+        }
+      };
+
+      this.testMap.set(testId, testData);
+
+      // Send test start event first (so the test gets created in DB)
+      await this.sendToApi({
+        type: 'testStart',
+        runId: this.runId,
+        timestamp: new Date().toISOString(),
+        test: testData
+      });
+    }
 
     if (testData) {
       // Update test data with latest result
@@ -356,6 +422,7 @@ class TestLensReporter {
       const isFinalAttempt = result.status === 'passed' || result.status === 'skipped' || result.retry >= test.retries;
       
       if (isFinalAttempt) {
+        console.log(`[TestLens] Sending testEnd - testId: ${testData.id}, status: ${testData.status}, originalStatus: ${testData.originalStatus}`);
         // Send test end event to API
         await this.sendToApi({
           type: 'testEnd',
@@ -741,7 +808,9 @@ class TestLensReporter {
 
   getTestId(test) {
     const cleanTitle = test.title.replace(/@[\w-]+/g, '').trim();
-    return `${test.location.file}:${test.location.line}:${cleanTitle}`;
+    // Normalize path separators to forward slashes for cross-platform consistency
+    const normalizedFile = test.location.file.replace(/\\/g, '/');
+    return `${normalizedFile}:${test.location.line}:${cleanTitle}`;
   }
 
   getFileSize(filePath) {

package/index.ts

@@ -409,7 +409,73 @@ export class TestLensReporter implements Reporter {
 
   async onTestEnd(test: TestCase, result: TestResult): Promise<void> {
     const testId = this.getTestId(test);
-    const testData = this.testMap.get(testId);
+    let testData = this.testMap.get(testId);
+
+    console.log(`[TestLens] onTestEnd called for test: ${test.title}, status: ${result.status}, testData exists: ${!!testData}`);
+
+    // For skipped tests, onTestBegin might not be called, so we need to create the test data here
+    if (!testData) {
+      console.log(`[TestLens] Creating test data for skipped/uncreated test: ${test.title}`);
+      // Create spec data if not exists (skipped tests might not have spec data either)
+      const specPath = test.location.file;
+      const specKey = `${specPath}-${test.parent.title}`;
+      
+      if (!this.specMap.has(specKey)) {
+        const specData: SpecData = {
+          filePath: path.relative(process.cwd(), specPath),
+          testSuiteName: test.parent.title,
+          tags: this.extractTags(test),
+          startTime: new Date().toISOString(),
+          status: 'skipped'
+        };
+        this.specMap.set(specKey, specData);
+
+        // Send spec start event to API
+        await this.sendToApi({
+          type: 'specStart',
+          runId: this.runId,
+          timestamp: new Date().toISOString(),
+          spec: specData
+        });
+      }
+
+      // Create test data for skipped test
+      testData = {
+        id: testId,
+        name: test.title,
+        status: 'skipped',
+        originalStatus: 'skipped',
+        duration: 0,
+        startTime: new Date().toISOString(),
+        endTime: new Date().toISOString(),
+        errorMessages: [],
+        errors: [],
+        retryAttempts: test.retries,
+        currentRetry: 0,
+        annotations: test.annotations.map((ann: any) => ({
+          type: ann.type,
+          description: ann.description
+        })),
+        projectName: test.parent.project()?.name || 'default',
+        workerIndex: result.workerIndex,
+        parallelIndex: result.parallelIndex,
+        location: {
+          file: path.relative(process.cwd(), test.location.file),
+          line: test.location.line,
+          column: test.location.column
+        }
+      };
+
+      this.testMap.set(testId, testData);
+
+      // Send test start event first (so the test gets created in DB)
+      await this.sendToApi({
+        type: 'testStart',
+        runId: this.runId,
+        timestamp: new Date().toISOString(),
+        test: testData
+      });
+    }
 
     if (testData) {
       // Update test data with latest result
@@ -515,6 +581,7 @@ export class TestLensReporter implements Reporter {
       const isFinalAttempt = result.status === 'passed' || result.status === 'skipped' || result.retry >= test.retries;
       
       if (isFinalAttempt) {
+        console.log(`[TestLens] Sending testEnd - testId: ${testData.id}, status: ${testData.status}, originalStatus: ${testData.originalStatus}`);
         // Send test end event to API
         await this.sendToApi({
           type: 'testEnd',
@@ -879,7 +946,9 @@ export class TestLensReporter implements Reporter {
 
   private getTestId(test: TestCase): string {
     const cleanTitle = test.title.replace(/@[\w-]+/g, '').trim();
-    return `${test.location.file}:${test.location.line}:${cleanTitle}`;
+    // Normalize path separators to forward slashes for cross-platform consistency
+    const normalizedFile = test.location.file.replace(/\\/g, '/');
+    return `${normalizedFile}:${test.location.line}:${cleanTitle}`;
   }
 
 

package/lib/index.js

@@ -264,7 +264,66 @@ class TestLensReporter {
     }
     async onTestEnd(test, result) {
         const testId = this.getTestId(test);
-        const testData = this.testMap.get(testId);
+        let testData = this.testMap.get(testId);
+        console.log(`[TestLens] onTestEnd called for test: ${test.title}, status: ${result.status}, testData exists: ${!!testData}`);
+        // For skipped tests, onTestBegin might not be called, so we need to create the test data here
+        if (!testData) {
+            console.log(`[TestLens] Creating test data for skipped/uncreated test: ${test.title}`);
+            // Create spec data if not exists (skipped tests might not have spec data either)
+            const specPath = test.location.file;
+            const specKey = `${specPath}-${test.parent.title}`;
+            if (!this.specMap.has(specKey)) {
+                const specData = {
+                    filePath: path.relative(process.cwd(), specPath),
+                    testSuiteName: test.parent.title,
+                    tags: this.extractTags(test),
+                    startTime: new Date().toISOString(),
+                    status: 'skipped'
+                };
+                this.specMap.set(specKey, specData);
+                // Send spec start event to API
+                await this.sendToApi({
+                    type: 'specStart',
+                    runId: this.runId,
+                    timestamp: new Date().toISOString(),
+                    spec: specData
+                });
+            }
+            // Create test data for skipped test
+            testData = {
+                id: testId,
+                name: test.title,
+                status: 'skipped',
+                originalStatus: 'skipped',
+                duration: 0,
+                startTime: new Date().toISOString(),
+                endTime: new Date().toISOString(),
+                errorMessages: [],
+                errors: [],
+                retryAttempts: test.retries,
+                currentRetry: 0,
+                annotations: test.annotations.map((ann) => ({
+                    type: ann.type,
+                    description: ann.description
+                })),
+                projectName: test.parent.project()?.name || 'default',
+                workerIndex: result.workerIndex,
+                parallelIndex: result.parallelIndex,
+                location: {
+                    file: path.relative(process.cwd(), test.location.file),
+                    line: test.location.line,
+                    column: test.location.column
+                }
+            };
+            this.testMap.set(testId, testData);
+            // Send test start event first (so the test gets created in DB)
+            await this.sendToApi({
+                type: 'testStart',
+                runId: this.runId,
+                timestamp: new Date().toISOString(),
+                test: testData
+            });
+        }
         if (testData) {
             // Update test data with latest result
             testData.originalStatus = result.status;
@@ -353,6 +412,7 @@ class TestLensReporter {
             // If test passed or this is the last retry, send the event
             const isFinalAttempt = result.status === 'passed' || result.status === 'skipped' || result.retry >= test.retries;
             if (isFinalAttempt) {
+                console.log(`[TestLens] Sending testEnd - testId: ${testData.id}, status: ${testData.status}, originalStatus: ${testData.originalStatus}`);
                 // Send test end event to API
                 await this.sendToApi({
                     type: 'testEnd',
@@ -681,7 +741,9 @@ class TestLensReporter {
     }
     getTestId(test) {
         const cleanTitle = test.title.replace(/@[\w-]+/g, '').trim();
-        return `${test.location.file}:${test.location.line}:${cleanTitle}`;
+        // Normalize path separators to forward slashes for cross-platform consistency
+        const normalizedFile = test.location.file.replace(/\\/g, '/');
+        return `${normalizedFile}:${test.location.line}:${cleanTitle}`;
     }
     async uploadArtifactToS3(filePath, testId, fileName) {
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testlens-playwright-reporter",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "Universal Playwright reporter for TestLens - works with both TypeScript and JavaScript projects",
   "main": "index.js",
   "types": "index.d.ts",