@appliqation/automation-sdk 2.4.0 → 2.5.0

package/src/core/HttpClient.js

@@ -306,68 +306,6 @@ class HttpClient {
     }
   }
 
-  /**
-   * Fetch project information from API key
-   * Enables SDK auto-configuration where only API key is required.
-   * Returns project metadata including ID, title, and configured environments.
-   *
-   * @returns {Promise<Object>} Project metadata
-   * @property {boolean} success - Operation success status
-   * @property {number} project_id - Numeric project ID
-   * @property {number} project_nid - Same as project_id (for consistency)
-   * @property {string} project_title - Project name
-   * @property {Array<string>} environments - List of configured environment names
-   * @property {string} default_environment - First environment or 'Local' fallback
-   * @property {boolean} has_environments_configured - Whether environments exist
-   *
-   * @throws {Error} If API key is invalid or project not found
-   *
-   * @example
-   * const projectInfo = await httpClient.getProjectInfo();
-   * console.log(projectInfo.project_id); // 1162
-   * console.log(projectInfo.environments); // ['Development', 'Staging', 'Production']
-   * console.log(projectInfo.default_environment); // 'Development'
-   */
-  async getProjectInfo() {
-    logger.debug('Fetching project information from API key...');
-
-    try {
-      const response = await this.get('/api/automation/project/info');
-
-      logger.info('Project info retrieved successfully', {
-        project_id: response.data.project_id,
-        project_title: response.data.project_title,
-        environments: response.data.environments,
-        has_environments: response.data.has_environments_configured
-      });
-
-      return response.data;
-    } catch (error) {
-      logger.error('Failed to fetch project info', {
-        error: error.message,
-        status: error.response?.status,
-        code: error.code
-      });
-
-      // Enhance error message for common scenarios
-      if (error.response?.status === 400) {
-        throw new Error(
-          'No project associated with this API key. Please verify your API key is correctly configured.'
-        );
-      } else if (error.response?.status === 404) {
-        throw new Error(
-          'Project not found or invalid. Please verify your API key is associated with a valid project.'
-        );
-      } else if (error.response?.status === 401 || error.response?.status === 403) {
-        throw new Error(
-          'API key authentication failed. Please verify your API key is valid and not expired.'
-        );
-      }
-
-      throw error;
-    }
-  }
-
   /**
    * Set authorization header
    * @param {string} token - Authorization token

package/src/playwright/global-setup.js

@@ -1,170 +1,93 @@
 /**
  * Global Setup for JWT Browser Authentication
  *
- * This module automatically sets up browser authentication using JWT tokens
- * instead of traditional username/password login (setup-auth.js).
- *
- * How it works:
- * 1. Uses API Key to call /api/automation/run/create
- * 2. Receives JWT token from backend
- * 3. Navigates browser to app with ?qonsole_token={jwt}
- * 4. Backend validates JWT and establishes session
- * 5. Saves authenticated state to .auth/jwt.json
- * 6. All tests use this authenticated state
- *
- * Benefits:
- * - No username/password in .env
- * - No manual setup step required
- * - 1-hour token validity
- * - Auto-refresh support
- * - Works in CI/CD environments
+ * Enabled only when --appq CLI flag is present.
+ * Never blocks Playwright test execution — all errors degrade to warnings.
  *
  * @module playwright/global-setup
  */
 
-const { chromium } = require('@playwright/test');
+// Lazy-require @playwright/test to avoid double-load when SDK is symlinked
 const axios = require('axios');
 const https = require('https');
 const fs = require('fs');
 const path = require('path');
 const { DEFAULT_APPLIQATION_BASE_URL } = require('../constants');
 
-function toBoolean(value) {
-  if (value === undefined || value === null) return undefined;
-  if (typeof value === 'boolean') return value;
-  const normalized = String(value).trim().toLowerCase();
-  if (['1', 'true', 'yes', 'on'].includes(normalized)) return true;
-  if (['0', 'false', 'no', 'off'].includes(normalized)) return false;
-  return undefined;
-}
-
-function parseCliEnableFlag() {
-  const argv = process.argv || [];
-  for (let i = 0; i < argv.length; i++) {
-    const arg = argv[i];
-    if (arg.startsWith('--appq=')) {
-      return toBoolean(arg.split('=')[1]);
-    }
-    if (arg === '--appq') {
-      return true;
-    }
-    if (arg.startsWith('--enable-appq=')) {
-      return toBoolean(arg.split('=')[1]);
-    }
-    if (arg === '--enable-appq') {
-      return true;
-    }
-  }
-  return undefined;
-}
-
-function resolveEnableAppq(config) {
-  const cliValue = parseCliEnableFlag();
-  const envValue = process.env.APPLIQATION_ENABLE ?? process.env.APPQ ?? process.env.APPLIQATION_APPQ;
-  const configValue = config?.enableAppq ?? config?.options?.enableAppq;
-  const resolved = toBoolean(configValue) ?? toBoolean(cliValue) ?? toBoolean(envValue);
-  return resolved !== undefined ? resolved : true;
+/**
+ * Check if --appq flag is present in CLI args
+ * @returns {boolean}
+ */
+function isAppqEnabled() {
+  return (process.argv || []).includes('--appq');
 }
 
 /**
  * Setup JWT-based browser authentication
- *
  * @param {Object} config - Playwright config object
  * @returns {Promise<void>}
  */
 async function globalSetup(config) {
-  console.log('\n🚀 Global Setup: Initializing Test Environment...\n');
-
-  // Extract SDK configuration from reporter config or use env
-  const sdkConfig = extractSDKConfig(config);
-  sdkConfig.enableAppq = resolveEnableAppq(sdkConfig);
-
-  // Display startup information
-  console.log(`🌍 Environment: ${sdkConfig.environment || 'Not specified'}`);
-  console.log(`🔗 Test App URL: ${sdkConfig.appUrl || 'Not specified'}`);
+  console.log('\n[Appliqation] Global Setup: Initializing...\n');
 
-  if (sdkConfig.enableAppq === false) {
-    console.log('⚠️  Appq disabled via flag. Skipping JWT setup and backend calls.\n');
+  // Only run if --appq flag is present
+  if (!isAppqEnabled()) {
+    console.log('[Appliqation] Reporting disabled. Skipping JWT setup.\n');
     return;
   }
 
-  // Show Run ID and Timestamp only in DEBUG mode
-  if (process.env.LOG_LEVEL === 'DEBUG') {
-    const crypto = require('crypto');
-    const runId = crypto.randomUUID();
-    console.log(`📊 Run ID: ${runId}`);
-    console.log(`⏰ Timestamp: ${new Date().toISOString()}`);
-  }
-
-  console.log(`🔑 API Key: ${sdkConfig.apiKey ? 'Configured' : 'Not set'}\n`);
+  const sdkConfig = extractSDKConfig(config);
 
-  console.log('🔐 Setting up JWT browser authentication...\n');
+  console.log(`[Appliqation] Environment: ${sdkConfig.environment || 'Not specified'}`);
 
-  // Validate required configuration
+  // Validate API key — warn, don't throw
   if (!sdkConfig.apiKey) {
-    console.error('❌ APPLIQATION_API_KEY is required for JWT authentication');
-    console.error('   Please add to your .env file:\n');
-    console.error('   APPLIQATION_API_KEY=appq_live_xxxxx\n');
-    throw new Error('Missing APPLIQATION_API_KEY');
+    console.warn('[Appliqation] API key required. Set APPLIQATION_API_KEY in .env');
+    console.warn('[Appliqation] Tests will continue without JWT auth.\n');
+    return;
   }
 
-  if (!sdkConfig.baseUrl) {
-    console.error('❌ APPLIQATION_BASE_URL is required');
-    throw new Error('Missing APPLIQATION_BASE_URL');
-  }
+  console.log('[Appliqation] API Key: Configured');
 
   // Determine if JWT auth is enabled
-  const useJwtAuth = sdkConfig.useJwtAuth !== false; // Default: true
+  const useJwtAuth = sdkConfig.useJwtAuth !== false;
 
   if (!useJwtAuth) {
-    console.log('ℹ️  JWT authentication disabled. Using legacy session auth.\n');
+    console.log('[Appliqation] JWT authentication disabled.\n');
     return;
   }
 
   try {
-    // Step 1: Get JWT token from API
-    console.log('📡 Requesting JWT token from Appliqation backend...');
+    console.log('[Appliqation] Requesting JWT token...');
     const jwtData = await getJWTToken(sdkConfig);
 
     if (!jwtData.jwt_token) {
-      console.warn('⚠️  No JWT token received. Falling back to legacy auth.');
+      console.warn('[Appliqation] No JWT token received. Tests will continue without auth.\n');
       return;
     }
 
-    console.log(`✅ JWT token received (expires in 1 hour)\n`);
+    console.log('[Appliqation] JWT token received.');
 
-    // Step 2: Setup browser with JWT
-    console.log('🌐 Setting up browser session with JWT...');
+    console.log('[Appliqation] Setting up browser session...');
     await setupBrowserWithJWT(sdkConfig, jwtData.jwt_token);
 
-    console.log('✅ Browser authentication setup complete!');
-    console.log('📄 Authenticated state saved to: .auth/jwt.json\n');
-    console.log('✨ Tests will run with JWT authentication!\n');
+    console.log('[Appliqation] Browser authentication complete.');
+    console.log('[Appliqation] State saved to .auth/jwt.json\n');
 
-    // Store for use in tests (run_id will be set by reporter when tests execute)
     process.env.APPLIQATION_JWT_TOKEN = jwtData.jwt_token;
 
   } catch (error) {
-    console.error('\n❌ JWT authentication setup failed:', error.message);
-    console.error('\n💡 Troubleshooting:');
-    console.error('   1. Check APPLIQATION_API_KEY is valid');
-    console.error('   2. Check APPLIQATION_BASE_URL is accessible');
-    console.error('   3. Check backend has QONSOLE_JWT_SECRET configured');
-    console.error('   4. Try running: npm run setup-auth (legacy method)\n');
-
-    // Don't fail the test run - fall back to legacy auth
-    console.warn('⚠️  Falling back to legacy authentication method\n');
+    console.warn(`[Appliqation] Auth setup failed: ${error.message}`);
+    console.warn('[Appliqation] Tests will continue without JWT auth.\n');
   }
 }
 
 /**
  * Extract SDK configuration from Playwright config
- *
  * @param {Object} config - Playwright config
  * @returns {Object} SDK configuration
  */
 function extractSDKConfig(config) {
-  // Try to find SDK config in reporter configuration
   let sdkConfig = {};
 
   if (config.reporter) {
@@ -181,15 +104,14 @@ function extractSDKConfig(config) {
     }
   }
 
-  // Fallback to environment variables
-  const baseUrl = sdkConfig.baseUrl || process.env.APPLIQATION_BASE_URL || DEFAULT_APPLIQATION_BASE_URL;
+  const baseUrl = sdkConfig.baseUrl || DEFAULT_APPLIQATION_BASE_URL;
 
   return {
     baseUrl,
     apiKey: sdkConfig.apiKey || process.env.APPLIQATION_API_KEY,
     projectKey: sdkConfig.projectKey || process.env.APPLIQATION_PROJECT_KEY,
     scenarioId: sdkConfig.scenarioId || parseInt(process.env.APPLIQATION_SCENARIO_ID) || 0,
-    environment: sdkConfig.environment || process.env.APPLIQATION_ENVIRONMENT || 'Local',
+    environment: sdkConfig.environment || process.env.APPLIQATION_ENVIRONMENT,
     appUrl: sdkConfig.appUrl || process.env.APPLIQATION_APP_URL || process.env.TEST_APP_URL || baseUrl,
     useJwtAuth: sdkConfig.useJwtAuth !== undefined ? sdkConfig.useJwtAuth : process.env.APPLIQATION_USE_JWT_AUTH !== 'false',
     runTitle: sdkConfig.runTitle || process.env.APPLIQATION_RUN_TITLE || `JWT Auth Setup - ${new Date().toISOString()}`,
@@ -198,13 +120,10 @@ function extractSDKConfig(config) {
 
 /**
  * Get JWT token from Appliqation API
- *
  * @param {Object} sdkConfig - SDK configuration
- * @returns {Promise<Object>} JWT data { jwt_token, run_id, user_id, project_id }
+ * @returns {Promise<Object>} JWT data
  */
 async function getJWTToken(sdkConfig) {
-  // Get browser session JWT token directly (no need to create run matrix)
-  // The SDK reporter will create run matrices automatically when tests execute
   const jwtEndpoint = `${sdkConfig.baseUrl.replace(/\/$/, '')}/api/auth/jwt/browser`;
 
   const jwtPayload = {
@@ -213,12 +132,8 @@ async function getJWTToken(sdkConfig) {
 
   try {
     const jwtResponse = await axios.post(jwtEndpoint, jwtPayload, {
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      httpsAgent: new https.Agent({
-        rejectUnauthorized: false, // Allow self-signed certs in dev
-      }),
+      headers: { 'Content-Type': 'application/json' },
+      httpsAgent: new https.Agent({ rejectUnauthorized: false }),
       validateStatus: (status) => status < 500,
     });
 
@@ -228,12 +143,11 @@ async function getJWTToken(sdkConfig) {
 
     return {
       jwt_token: jwtResponse.data.jwt_token,
-      run_id: null, // No run created during auth setup
+      run_id: null,
       user_id: jwtResponse.data.user_id,
       project_id: jwtResponse.data.project_id,
       expires_in: jwtResponse.data.expires_in,
     };
-
   } catch (error) {
     if (error.response) {
       throw new Error(`API error: ${error.response.status} - ${error.response.data?.message || error.message}`);
@@ -244,69 +158,46 @@ async function getJWTToken(sdkConfig) {
 
 /**
  * Setup browser session with JWT token
- *
- * @param {Object} sdkConfig - SDK configuration
- * @param {string} jwtToken - JWT token
- * @returns {Promise<void>}
+ * @param {Object} sdkConfig
+ * @param {string} jwtToken
  */
 async function setupBrowserWithJWT(sdkConfig, jwtToken) {
-  const browser = await chromium.launch({
-    headless: true,
-  });
+  const { chromium } = require('@playwright/test');
+  const browser = await chromium.launch({ headless: true });
 
   try {
-    // Extract domain from baseUrl for cookie
     const baseUrl = sdkConfig.baseUrl.replace(/\/$/, '');
     const urlObj = new URL(baseUrl);
     const domain = urlObj.hostname;
 
-    // Create context with JWT cookie BEFORE navigating
-    const context = await browser.newContext({
-      ignoreHTTPSErrors: true, // Allow self-signed certs in dev
-    });
+    const context = await browser.newContext({ ignoreHTTPSErrors: true });
 
-    // Set JWT cookie
     await context.addCookies([{
       name: 'appliqation_jwt',
       value: jwtToken,
-      domain: domain,
+      domain,
       path: '/',
       httpOnly: true,
       secure: baseUrl.startsWith('https'),
       sameSite: 'Lax'
     }]);
 
-    console.log(`   ✓ JWT cookie set for domain: ${domain}`);
-
     const page = await context.newPage();
 
-    // Navigate to app (no query parameter needed)
-    console.log(`   Navigating to: ${baseUrl}...`);
-    await page.goto(baseUrl, {
-      waitUntil: 'networkidle',
-      timeout: 30000,
-    });
-
-    // Wait for authentication to be processed
+    await page.goto(baseUrl, { waitUntil: 'networkidle', timeout: 30000 });
     await page.waitForTimeout(2000);
 
-    // Verify authentication worked
     const currentUrl = page.url();
     if (currentUrl.includes('/user/login')) {
-      throw new Error('JWT authentication failed - redirected to login page');
+      throw new Error('JWT authentication failed — redirected to login page');
     }
 
-    console.log('   ✓ Browser authenticated successfully');
-
-    // Save authenticated state with cookie
     const authDir = path.resolve('.auth');
     if (!fs.existsSync(authDir)) {
       fs.mkdirSync(authDir, { recursive: true });
     }
 
     await context.storageState({ path: '.auth/jwt.json' });
-    console.log('   ✓ Authenticated state saved to .auth/jwt.json');
-
   } catch (error) {
     throw new Error(`Browser setup failed: ${error.message}`);
   } finally {

package/src/reporters/cypress/CypressReporter.js

@@ -161,18 +161,6 @@ class CypressReporter {
    */
   async createRun(details) {
     try {
-      // Auto-configure project from API key if needed
-      await this.client.ensureProjectConfig();
-
-      // Use auto-detected environment if not explicitly provided
-      if (!this.config.environment && this.client._projectInfo) {
-        this.config.environment = this.client._projectInfo.default_environment;
-        logger.info('Using auto-detected default environment', {
-          environment: this.config.environment,
-          source: 'api_key_project_config'
-        });
-      }
-
       const browser = details.browser?.displayName || details.browser?.name || 'Cypress';
       const platform = details.system?.platform || process.platform;
       const os = this.detectOS(platform);

package/src/reporters/jest/JestReporter.js

@@ -137,18 +137,6 @@ class JestReporter {
    */
   async createRun() {
     try {
-      // Auto-configure project from API key if needed
-      await this.client.ensureProjectConfig();
-
-      // Use auto-detected environment if not explicitly provided
-      if (!this.config.environment && this.client._projectInfo) {
-        this.config.environment = this.client._projectInfo.default_environment;
-        logger.info('Using auto-detected default environment', {
-          environment: this.config.environment,
-          source: 'api_key_project_config'
-        });
-      }
-
       const os = this.detectOS();
 
       const runOptions = {