@dev-blinq/cucumber_client 1.0.1345-dev → 1.0.1345-stage

package/bin/client/recorderv3/bvt_recorder.js

@@ -12,11 +12,12 @@ import { updateFeatureFile } from "./update_feature.js";
 import { parseStepTextParameters } from "../cucumber/utils.js";
 import { AstBuilder, GherkinClassicTokenMatcher, Parser } from "@cucumber/gherkin";
 import chokidar from "chokidar";
-import logger from "../../logger.js";
 import { unEscapeNonPrintables } from "../cucumber/utils.js";
 import { findAvailablePort } from "../utils/index.js";
-import { Step } from "../cucumber/feature.js";
-
+import socketLogger from "../utils/socket_logger.js";
+import { tmpdir } from "os";
+import { faker } from "@faker-js/faker/locale/en_US";
+import { chromium } from "playwright-core";
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
 const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
@@ -45,15 +46,15 @@ async function evaluate(frame, script) {
 async function findNestedFrameSelector(frame, obj) {
   try {
     const parent = frame.parentFrame();
-    if (parent) console.log(`Parent frame: ${JSON.stringify(parent)}`);
     if (!parent) return { children: obj };
     const frameElement = await frame.frameElement();
     if (!frameElement) return;
     const selectors = await parent.evaluate((element) => {
-      return window.getPWLocators(element);
+      return window.__bvt_Recorder.locatorGenerator.getElementLocators(element, { excludeText: true }).locators;
     }, frameElement);
     return findNestedFrameSelector(parent, { children: obj, selectors });
   } catch (e) {
+    socketLogger.error(`Error in findNestedFrameSelector: ${e}`);
     console.error(e);
   }
 }
@@ -150,6 +151,7 @@ const transformAction = (action, el, isVerify, isPopupCloseClick, isInHoverMode,
       };
     }
     default: {
+      socketLogger.error(`Action not supported: ${action.name}`);
       console.log("action not supported", action);
       throw new Error("action not supported");
     }
@@ -161,6 +163,7 @@ const transformAction = (action, el, isVerify, isPopupCloseClick, isInHoverMode,
  * @property {string} projectDir
  * @property {string} TOKEN
  * @property {(name:string, data:any)=> void} sendEvent
+ * @property {Object} logger
  */
 export class BVTRecorder {
   #currentURL = "";
@@ -174,7 +177,6 @@ export class BVTRecorder {
    */
   constructor(initialState) {
     Object.assign(this, initialState);
-    this.logger = logger;
     this.screenshotMap = new Map();
     this.snapshotMap = new Map();
     this.scenariosStepsMap = new Map();
@@ -184,40 +186,16 @@ export class BVTRecorder {
       projectDir: this.projectDir,
       logger: this.logger,
     });
-    this.stepRunner = new BVTStepRunner({
-      projectDir: this.projectDir,
-      sendExecutionStatus: (data) => {
-        if (data && data.type) {
-          switch (data.type) {
-            case "cmdExecutionStart":
-              console.log("Sending cmdExecutionStart event for cmdId:", data);
-              this.sendEvent(this.events.cmdExecutionStart, data);
-              break;
-            case "cmdExecutionSuccess":
-              console.log("Sending cmdExecutionSuccess event for cmdId:", data);
-              this.sendEvent(this.events.cmdExecutionSuccess, data);
-              break;
-            case "cmdExecutionError":
-              console.log("Sending cmdExecutionError event for cmdId:", data);
-              this.sendEvent(this.events.cmdExecutionError, data);
-              break;
-            case "interceptResults":
-              console.log("Sending interceptResults event");
-              this.sendEvent(this.events.interceptResults, data);
-              break;
-            default:
-              console.warn("Unknown command execution status type:", data.type);
-              break;
-          }
-        }
-      },
-    });
     this.pageSet = new Set();
+    this.pageMetaDataSet = new Set();
     this.lastKnownUrlPath = "";
-    // TODO: what is world?
     this.world = { attach: () => {} };
     this.shouldTakeScreenshot = true;
     this.watcher = null;
+    this.networkEventsFolder = path.join(tmpdir(), "blinq_network_events");
+    if (existsSync(this.networkEventsFolder)) {
+      rmSync(this.networkEventsFolder, { recursive: true, force: true });
+    }
   }
   events = {
     onFrameNavigate: "BVTRecorder.onFrameNavigate",
@@ -232,12 +210,14 @@ export class BVTRecorder {
     cmdExecutionSuccess: "BVTRecorder.cmdExecutionSuccess",
     cmdExecutionError: "BVTRecorder.cmdExecutionError",
     interceptResults: "BVTRecorder.interceptResults",
+    onDebugURLChange: "BVTRecorder.onDebugURLChange",
+    updateCommand: "BVTRecorder.updateCommand",
   };
   bindings = {
     __bvt_recordCommand: async ({ frame, page, context }, event) => {
       this.#activeFrame = frame;
       const nestFrmLoc = await findNestedFrameSelector(frame);
-      console.log(`Time taken for action: ${event.statistics.time}`);
+      this.logger.info(`Time taken for action: ${event.statistics.time}`);
       await this.onAction({ ...event, nestFrmLoc });
     },
     __bvt_getMode: async () => {
@@ -256,8 +236,7 @@ export class BVTRecorder {
       await this.onClosePopup();
     },
     __bvt_log: async (src, message) => {
-      // this.logger.info(message);
-      console.log(`Inside Browser: ${message}`);
+      this.logger.info(`Inside Browser: ${message}`);
     },
     __bvt_getObject: (_src, obj) => {
       this.processObject(obj);
@@ -269,7 +248,6 @@ export class BVTRecorder {
     const locator = await this.web.page.locator(selector);
     const snapshot = await locator.ariaSnapshot();
     return snapshot;
-    // Triggering workflow
   };
 
   processObject = async ({ type, action, value }) => {
@@ -320,10 +298,11 @@ export class BVTRecorder {
   }
 
   async _initBrowser({ url }) {
+    socketLogger.info("Only present in 1.0.1293-stage");
     this.#remoteDebuggerPort = await findAvailablePort();
     process.env.CDP_LISTEN_PORT = this.#remoteDebuggerPort;
 
-    this.stepRunner.setRemoteDebugPort(this.#remoteDebuggerPort);
+    // this.stepRunner.setRemoteDebugPort(this.#remoteDebuggerPort);
     this.world = { attach: () => {} };
 
     const ai_config_file = path.join(this.projectDir, "ai_config.json");
@@ -332,9 +311,10 @@ export class BVTRecorder {
       try {
         ai_config = JSON.parse(readFileSync(ai_config_file, "utf8"));
       } catch (error) {
-        console.error("Error reading ai_config.json", error);
+        this.logger.error("Error reading ai_config.json", error);
       }
     }
+    this.config = ai_config;
     const initScripts = {
       // recorderCjs: injectedScriptSource,
       scripts: [
@@ -343,16 +323,37 @@ export class BVTRecorder {
       ],
     };
 
-    let startTime = Date.now();
     const bvtContext = await initContext(url, false, false, this.world, 450, initScripts, this.envName);
-    let stopTime = Date.now();
-    this.logger.info(`Browser launched in ${(stopTime - startTime) / 1000} s`);
     this.bvtContext = bvtContext;
+    this.stepRunner = new BVTStepRunner({
+      projectDir: this.projectDir,
+      sendExecutionStatus: (data) => {
+        if (data && data.type) {
+          switch (data.type) {
+            case "cmdExecutionStart":
+              this.sendEvent(this.events.cmdExecutionStart, data);
+              break;
+            case "cmdExecutionSuccess":
+              this.sendEvent(this.events.cmdExecutionSuccess, data);
+              break;
+            case "cmdExecutionError":
+              this.sendEvent(this.events.cmdExecutionError, data);
+              break;
+            case "interceptResults":
+              this.sendEvent(this.events.interceptResults, data);
+              break;
+            default:
+              break;
+          }
+        }
+      },
+      bvtContext: this.bvtContext,
+    });
     const context = bvtContext.playContext;
     this.context = context;
     this.web = bvtContext.stable || bvtContext.web;
+    this.web.tryAllStrategies = true;
     this.page = bvtContext.page;
-
     this.pageSet.add(this.page);
     this.lastKnownUrlPath = this._updateUrlPath();
     const browser = await this.context.browser();
@@ -366,6 +367,14 @@ export class BVTRecorder {
     this.web.onRestoreSaveState = (url) => {
       this._initBrowser({ url });
     };
+
+    // create a second browser for locator generation
+    this.backgroundBrowser = await chromium.launch({
+      headless: true,
+    });
+    this.backgroundContext = await this.backgroundBrowser.newContext({});
+    await this.backgroundContext.addInitScript({ content: this.getInitScripts(this.config) });
+    await this.backgroundContext.newPage();
   }
   async onClosePopup() {
     // console.log("close popups");
@@ -380,13 +389,15 @@ export class BVTRecorder {
         }
         return;
       } catch (error) {
-        console.error("Error evaluting in context:", error);
+        // console.error("Error evaluting in context:", error);
+        this.logger.error("Error evaluating in context:", error);
       }
     }
   }
 
   getMode() {
-    console.log("getMode", this.#mode);
+    // console.log("getMode", this.#mode);
+    this.logger.info("Current mode:", this.#mode);
     return this.#mode;
   }
 
@@ -428,6 +439,8 @@ export class BVTRecorder {
           this.sendEvent(this.events.onBrowserClose);
         }
       } catch (error) {
+        this.logger.error("Error in page close event");
+        this.logger.error(error);
         console.error("Error in page close event");
         console.error(error);
       }
@@ -438,8 +451,10 @@ export class BVTRecorder {
         if (frame !== page.mainFrame()) return;
         this.handlePageTransition();
       } catch (error) {
+        this.logger.error("Error in handlePageTransition event");
+        this.logger.error(error);
         console.error("Error in handlePageTransition event");
-        // console.error(error);
+        console.error(error);
       }
       try {
         if (frame !== this.#activeFrame) return;
@@ -458,6 +473,8 @@ export class BVTRecorder {
         // await this._setRecordingMode(frame);
         // await this._initPage(page);
       } catch (error) {
+        this.logger.error("Error in frame navigate event");
+        this.logger.error(error);
         console.error("Error in frame navigate event");
         // console.error(error);
       }
@@ -540,13 +557,9 @@ export class BVTRecorder {
 
     try {
       const result = await client.send("Page.getNavigationHistory");
-      // console.log("Navigation History:", result);
       const entries = result.entries;
       const currentIndex = result.currentIndex;
 
-      // ignore if currentIndex is not the last entry
-      // if (currentIndex !== entries.length - 1) return;
-
       const currentEntry = entries[currentIndex];
       const transitionInfo = this.analyzeTransitionType(entries, currentIndex, currentEntry);
       this.previousIndex = currentIndex;
@@ -559,6 +572,8 @@ export class BVTRecorder {
         navigationAction: transitionInfo.action,
       };
     } catch (error) {
+      this.logger.error("Error in getCurrentTransition event");
+      this.logger.error(error);
       console.error("Error in getTransistionType event", error);
     } finally {
       await client.detach();
@@ -623,9 +638,12 @@ export class BVTRecorder {
         this.pageSet.add(page);
 
         await page.waitForLoadState("domcontentloaded");
+
         // add listener for frame navigation on new tab
         this._addFrameNavigateListener(page);
       } catch (error) {
+        this.logger.error("Error in page event");
+        this.logger.error(error);
         console.error("Error in page event");
         console.error(error);
       }
@@ -667,6 +685,7 @@ export class BVTRecorder {
       const { data } = await client.send("Page.captureScreenshot", { format: "png" });
       return data;
     } catch (error) {
+      this.logger.error("Error in taking browser screenshot");
       console.error("Error in taking browser screenshot", error);
     } finally {
       await client.detach();
@@ -682,6 +701,52 @@ export class BVTRecorder {
       console.error("Error in saving screenshot: ", error);
     }
   }
+  async generateLocators(event) {
+    const snapshotDetails = event.snapshotDetails;
+    if (!snapshotDetails) {
+      throw new Error("No snapshot details found");
+    }
+    const mode = event.mode;
+    const inputID = event.element.inputID;
+
+    const { id, contextId, doc } = snapshotDetails;
+    // const selector = `[data-blinq-id="${id}"]`;
+    const newPage = await this.backgroundContext.newPage();
+    await newPage.setContent(doc);
+    const locatorsObj = await newPage.evaluate(
+      ([id, contextId, mode]) => {
+        const recorder = window.__bvt_Recorder;
+        const contextElement = document.querySelector(`[data-blinq-context-id="${contextId}"]`);
+        const el = document.querySelector(`[data-blinq-id="${id}"]`);
+        if (contextElement) {
+          const result = recorder.locatorGenerator.toContextLocators(el, contextElement);
+          return result;
+        }
+        const isRecordingText = mode === "recordingText";
+        return recorder.locatorGenerator.getElementLocators(el, {
+          excludeText: isRecordingText,
+        });
+      },
+      [id, contextId, mode]
+    );
+
+    console.log(`Generated locators: for ${inputID}: `, JSON.stringify(locatorsObj));
+    await newPage.close();
+    if (event.nestFrmLoc?.children) {
+      locatorsObj.nestFrmLoc = event.nestFrmLoc.children;
+    }
+
+    this.sendEvent(this.events.updateCommand, {
+      locators: {
+        locators: locatorsObj.locators,
+        nestFrmLoc: locatorsObj.nestFrmLoc,
+        iframe_src: !event.frame.isTop ? event.frame.url : undefined,
+      },
+      allStrategyLocators: locatorsObj.allStrategyLocators,
+      inputID,
+    });
+    // const
+  }
   async onAction(event) {
     this._updateUrlPath();
     // const locators = this.overlayLocators(event);
@@ -695,26 +760,26 @@ export class BVTRecorder {
         event.mode === "recordingHover",
         event.mode === "multiInspecting"
       ),
-      locators: {
-        locators: event.locators,
-        iframe_src: !event.frame.isTop ? event.frame.url : undefined,
-      },
-      allStrategyLocators: event.allStrategyLocators,
+      // locators: {
+      //   locators: event.locators,
+      //   iframe_src: !event.frame.isTop ? event.frame.url : undefined,
+      // },
+      // allStrategyLocators: event.allStrategyLocators,
       url: event.frame.url,
       title: event.frame.title,
       extract: {},
       lastKnownUrlPath: this.lastKnownUrlPath,
     };
-    if (event.nestFrmLoc?.children) {
-      cmdEvent.locators.nestFrmLoc = event.nestFrmLoc.children;
-    }
+    // if (event.nestFrmLoc?.children) {
+    //   cmdEvent.locators.nestFrmLoc = event.nestFrmLoc.children;
+    // }
     // this.logger.info({ event });
     if (this.shouldTakeScreenshot) {
       await this.storeScreenshot(event);
     }
-
     this.sendEvent(this.events.onNewCommand, cmdEvent);
     this._updateUrlPath();
+    await this.generateLocators(event);
   }
   _updateUrlPath() {
     try {
@@ -788,7 +853,6 @@ export class BVTRecorder {
   }
 
   async startRecordingInput() {
-    console.log("startRecordingInput");
     await this.setMode("recordingInput");
   }
   async stopRecordingInput() {
@@ -812,9 +876,17 @@ export class BVTRecorder {
   }
 
   async abortExecution() {
-    this.bvtContext.web.abortedExecution = true;
     await this.stepRunner.abortExecution();
   }
+
+  async pauseExecution({ cmdId }) {
+    await this.stepRunner.pauseExecution(cmdId);
+  }
+
+  async resumeExecution({ cmdId }) {
+    await this.stepRunner.resumeExecution(cmdId);
+  }
+
   async dealyedRevertMode() {
     const timerId = setTimeout(async () => {
       await this.revertMode();
@@ -828,13 +900,15 @@ export class BVTRecorder {
       TEMP_RUN: true,
       REPORT_FOLDER: this.bvtContext.reportFolder,
       BLINQ_ENV: this.envName,
-      STORE_DETAILED_NETWORK_DATA: listenNetwork ? "true" : "false",
-      CURRENT_STEP_ID: step.id,
     };
 
     this.bvtContext.navigate = true;
     this.bvtContext.loadedRoutes = null;
-    this.bvtContext.web.abortedExecution = false;
+    if (listenNetwork) {
+      this.bvtContext.STORE_DETAILED_NETWORK_DATA = true;
+    } else {
+      this.bvtContext.STORE_DETAILED_NETWORK_DATA = false;
+    }
     for (const [key, value] of Object.entries(_env)) {
       process.env[key] = value;
     }
@@ -852,6 +926,7 @@ export class BVTRecorder {
           parametersMap,
           envPath: this.envName,
           tags,
+          config: this.config,
         },
         this.bvtContext,
         {
@@ -906,6 +981,7 @@ export class BVTRecorder {
     //   map: this.scenariosStepsMap,
     // });
   }
+
   async generateStepName({ commands, stepsNames, parameters, map }) {
     return await this.namesService.generateStepName({ commands, stepsNames, parameters, map });
   }
@@ -957,10 +1033,11 @@ export class BVTRecorder {
     if (existsSync(_getDataFile(this.world, this.bvtContext, this.web))) {
       try {
         const testData = JSON.parse(readFileSync(_getDataFile(this.world, this.bvtContext, this.web), "utf8"));
-        this.logger.info("Test data", testData);
+        // this.logger.info("Test data", testData);
         this.sendEvent(this.events.getTestData, testData);
       } catch (e) {
-        this.logger.error("Error reading test data file", e);
+        // this.logger.error("Error reading test data file", e);
+        console.log("Error reading test data file", e);
       }
     }
 
@@ -969,10 +1046,12 @@ export class BVTRecorder {
     this.watcher.on("all", async (event, path) => {
       try {
         const testData = JSON.parse(await readFile(_getDataFile(this.world, this.bvtContext, this.web), "utf8"));
-        this.logger.info("Test data", testData);
+        // this.logger.info("Test data", testData);
+        console.log("Test data changed", testData);
         this.sendEvent(this.events.getTestData, testData);
       } catch (e) {
-        this.logger.error("Error reading test data file", e);
+        // this.logger.error("Error reading test data file", e);
+        console.log("Error reading test data file", e);
       }
     });
   }
@@ -1005,7 +1084,7 @@ export class BVTRecorder {
       .filter((file) => file.endsWith(".feature"))
       .map((file) => path.join(this.projectDir, "features", file));
     try {
-      const parsedFiles = featureFiles.map((file) => parseFeatureFile(file));
+      const parsedFiles = featureFiles.map((file) => this.parseFeatureFile(file));
       const output = {};
       parsedFiles.forEach((file) => {
         if (!file.feature) return;
@@ -1033,7 +1112,7 @@ export class BVTRecorder {
   loadExistingScenario({ featureName, scenarioName }) {
     const step_definitions = loadStepDefinitions(this.projectDir);
     const featureFilePath = path.join(this.projectDir, "features", featureName);
-    const gherkinDoc = parseFeatureFile(featureFilePath);
+    const gherkinDoc = this.parseFeatureFile(featureFilePath);
     const scenario = gherkinDoc.feature.children.find((child) => child.scenario.name === scenarioName)?.scenario;
 
     const steps = [];
@@ -1189,23 +1268,57 @@ export class BVTRecorder {
   }
   async resetExecution({ tags = [] }) {
     // run after hooks followed by before hooks
-    await this.runAfterHooks({ tags });
-    await this.runBeforeHooks({ tags });
+    await this.cleanupExecution({ tags });
+    await this.initExecution({ tags });
   }
-}
 
-const parseFeatureFile = (featureFilePath) => {
-  try {
-    let id = 0;
-    const uuidFn = () => (++id).toString(16);
-    const builder = new AstBuilder(uuidFn);
-    const matcher = new GherkinClassicTokenMatcher();
-    const parser = new Parser(builder, matcher);
-    const source = readFileSync(featureFilePath, "utf8");
-    const gherkinDocument = parser.parse(source);
-    return gherkinDocument;
-  } catch (e) {
-    console.log(e);
+  parseFeatureFile(featureFilePath) {
+    try {
+      let id = 0;
+      const uuidFn = () => (++id).toString(16);
+      const builder = new AstBuilder(uuidFn);
+      const matcher = new GherkinClassicTokenMatcher();
+      const parser = new Parser(builder, matcher);
+      const source = readFileSync(featureFilePath, "utf8");
+      const gherkinDocument = parser.parse(source);
+      return gherkinDocument;
+    } catch (e) {
+      this.logger.error(`Error parsing feature file: ${featureFilePath}`);
+      console.log(e);
+    }
+    return {};
   }
-  return {};
-};
+
+  stopRecordingNetwork(input) {
+    if (this.bvtContext) {
+      this.bvtContext.STORE_DETAILED_NETWORK_DATA = false;
+    }
+  }
+
+  async fakeParams(params) {
+    const newFakeParams = {};
+    Object.keys(params).forEach((key) => {
+      if (!params[key].startsWith("{{") || !params[key].endsWith("}}")) {
+        newFakeParams[key] = params[key];
+        return;
+      }
+
+      try {
+        const value = params[key].substring(2, params[key].length - 2).trim();
+        const faking = value.split("(")[0].split(".");
+        let argument = value.substring(value.indexOf("(") + 1, value.lastIndexOf(")"));
+        argument = isNaN(Number(argument)) || argument === "" ? argument : Number(argument);
+        let fakeFunc = faker;
+        faking.forEach((f) => {
+          fakeFunc = fakeFunc[f];
+        });
+        const newValue = fakeFunc(argument);
+        newFakeParams[key] = newValue;
+      } catch (error) {
+        newFakeParams[key] = params[key];
+      }
+    });
+
+    return newFakeParams;
+  }
+}

package/bin/client/recorderv3/implemented_steps.js

@@ -13,7 +13,6 @@ const uuidFn = () => (++id).toString(16);
 const builder = new AstBuilder(uuidFn);
 const matcher = new GherkinClassicTokenMatcher();
 const parser = new Parser(builder, matcher);
-
 let i = 0;
 const getImplId = () => {
   return `I-${i++}`;
@@ -61,6 +60,11 @@ export function parseRouteFiles(projectDir, step) {
   const routeFolder = path.join(projectDir, "data", "routes");
   const templateRouteMap = new Map();
 
+  if (!existsSync(routeFolder)) {
+    step.routeItems = null;
+    return;
+  }
+
   // Go over all the files in the route folder and parse them
   const routeFiles = readdirSync(routeFolder).filter((file) => file.endsWith(".json"));
   for (const file of routeFiles) {
@@ -87,8 +91,8 @@ export function parseRouteFiles(projectDir, step) {
         const filters = item.filters || {};
         const queryParams = filters?.queryParams || {};
         const queryParamsArray = Object.keys(queryParams).map((key) => ({
-          paramKey: key,
-          paramValue: queryParams[key],
+          key: key,
+          value: queryParams[key],
         }));
         filters.queryParams = queryParamsArray || [];
       });
@@ -112,6 +116,12 @@ export const getImplementedSteps = async (projectDir) => {
     const utilsContent = readFileSync(utilsTemplateFilePath, "utf8");
     //console.log({ utilsContent });
     writeFileSync(utilsFilePath, utilsContent, "utf8");
+    const hooksTemplateFilePath = path.join(__dirname, "../../assets", "templates", "_hooks_template.txt");
+    if (existsSync(hooksTemplateFilePath)) {
+      const hooksFilePath = path.join(stepDefinitionFolderPath, "_hooks.mjs");
+      const hooksContent = readFileSync(hooksTemplateFilePath, "utf8");
+      writeFileSync(hooksFilePath, hooksContent, "utf8");
+    }
   } catch (error) {
     foundErrors.push({ error });
   }
@@ -284,17 +294,17 @@ export const getImplementedSteps = async (projectDir) => {
     for (const tag of scenario.tags) {
       delete tag.location;
     }
-    // for (const scenario of scenarios) {
-    //   for (const step of scenario.steps) {
-    //     if (step.templateIndex === undefined) {
-    //       const cleanStepName = stepsDefinitions._stepNameToTemplate(step.text);
-    //       const index = implementedSteps.findIndex((istep) => {
-    //         return cleanStepName === istep.pattern;
-    //       });
-    //       step.templateIndex = index;
-    //     }
-    //   }
-    // }
+    for (const scenario of scenarios) {
+      for (const step of scenario.steps) {
+        if (step.templateIndex === undefined) {
+          const cleanStepName = stepsDefinitions._stepNameToTemplate(step.text);
+          const index = implementedSteps.findIndex((istep) => {
+            return cleanStepName === istep.pattern;
+          });
+          step.templateIndex = index;
+        }
+      }
+    }
   }
   if (foundErrors.length > 0) {
     console.log("foundErrors", foundErrors);