testdriverai 7.2.56 → 7.2.57

package/lib/core/Dashcam.js

@@ -1,7 +1,7 @@
 /**
  * Dashcam Class
  * Manages Dashcam CLI recording lifecycle
- * 
+ *
  * Provides a clean interface for:
  * - Authentication
  * - Log tracking
@@ -9,7 +9,7 @@
  * - Retrieving replay URLs
  */
 
-const { logger } = require('../../interfaces/logger');
+const { logger } = require("../../interfaces/logger");
 
 class Dashcam {
   /**
@@ -23,12 +23,16 @@ class Dashcam {
    */
   constructor(client, options = {}) {
     if (!client) {
-      throw new Error('Dashcam requires a TestDriver client instance');
+      throw new Error("Dashcam requires a TestDriver client instance");
     }
-    
+
     this.client = client;
     // Use provided apiKey, or client's apiKey, or fallback to a default
-    this.apiKey = options.apiKey || client.apiKey || client.config?.TD_API_KEY || '4e93d8bf-3886-4d26-a144-116c4063522d';
+    this.apiKey =
+      options.apiKey ||
+      client.apiKey ||
+      client.config?.TD_API_KEY ||
+      "4e93d8bf-3886-4d26-a144-116c4063522d";
     this.autoStart = options.autoStart ?? false;
     this.logs = options.logs || [];
     this.recording = false;
@@ -46,18 +50,21 @@ class Dashcam {
     // Check for Vitest context
     if (this.client.__vitestContext) {
       const task = this.client.__vitestContext;
-      const testName = task.name || 'Test';
+      const testName = task.name || "Test";
       const fileName = task.file?.name || task.file?.filepath;
       if (fileName) {
-        const baseName = fileName.split('/').pop().replace(/\.(test|spec)\.(js|mjs|ts|tsx)$/, '');
+        const baseName = fileName
+          .split("/")
+          .pop()
+          .replace(/\.(test|spec)\.(js|mjs|ts|tsx)$/, "");
         return `${baseName} - ${testName}`;
       }
       return testName;
     }
-    
+
     // Fallback to timestamp
     const now = new Date();
-    return `Recording ${now.toISOString().replace(/T/, ' ').replace(/\..+/, '')}`;
+    return `Recording ${now.toISOString().replace(/T/, " ").replace(/\..+/, "")}`;
   }
 
   /**
@@ -65,7 +72,7 @@ class Dashcam {
    * @private
    */
   _getShell() {
-    return this.client.os === 'windows' ? 'pwsh' : 'sh';
+    return this.client.os === "windows" ? "pwsh" : "sh";
   }
 
   /**
@@ -73,7 +80,9 @@ class Dashcam {
    * @private
    */
   _getApiRoot() {
-    return this.client.config?.TD_API_ROOT || 'https://testdriver-api.onrender.com';
+    return (
+      this.client.config?.TD_API_ROOT || "https://testdriver-api.onrender.com"
+    );
   }
 
   /**
@@ -82,15 +91,15 @@ class Dashcam {
    * @param {string} apiRoot - The API root URL
    * @returns {string} The corresponding console URL
    */
-  static getConsoleUrl(apiRoot = 'https://testdriver-api.onrender.com') {
+  static getConsoleUrl(apiRoot = "https://testdriver-api.onrender.com") {
     // Map API roots to console URLs
     const apiToConsoleMap = {
-      'https://testdriver-api.onrender.com': 'https://console.testdriver.ai',
-      'https://v6.testdriver.ai': 'https://console.testdriver.ai',
-      'https://replayable-dev-ian-mac-m1-16.ngrok.io': 'http://localhost:3001',
+      "https://testdriver-api.onrender.com": "https://console.testdriver.ai",
+      "https://v6.testdriver.ai": "https://console.testdriver.ai",
+      "https://replayable-dev-ian-mac-m1-16.ngrok.io": "http://localhost:3001",
     };
-    
-    return apiToConsoleMap[apiRoot] || 'https://console.testdriver.ai';
+
+    return apiToConsoleMap[apiRoot] || "https://console.testdriver.ai";
   }
 
   /**
@@ -99,12 +108,17 @@ class Dashcam {
    */
   async _getDashcamPath() {
     const shell = this._getShell();
-    const npmPrefix = await this.client.exec(shell, 'npm prefix -g', 40000, false);
-    
-    if (this.client.os === 'windows') {
-      return 'C:\\Program Files\\nodejs\\dashcam.cmd';
+    const npmPrefix = await this.client.exec(
+      shell,
+      "npm prefix -g",
+      40000,
+      false,
+    );
+
+    if (this.client.os === "windows") {
+      return "C:\\Program Files\\nodejs\\dashcam.cmd";
     }
-    return npmPrefix.trim() + '/bin/dashcam';
+    return npmPrefix.trim() + "/bin/dashcam";
   }
 
   /**
@@ -117,28 +131,27 @@ class Dashcam {
     const shell = this._getShell();
     const apiRoot = this._getApiRoot();
 
-    if (this.client.os === 'windows') {
-
+    if (this.client.os === "windows") {
       const dashcamPath = await this._getDashcamPath();
-      this._log('debug', 'Dashcam executable path:', dashcamPath);
-      
+      this._log("debug", "Dashcam executable path:", dashcamPath);
+
       // Authenticate with TD_API_ROOT
       const authOutput = await this.client.exec(
         shell,
         `$env:TD_API_ROOT="${apiRoot}"; & "${dashcamPath}" auth ${key}`,
         120000,
-        false
+        false,
       );
-      this._log('debug', 'Auth output:', authOutput);
+      this._log("debug", "Auth output:", authOutput);
     } else {
       // Linux/Mac authentication with TD_API_ROOT
       const authOutput = await this.client.exec(
         shell,
         `TD_API_ROOT="${apiRoot}" dashcam auth ${key}`,
         120000,
-        false
+        false,
       );
-      this._log('debug', 'Auth output:', authOutput);
+      this._log("debug", "Auth output:", authOutput);
     }
 
     this._authenticated = true;
@@ -154,24 +167,24 @@ class Dashcam {
     const shell = this._getShell();
     const apiRoot = this._getApiRoot();
 
-    if (this.client.os === 'windows') {
+    if (this.client.os === "windows") {
       // Create log file if it doesn't exist
       const createFileOutput = await this.client.exec(
         shell,
         `New-Item -ItemType File -Path "${path}" -Force`,
         10000,
-        false
+        false,
       );
-      this._log('debug', 'Create log file output:', createFileOutput);
+      this._log("debug", "Create log file output:", createFileOutput);
 
       const dashcamPath = await this._getDashcamPath();
       const addLogOutput = await this.client.exec(
         shell,
         `$env:TD_API_ROOT="${apiRoot}"; & "${dashcamPath}" logs --add --type=file --file="${path}" --name="${name}"`,
         120000,
-        false
+        false,
       );
-      this._log('debug', 'Add log tracking output:', addLogOutput);
+      this._log("debug", "Add log tracking output:", addLogOutput);
     } else {
       // Create log file
       await this.client.exec(shell, `touch ${path}`, 10000, false);
@@ -181,9 +194,9 @@ class Dashcam {
         shell,
         `TD_API_ROOT="${apiRoot}" dashcam logs --add --type=file --file="${path}" --name="${name}"`,
         10000,
-        false
+        false,
       );
-      this._log('debug', 'Add log tracking output:', addLogOutput);
+      this._log("debug", "Add log tracking output:", addLogOutput);
     }
   }
 
@@ -198,22 +211,22 @@ class Dashcam {
     const dashcamPath = await this._getDashcamPath();
     const apiRoot = this._getApiRoot();
 
-    if (this.client.os === 'windows') {
+    if (this.client.os === "windows") {
       const addLogOutput = await this.client.exec(
         shell,
         `$env:TD_API_ROOT="${apiRoot}"; & "${dashcamPath}" logs --add --type=application --application="${application}" --name="${name}"`,
         120000,
-        false
+        false,
       );
-      this._log('debug', 'Add application log tracking output:', addLogOutput);
+      this._log("debug", "Add application log tracking output:", addLogOutput);
     } else {
       const addLogOutput = await this.client.exec(
         shell,
         `TD_API_ROOT="${apiRoot}" dashcam logs --add --type=application --application="${application}" --name="${name}"`,
         10000,
-        false
+        false,
       );
-      this._log('debug', 'Add application log tracking output:', addLogOutput);
+      this._log("debug", "Add application log tracking output:", addLogOutput);
     }
   }
 
@@ -228,22 +241,22 @@ class Dashcam {
     const dashcamPath = await this._getDashcamPath();
     const apiRoot = this._getApiRoot();
 
-    if (this.client.os === 'windows') {
+    if (this.client.os === "windows") {
       const addLogOutput = await this.client.exec(
         shell,
         `$env:TD_API_ROOT="${apiRoot}"; & "${dashcamPath}" logs --add --type=web --pattern="${pattern}" --name="${name}"`,
         120000,
-        false
+        false,
       );
-      this._log('debug', 'Add web log tracking output:', addLogOutput);
+      this._log("debug", "Add web log tracking output:", addLogOutput);
     } else {
       const addLogOutput = await this.client.exec(
         shell,
         `TD_API_ROOT="${apiRoot}" dashcam logs --add --type=web --pattern="${pattern}" --name="${name}"`,
         10000,
-        false
+        false,
       );
-      this._log('debug', 'Add web log tracking output:', addLogOutput);
+      this._log("debug", "Add web log tracking output:", addLogOutput);
     }
   }
 
@@ -253,7 +266,7 @@ class Dashcam {
    */
   async start() {
     if (this.recording) {
-      this._log('warn', 'Dashcam already recording');
+      this._log("warn", "Dashcam already recording");
       return;
     }
 
@@ -265,13 +278,14 @@ class Dashcam {
     const shell = this._getShell();
     const apiRoot = this._getApiRoot();
 
-    if (this.client.os === 'windows') {
+    if (this.client.os === "windows") {
       const dashcamPath = await this._getDashcamPath();
-      
+
       // Start dashcam record and redirect output with TD_API_ROOT
-      const outputFile = 'C:\\Users\\testdriver\\.dashcam-cli\\dashcam-start.log';
+      const outputFile =
+        "C:\\Users\\testdriver\\.dashcam-cli\\dashcam-start.log";
       //  const titleArg = this.title ? ` --title=\`"${this.title.replace(/"/g, '`"')}\`"` : '';
-      let titleArg = '';
+      let titleArg = "";
       const startScript = `
         try {
           $env:TD_API_ROOT="${apiRoot}"
@@ -289,34 +303,44 @@ class Dashcam {
       `;
 
       // add  2>&1" -PassThru
-      
+
       // Capture startTime right before issuing the dashcam command to sync with actual recording start
       this.startTime = Date.now();
-      const startOutput = await this.client.exec(shell, startScript, 10000, false);
-      this._log('debug', 'Start-Process output:', startOutput);
-      
+      const startOutput = await this.client.exec(
+        shell,
+        startScript,
+        10000,
+        false,
+      );
+      this._log("debug", "Start-Process output:", startOutput);
+
       // Wait and check output
-      await new Promise(resolve => setTimeout(resolve, 2000));
+      await new Promise((resolve) => setTimeout(resolve, 2000));
       const dashcamOutput = await this.client.exec(
         shell,
         `Get-Content "${outputFile}" -ErrorAction SilentlyContinue`,
         10000,
-        false
+        false,
       );
-      this._log('debug', 'Dashcam record output:', dashcamOutput);
-      
+      this._log("debug", "Dashcam record output:", dashcamOutput);
+
       // Give process time to initialize
-      await new Promise(resolve => setTimeout(resolve, 5000));
-      
-      this._log('debug', 'Dashcam recording started');
+      await new Promise((resolve) => setTimeout(resolve, 5000));
+
+      this._log("debug", "Dashcam recording started");
     } else {
       // Linux/Mac with TD_API_ROOT
-      this._log('debug', 'Starting dashcam recording on Linux/Mac...');
-      const titleArg = this.title ? ` --title="${this.title.replace(/"/g, '\"')}"` : '';
+      this._log("debug", "Starting dashcam recording on Linux/Mac...");
+      const titleArg = this.title
+        ? ` --title="${this.title.replace(/"/g, '"')}"`
+        : "";
       // Capture startTime right before issuing the dashcam command to sync with actual recording start
       this.startTime = Date.now();
-      await this.client.exec(shell, `TD_API_ROOT="${apiRoot}" dashcam record${titleArg} >/dev/null 2>&1 &`);
-      this._log('debug', 'Dashcam recording started');
+      await this.client.exec(
+        shell,
+        `TD_API_ROOT="${apiRoot}" dashcam record${titleArg} >/dev/null 2>&1 &`,
+      );
+      this._log("debug", "Dashcam recording started");
     }
 
     this.recording = true;
@@ -329,7 +353,7 @@ class Dashcam {
    */
   setTitle(title) {
     this.title = title;
-    this._log('info', `Set dashcam recording title: ${title}`);
+    this._log("debug", `Set dashcam recording title: ${title}`);
   }
 
   /**
@@ -339,28 +363,38 @@ class Dashcam {
   async stop() {
     if (!this.recording) {
       // Internal log only - don't spam user console
-      this._log('warn', 'Dashcam not recording');
+      this._log("warn", "Dashcam not recording");
       return null;
     }
 
-    this._log('debug', 'Stopping dashcam and retrieving URL...');
+    this._log("debug", "Stopping dashcam and retrieving URL...");
     const shell = this._getShell();
     const apiRoot = this._getApiRoot();
     let output;
 
-    if (this.client.os === 'windows') {
-      this._log('info', 'Stopping dashcam process on Windows...');
-      
+    if (this.client.os === "windows") {
+      this._log("debug", "Stopping dashcam process on Windows...");
+
       const dashcamPath = await this._getDashcamPath();
-      
+
       // Stop and get output with TD_API_ROOT
-      output = await this.client.exec(shell, `$env:TD_API_ROOT="${apiRoot}"; & "${dashcamPath}" stop`, 300000, false);
-      this._log('debug', 'Dashcam stop command output:', output);
+      output = await this.client.exec(
+        shell,
+        `$env:TD_API_ROOT="${apiRoot}"; & "${dashcamPath}" stop`,
+        300000,
+        process.env.DEBUG == "true" ? true : false,
+      );
+      this._log("debug", "Dashcam stop command output:", output);
     } else {
       // Linux/Mac with TD_API_ROOT
       const dashcamPath = await this._getDashcamPath();
-      output = await this.client.exec(shell, `TD_API_ROOT="${apiRoot}" "${dashcamPath}" stop`, 300000, false);
-      this._log('debug', 'Dashcam command output:', output);
+      output = await this.client.exec(
+        shell,
+        `TD_API_ROOT="${apiRoot}" "${dashcamPath}" stop`,
+        300000,
+        process.env.DEBUG == "true" ? true : false,
+      );
+      this._log("debug", "Dashcam command output:", output);
     }
 
     this.recording = false;
@@ -369,25 +403,29 @@ class Dashcam {
     if (output) {
       // Look for replay URL with optional query parameters (most specific)
       // Matches: http://localhost:3001/replay/abc123?share=xyz or https://app.dashcam.io/replay/abc123
-      const replayUrlMatch = output.match(/https?:\/\/[^\s"',}]+\/replay\/[^\s"',}]+/);
+      const replayUrlMatch = output.match(
+        /https?:\/\/[^\s"',}]+\/replay\/[^\s"',}]+/,
+      );
       if (replayUrlMatch) {
         let url = replayUrlMatch[0];
         // Remove trailing punctuation but keep query params
-        url = url.replace(/[.,;:!\)\]]+$/, '').trim();
+        url = url.replace(/[.,;:!\)\]]+$/, "").trim();
         return url;
       }
-      
+
       // Fallback: any dashcam.io or testdriver.ai URL
-      const dashcamUrlMatch = output.match(/https?:\/\/(?:app\.)?(?:dashcam\.io|testdriver\.ai)[^\s"',}]+/);
+      const dashcamUrlMatch = output.match(
+        /https?:\/\/(?:app\.)?(?:dashcam\.io|testdriver\.ai)[^\s"',}]+/,
+      );
       if (dashcamUrlMatch) {
         let url = dashcamUrlMatch[0];
-        url = url.replace(/[.,;:!\?\)\]]+$/, '').trim();
+        url = url.replace(/[.,;:!\?\)\]]+$/, "").trim();
         return url;
       }
-      
-      this._log('warn', 'No replay URL found in dashcam output');
+
+      this._log("warn", "No replay URL found in dashcam output");
     } else {
-      this._log('warn', 'Dashcam command returned no output');
+      this._log("warn", "Dashcam command returned no output");
     }
 
     return null;
@@ -398,24 +436,26 @@ class Dashcam {
    * @private
    */
   _log(level, ...args) {
-    const message = args.map(arg => 
-      typeof arg === 'object' ? JSON.stringify(arg, null, 2) : String(arg)
-    ).join(' ');
-    
+    const message = args
+      .map((arg) =>
+        typeof arg === "object" ? JSON.stringify(arg, null, 2) : String(arg),
+      )
+      .join(" ");
+
     const logMessage = `[DASHCAM] ${message}`;
-    
+
     // Use the TestDriver logger based on level
     switch (level) {
-      case 'error':
+      case "error":
         logger.error(logMessage);
         break;
-      case 'warn':
+      case "warn":
         logger.warn(logMessage);
         break;
-      case 'debug':
+      case "debug":
         logger.debug(logMessage);
         break;
-      case 'info':
+      case "info":
       default:
         logger.info(logMessage);
         break;