testlens-playwright-reporter 0.3.2 → 0.3.4

package/index.ts

@@ -22,8 +22,8 @@ async function getMime() {
 export interface TestLensReporterConfig {
   /** TestLens API endpoint URL */
   apiEndpoint?: string;
-  /** API key for authentication - required, must be provided in config */
-  apiKey: string;
+  /** API key for authentication - can be provided in config or via TESTLENS_API_KEY environment variable */
+  apiKey?: string;
   /** Enable real-time streaming of test events */
   enableRealTimeStream?: boolean;
   /** Enable Git information collection */
@@ -46,13 +46,15 @@ export interface TestLensReporterConfig {
   rejectUnauthorized?: boolean;
   /** Alternative SSL option - set to true to ignore SSL certificate errors */
   ignoreSslErrors?: boolean;
+  /** Custom metadata from CLI arguments (automatically parsed from --key=value arguments) */
+  customMetadata?: Record<string, string>;
 }
 
 export interface TestLensReporterOptions {
   /** TestLens API endpoint URL */
   apiEndpoint?: string;
-  /** API key for authentication - required, must be provided in config */
-  apiKey: string;
+  /** API key for authentication - can be provided in config or via TESTLENS_API_KEY environment variable */
+  apiKey?: string;
   /** Enable real-time streaming of test events */
   enableRealTimeStream?: boolean;
   /** Enable Git information collection */
@@ -75,6 +77,8 @@ export interface TestLensReporterOptions {
   rejectUnauthorized?: boolean;
   /** Alternative SSL option - set to true to ignore SSL certificate errors */
   ignoreSslErrors?: boolean;
+  /** Custom metadata from CLI arguments (automatically parsed from --key=value arguments) */
+  customMetadata?: Record<string, string>;
 }
 
 export interface GitInfo {
@@ -119,6 +123,8 @@ export interface RunMetadata {
   failedTests?: number;
   skippedTests?: number;
   status?: string;
+  testlensBuildName?: string;
+  customMetadata?: Record<string, string>;
 }
 
 export interface TestError {
@@ -163,7 +169,7 @@ export interface TestData {
 export interface SpecData {
   filePath: string;
   testSuiteName: string;
-  tags: string[];
+  tags?: string[];
   startTime: string;
   endTime?: string;
   status: string;
@@ -176,11 +182,61 @@ export class TestLensReporter implements Reporter {
   private runMetadata: RunMetadata;
   private specMap: Map<string, SpecData>;
   private testMap: Map<string, TestData>;
+  private runCreationFailed: boolean = false; // Track if run creation failed due to limits
+
+  /**
+   * Parse custom metadata from environment variables
+   * Checks for common metadata environment variables
+   */
+  private static parseCustomArgs(): Record<string, string> {
+    const customArgs: Record<string, string> = {};
+    
+    // Common environment variable names for build metadata
+    const envVarMappings: Record<string, string[]> = {
+      'testlensBuildTag': ['BUILDTAG', 'BUILD_TAG','TestlensBuildTag'],
+      'testlensBuildName': ['BUILDNAME', 'BUILD_NAME', 'TestlensBuildName'],
+      'environment': ['ENVIRONMENT', 'ENV', 'NODE_ENV', 'DEPLOYMENT_ENV'],
+      'branch': ['BRANCH', 'GIT_BRANCH', 'CI_COMMIT_BRANCH', 'GITHUB_REF_NAME'],
+      'team': ['TEAM', 'TEAM_NAME'],
+      'project': ['PROJECT', 'PROJECT_NAME'],
+      'customvalue': ['CUSTOMVALUE', 'CUSTOM_VALUE']
+    };
+    
+    // Check for each metadata key
+    Object.entries(envVarMappings).forEach(([key, envVars]) => {
+      for (const envVar of envVars) {
+        const value = process.env[envVar];
+        if (value) {
+          customArgs[key] = value;
+          console.log(`✓ Found ${envVar}=${value} (mapped to '${key}')`);
+          break; // Use first match
+        }
+      }
+    });
+    
+    return customArgs;
+  }
 
   constructor(options: TestLensReporterOptions) {
+    // Parse custom CLI arguments
+    const customArgs = TestLensReporter.parseCustomArgs();
+    
+    // Allow API key from environment variable if not provided in config
+    // Check multiple environment variable names in priority order (uppercase and lowercase)
+    const apiKey = options.apiKey 
+      || process.env.TESTLENS_API_KEY 
+      || process.env.testlens_api_key
+      || process.env.TESTLENS_KEY
+      || process.env.testlens_key
+      || process.env.testlensApiKey
+      || process.env.PLAYWRIGHT_API_KEY
+      || process.env.playwright_api_key
+      || process.env.PW_API_KEY
+      || process.env.pw_api_key;
+    
     this.config = {
       apiEndpoint: options.apiEndpoint || 'https://testlens.qa-path.com/api/v1/webhook/playwright',
-      apiKey: options.apiKey, // API key must come from config file
+      apiKey: apiKey, // API key from config or environment variable
       enableRealTimeStream: options.enableRealTimeStream !== undefined ? options.enableRealTimeStream : true,
       enableGitInfo: options.enableGitInfo !== undefined ? options.enableGitInfo : true,
       enableArtifacts: options.enableArtifacts !== undefined ? options.enableArtifacts : true,
@@ -189,11 +245,16 @@ export class TestLensReporter implements Reporter {
       batchSize: options.batchSize || 10,
       flushInterval: options.flushInterval || 5000,
       retryAttempts: options.retryAttempts !== undefined ? options.retryAttempts : 0,
-      timeout: options.timeout || 60000
+      timeout: options.timeout || 60000,
+      customMetadata: { ...customArgs, ...options.customMetadata } // CLI args + config metadata
     } as Required<TestLensReporterConfig>;
 
     if (!this.config.apiKey) {
-      throw new Error('API_KEY is required for TestLensReporter. Pass it as apiKey option in your playwright config.');
+      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.');
+    }
+    
+    if (apiKey !== options.apiKey) {
+      console.log('✓ Using API key from environment variable');
     }
 
     // Determine SSL validation behavior
@@ -257,10 +318,20 @@ export class TestLensReporter implements Reporter {
     this.runMetadata = this.initializeRunMetadata();
     this.specMap = new Map<string, SpecData>();
     this.testMap = new Map<string, TestData>();
+    this.runCreationFailed = false;
+    
+    // Log custom metadata if any
+    if (this.config.customMetadata && Object.keys(this.config.customMetadata).length > 0) {
+      console.log('\n📋 Custom Metadata Detected:');
+      Object.entries(this.config.customMetadata).forEach(([key, value]) => {
+        console.log(`   ${key}: ${value}`);
+      });
+      console.log('');
+    }
   }
 
   private initializeRunMetadata(): RunMetadata {
-    return {
+    const metadata: RunMetadata = {
       id: this.runId,
       startTime: new Date().toISOString(),
       environment: 'production',
@@ -269,6 +340,18 @@ export class TestLensReporter implements Reporter {
       playwrightVersion: this.getPlaywrightVersion(),
       nodeVersion: process.version
     };
+    
+    // Add custom metadata if provided
+    if (this.config.customMetadata && Object.keys(this.config.customMetadata).length > 0) {
+      metadata.customMetadata = this.config.customMetadata;
+      
+      // Extract testlensBuildName as a dedicated field for dashboard display
+      if (this.config.customMetadata.testlensBuildName) {
+        metadata.testlensBuildName = this.config.customMetadata.testlensBuildName;
+      }
+    }
+    
+    return metadata;
   }
 
   private getPlaywrightVersion(): string {
@@ -301,7 +384,13 @@ export class TestLensReporter implements Reporter {
   }
 
   async onBegin(config: FullConfig, suite: Suite): Promise<void> {
-    console.log(`🚀 TestLens Reporter starting - Run ID: ${this.runId}`);
+    // Show Build Name if provided, otherwise show Run ID
+    if (this.runMetadata.testlensBuildName) {
+      console.log(`🚀 TestLens Reporter starting - Build: ${this.runMetadata.testlensBuildName}`);
+      console.log(`   Run ID: ${this.runId}`);
+    } else {
+      console.log(`🚀 TestLens Reporter starting - Run ID: ${this.runId}`);
+    }
     
     // Collect Git information if enabled
     if (this.config.enableGitInfo) {
@@ -333,18 +422,24 @@ export class TestLensReporter implements Reporter {
   }
 
   async onTestBegin(test: TestCase, result: TestResult): Promise<void> {
+    // Log which test is starting
+    console.log(`\n▶️  Running test: ${test.title}`);
+    
     const specPath = test.location.file;
     const specKey = `${specPath}-${test.parent.title}`;
 
     // Create or update spec data
     if (!this.specMap.has(specKey)) {
+      const extractedTags = this.extractTags(test);
       const specData: SpecData = {
         filePath: path.relative(process.cwd(), specPath),
         testSuiteName: test.parent.title,
-        tags: this.extractTags(test),
         startTime: new Date().toISOString(),
         status: 'running'
       };
+      if (extractedTags.length > 0) {
+        specData.tags = extractedTags;
+      }
       this.specMap.set(specKey, specData);
 
       // Send spec start event to API
@@ -419,13 +514,16 @@ export class TestLensReporter implements Reporter {
       const specKey = `${specPath}-${test.parent.title}`;
       
       if (!this.specMap.has(specKey)) {
+        const extractedTags = this.extractTags(test);
         const specData: SpecData = {
           filePath: path.relative(process.cwd(), specPath),
           testSuiteName: test.parent.title,
-          tags: this.extractTags(test),
           startTime: new Date().toISOString(),
           status: 'skipped'
         };
+        if (extractedTags.length > 0) {
+          specData.tags = extractedTags;
+        }
         this.specMap.set(specKey, specData);
 
         // Send spec start event to API
@@ -615,6 +713,18 @@ export class TestLensReporter implements Reporter {
       });
 
       if (remainingTests.length === 0) {
+        // Aggregate tags from all tests in this spec
+        const allTags = new Set<string>();
+        test.parent.tests.forEach((t: any) => {
+          const tags = this.extractTags(t);
+          tags.forEach(tag => allTags.add(tag));
+        });
+        const aggregatedTags = Array.from(allTags);
+        // Only update tags if we have any
+        if (aggregatedTags.length > 0) {
+          specData.tags = aggregatedTags;
+        }
+        
         specData.endTime = new Date().toISOString();
         
         // Send spec end event to API
@@ -664,13 +774,23 @@ export class TestLensReporter implements Reporter {
       }
     });
 
-    console.log(`📊 TestLens Report completed - Run ID: ${this.runId}`);
+    // Show Build Name if provided, otherwise show Run ID
+    if (this.runMetadata.testlensBuildName) {
+      console.log(`📊 TestLens Report completed - Build: ${this.runMetadata.testlensBuildName}`);
+      console.log(`   Run ID: ${this.runId}`);
+    } else {
+      console.log(`📊 TestLens Report completed - Run ID: ${this.runId}`);
+    }
     console.log(`🎯 Results: ${passedTests} passed, ${failedTests} failed (${timedOutTests} timeouts), ${skippedTests} skipped`);
   }
 
   private async sendToApi(payload: any): Promise<void> {
+    // Skip sending if run creation already failed
+    if (this.runCreationFailed && payload.type !== 'runStart') {
+      return;
+    }
+    
     try {
-      console.log(`📤 Sending ${payload.type} event to ${this.config.apiEndpoint}`);
       const response = await this.axiosInstance.post('', payload, {
         headers: {
           'X-API-Key': this.config.apiKey
@@ -680,21 +800,91 @@ export class TestLensReporter implements Reporter {
         console.log(`✅ Sent ${payload.type} event to TestLens (HTTP ${response.status})`);
       }
     } catch (error: any) {
-      console.error(`❌ Failed to send ${payload.type} event to TestLens:`, {
-        message: error?.message || 'Unknown error',
-        status: error?.response?.status,
-        statusText: error?.response?.statusText,
-        data: error?.response?.data,
-        code: error?.code,
-        url: error?.config?.url,
-        method: error?.config?.method
-      });
+      const errorData = error?.response?.data;
+      const status = error?.response?.status;
+      
+      // Check for limit exceeded (403)
+      if (status === 403 && errorData?.error === 'limit_exceeded') {
+        // Set flag to skip subsequent events
+        if (payload.type === 'runStart' && errorData?.limit_type === 'test_runs') {
+          this.runCreationFailed = true;
+        }
+        
+        console.error('\n' + '='.repeat(80));
+        if (errorData?.limit_type === 'test_cases') {
+          console.error('❌ TESTLENS ERROR: Test Cases Limit Reached');
+        } else if (errorData?.limit_type === 'test_runs') {
+          console.error('❌ TESTLENS ERROR: Test Runs Limit Reached');
+        } else {
+          console.error('❌ TESTLENS ERROR: Plan Limit Reached');
+        }
+        console.error('='.repeat(80));
+        console.error('');
+        console.error(errorData?.message || 'You have reached your plan limit.');
+        console.error('');
+        console.error(`Current usage: ${errorData?.current_usage || 'N/A'} / ${errorData?.limit || 'N/A'}`);
+        console.error('');
+        console.error('To continue, please upgrade your plan.');
+        console.error('Contact: support@alternative-path.com');
+        console.error('');
+        console.error('='.repeat(80));
+        console.error('');
+        return; // Don't log the full error object for limit errors
+      }
+      
+      // Check for trial expiration, subscription errors, or limit errors (401)
+      if (status === 401) {
+        if (errorData?.error === 'trial_expired' || errorData?.error === 'subscription_inactive' || 
+            errorData?.error === 'test_cases_limit_reached' || errorData?.error === 'test_runs_limit_reached') {
+          console.error('\n' + '='.repeat(80));
+          
+          if (errorData?.error === 'test_cases_limit_reached') {
+            console.error('❌ TESTLENS ERROR: Test Cases Limit Reached');
+          } else if (errorData?.error === 'test_runs_limit_reached') {
+            console.error('❌ TESTLENS ERROR: Test Runs Limit Reached');
+          } else {
+            console.error('❌ TESTLENS ERROR: Your trial plan has ended');
+          }
+          
+          console.error('='.repeat(80));
+          console.error('');
+          console.error(errorData?.message || 'Your trial period has expired.');
+          console.error('');
+          console.error('To continue using TestLens, please upgrade to Enterprise plan.');
+          console.error('Contact: ' + (errorData?.contactEmail || 'support@alternative-path.com'));
+          console.error('');
+          if (errorData?.trial_end_date) {
+            console.error(`Trial ended: ${new Date(errorData.trial_end_date).toLocaleDateString()}`);
+            console.error('');
+          }
+          console.error('='.repeat(80));
+          console.error('');
+        } else {
+          console.error(`❌ Authentication failed: ${errorData?.error || 'Invalid API key'}`);
+        }
+      } else if (status !== 403) {
+        // Log other errors (but not 403 which we handled above)
+        console.error(`❌ Failed to send ${payload.type} event to TestLens:`, {
+          message: error?.message || 'Unknown error',
+          status: status,
+          statusText: error?.response?.statusText,
+          data: errorData,
+          code: error?.code,
+          url: error?.config?.url,
+          method: error?.config?.method
+        });
+      }
       
       // Don't throw error to avoid breaking test execution
     }
   }
 
   private async processArtifacts(testId: string, result: TestResult): Promise<void> {
+    // Skip artifact processing if run creation failed
+    if (this.runCreationFailed) {
+      return;
+    }
+    
     const attachments = result.attachments;
     
     for (const attachment of attachments) {
@@ -810,7 +1000,15 @@ export class TestLensReporter implements Reporter {
 
       console.log(`📝 Sent ${codeBlocks.length} code blocks for: ${path.basename(specPath)}`);
     } catch (error: any) {
-      console.error('Failed to send spec code blocks:', error?.response?.data || error?.message || 'Unknown error');
+      const errorData = error?.response?.data;
+      
+      // Handle duplicate spec code blocks gracefully (when re-running tests)
+      if (errorData?.error && errorData.error.includes('duplicate key value violates unique constraint')) {
+        console.log(`ℹ️  Spec code blocks already exist for: ${path.basename(specPath)} (skipped)`);
+        return;
+      }
+      
+      console.error('Failed to send spec code blocks:', errorData || error?.message || 'Unknown error');
     }
   }
 
@@ -917,7 +1115,7 @@ export class TestLensReporter implements Reporter {
         remoteUrl
       };
     } catch (error: any) {
-      console.warn('Could not collect Git information:', error.message);
+      // Silently skip git information if not in a git repository
       return null;
     }
   }
@@ -932,18 +1130,35 @@ export class TestLensReporter implements Reporter {
   private extractTags(test: TestCase): string[] {
     const tags: string[] = [];
     
-    test.annotations.forEach((annotation: any) => {
-      if (annotation.type === 'tag' && annotation.description) {
-        tags.push(annotation.description);
+    // Playwright stores tags in the _tags property
+    const testTags = (test as any)._tags;
+    if (testTags && Array.isArray(testTags)) {
+      tags.push(...testTags);
+    }
+
+    // Also get tags from parent suites by walking up the tree
+    let currentSuite: Suite | undefined = test.parent;
+    while (currentSuite) {
+      const suiteTags = (currentSuite as any)._tags;
+      if (suiteTags && Array.isArray(suiteTags)) {
+        tags.push(...suiteTags);
       }
-    });
+      currentSuite = currentSuite.parent;
+    }
 
+    // Also extract @tags from test title for backward compatibility
     const tagMatches = test.title.match(/@[\w-]+/g);
     if (tagMatches) {
       tags.push(...tagMatches);
     }
 
-    return tags;
+    // Add testlensBuildTag from custom metadata if present
+    if (this.config.customMetadata?.testlensBuildTag) {
+      tags.push(`@${this.config.customMetadata.testlensBuildTag}`);
+    }
+    
+    // Remove duplicates and return
+    return [...new Set(tags)];
   }
 
   private getTestId(test: TestCase): string {
@@ -1038,6 +1253,39 @@ export class TestLensReporter implements Reporter {
         throw new Error(`Upload confirmation failed: ${confirmResponse.data.error || 'Unknown error'}`);
       }
     } catch (error: any) {
+      // Check for trial expiration, subscription errors, or limit errors
+      if (error?.response?.status === 401) {
+        const errorData = error?.response?.data;
+        
+        if (errorData?.error === 'trial_expired' || errorData?.error === 'subscription_inactive' ||
+            errorData?.error === 'test_cases_limit_reached' || errorData?.error === 'test_runs_limit_reached') {
+          console.error('\\n' + '='.repeat(80));
+          
+          if (errorData?.error === 'test_cases_limit_reached') {
+            console.error('❌ TESTLENS ERROR: Test Cases Limit Reached');
+          } else if (errorData?.error === 'test_runs_limit_reached') {
+            console.error('❌ TESTLENS ERROR: Test Runs Limit Reached');
+          } else {
+            console.error('❌ TESTLENS ERROR: Your trial plan has ended');
+          }
+          
+          console.error('='.repeat(80));
+          console.error('');
+          console.error(errorData?.message || 'Your trial period has expired.');
+          console.error('');
+          console.error('To continue using TestLens, please upgrade to Enterprise plan.');
+          console.error('Contact: ' + (errorData?.contactEmail || 'support@alternative-path.com'));
+          console.error('');
+          if (errorData?.trial_end_date) {
+            console.error(`Trial ended: ${new Date(errorData.trial_end_date).toLocaleDateString()}`);
+            console.error('');
+          }
+          console.error('='.repeat(80));
+          console.error('');
+          return null;
+        }
+      }
+      
       // Better error messages for common issues
       let errorMsg = error.message;
       

package/package.json

@@ -1,18 +1,24 @@
 {
   "name": "testlens-playwright-reporter",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Universal Playwright reporter for TestLens - works with both TypeScript and JavaScript projects",
   "main": "index.js",
   "types": "index.d.ts",
+  "bin": {
+    "testlens-cross-env": "cross-env.js"
+  },
   "files": [
     "index.js",
     "index.d.ts",
     "index.ts",
     "lib/",
+    "postinstall.js",
+    "cross-env.js",
     "README.md",
     "CHANGELOG.md"
   ],
   "scripts": {
+    "postinstall": "node postinstall.js",
     "prepack": "node build-embed-env.js",
     "prepublishOnly": "npm run lint && npm run test",
     "test": "echo 'Tests will be added in future versions'",
@@ -35,7 +41,7 @@
   ],
   "author": {
     "name": "TestLens Team",
-    "email": "support@testlens.io",
+    "email": "support@alternative-path.com",
     "url": "https://testlens.qa-path.com"
   },
   "license": "MIT",
@@ -46,9 +52,11 @@
     "@aws-sdk/client-s3": "^3.624.0",
     "@aws-sdk/s3-request-presigner": "^3.624.0",
     "axios": "^1.11.0",
+    "cross-env": "^7.0.3",
     "dotenv": "^16.4.5",
     "form-data": "^4.0.1",
-    "mime": "^4.0.4"
+    "mime": "^4.0.4",
+    "tslib": "^2.8.1"
   },
   "engines": {
     "node": ">=16.0.0",

package/postinstall.js

@@ -0,0 +1,39 @@
+const fs = require('fs');
+const path = require('path');
+
+try {
+  // Get the parent project's node_modules/.bin directory
+  // When installed, we are in: project/node_modules/testlens-playwright-reporter/
+  // We need to go to: project/node_modules/.bin/
+  const parentBinDir = path.resolve(__dirname, '..', '.bin');
+  const localBinDir = path.resolve(__dirname, 'node_modules', '.bin');
+  
+  // Check if parent bin directory exists
+  if (!fs.existsSync(parentBinDir)) {
+    console.log('Parent .bin directory not found, skipping cross-env setup');
+    process.exit(0);
+  }
+
+  // Check if cross-env exists in our node_modules
+  const crossEnvCmd = process.platform === 'win32' ? 'cross-env.cmd' : 'cross-env';
+  const crossEnvPs1 = 'cross-env.ps1';
+  const sourceCmdPath = path.join(localBinDir, crossEnvCmd);
+  const sourcePs1Path = path.join(localBinDir, crossEnvPs1);
+  
+  if (fs.existsSync(sourceCmdPath)) {
+    const targetCmdPath = path.join(parentBinDir, crossEnvCmd);
+    
+    // Copy the file
+    fs.copyFileSync(sourceCmdPath, targetCmdPath);
+    console.log('✓ cross-env binary installed');
+    
+    // Also copy PowerShell script on Windows
+    if (process.platform === 'win32' && fs.existsSync(sourcePs1Path)) {
+      const targetPs1Path = path.join(parentBinDir, crossEnvPs1);
+      fs.copyFileSync(sourcePs1Path, targetPs1Path);
+    }
+  }
+} catch (error) {
+  // Don't fail installation if this doesn't work
+  console.log('Note: Could not setup cross-env automatically:', error.message);
+}