testdriverai 5.4.1 → 5.5.0

package/agent.js

@@ -30,7 +30,7 @@ const yaml = require("js-yaml");
 const sanitizeFilename = require("sanitize-filename");
 
 // local modules
-const { server } = require("./lib/ipc.js");
+const server = require("./lib/ipc.js");
 const speak = require("./lib/speak.js");
 const analytics = require("./lib/analytics.js");
 const log = require("./lib/logger.js");
@@ -53,6 +53,7 @@ const { emitter, events } = require("./lib/events.js");
 
 const logger = log.logger;
 
+let thisFile;
 let lastPrompt = "";
 let terminalApp = "";
 let commandHistory = [];
@@ -110,12 +111,6 @@ let getArgs = () => {
   }
 
   if (!args[file]) {
-    // make testdriver directory if it doesn't exist
-    let testdriverFolder = path.join(workingDir, "testdriver");
-    if (!fs.existsSync(testdriverFolder)) {
-      fs.mkdirSync(testdriverFolder);
-    }
-
     args[file] = "testdriver/testdriver.yaml";
   }
 
@@ -130,21 +125,6 @@ let getArgs = () => {
   return { command: args[command], file: args[file] };
 };
 
-let a = getArgs();
-
-let thisFile = a.file;
-const thisCommand = a.command;
-
-logger.info(chalk.green(`Howdy! I'm TestDriver v${package.version}`));
-logger.info(`This is beta software!`);
-logger.info("");
-logger.info(chalk.yellow(`Join our Discord for help`));
-logger.info(`https://discord.com/invite/cWDFW8DzPm`);
-logger.info("");
-
-// individual run ID for this session
-// let runID = new Date().getTime();
-
 function fileCompleter(line) {
   line = line.slice(5); // remove /run
   const lastSepIndex = line.lastIndexOf(path.sep);
@@ -407,14 +387,13 @@ const executeCommands = async (
         executionHistory[executionHistory.length - 1]?.commands.push(command);
       }
 
-      if (!dry) {
-        await runCommand(command, depth, shouldSave);
-      }
-
       if (shouldSave) {
         await save({ silent: true });
       }
 
+      if (!dry) {
+        await runCommand(command, depth, shouldSave);
+      }
       let timeToComplete = (new Date().getTime() - lastCommand) / 1000;
       // logger.info(timeToComplete, 'seconds')
 
@@ -526,6 +505,10 @@ const loadYML = async (file) => {
     process.env["TD_INTERPOLATION_VARS"] || "{}",
   );
 
+  if (!yml) {
+    return {};
+  }
+
   yml = await parser.validateYAML(yml);
 
   // Inject environment variables into any ${VAR} strings
@@ -770,8 +753,10 @@ const actOnMarkdown = async (
 };
 
 const ensureMacScreenPerms = async () => {
+
   // if os is mac, check for screen capture permissions
   if (
+    !config.TD_OVERLAY_ID && 
     !config.TD_VM &&
     process.platform === "darwin"
   ) {
@@ -781,10 +766,10 @@ const ensureMacScreenPerms = async () => {
 
       logger.info(chalk.red("Screen capture permissions not enabled."));
       logger.info(
-        "You must enable screen capture permissions for the application calling `testdriverai`.",
+        "You must enable screen capture permissions for this terminal application within System Settings.",
       );
       logger.info(
-        "Read More: https://docs.testdriver.ai/faq/screen-recording-permissions-mac-only",
+        "Navigate to System Settings > Privacy & Security > Screen Recording and enable screen recording permissions for the terminal you are using to run this command.",
       );
       analytics.track("noMacPermissions");
       return exit();
@@ -797,6 +782,7 @@ const ensureMacScreenPerms = async () => {
 // simple function to backfill the chat history with a prompt and
 // then call `promptUser()` to get the user input
 const firstPrompt = async () => {
+  
   // readline is what allows us to get user input
   rl = readline.createInterface({
     terminal: true,
@@ -807,8 +793,6 @@ const firstPrompt = async () => {
     completer,
   });
 
-  analytics.track("first prompt");
-
   rl.on("SIGINT", async () => {
     analytics.track("sigint");
     await exit(false);
@@ -902,11 +886,12 @@ const firstPrompt = async () => {
     }
 
     setTerminalWindowTransparency(false);
+
     promptUser();
   };
 
   rl.on("line", handleInput);
-  server.on("input", handleInput);
+  server.emitter.on("input", handleInput);
 
   // if file exists, load it
   if (fs.existsSync(thisFile)) {
@@ -924,18 +909,17 @@ const firstPrompt = async () => {
 
     let yml = fs.readFileSync(thisFile, "utf-8");
 
-    let markdown = `\`\`\`yaml
-${yml}
-\`\`\``;
-
-    logger.info(`Loaded test script ${thisFile}\n`);
-
-    log.prettyMarkdown(`
+    if (yml) {
 
-${markdown}
+      let markdown = `\`\`\`yaml
+${yml}\`\`\``;
+      
+      logger.info(`Loaded test script ${thisFile}\n`);
+      log.prettyMarkdown(markdown);
+      logger.info("New commands will be appended.")
+      console.log('')
 
-New commands will be appended.
-`);
+    }
   }
 
   promptUser();
@@ -1072,6 +1056,7 @@ let runRawYML = async (yml) => {
   // add the root key steps: with array of commands:
   if (ymlObj && !ymlObj.steps) {
     ymlObj = {
+      version: package.version,
       steps: [ymlObj],
     };
   }
@@ -1080,7 +1065,7 @@ let runRawYML = async (yml) => {
   fs.writeFileSync(tmpobj.name, yaml.dump(ymlObj));
 
   // and run it with run()
-  await run(tmpobj.name, false, true);
+  await run(tmpobj.name, false, false);
 };
 
 // this will load a regression test from a file location
@@ -1156,7 +1141,7 @@ ${yaml.dump(step)}
 
 const promptUser = () => {
   emitter.emit(events.interactive, true);
-  rl.prompt(true);
+  process.nextTick(() => rl.prompt());
 };
 
 const setTerminalApp = async (win) => {
@@ -1235,6 +1220,43 @@ const start = async () => {
   //   process.exit();
   // }
 
+  let a = getArgs();
+
+  // make testdriver directory if it doesn't exist
+  let testdriverFolder = path.join(workingDir, "testdriver");
+  if (!fs.existsSync(testdriverFolder)) {
+
+    fs.mkdirSync(testdriverFolder);
+    // log
+    logger.info(chalk.dim(`Created testdriver directory`));
+    console.log(
+      chalk.dim(`Created testdriver directory: ${testdriverFolder}`),
+    );
+
+  }
+
+  // if testdriver.yaml doesn't exist, make it
+  let testdriverFile = path.join(testdriverFolder, "testdriver.yaml");
+  if (!fs.existsSync(testdriverFile)) {
+    fs.writeFileSync(testdriverFile, "");
+    logger.info(chalk.dim(`Created testdriver.yaml`));
+    console.log(chalk.dim(`Created testdriver.yaml: ${testdriverFile}`));
+  }
+
+  thisFile = a.file;
+  const thisCommand = a.command;
+
+  logger.info(chalk.green(`Howdy! I'm TestDriver v${package.version}`));
+  logger.info(`This is beta software!`);
+  logger.info("");
+  logger.info(chalk.yellow(`Join our Discord for help`));
+  logger.info(`https://discord.com/invite/cWDFW8DzPm`);
+  logger.info("");
+
+  // individual run ID for this session
+  // let runID = new Date().getTime();
+
+
   // await sdk.auth();
   if (thisCommand !== "run") {
     speak("Howdy! I am TestDriver version " + package.version);
@@ -1242,6 +1264,7 @@ const start = async () => {
 
   if (thisCommand !== "init" && thisCommand !== "upload-secrets") {
     logger.info(chalk.dim(`Working on ${thisFile}`));
+    console.log("");
 
     loadYML(thisFile)
 
@@ -1249,11 +1272,11 @@ const start = async () => {
       logger.info(
         chalk.red("Warning! ") +
           chalk.dim(
-            "Local mode sends screenshots of the desktop to our API. Set `TD_VM=true` to run in a secure VM.",
+            "Local mode sends screenshots of the desktop to our API. Set `TD_VM` to run in a secure VM.",
           ),
       );
       logger.info(
-        chalk.dim("https://docs.testdriver.ai/security-and-privacy/agent"),
+        chalk.dim("Read More: https://docs.testdriver.ai/security-and-privacy/agent"),
       );
       logger.info("");
     }

package/index.js

@@ -9,7 +9,9 @@ if (process.argv[2] === "--help" || process.argv[2] === "-h") {
   console.log("Command: testdriverai [init, run, edit] [yaml filepath]");
   process.exit(0);
 }
+
 if (process.argv[2] === "--renderer") {
+
   const {
     // connectToOverlay,
     createOverlayProcess,
@@ -38,6 +40,7 @@ if (process.argv[2] === "--renderer") {
   })();
 } else {
   (async () => {
+
     if (!config.TD_OVERLAY) {
       let agent = require("./agent.js");
       await agent.start();

package/lib/commander.js

@@ -9,7 +9,7 @@ const analytics = require("./analytics");
 const marky = require("marky");
 const sdk = require("./sdk");
 const outputs = require("./outputs");
-const {server} = require("./ipc");
+const server = require("./ipc");
 
 // replace all occurances of ${OUTPUT.ls} with outputs.get("ls") in every possible property of the `object` 
 // this is a recursive function that will go through all the properties of the object

package/lib/commands.js

@@ -2,7 +2,7 @@
 const sdk = require("./sdk");
 const vm = require("vm");
 const chalk = require("chalk");
-const server = require("./ipc").server;
+const server = require("./ipc");
 const {
   captureScreenBase64,
   captureScreenPNG,

package/lib/config.js

@@ -34,7 +34,8 @@ const config = {
   TD_SECRET: null,
   TD_VM: false,
   TD_OVERLAY_ID: null,
-  TD_VM_RESOLUTION: [1024, 768]
+  TD_VM_RESOLUTION: [1024, 768],
+  TD_IPC_ID: `testdriverai_${process.pid}`,
 };
 
 // Find all env vars starting with TD_

package/lib/ipc.js

@@ -1,50 +1,17 @@
-const { EventEmitter } = require("events");
-const { default: nodeIPC } = require("node-ipc");
-const { IPC } = nodeIPC;
+let { emitter } = require("./events");
 
-class IPCServerSingleton extends EventEmitter {
-  ipc = new IPC();
-  interactive = false;
+process.on("connect", () => {
+  broadcast("connect", {});
+});
 
-  /**
-   * @type {Map<string, Function[]>}
-   */
-  eventListeners;
+process.on("message", (raw) => {
+  let { event, data } = JSON.parse(raw);
+  emitter.emit(event, data);
+});
 
-  constructor() {
-    if (!IPCServerSingleton.instance) {
-      super();
-      this.ipc = new IPC();
-      this.eventListeners = new Map();
-
-      this.ipc.config.id = `testdriverai_${process.pid}`;
-      this.ipc.config.retry = 50;
-      this.ipc.config.silent = true;
-
-      this.ipc.serve(() => {
-        this.ipc.server.on("connect", (socket) => {
-          this.ipc.server.emit(socket, "interactive", this.interactive);
-        });
-
-        this.ipc.server.on("message", ({ event, data }) => {
-          this.emit(event, data);
-        });
-      });
-
-      this.ipc.server.start();
-
-      IPCServerSingleton.instance = this;
-    }
-    return IPCServerSingleton.instance;
-  }
-
-  broadcast(event, data) {
-    if (event === "interactive") {
-      this.interactive = data;
-    }
-    this.ipc.server.broadcast("message", { event, data });
-  }
+let broadcast = (event, data) => {
+  let d = {event, data};
+  process.send(d);
 }
 
-const server = new IPCServerSingleton();
-module.exports = { server };
+module.exports = { broadcast, emitter };

package/lib/logger.js

@@ -1,7 +1,7 @@
 // central logger for the bot
 const winston = require("winston");
 const os = require("os");
-const { server } = require("./ipc");
+const server = require("./ipc");
 
 // simple match for aws instance i-*
 const shouldLog =

package/lib/system.js

@@ -162,7 +162,9 @@ const initializeActiveWindow = async () => {
     // For some reason, the import fails in certain situations
     const activeWindow = await import("get-windows")
       .then(({ activeWindow }) => activeWindow)
-      .catch(() => null);
+      .catch(() => {
+        return null;
+      });
     activeWindowFn = activeWindow;
   }
   return activeWindowFn;
@@ -174,7 +176,14 @@ const activeWin = async () => {
     return "error getting active window, proceed normally";
   } else {
     const activeWindow = await initializeActiveWindow();
-    return await activeWindow?.();
+    let windows;
+    try {
+      windows = await activeWindow?.();
+    } catch (e) {
+      console.error("Error getting active window", e);
+        return "error getting active window, proceed normally";
+    }
+    return windows;
   }
 };
 

package/package.json

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

package/schema.json

@@ -70,26 +70,26 @@
                       "keys": {
                         "type": "array",
                         "items": {
-                          "type": "string"
-                        },
-                        "enum": [
-                          [
-                            "backspace", "delete", "enter", "tab", "escape", "up", "down", "right", "left",
-                            "home", "end", "pageup", "pagedown", "f1", "f2", "f3", "f4", "f5", "f6", "f7",
-                            "f8", "f9", "f10", "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18", "f19",
-                            "f20", "f21", "f22", "f23", "f24", "capslock", "command", "alt", "right_alt",
-                            "control", "left_control", "right_control", "shift", "right_shift", "space",
-                            "printscreen", "insert", "menu", "audio_mute", "audio_vol_down", "audio_vol_up",
-                            "audio_play", "audio_stop", "audio_pause", "audio_prev", "audio_next",
-                            "audio_rewind", "audio_forward", "audio_repeat", "audio_random", "numpad_lock",
-                            "numpad_0", "numpad_1", "numpad_2", "numpad_3", "numpad_4", "numpad_5",
-                            "numpad_6", "numpad_7", "numpad_8", "numpad_9", "numpad_+", "numpad_-",
-                            "numpad_*", "numpad_/", "numpad_.", "lights_mon_up", "lights_mon_down",
-                            "lights_kbd_toggle", "lights_kbd_up", "lights_kbd_down", "a", "b", "c", "d", "e",
-                            "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u",
-                            "v", "w", "x", "y", "z", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"
+                          "type": "string",
+                          "enum": [
+                            [
+                              "backspace", "delete", "enter", "tab", "escape", "up", "down", "right", "left",
+                              "home", "end", "pageup", "pagedown", "f1", "f2", "f3", "f4", "f5", "f6", "f7",
+                              "f8", "f9", "f10", "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18", "f19",
+                              "f20", "f21", "f22", "f23", "f24", "capslock", "command", "alt", "right_alt",
+                              "control", "left_control", "right_control", "shift", "right_shift", "space",
+                              "printscreen", "insert", "menu", "audio_mute", "audio_vol_down", "audio_vol_up",
+                              "audio_play", "audio_stop", "audio_pause", "audio_prev", "audio_next",
+                              "audio_rewind", "audio_forward", "audio_repeat", "audio_random", "numpad_lock",
+                              "numpad_0", "numpad_1", "numpad_2", "numpad_3", "numpad_4", "numpad_5",
+                              "numpad_6", "numpad_7", "numpad_8", "numpad_9", "numpad_+", "numpad_-",
+                              "numpad_*", "numpad_/", "numpad_.", "lights_mon_up", "lights_mon_down",
+                              "lights_kbd_toggle", "lights_kbd_up", "lights_kbd_down", "a", "b", "c", "d", "e",
+                              "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u",
+                              "v", "w", "x", "y", "z", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"
+                            ]
                           ]
-                        ]
+                        }
                       }
                     },
                     "required": [