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

package/bin/client/recorderv3/bvt_recorder.js

@@ -3,7 +3,7 @@ import { closeContext, initContext, _getDataFile, resetTestData } from "automati
 import { existsSync, readdirSync, readFileSync, rmSync } from "fs";
 import path from "path";
 import url from "url";
-import { getImplementedSteps, getStepsAndCommandsForScenario } from "./implemented_steps.js";
+import { getImplementedSteps, parseRouteFiles } from "./implemented_steps.js";
 import { NamesService } from "./services.js";
 import { BVTStepRunner } from "./step_runner.js";
 import { readFile, writeFile } from "fs/promises";
@@ -12,10 +12,9 @@ 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 socketLogger from "../utils/socket_logger.js";
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
 const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
@@ -24,11 +23,11 @@ export function getInitScript(config, options) {
   window.__bvt_Recorder_config = ${JSON.stringify(config ?? null)};
   window.__PW_options = ${JSON.stringify(options ?? null)};
   `;
-  const recorderScript = readFileSync(path.join(__dirname, "..", "..", "assets", "bundled_scripts", "recorder.js"), "utf8")
-  return (
-    preScript +
-    recorderScript
+  const recorderScript = readFileSync(
+    path.join(__dirname, "..", "..", "assets", "bundled_scripts", "recorder.js"),
+    "utf8"
   );
+  return preScript + recorderScript;
 }
 
 async function evaluate(frame, script) {
@@ -44,15 +43,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);
   }
 }
@@ -149,6 +148,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");
     }
@@ -160,6 +160,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 = "";
@@ -173,7 +174,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();
@@ -183,14 +183,10 @@ export class BVTRecorder {
       projectDir: this.projectDir,
       logger: this.logger,
     });
-    this.stepRunner = new BVTStepRunner({
-      projectDir: this.projectDir,
-    });
     this.pageSet = new Set();
-
+    this.pageMetaDataSet = new Set();
     this.lastKnownUrlPath = "";
-    // TODO: what is world?
-    this.world = { attach: () => { } };
+    this.world = { attach: () => {} };
     this.shouldTakeScreenshot = true;
     this.watcher = null;
   }
@@ -203,12 +199,16 @@ export class BVTRecorder {
     onStepDetails: "BVTRecorder.onStepDetails",
     getTestData: "BVTRecorder.getTestData",
     onGoto: "BVTRecorder.onGoto",
+    cmdExecutionStart: "BVTRecorder.cmdExecutionStart",
+    cmdExecutionSuccess: "BVTRecorder.cmdExecutionSuccess",
+    cmdExecutionError: "BVTRecorder.cmdExecutionError",
+    interceptResults: "BVTRecorder.interceptResults",
   };
   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 () => {
@@ -227,8 +227,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);
@@ -293,8 +292,8 @@ export class BVTRecorder {
     this.#remoteDebuggerPort = await findAvailablePort();
     process.env.CDP_LISTEN_PORT = this.#remoteDebuggerPort;
 
-    this.stepRunner.setRemoteDebugPort(this.#remoteDebuggerPort);
-    this.world = { attach: () => { } };
+    // this.stepRunner.setRemoteDebugPort(this.#remoteDebuggerPort);
+    this.world = { attach: () => {} };
 
     const ai_config_file = path.join(this.projectDir, "ai_config.json");
     let ai_config = {};
@@ -302,9 +301,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: [
@@ -313,16 +313,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();
@@ -350,13 +371,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;
   }
 
@@ -398,6 +421,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);
       }
@@ -408,8 +433,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;
@@ -428,11 +455,82 @@ 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);
       }
     });
   }
+
+  hasHistoryReplacementAtIndex(previousEntries, currentEntries, index) {
+    if (!previousEntries || !currentEntries) return false;
+    if (index >= previousEntries.length || index >= currentEntries.length) return false;
+
+    const prevEntry = previousEntries[index];
+    // console.log("prevEntry", prevEntry);
+    const currEntry = currentEntries[index];
+    // console.log("currEntry", currEntry);
+
+    // Check if the entry at this index has been replaced
+    return prevEntry.id !== currEntry.id;
+  }
+
+  // Even simpler approach for your specific case
+  analyzeTransitionType(entries, currentIndex, currentEntry) {
+    // console.log("Analyzing transition type");
+    // console.log("===========================");
+    // console.log("Current Index:", currentIndex);
+    // console.log("Current Entry:", currentEntry);
+    // console.log("Current Entries:", entries);
+    // console.log("Current entries length:", entries.length);
+    // console.log("===========================");
+    // console.log("Previous Index:", this.previousIndex);
+    // // console.log("Previous Entry:", this.previousEntries[this.previousIndex]);
+    // console.log("Previous Entries:", this.previousEntries);
+    // console.log("Previous entries length:", this.previousHistoryLength);
+
+    if (this.previousIndex === null || this.previousHistoryLength === null || !this.previousEntries) {
+      return {
+        action: "initial",
+      };
+    }
+
+    const indexDiff = currentIndex - this.previousIndex;
+    const lengthDiff = entries.length - this.previousHistoryLength;
+
+    // Backward navigation
+    if (indexDiff < 0) {
+      return { action: "back" };
+    }
+
+    // Forward navigation
+    if (indexDiff > 0 && lengthDiff === 0) {
+      // Check if the entry at current index is the same as before
+      const entryReplaced = this.hasHistoryReplacementAtIndex(this.previousEntries, entries, currentIndex);
+
+      if (entryReplaced) {
+        return { action: "navigate" }; // New navigation that replaced forward history
+      } else {
+        return { action: "forward" }; // True forward navigation
+      }
+    }
+
+    // New navigation (history grew)
+    if (lengthDiff > 0) {
+      return { action: "navigate" };
+    }
+
+    // Same position, same length
+    if (lengthDiff <= 0) {
+      const entryReplaced = this.hasHistoryReplacementAtIndex(this.previousEntries, entries, currentIndex);
+
+      return entryReplaced ? { action: "navigate" } : { action: "reload" };
+    }
+
+    return { action: "unknown" };
+  }
+
   async getCurrentTransition() {
     if (this?.web?.browser?._name !== "chromium") {
       return;
@@ -441,35 +539,68 @@ export class BVTRecorder {
 
     try {
       const result = await client.send("Page.getNavigationHistory");
-      // console.log("result", 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];
-      return currentEntry;
+      const transitionInfo = this.analyzeTransitionType(entries, currentIndex, currentEntry);
+      this.previousIndex = currentIndex;
+      this.previousHistoryLength = entries.length;
+      this.previousUrl = currentEntry.url;
+      this.previousEntries = [...entries]; // Store a copy of current entries
+
+      return {
+        currentEntry,
+        navigationAction: transitionInfo.action,
+      };
     } catch (error) {
-      console.error("Error in getTransistionType event");
+      this.logger.error("Error in getCurrentTransition event");
+      this.logger.error(error);
+      console.error("Error in getTransistionType event", error);
     } finally {
       await client.detach();
     }
   }
-  userInitiatedTranistionTypes = ["typed", "address_bar"];
+  userInitiatedTransitionTypes = ["typed", "address_bar"];
   async handlePageTransition() {
     const transition = await this.getCurrentTransition();
     if (!transition) return;
-    // console.log("transitionType", transition.transitionType);
-    if (this.userInitiatedTranistionTypes.includes(transition.transitionType)) {
-      const env = JSON.parse(readFileSync(this.envName), "utf8");
-      const baseUrl = env.baseUrl;
-      let url = transition.userTypedURL;
-      if (baseUrl && url.startsWith(baseUrl)) {
-        url = url.replace(baseUrl, "{{env.baseUrl}}");
-      }
-      // console.log("User initiated transition");
-      this.sendEvent(this.events.onGoto, { url });
+
+    const { currentEntry, navigationAction } = transition;
+
+    switch (navigationAction) {
+      case "initial":
+        // console.log("Initial navigation, no action taken");
+        return;
+      case "navigate":
+        // console.log("transitionType", transition.transitionType);
+        // console.log("sending onGoto event", { url: currentEntry.url,
+        // type: "navigate", });
+        if (this.userInitiatedTransitionTypes.includes(currentEntry.transitionType)) {
+          const env = JSON.parse(readFileSync(this.envName), "utf8");
+          const baseUrl = env.baseUrl;
+          let url = currentEntry.userTypedURL;
+          if (baseUrl && url.startsWith(baseUrl)) {
+            url = url.replace(baseUrl, "{{env.baseUrl}}");
+          }
+          // console.log("User initiated transition");
+          this.sendEvent(this.events.onGoto, { url, type: "navigate" });
+        }
+        return;
+      case "back":
+        // console.log("User navigated back");
+        // console.log("sending onGoto event", {
+        //   type: "back",
+        // });
+        this.sendEvent(this.events.onGoto, { type: "back" });
+        return;
+      case "forward":
+        // console.log("User navigated forward"); console.log("sending onGoto event", { type: "forward", });
+        this.sendEvent(this.events.onGoto, { type: "forward" });
+        return;
+      default:
+        this.sendEvent(this.events.onGoto, { type: "unknown" });
+        return;
     }
   }
 
@@ -493,6 +624,8 @@ export class BVTRecorder {
         // 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);
       }
@@ -534,6 +667,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();
@@ -596,8 +730,13 @@ export class BVTRecorder {
   }
   async closeBrowser() {
     delete process.env.TEMP_RUN;
-    await this.watcher.close().then(() => { });
+    await this.watcher.close().then(() => {});
     this.watcher = null;
+    this.previousIndex = null;
+    this.previousHistoryLength = null;
+    this.previousUrl = null;
+    this.previousEntries = null;
+
     await closeContext();
     this.pageSet.clear();
   }
@@ -674,40 +813,61 @@ export class BVTRecorder {
   async abortExecution() {
     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();
     }, 100);
     this.timerId = timerId;
   }
-  async runStep({ step, parametersMap }, options) {
+  async runStep({ step, parametersMap, tags, isFirstStep, listenNetwork }, options) {
+    const { skipAfter = true, skipBefore = !isFirstStep } = options || {};
     const _env = {
       TOKEN: this.TOKEN,
       TEMP_RUN: true,
       REPORT_FOLDER: this.bvtContext.reportFolder,
       BLINQ_ENV: this.envName,
+      STORE_DETAILED_NETWORK_DATA: listenNetwork ? "true" : "false",
+      DEBUG: "blinq:route",
     };
 
     this.bvtContext.navigate = true;
+    this.bvtContext.loadedRoutes = null;
     for (const [key, value] of Object.entries(_env)) {
       process.env[key] = value;
     }
+
     if (this.timerId) {
       clearTimeout(this.timerId);
       this.timerId = null;
     }
     await this.setMode("running");
+
     try {
-      await this.stepRunner.runStep(
+      const { result, info } = await this.stepRunner.runStep(
         {
           step,
           parametersMap,
           envPath: this.envName,
+          tags,
+          config: this.config,
         },
         this.bvtContext,
-        options
+        {
+          skipAfter,
+          skipBefore,
+        }
       );
       await this.revertMode();
+      return { info };
     } catch (error) {
       await this.revertMode();
       throw error;
@@ -718,15 +878,10 @@ export class BVTRecorder {
       this.bvtContext.navigate = false;
     }
   }
-  async runScenario({ steps, parametersMap }) {
-    for (const step of steps) {
-      await this.runStep({ step, parametersMap });
-    }
-  }
   async saveScenario({ scenario, featureName, override, isSingleStep }) {
     await updateStepDefinitions({ scenario, featureName, projectDir: this.projectDir }); // updates mjs files
     if (!isSingleStep) await updateFeatureFile({ featureName, scenario, override, projectDir: this.projectDir }); // updates gherkin files
-    await this.cleanup();
+    await this.cleanup({ tags: scenario.tags });
   }
   async getImplementedSteps() {
     const stepsAndScenarios = await getImplementedSteps(this.projectDir);
@@ -750,6 +905,7 @@ export class BVTRecorder {
         step.commands = [];
       }
     }
+    return steps;
     // return getStepsAndCommandsForScenario({
     //   name,
     //   featureName,
@@ -757,6 +913,7 @@ export class BVTRecorder {
     //   map: this.scenariosStepsMap,
     // });
   }
+
   async generateStepName({ commands, stepsNames, parameters, map }) {
     return await this.namesService.generateStepName({ commands, stepsNames, parameters, map });
   }
@@ -808,10 +965,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);
       }
     }
 
@@ -820,10 +978,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);
       }
     });
   }
@@ -839,9 +999,9 @@ export class BVTRecorder {
     }
   }
 
-  async discardTestData() {
+  async discardTestData({ tags }) {
     resetTestData(this.envName, this.world);
-    await this.cleanup();
+    await this.cleanup({ tags });
   }
   async addToTestData(obj) {
     if (!existsSync(_getDataFile(this.world, this.bvtContext, this.web))) {
@@ -856,7 +1016,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;
@@ -880,10 +1040,11 @@ export class BVTRecorder {
     const stepParams = parseStepTextParameters(stepName);
     return getCommandsForImplementedStep(stepName, step_definitions, stepParams).commands;
   }
+
   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 = [];
@@ -908,6 +1069,7 @@ export class BVTRecorder {
         ..._s,
         keyword: step.keyword.trim(),
       };
+      parseRouteFiles(this.projectDir, _step);
       steps.push(_step);
     }
     return {
@@ -947,7 +1109,7 @@ export class BVTRecorder {
     }
     return result;
   }
-  async cleanup() {
+  async cleanup({ tags }) {
     const noopStep = {
       text: "Noop",
       isImplemented: true,
@@ -961,6 +1123,7 @@ export class BVTRecorder {
         {
           step: noopStep,
           parametersMap: {},
+          tags: tags || [],
         },
         {
           skipAfter: false,
@@ -999,20 +1162,62 @@ export class BVTRecorder {
       return false;
     }
   }
-}
+  async initExecution({ tags = [] }) {
+    // run before hooks
+    const noopStep = {
+      text: "Noop",
+      isImplemented: true,
+    };
+    await this.runStep(
+      {
+        step: noopStep,
+        parametersMap: {},
+        tags,
+      },
+      {
+        skipBefore: false,
+        skipAfter: true,
+      }
+    );
+  }
+  async cleanupExecution({ tags = [] }) {
+    // run after hooks
+    const noopStep = {
+      text: "Noop",
+      isImplemented: true,
+    };
+    await this.runStep(
+      {
+        step: noopStep,
+        parametersMap: {},
+        tags,
+      },
+      {
+        skipBefore: true,
+        skipAfter: false,
+      }
+    );
+  }
+  async resetExecution({ tags = [] }) {
+    // run after hooks followed by before hooks
+    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 {};
-};
+}