@appliqation/automation-sdk 2.1.0

package/src/constants.js

@@ -0,0 +1,245 @@
+/**
+ * SDK Constants
+ * Centralized location for all magic numbers and configuration values
+ */
+
+// ============================================================================
+// HTTP & Network Configuration
+// ============================================================================
+
+/**
+ * Default HTTP timeout in milliseconds
+ * @constant {number}
+ */
+const DEFAULT_TIMEOUT = 45000; // 45 seconds
+
+/**
+ * Maximum number of retry attempts
+ * @constant {number}
+ */
+const DEFAULT_RETRIES = 3;
+
+/**
+ * Base retry delay in milliseconds (used for exponential backoff)
+ * @constant {number}
+ */
+const DEFAULT_RETRY_DELAY = 1000; // 1 second
+
+/**
+ * Maximum retry delay in milliseconds (cap for exponential backoff)
+ * @constant {number}
+ */
+const MAX_RETRY_DELAY = 30000; // 30 seconds
+
+/**
+ * Retry jitter factor (percentage as decimal)
+ * Adds randomness to prevent thundering herd
+ * @constant {number}
+ */
+const RETRY_JITTER_FACTOR = 0.1; // 10%
+
+/**
+ * Exponential backoff base multiplier
+ * @constant {number}
+ */
+const BACKOFF_MULTIPLIER = 2;
+
+// ============================================================================
+// Connection Pooling Configuration
+// ============================================================================
+
+/**
+ * Enable HTTP keep-alive by default
+ * @constant {boolean}
+ */
+const DEFAULT_KEEP_ALIVE = true;
+
+/**
+ * Maximum number of concurrent sockets
+ * @constant {number}
+ */
+const DEFAULT_MAX_SOCKETS = 50;
+
+/**
+ * Maximum number of free sockets in the pool
+ * @constant {number}
+ */
+const DEFAULT_MAX_FREE_SOCKETS = 10;
+
+/**
+ * Keep-alive timeout in milliseconds
+ * @constant {number}
+ */
+const DEFAULT_KEEP_ALIVE_MSECS = 1000; // 1 second
+
+// ============================================================================
+// Batch Processing Configuration
+// ============================================================================
+
+/**
+ * Default batch size for result submission
+ * @constant {number}
+ */
+const DEFAULT_BATCH_SIZE = 50;
+
+/**
+ * Enable batch submission by default
+ * @constant {boolean}
+ */
+const DEFAULT_BATCH_SUBMIT = true;
+
+/**
+ * Enable logging of orphan tests by default
+ * @constant {boolean}
+ */
+const DEFAULT_LOG_ORPHANS = true;
+
+// ============================================================================
+// JWT Token Configuration
+// ============================================================================
+
+/**
+ * JWT token refresh threshold in minutes
+ * Refresh when token has less than this time remaining
+ * @constant {number}
+ */
+const JWT_REFRESH_THRESHOLD_MINUTES = 55;
+
+/**
+ * JWT token minimum validity in minutes
+ * Token must be valid for at least this long
+ * @constant {number}
+ */
+const JWT_MIN_VALIDITY_MINUTES = 5;
+
+// ============================================================================
+// Log Levels
+// ============================================================================
+
+/**
+ * Available log levels
+ * @constant {Object}
+ */
+const LOG_LEVELS = {
+  ERROR: 'ERROR',
+  WARN: 'WARN',
+  INFO: 'INFO',
+  DEBUG: 'DEBUG'
+};
+
+/**
+ * Default log level
+ * @constant {string}
+ */
+const DEFAULT_LOG_LEVEL = LOG_LEVELS.INFO;
+
+// ============================================================================
+// Test Result Statuses
+// ============================================================================
+
+/**
+ * Test result statuses
+ * @constant {Object}
+ */
+const TEST_STATUS = {
+  PASS: 'pass',
+  FAIL: 'fail',
+  SKIP: 'skip'
+};
+
+// ============================================================================
+// HTTP Status Codes for Retry Logic
+// ============================================================================
+
+/**
+ * HTTP status code for rate limiting
+ * @constant {number}
+ */
+const HTTP_TOO_MANY_REQUESTS = 429;
+
+/**
+ * HTTP status code for request timeout
+ * @constant {number}
+ */
+const HTTP_REQUEST_TIMEOUT = 408;
+
+/**
+ * HTTP status code threshold for server errors
+ * @constant {number}
+ */
+const HTTP_SERVER_ERROR_THRESHOLD = 500;
+
+// ============================================================================
+// Default Values
+// ============================================================================
+
+/**
+ * Default scenario ID for generic automation runs
+ * @constant {number}
+ */
+const DEFAULT_SCENARIO_ID = 0;
+
+/**
+ * Default environment name
+ * @constant {string}
+ */
+const DEFAULT_ENVIRONMENT = 'Local';
+
+/**
+ * Default device type
+ * @constant {string}
+ */
+const DEFAULT_DEVICE = 'Desktop';
+
+/**
+ * Default operating system
+ * @constant {string}
+ */
+const DEFAULT_OS = 'Unknown';
+
+// ============================================================================
+// Exports
+// ============================================================================
+
+module.exports = {
+  // HTTP & Network
+  DEFAULT_TIMEOUT,
+  DEFAULT_RETRIES,
+  DEFAULT_RETRY_DELAY,
+  MAX_RETRY_DELAY,
+  RETRY_JITTER_FACTOR,
+  BACKOFF_MULTIPLIER,
+
+  // Connection Pooling
+  DEFAULT_KEEP_ALIVE,
+  DEFAULT_MAX_SOCKETS,
+  DEFAULT_MAX_FREE_SOCKETS,
+  DEFAULT_KEEP_ALIVE_MSECS,
+
+  // Batch Processing
+  DEFAULT_BATCH_SIZE,
+  DEFAULT_BATCH_SUBMIT,
+  DEFAULT_LOG_ORPHANS,
+
+  // JWT
+  JWT_REFRESH_THRESHOLD_MINUTES,
+  JWT_MIN_VALIDITY_MINUTES,
+
+  // Logging
+  LOG_LEVELS,
+  DEFAULT_LOG_LEVEL,
+
+  // Test Status
+  TEST_STATUS,
+
+  // HTTP Status Codes
+  HTTP_TOO_MANY_REQUESTS,
+  HTTP_REQUEST_TIMEOUT,
+  HTTP_SERVER_ERROR_THRESHOLD,
+
+  // Defaults
+  DEFAULT_SCENARIO_ID,
+  DEFAULT_ENVIRONMENT,
+  DEFAULT_DEVICE,
+  DEFAULT_OS
+};

package/src/core/AuthManager.js

@@ -0,0 +1,353 @@
+const axios = require('axios');
+const logger = require('../utils/logger');
+
+class AuthManager {
+  constructor(config) {
+    this.config = config;
+    this.csrfToken = null;
+    this.sessionCookie = null;
+    this.jwtToken = null;
+    this.jwtExpiry = null;
+    this.lastAuthTime = null;
+    this.tokenExpiryTime = null;
+    this.runConfig = null; // Store run configuration for JWT refresh
+
+    // Determine authentication mode
+    this.authMode = config.apiKey ? 'api_key' : 'csrf';
+  }
+
+  async getAuthHeaders() {
+    const headers = {
+      'Content-Type': 'application/json',
+      'Accept': 'application/json'
+    };
+
+    // API Key authentication (for automation)
+    if (this.authMode === 'api_key' && this.config.apiKey) {
+      headers['X-API-Key'] = this.config.apiKey;
+
+      // Add JWT token if available and not expired
+      if (this.jwtToken && !this.isJwtExpired()) {
+        headers['Authorization'] = `Bearer ${this.jwtToken}`;
+      }
+
+      return headers;
+    }
+
+    // Legacy CSRF authentication (backward compatible)
+    if (!this.csrfToken || this.isTokenExpired()) {
+      await this.authenticate();
+    }
+
+    headers['Authorization'] = `Basic ${Buffer.from(`${this.config.username}:${this.config.password}`).toString('base64')}`;
+
+    if (this.csrfToken) {
+      headers['X-CSRF-Token'] = this.csrfToken;
+    }
+
+    if (this.sessionCookie) {
+      headers['Cookie'] = this.sessionCookie;
+    }
+
+    return headers;
+  }
+
+  async authenticate() {
+    try {
+      logger.info('Authenticating with Drupal...');
+      
+      // Step 1: Get CSRF token
+      await this.getCsrfToken();
+      
+      // Step 2: Login to establish session
+      await this.login();
+      
+      this.lastAuthTime = Date.now();
+      // Set token expiry to 1 hour from now
+      this.tokenExpiryTime = Date.now() + (60 * 60 * 1000);
+      
+      logger.info('Authentication successful');
+    } catch (error) {
+      logger.error('Authentication failed', { error: error.message });
+      throw new Error(`Authentication failed: ${error.message}`);
+    }
+  }
+
+  async getCsrfToken() {
+    try {
+      const response = await axios.get(`${this.config.baseUrl}/session/token`, {
+        headers: {
+          'Authorization': `Basic ${Buffer.from(`${this.config.username}:${this.config.password}`).toString('base64')}`
+        },
+        timeout: this.config.timeout || 30000
+      });
+
+      this.csrfToken = response.data;
+      
+      // Extract session cookie if present
+      const setCookieHeader = response.headers['set-cookie'];
+      if (setCookieHeader) {
+        this.sessionCookie = setCookieHeader
+          .map(cookie => cookie.split(';')[0])
+          .join('; ');
+      }
+
+      logger.debug('CSRF token obtained successfully');
+    } catch (error) {
+      logger.error('Failed to get CSRF token', { error: error.message });
+      throw error;
+    }
+  }
+
+  async login() {
+    try {
+      const loginData = {
+        name: this.config.username,
+        pass: this.config.password
+      };
+
+      const headers = {
+        'Content-Type': 'application/json',
+        'Authorization': `Basic ${Buffer.from(`${this.config.username}:${this.config.password}`).toString('base64')}`
+      };
+
+      if (this.csrfToken) {
+        headers['X-CSRF-Token'] = this.csrfToken;
+      }
+
+      const response = await axios.post(
+        `${this.config.baseUrl}/user/login?_format=json`,
+        loginData,
+        {
+          headers,
+          timeout: this.config.timeout || 30000
+        }
+      );
+
+      // Update session cookie from login response
+      const setCookieHeader = response.headers['set-cookie'];
+      if (setCookieHeader) {
+        this.sessionCookie = setCookieHeader
+          .map(cookie => cookie.split(';')[0])
+          .join('; ');
+      }
+
+      logger.debug('Login successful');
+    } catch (error) {
+      // Login might fail but Basic Auth could still work
+      logger.warn('Login request failed, continuing with Basic Auth', { error: error.message });
+    }
+  }
+
+  async refreshToken() {
+    logger.info('Refreshing authentication token...');
+    this.csrfToken = null;
+    this.sessionCookie = null;
+    await this.authenticate();
+  }
+
+  isTokenExpired() {
+    if (!this.tokenExpiryTime) return true;
+    return Date.now() > this.tokenExpiryTime;
+  }
+
+  getLastAuthTime() {
+    return this.lastAuthTime;
+  }
+
+  // Method to manually set CSRF token if needed
+  setCsrfToken(token) {
+    this.csrfToken = token;
+    this.tokenExpiryTime = Date.now() + (60 * 60 * 1000); // 1 hour expiry
+  }
+
+  // Method to clear authentication data
+  clearAuth() {
+    this.csrfToken = null;
+    this.sessionCookie = null;
+    this.jwtToken = null;
+    this.jwtExpiry = null;
+    this.lastAuthTime = null;
+    this.tokenExpiryTime = null;
+  }
+
+  // JWT token management methods (for API key authentication)
+  setJwtToken(token) {
+    this.jwtToken = token;
+    this.jwtExpiry = this.parseJwtExpiry(token);
+    logger.debug('JWT token stored', { expiresAt: new Date(this.jwtExpiry).toISOString() });
+  }
+
+  parseJwtExpiry(token) {
+    try {
+      const payload = JSON.parse(Buffer.from(token.split('.')[1], 'base64').toString());
+      // Convert to milliseconds and subtract 5 minutes for safety margin
+      return (payload.exp * 1000) - (5 * 60 * 1000);
+    } catch (error) {
+      logger.warn('Failed to parse JWT expiry', { error: error.message });
+      // Default to 23 hours from now if parsing fails
+      return Date.now() + (23 * 60 * 60 * 1000);
+    }
+  }
+
+  isJwtExpired() {
+    if (!this.jwtExpiry) return true;
+    return Date.now() >= this.jwtExpiry;
+  }
+
+  /**
+   * Refresh JWT token by creating a new automation run
+   * Uses the stored run configuration and API key
+   * @returns {Promise<string>} New JWT token
+   */
+  async refreshJwtToken() {
+    if (!this.config.apiKey) {
+      throw new Error('Cannot refresh JWT: API key not configured');
+    }
+
+    if (!this.runConfig) {
+      throw new Error('Cannot refresh JWT: Run configuration not set. Call setRunConfig() first.');
+    }
+
+    try {
+      logger.info('Refreshing JWT token...', {
+        projectKey: this.runConfig.projectKey,
+        scenarioId: this.runConfig.scenarioId,
+        environment: this.runConfig.environment
+      });
+
+      const https = require('https');
+
+      // Prepare payload for run creation
+      const payload = {
+        project_key: this.runConfig.projectKey,
+        scenario_id: this.runConfig.scenarioId || 0,
+        environment: this.runConfig.environment || 'Local',
+        browsers: this.runConfig.browsers || ['Chrome'],
+        device: this.runConfig.device || 'Desktop',
+        os: this.runConfig.os || 'Linux',
+        title: this.runConfig.title || `Automation Run - ${new Date().toISOString()}`
+      };
+
+      // Make direct API call to get new JWT token
+      const response = await axios.post(
+        `${this.config.baseUrl}/api/automation/run/create`,
+        payload,
+        {
+          headers: {
+            'X-API-Key': this.config.apiKey,
+            'Content-Type': 'application/json'
+          },
+          httpsAgent: new https.Agent({
+            rejectUnauthorized: this.config.rejectUnauthorized !== undefined ? this.config.rejectUnauthorized : true
+          }),
+          timeout: this.config.timeout || 30000
+        }
+      );
+
+      if (!response.data || !response.data.jwt_token) {
+        throw new Error('Invalid response: JWT token not received');
+      }
+
+      // Store the new JWT token
+      this.setJwtToken(response.data.jwt_token);
+
+      logger.info('JWT token refreshed successfully', {
+        expiresAt: new Date(this.jwtExpiry).toISOString()
+      });
+
+      return response.data.jwt_token;
+    } catch (error) {
+      logger.error('Failed to refresh JWT token', {
+        error: error.message,
+        status: error.response?.status,
+        data: error.response?.data
+      });
+      throw new Error(`JWT refresh failed: ${error.message}`);
+    }
+  }
+
+  /**
+   * Check if JWT token should be refreshed
+   * Returns true if token is within 5 minutes of expiring
+   * @returns {boolean} True if token should be refreshed
+   */
+  shouldRefreshJwt() {
+    if (!this.jwtExpiry) return false;
+    // Refresh if we're within 5 minutes of expiration
+    const refreshThreshold = Date.now() + (5 * 60 * 1000);
+    return refreshThreshold >= this.jwtExpiry;
+  }
+
+  /**
+   * Set run configuration for JWT token refresh
+   * This must be called before refreshJwtToken() can work
+   * @param {Object} config - Run configuration
+   * @param {string} config.projectKey - Project key
+   * @param {number} config.scenarioId - Scenario ID (optional, defaults to 0)
+   * @param {string} config.environment - Environment name
+   * @param {string[]} config.browsers - Browser names (optional)
+   * @param {string} config.device - Device type (optional)
+   * @param {string} config.os - Operating system (optional)
+   * @param {string} config.title - Run title (optional)
+   */
+  setRunConfig(config) {
+    this.runConfig = config;
+    logger.debug('Run configuration stored for JWT refresh', {
+      projectKey: config.projectKey,
+      scenarioId: config.scenarioId,
+      environment: config.environment
+    });
+  }
+
+  getAuthMode() {
+    return this.authMode;
+  }
+
+  hasApiKey() {
+    return !!this.config.apiKey;
+  }
+
+  /**
+   * Get JWT token for browser authentication
+   * Returns the stored JWT token if available and not expired
+   *
+   * @returns {string|null} JWT token or null
+   */
+  getJwtForBrowser() {
+    if (this.jwtToken && !this.isJwtExpired()) {
+      return this.jwtToken;
+    }
+    return null;
+  }
+
+  /**
+   * Get authenticated URL with JWT token for browser navigation
+   *
+   * @param {string} baseUrl - Base URL to navigate to
+   * @param {string} path - Optional path to append
+   * @returns {string|null} URL with JWT token or null if no token available
+   */
+  getAuthenticatedUrl(baseUrl, path = '') {
+    const token = this.getJwtForBrowser();
+    if (!token) {
+      return null;
+    }
+
+    const url = path ? `${baseUrl.replace(/\/$/, '')}/${path.replace(/^\//, '')}` : baseUrl;
+    const separator = url.includes('?') ? '&' : '?';
+    return `${url}${separator}qonsole_token=${encodeURIComponent(token)}`;
+  }
+
+  /**
+   * Check if browser authentication is available
+   * (requires JWT token to be set)
+   *
+   * @returns {boolean} True if JWT token is available for browser auth
+   */
+  hasBrowserAuth() {
+    return !!this.getJwtForBrowser();
+  }
+}
+
+module.exports = AuthManager;