@alternative-path/testlens-playwright-reporter 0.4.7 → 0.4.9

package/README.md

@@ -126,6 +126,88 @@ The reporter automatically reads these environment variables (no config changes
 - **API Key**: `TESTLENS_API_KEY` (also checks: `testlens_api_key`, `TESTLENS_KEY`, `testlensApiKey`, `PLAYWRIGHT_API_KEY`, `PW_API_KEY`)
 - **Build Name**: `testlensBuildName` (also checks: `TESTLENS_BUILD_NAME`, `BUILDNAME`, `BUILD_NAME`)
 - **Build Tag**: `testlensBuildTag` (also checks: `TESTLENS_BUILD_TAG`, `BUILDTAG`, `BUILD_TAG`)
+- **Execution ID** (one run per pipeline): see [One test run per pipeline execution](#one-test-run-per-pipeline-execution) below.
+
+### One test run per pipeline execution
+
+If your pipeline runs `npx playwright test` in **multiple steps**, you get one TestLens run per step. To group all steps into **one** run, set **`TESTLENS_EXECUTION_ID`** to your pipeline’s run identifier (e.g. build number or run ID) in every step. Use one of the three methods below. For per-CI examples (Bitbucket, GitHub, GitLab, Azure DevOps, Jenkins), see **[PIPELINE_EXECUTION_ID.md](./PIPELINE_EXECUTION_ID.md)**.
+
+#### 1. Environment variable (recommended in CI)
+
+Set one of these env vars **before** each Playwright step. The reporter uses the **first one it finds** (in this order):
+
+| Env var | When to use |
+|---------|--------------|
+| `TESTLENS_EXECUTION_ID` | Any pipeline; set this to your build/run ID |
+| `TestlensExecutionId`, `TestLensExecutionId`, `testlensexecutionid` | Alternative spellings |
+| `BITBUCKET_BUILD_UUID` | Bitbucket Pipelines (auto-set; no config needed) |
+| `GITHUB_RUN_ID` | GitHub Actions (auto-set) |
+| `CI_PIPELINE_ID`, `CI_JOB_ID` | GitLab CI |
+| `BUILD_BUILDID`, `SYSTEM_JOBID` | Azure DevOps |
+| `BUILD_ID`, `BUILD_NUMBER` | Jenkins |
+| `CIRCLE_WORKFLOW_ID`, `CIRCLE_BUILD_NUM` | CircleCI |
+
+**Command examples:**
+
+```bash
+# Linux / macOS
+export TESTLENS_EXECUTION_ID="${BITBUCKET_BUILD_UUID}"
+npx playwright test
+
+# Or inline
+TESTLENS_EXECUTION_ID="my-build-123" npx playwright test
+```
+
+```powershell
+# Windows PowerShell
+$env:TESTLENS_EXECUTION_ID = $env:BITBUCKET_BUILD_UUID
+npx playwright test
+
+# Or inline
+$env:TESTLENS_EXECUTION_ID="my-build-123"; npx playwright test
+```
+
+```cmd
+REM Windows CMD
+set TESTLENS_EXECUTION_ID=my-build-123 && npx playwright test
+```
+
+#### 2. Config option `executionId`
+
+In your Playwright config, set the top-level reporter option:
+
+```typescript
+// playwright.config.ts
+reporter: [
+  ['@alternative-path/testlens-playwright-reporter', {
+    apiKey: process.env.TESTLENS_API_KEY,
+    executionId: process.env.BITBUCKET_BUILD_UUID,  // or any string
+  }]
+],
+```
+
+#### 3. Config option `customMetadata`
+
+You can pass the execution ID inside `customMetadata` (as `executionId` or `TESTLENS_EXECUTION_ID`):
+
+```typescript
+// playwright.config.ts
+reporter: [
+  ['@alternative-path/testlens-playwright-reporter', {
+    apiKey: process.env.TESTLENS_API_KEY,
+    customMetadata: {
+      executionId: process.env.BITBUCKET_BUILD_UUID,
+      // or: TESTLENS_EXECUTION_ID: process.env.BITBUCKET_BUILD_UUID,
+      testlensBuildName: 'Build123',
+      testlensBuildTag: 'smoke',
+    },
+  }]
+],
+```
+
+#### Recommendation
+
+Prefer a **UUID or globally unique ID** (e.g. `BITBUCKET_BUILD_UUID`, `GITHUB_RUN_ID`) so different repos or pipelines never share the same run. Build numbers like `BUILD_NUMBER` reset per repo and can collide. See **[PIPELINE_EXECUTION_ID.md](./PIPELINE_EXECUTION_ID.md)** for per-CI examples.
 
 ### Notes
 
@@ -140,6 +222,7 @@ The reporter automatically reads these environment variables (no config changes
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
 | `apiKey` | `string` | **Required** | Your TestLens API key |
+| `executionId` | `string` | — | Optional. When set (or use env `TESTLENS_EXECUTION_ID`, any auto-detected CI run ID, or `customMetadata.executionId` / `customMetadata.TESTLENS_EXECUTION_ID`), used as run ID so multiple pipeline steps share one run. See [PIPELINE_EXECUTION_ID.md](./PIPELINE_EXECUTION_ID.md). |
 
 ## Artifacts
 

package/index.d.ts

@@ -28,6 +28,8 @@ export interface TestLensReporterConfig {
     ignoreSslErrors?: boolean;
     /** Custom metadata from CLI arguments (automatically parsed from --key=value arguments) */
     customMetadata?: Record<string, string | string[]>;
+    /** Execution ID for one run per pipeline (e.g. from TESTLENS_EXECUTION_ID or CI build UUID). When set, used as runId so multiple steps share one run. */
+    executionId?: string;
 }
 export interface TestLensReporterOptions {
     /** TestLens API endpoint URL */
@@ -58,6 +60,8 @@ export interface TestLensReporterOptions {
     ignoreSslErrors?: boolean;
     /** Custom metadata from CLI arguments (automatically parsed from --key=value arguments) */
     customMetadata?: Record<string, string | string[]>;
+    /** Execution ID for one run per pipeline (e.g. from TESTLENS_EXECUTION_ID or CI build UUID). When set, used as runId so multiple steps share one run. */
+    executionId?: string;
 }
 export interface GitInfo {
     branch: string;
@@ -99,6 +103,7 @@ export interface RunMetadata {
     passedTests?: number;
     failedTests?: number;
     skippedTests?: number;
+    timedOutTests?: number;
     status?: string;
     testlensBuildName?: string;
     customMetadata?: Record<string, string | string[]>;
@@ -156,11 +161,13 @@ export declare class TestLensReporter implements Reporter {
     private axiosInstance;
     private runId;
     private runMetadata;
+    private usedExecutionId;
     private specMap;
     private testMap;
     private runCreationFailed;
     private cliArgs;
     private pendingUploads;
+    private traceNetworkRows;
     private artifactStats;
     private artifactsSeen;
     /**

package/index.js

@@ -91,6 +91,23 @@ class TestLensReporter {
             // Support both TestLens-specific names (recommended) and common CI names
             'testlensBuildTag': ['testlensBuildTag', 'TESTLENS_BUILD_TAG', 'TESTLENS_BUILDTAG', 'BUILDTAG', 'BUILD_TAG', 'TestlensBuildTag', 'TestLensBuildTag'],
             'testlensBuildName': ['testlensBuildName', 'TESTLENS_BUILD_NAME', 'TESTLENS_BUILDNAME', 'BUILDNAME', 'BUILD_NAME', 'TestlensBuildName', 'TestLensBuildName'],
+            // Execution ID for one run per pipeline (checked in order; prefer TESTLENS_EXECUTION_ID, then CI-specific UUIDs)
+            'executionId': [
+                'TESTLENS_EXECUTION_ID',
+                'TestlensExecutionId',
+                'TestLensExecutionId',
+                'testlensexecutionid',
+                'BITBUCKET_BUILD_UUID',
+                'GITHUB_RUN_ID',
+                'CI_PIPELINE_ID',
+                'CI_JOB_ID',
+                'BUILD_BUILDID',
+                'SYSTEM_JOBID',
+                'BUILD_ID',
+                'BUILD_NUMBER',
+                'CIRCLE_WORKFLOW_ID',
+                'CIRCLE_BUILD_NUM'
+            ],
             'environment': ['ENVIRONMENT', 'ENV', 'NODE_ENV', 'DEPLOYMENT_ENV'],
             'branch': ['BRANCH', 'GIT_BRANCH', 'CI_COMMIT_BRANCH', 'GITHUB_REF_NAME'],
             'team': ['TEAM', 'TEAM_NAME'],
@@ -118,9 +135,11 @@ class TestLensReporter {
         return customArgs;
     }
     constructor(options) {
+        this.usedExecutionId = false; // True when runId came from executionId (multi-step); backend should aggregate runEnd
         this.runCreationFailed = false; // Track if run creation failed due to limits
         this.cliArgs = {}; // Store CLI args separately
         this.pendingUploads = new Set(); // Track pending artifact uploads
+        this.traceNetworkRows = []; // Network requests/responses from trace zip for current test
         this.artifactStats = {
             uploaded: { screenshot: 0, video: 0, trace: 0, attachment: 0 },
             skipped: { screenshot: 0, video: 0, trace: 0, attachment: 0 },
@@ -156,7 +175,8 @@ class TestLensReporter {
             timeout: options.timeout || 60000,
             rejectUnauthorized: options.rejectUnauthorized,
             ignoreSslErrors: options.ignoreSslErrors,
-            customMetadata: { ...options.customMetadata, ...customArgs } // Config metadata first, then CLI args override
+            customMetadata: { ...options.customMetadata, ...customArgs }, // Config metadata first, then CLI args override
+            executionId: options.executionId
         };
         if (!this.config.apiKey) {
             throw new Error('API_KEY is required for TestLensReporter. Pass it as apiKey option in your playwright config or set one of these environment variables: TESTLENS_API_KEY, TESTLENS_KEY, PLAYWRIGHT_API_KEY, PW_API_KEY, API_KEY, or APIKEY.');
@@ -222,7 +242,17 @@ class TestLensReporter {
             }
             return Promise.reject(error);
         });
-        this.runId = (0, crypto_1.randomUUID)();
+        const executionIdFromCustomMetadata = this.config.customMetadata?.executionId ?? this.config.customMetadata?.TESTLENS_EXECUTION_ID;
+        const executionIdFromCustomMetadataStr = Array.isArray(executionIdFromCustomMetadata)
+            ? executionIdFromCustomMetadata[0]
+            : executionIdFromCustomMetadata;
+        const executionIdRaw = options.executionId ??
+            process.env.TESTLENS_EXECUTION_ID ??
+            customArgs.executionId ??
+            executionIdFromCustomMetadataStr;
+        const executionId = typeof executionIdRaw === 'string' && executionIdRaw.trim() ? String(executionIdRaw).trim() : undefined;
+        this.runId = executionId || (0, crypto_1.randomUUID)();
+        this.usedExecutionId = !!executionId;
         this.runMetadata = this.initializeRunMetadata();
         this.specMap = new Map();
         this.testMap = new Map();
@@ -406,7 +436,9 @@ class TestLensReporter {
         }
     }
     async onTestEnd(test, result) {
+        this.traceNetworkRows = []; // Reset at start of each test
         const testId = this.getTestId(test);
+        let testCaseId = '';
         let testData = this.testMap.get(testId);
         logger.debug(`[ARTIFACTS] attachments=${result.attachments?.length ?? 0}`);
         if (result.attachments && result.attachments.length > 0) {
@@ -577,10 +609,15 @@ class TestLensReporter {
                 timestamp: new Date().toISOString(),
                 test: testData
             });
+            testCaseId = testEndResponse?.testCaseId;
             // Handle artifacts (test case is now guaranteed to be in database)
             if (this.config.enableArtifacts) {
-                // Pass test case DB ID if available for faster lookups
-                await this.processArtifacts(testId, result, testEndResponse?.testCaseId);
+                // Pass test case DB ID if available for faster lookups; pass status/endTime so backend
+                // can fix up test case status if testEnd failed but artifact request succeeds
+                await this.processArtifacts(testId, result, testEndResponse?.testCaseId, {
+                    status: testData.status,
+                    endTime: testData.endTime
+                });
             }
             else if (result.attachments && result.attachments.length > 0) {
                 for (const attachment of result.attachments) {
@@ -650,7 +687,7 @@ class TestLensReporter {
                     spec: specData
                 });
                 // Send spec code blocks to API
-                await this.sendSpecCodeBlocks(specPath);
+                await this.sendSpecCodeBlocks(specPath, test.title, testData?.errors || [], this.runId, testId, testCaseId);
             }
         }
     }
@@ -705,7 +742,8 @@ class TestLensReporter {
                 failedTests, // Already includes timedOut tests (normalized to 'failed')
                 skippedTests,
                 timedOutTests, // For informational purposes
-                status: normalizedRunStatus
+                status: normalizedRunStatus,
+                aggregationMode: this.usedExecutionId ? 'append' : 'replace'
             }
         });
         // Show Build Name if provided, otherwise show Run ID
@@ -815,7 +853,7 @@ class TestLensReporter {
             // Don't throw error to avoid breaking test execution
         }
     }
-    async processArtifacts(testId, result, testCaseDbId) {
+    async processArtifacts(testId, result, testCaseDbId, testEndPayload) {
         // Skip artifact processing if run creation failed
         if (this.runCreationFailed) {
             return;
@@ -839,6 +877,81 @@ class TestLensReporter {
                     this.bumpArtifactStat('skipped', artifactType);
                     continue;
                 }
+                // Trace zip (default from Playwright): extract network-like data and print to console
+                const isTraceZip = artifactType === 'trace' && attachment.path && (attachment.path.endsWith('.zip') || attachment.contentType === 'application/zip');
+                if (isTraceZip) {
+                    try {
+                        const traceStart = Date.now();
+                        const AdmZip = require('adm-zip');
+                        const zip = new AdmZip(attachment.path);
+                        const entries = zip.getEntries();
+                        const networkRows = [];
+                        for (const e of entries) {
+                            if (e.isDirectory || !e.getData)
+                                continue;
+                            const name = (e.entryName || '').toLowerCase();
+                            const isNetworkFile = name.endsWith('.network') || name.includes('.network') || name === 'network';
+                            if (!isNetworkFile)
+                                continue;
+                            const data = e.getData();
+                            if (!data)
+                                continue;
+                            const text = data.toString('utf8');
+                            if (!text || text.length < 2)
+                                continue;
+                            const isApplicationJson = (o) => {
+                                if (!o || typeof o !== 'object')
+                                    return false;
+                                const res = o.snapshot?.response ?? o.response;
+                                if (!res)
+                                    return false;
+                                const mime = res.content?.mimeType;
+                                if (typeof mime === 'string') {
+                                    const type = mime.split(';')[0].trim().toLowerCase();
+                                    return type === 'application/json';
+                                }
+                                const headers = res.headers;
+                                if (Array.isArray(headers)) {
+                                    const ct = headers.find((h) => (h.name || '').toLowerCase() === 'content-type');
+                                    const val = ct?.value;
+                                    if (typeof val === 'string') {
+                                        const type = val.split(';')[0].trim().toLowerCase();
+                                        return type === 'application/json';
+                                    }
+                                }
+                                return false;
+                            };
+                            const lines = text.split(/\r?\n/).filter(Boolean);
+                            for (const line of lines) {
+                                try {
+                                    const obj = JSON.parse(line);
+                                    if (obj && typeof obj === 'object' && isApplicationJson(obj))
+                                        networkRows.push(obj);
+                                }
+                                catch (_) { }
+                            }
+                            if (networkRows.length === 0 && lines.length > 0) {
+                                try {
+                                    const arr = JSON.parse(text);
+                                    if (Array.isArray(arr))
+                                        networkRows.push(...arr.filter((x) => x != null && typeof x === 'object' && isApplicationJson(x)));
+                                }
+                                catch (_) { }
+                            }
+                        }
+                        const durationMs = Date.now() - traceStart;
+                        if (networkRows.length > 0) {
+                            this.traceNetworkRows = networkRows;
+                        }
+                        else {
+                            this.traceNetworkRows = [];
+                        }
+                    }
+                    catch (e) {
+                        logger.warn('[TRACE] Could not read trace zip: ' + (e && e.message));
+                        this.traceNetworkRows = [];
+                    }
+                }
                 try {
                     // Determine proper filename with extension
                     // Playwright attachment.name often doesn't have extension, so we need to derive it
@@ -894,7 +1007,12 @@ class TestLensReporter {
                                 fileSize: this.getFileSize(attachment.path),
                                 storageType: 's3',
                                 s3Key: s3Data.key,
-                                s3Url: s3Data.url
+                                s3Url: s3Data.url,
+                                // So backend can fix test case status if testEnd failed but artifact succeeded
+                                ...(testEndPayload && {
+                                    testStatus: testEndPayload.status,
+                                    testEndTime: testEndPayload.endTime
+                                })
                             };
                             // Send artifact data to API
                             await this.sendToApi({
@@ -928,12 +1046,12 @@ class TestLensReporter {
             }
         }
     }
-    async sendSpecCodeBlocks(specPath) {
+    async sendSpecCodeBlocks(specPath, testName, errors, runId, test_id, testCaseId) {
         try {
             // Extract code blocks using built-in parser
             const testBlocks = this.extractTestBlocks(specPath);
             // Transform blocks to match backend API expectations
-            const codeBlocks = testBlocks.map(block => ({
+            const codeBlocks = testBlocks.filter(block => block.name === testName).map(block => ({
                 type: block.type, // 'test' or 'describe'
                 name: block.name, // test/describe name
                 content: block.content, // full code content
@@ -951,7 +1069,12 @@ class TestLensReporter {
             await this.axiosInstance.post(specEndpoint, {
                 filePath: path.relative(process.cwd(), specPath),
                 codeBlocks,
-                testSuiteName: path.basename(specPath).replace(/\.(spec|test)\.(js|ts)$/, '')
+                errors,
+                traceNetworkRows: this.traceNetworkRows,
+                testSuiteName: path.basename(specPath).replace(/\.(spec|test)\.(js|ts)$/, ''),
+                runId,
+                test_id,
+                testCaseId
             });
             logger.debug(`Sent ${codeBlocks.length} code blocks for: ${path.basename(specPath)}`);
         }
@@ -970,53 +1093,94 @@ class TestLensReporter {
             const content = fs.readFileSync(filePath, 'utf-8');
             const blocks = [];
             const lines = content.split('\n');
-            let currentDescribe = null;
-            let braceCount = 0;
+            // Use a stack to track nested describe blocks with their brace depths
+            const describeStack = [];
+            let globalBraceCount = 0;
             let inBlock = false;
             let blockStart = -1;
+            let blockBraceCount = 0;
             let blockType = 'test';
             let blockName = '';
+            let blockDescribe = undefined;
             for (let i = 0; i < lines.length; i++) {
                 const line = lines[i];
                 const trimmedLine = line.trim();
-                // Check for describe blocks
-                const describeMatch = trimmedLine.match(/describe\s*\(\s*['"`]([^'"`]+)['"`]/);
-                if (describeMatch) {
-                    currentDescribe = describeMatch[1];
-                }
-                // Check for test blocks
-                const testMatch = trimmedLine.match(/test\s*\(\s*['"`]([^'"`]+)['"`]/);
-                if (testMatch && !inBlock) {
-                    blockType = 'test';
-                    blockName = testMatch[1];
-                    blockStart = i;
-                    braceCount = 0;
-                    inBlock = true;
+                if (!inBlock) {
+                    // Check for describe blocks: describe(), test.describe(), test.describe.serial(), etc.
+                    const describeMatch = trimmedLine.match(/(?:test\.)?describe(?:\.(?:serial|parallel|only|skip|fixme))?\s*\(\s*['"`]([^'"`]+)['"`]/);
+                    if (describeMatch) {
+                        // Count braces on this line to find the opening brace
+                        let lineOpenBraces = 0;
+                        for (const char of line) {
+                            if (char === '{') {
+                                globalBraceCount++;
+                                lineOpenBraces++;
+                            }
+                            if (char === '}')
+                                globalBraceCount--;
+                        }
+                        // Push describe onto stack with the current brace depth
+                        describeStack.push({ name: describeMatch[1], braceDepth: globalBraceCount });
+                        continue;
+                    }
+                    // Check for test blocks: test(), test.only(), test.skip(), test.fixme(), it(), it.only(), etc.
+                    const testMatch = trimmedLine.match(/(?:test|it)(?:\.(?:only|skip|fixme|slow))?\s*\(\s*['"`]([^'"`]+)['"`]/);
+                    if (testMatch) {
+                        blockType = 'test';
+                        blockName = testMatch[1];
+                        blockStart = i;
+                        blockBraceCount = 0;
+                        // Capture the current innermost describe name
+                        blockDescribe = describeStack.length > 0 ? describeStack[describeStack.length - 1].name : undefined;
+                        inBlock = true;
+                    }
                 }
-                // Count braces when in a block
+                // Count braces
                 if (inBlock) {
                     for (const char of line) {
-                        if (char === '{')
-                            braceCount++;
-                        if (char === '}')
-                            braceCount--;
-                        if (braceCount === 0 && blockStart !== -1 && i > blockStart) {
-                            // End of block found
+                        if (char === '{') {
+                            blockBraceCount++;
+                            globalBraceCount++;
+                        }
+                        if (char === '}') {
+                            blockBraceCount--;
+                            globalBraceCount--;
+                        }
+                        if (blockBraceCount === 0 && blockStart !== -1 && i > blockStart) {
+                            // End of test block found
                             const blockContent = lines.slice(blockStart, i + 1).join('\n');
                             blocks.push({
                                 type: blockType,
                                 name: blockName,
                                 content: blockContent,
-                                describe: currentDescribe || undefined,
+                                describe: blockDescribe,
                                 startLine: blockStart + 1,
                                 endLine: i + 1
                             });
                             inBlock = false;
                             blockStart = -1;
+                            // Pop any describe blocks that have closed
+                            while (describeStack.length > 0 && globalBraceCount < describeStack[describeStack.length - 1].braceDepth) {
+                                describeStack.pop();
+                            }
                             break;
                         }
                     }
                 }
+                else {
+                    // Track braces outside of test blocks (for describe open/close)
+                    for (const char of line) {
+                        if (char === '{')
+                            globalBraceCount++;
+                        if (char === '}') {
+                            globalBraceCount--;
+                            // Pop any describe blocks that have closed
+                            while (describeStack.length > 0 && globalBraceCount < describeStack[describeStack.length - 1].braceDepth) {
+                                describeStack.pop();
+                            }
+                        }
+                    }
+                }
             }
             return blocks;
         }
@@ -1127,7 +1291,6 @@ class TestLensReporter {
             // Step 1: Request pre-signed URL from server
             const presignedUrlEndpoint = `${baseUrl}/api/v1/artifacts/public/presigned-url`;
             const requestBody = {
-                apiKey: this.config.apiKey,
                 testRunId: this.runId,
                 testId: testId,
                 fileName: fileName,
@@ -1169,7 +1332,6 @@ class TestLensReporter {
             // Step 3: Confirm upload with server to save metadata
             const confirmEndpoint = `${baseUrl}/api/v1/artifacts/public/confirm-upload`;
             const confirmBody = {
-                apiKey: this.config.apiKey,
                 testRunId: this.runId,
                 testId: testId,
                 s3Key: s3Key,
@@ -1261,7 +1423,7 @@ class TestLensReporter {
             // Try different ways to access getType method
             const getType = mime.getType || mime.default?.getType;
             if (typeof getType === 'function') {
-                const mimeType = getType.call(mime, ext) || getType.call(mime.default, ext);
+                const mimeType = getType.call(mime, ext) || (mime.default ? getType.call(mime.default, ext) : null);
                 return mimeType || 'application/octet-stream';
             }
         }