testdriverai 4.2.10 → 4.2.11

package/lib/logger.js

@@ -1,8 +1,6 @@
 // central logger for the bot
 const winston = require("winston");
 const os = require("os");
-const stripAnsi = require("@electerm/strip-ansi").default;
-const package = require("../package.json");
 
 // simple match for aws instance i-*
 const shouldLog =
@@ -12,13 +10,40 @@ const shouldLog =
 const { marked } = require("marked");
 const { markedTerminal } = require("marked-terminal");
 
-let depth = 0;
-let setDepth = (d) => {
-  depth = d - 1;
-  if (depth < 0) {
-    depth = 0;
+const { printf } = winston.format;
+
+const logFormat = printf(({ message }) => {
+  return `${message}`;
+});
+
+let interpolationVars = JSON.parse(process.env.TD_INTERPOLATION_VARS || '{}');
+
+const censorSensitiveData = (message) => {
+  for (let value of Object.values(interpolationVars)) {
+
+    // Avoid replacing vars that are 0 or 1 character
+    if (value.length >= 2) {
+      message = message.replaceAll(value, "****");
+    }
   }
-};
+  return message;
+}
+
+const logger = winston.createLogger({
+  level: shouldLog ? 'debug' : 'info',
+  format: winston.format.combine(
+    winston.format.splat(),
+    winston.format((info) => {
+      info.message = censorSensitiveData(info.message);
+      return info;
+    })(),
+    logFormat
+  ),
+  transports: [
+    new winston.transports.Console(),
+  ],
+});
+
 
 // marked is a markdown parser
 // markedTerminal allows us to render markdown in CLI
@@ -57,8 +82,9 @@ const createMarkdownStreamLogger = () => {
 
       const consoleOutput = markedParsePartial(buffer, 0, -1);
 
-      const diff = consoleOutput.replace(previousConsoleOutput, "");
+      let diff = consoleOutput.replace(previousConsoleOutput, "");
       if (diff) {
+        diff = censorSensitiveData(diff);
         process.stdout.write(diff);
       }
     },
@@ -66,22 +92,22 @@ const createMarkdownStreamLogger = () => {
 
       const previousConsoleOutput = markedParsePartial(buffer, 0, -1);
       const consoleOutput = markedParsePartial(buffer, 0, Infinity);
-      const diff = consoleOutput.replace(previousConsoleOutput, "");
+      let diff = consoleOutput.replace(previousConsoleOutput, "");
 
       if (diff) {
+        diff = censorSensitiveData(diff);
         process.stdout.write(diff);
       }
       process.stdout.write("\n\n");
       buffer = "";
-      log("silly", consoleOutput);
     },
   };
 };
 
 const prettyMarkdown = (markdown) => {
   if (typeof markdown !== "string") {
-    log("error", "prettyMarkdown requires a string");
-    log("error", markdown);
+    logger.error("prettyMarkdown requires a string");
+    logger.error(markdown);
     return;
   }
 
@@ -91,62 +117,12 @@ const prettyMarkdown = (markdown) => {
   consoleOutput = consoleOutput.replace(/\n$/, "");
   consoleOutput = consoleOutput.replace(/^/gm, spaceChar);
 
-  // note that this is logged 3 times:
-
-  // datadog
-  log("silly", consoleOutput);
-
-  // user terminal
-  console.log(consoleOutput);
-};
-
-const logger = winston.createLogger({
-  transports: [],
-});
-
-if (shouldLog) {
-  logger.add(
-    new winston.transports.Console({
-      format: winston.format.combine(
-        winston.format.colorize(),
-        winston.format.simple(),
-      ),
-      level: "silly",
-    }),
-  );
-}
-
-const log = (level, message, indent = false) => {
-  let m = message;
-
-  if (indent) {
-    m = spaceChar + message;
-  }
-
-  if (process.env["DEV"] || (level !== "silly" && level !== "debug")) {
-    console.log(m);
-  }
-
-  if (typeof message === "string" || message instanceof String) {
-    message = stripAnsi(message);
-  } else {
-    message = JSON.stringify(message);
-  }
-
-  if (shouldLog) {
-    logger.log({
-      level,
-      message,
-      version: package.version,
-    });
-  }
+  logger.info(consoleOutput);
 };
 
-let loggy = {
-  log,
-  setDepth,
+module.exports = {
+  logger,
   prettyMarkdown,
   createMarkdownStreamLogger,
 };
 
-module.exports = loggy;

package/lib/overlay.js

@@ -3,6 +3,7 @@ const ipc = require("node-ipc").default;
 const { fork } = require("child_process");
 
 const { emitter, eventsArray } = require("./events.js");
+const { logger } = require("./logger.js");
 
 ipc.config.id = "testdriverai";
 ipc.config.retry = 50;
@@ -10,7 +11,7 @@ ipc.config.silent = true;
 
 let electronProcess;
 
-console.log("Spawning GUI...");
+logger.info("Spawning GUI...");
 
 try {
   // Resolve the path to Electron CLI
@@ -27,7 +28,7 @@ try {
   );
 
 } catch (error) {
-  console.error("Failed to locate Electron CLI or start process:", error);
+  logger.error("Failed to locate Electron CLI or start process:", error);
 }
 
 

package/lib/redraw.js

@@ -2,7 +2,7 @@ const { captureScreenPNG } = require("./system");
 const os = require("os");
 const path = require("path");
 const { compare } = require("odiff-bin");
-const logger = require("./logger");
+const logger = require("./logger").logger;
 
 // network
 const si = require('systeminformation');
@@ -66,11 +66,11 @@ async function updateNetwork() {
   if (os.platform() === 'win32') {
     exec(`powershell -File ${scriptPath}`, (error, stdout, stderr) => {
       if (error) {
-        console.error(`Error executing PowerShell script: ${error}`);
+        logger.error(`Error executing PowerShell script: ${error}`);
         return;
       }
       if (stderr) {
-        console.error(`PowerShell error: ${stderr}`);
+        logger.error(`PowerShell error: ${stderr}`);
         return;
       }
       
@@ -79,7 +79,7 @@ async function updateNetwork() {
         const result = JSON.parse(stdout.trim());
         parseNetworkStats(result.totalBytesReceived, result.totalBytesSent);
       } catch (parseError) {
-        console.error(`Error parsing JSON: ${parseError}`);
+        logger.error(`Error parsing JSON: ${parseError}`);
       }
     });
   } else if (os.platform() === 'darwin') {
@@ -140,10 +140,10 @@ async function checkCondition(resolve, startTime, timeoutMs) {
   let networkText = networkSettled ? chalk.green(`y`) : chalk.dim(`${Math.trunc((diffRxBytes + diffTxBytes) / networkUpdateInterval)}b/s`);
   let timeoutText = isTimeout ?  chalk.green(`y`) : chalk.dim(`${Math.floor((timeElapsed)/1000)}/${(timeoutMs / 1000)}s`);
 
-  logger.log("debug", `   ` + chalk.dim('redraw=') + redrawText + chalk.dim(' network=') + networkText + chalk.dim(' timeout=') + timeoutText);
+  logger.debug(`   ` + chalk.dim('redraw=') + redrawText + chalk.dim(' network=') + networkText + chalk.dim(' timeout=') + timeoutText);
 
   if ((screenHasRedrawn && networkSettled) || isTimeout) {
-    logger.log("debug", `   `);
+    logger.debug(`   `);
     resolve("true");
   } else {
     checkCondition(resolve, startTime, timeoutMs);
@@ -151,7 +151,7 @@ async function checkCondition(resolve, startTime, timeoutMs) {
 }
 
 function wait(timeoutMs) {
-  logger.log("debug", `   `);
+  logger.debug(`   `);
   return new Promise((resolve) => {
     const startTime = Date.now();
     checkCondition(resolve, startTime, timeoutMs);

package/lib/sdk.js

@@ -6,12 +6,12 @@ const version = 'v4.1.0';
 const root = config["TD_API_ROOT"];
 const axios = require('axios');
 
-const log = require('./logger');
+const { logger } = require('./logger');
 
 // let token = null;
 
 const outputError = async (error) => {
-  console.log(chalk.red(error.status), chalk.red(error.statusText));
+  logger.info(chalk.red(error.status), chalk.red(error.statusText));
 };
 
 const parseBody = async (response, body) => {
@@ -55,7 +55,7 @@ const parseBody = async (response, body) => {
     }
     return body;
   } catch (err) {
-    console.log(chalk.red("Parsing Error", err));
+    logger.error(chalk.red("Parsing Error", err));
     throw err;
   }
 };
@@ -64,7 +64,7 @@ let auth = async () => {
   // data.apiKey = process.env.DASHCAM_API_KEY; @todo add-auth
 
   // if (!data.apiKey) {
-  //   console.log(chalk.red('API key not found. Set DASHCAM_API_KEY in your environment.'));
+  //   logger.info(chalk.red('API key not found. Set DASHCAM_API_KEY in your environment.'));
   //   process.exit(1);
   // }
 
@@ -98,7 +98,7 @@ const req = async (path, data, onChunk) => {
     ? [root, path].join("")
     : [root, "api", version, "testdriver", path].join("/");
 
-  log.log("debug", `making request to ${url}`);
+  logger.debug(`making request to ${url}`);
 
   const config = {
     method: "post",

package/lib/subimage/index.js

@@ -2,6 +2,7 @@
 const Jimp = require("jimp");
 const path = require("path");
 const cv = require("./opencv.js");
+const { logger } = require("../logger");
 
 async function findTemplateImage(haystack, needle, threshold) {
   try {
@@ -54,8 +55,8 @@ async function findTemplateImage(haystack, needle, threshold) {
 
     return positions;
   } catch (err) {
-    console.log(err);
-    console.error("OpenCV threw an error");
+    logger.error(err);
+    logger.error("OpenCV threw an error");
   }
 }
 

package/lib/system.js

@@ -8,6 +8,8 @@ const robot = require("robotjs");
 const sharp = require("sharp");
 const { emitter, events } = require("./events.js");
 
+const { logger } = require("./logger.js");
+
 let primaryDisplay = null;
 
 // get the primary display
@@ -126,7 +128,7 @@ const activeWin = async () => {
     const activeWindow = await initializeActiveWindow();
     return await activeWindow();
   } catch (error) {
-    console.error('Error getting active window:', error);
+    logger.error('Error getting active window: %s', error);
     return null;
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testdriverai",
-  "version": "4.2.10",
+  "version": "4.2.11",
   "description": "Next generation autonomous AI agent for end-to-end testing of web & desktop",
   "main": "index.js",
   "bin": {