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

package/bin/client/project.js

@@ -82,6 +82,12 @@ class Project {
       const utilsContent = readFileSync(utilsPath, "utf8");
       const utilsFileName = this.stepsFolder + "/utils.mjs";
       writeFileSync(utilsFileName, utilsContent, "utf8");
+      const hooksTemplateFilePath = path.join(__dirname, "../assets", "templates", "_hooks_template.txt");
+      if (existsSync(hooksTemplateFilePath)) {
+        const hooksFilePath = path.join(this.stepsFolder, "_hooks.mjs");
+        const hooksContent = readFileSync(hooksTemplateFilePath, "utf8");
+        writeFileSync(hooksFilePath, hooksContent, "utf8");
+      }
     } catch (e) {
       logger.error("Error loading utils_template");
     }
@@ -104,7 +110,7 @@ class Project {
         this.pages.push(page);
       }
     }
-    return envFile;
+    return this.environment.name;
   }
   getPagesNames() {
     let result = [];

package/bin/client/recorderv3/bvt_recorder.js

@@ -3,8 +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 pkg from "../../min/injectedScript.min.cjs";
-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";
@@ -16,41 +15,21 @@ 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";
+
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
-const { source: injectedScriptSource } = pkg;
+
 const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
-export function getInitScript(config) {
-  const popupHandlers = config?.popupHandlers ?? [];
-
-  const disableHighlight = config?.disableHighlight ?? false;
-
-  const disableMultipleLocators = config?.disableMultipleLocators ?? false;
-
-  const popupScript = `
-  window.__bvt_Recorder.setPopupHandlers(${JSON.stringify(popupHandlers)}); 
-  window.__bvt_Recorder.setDisableHighlight(${JSON.stringify(disableHighlight)});
-  window.__bvt_Recorder.setImproviseLocators(${JSON.stringify(!disableMultipleLocators)});`;
-  return (
-    [
-      path.join(__dirname, "..", "..", "assets", "preload", "accessibility.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "dom-utils.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "generateSelector.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "locators.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "unique_locators.js"),
-      // path.join(__dirname, "..", "..", "assets", "preload", "pw_locators.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "climb.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "text-locator.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "toolbar.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "recording-tool.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "find_context.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "recorderv3.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "findElementText.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "css_gen.js"),
-      path.join(__dirname, "..", "..", "assets", "preload", "yaml.js"),
-    ]
-      .map((filePath) => readFileSync(filePath, "utf8"))
-      .join("\n") + popupScript
+export function getInitScript(config, options) {
+  const preScript = `
+  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;
 }
 
 async function evaluate(frame, script) {
@@ -71,7 +50,7 @@ async function findNestedFrameSelector(frame, 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) {
@@ -205,11 +184,8 @@ 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: () => {} };
@@ -225,6 +201,10 @@ 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) => {
@@ -300,29 +280,22 @@ export class BVTRecorder {
     return result;
   }
   getInitScripts(config) {
-    return getInitScript(config);
-    // const scripts = []
-    // scripts.push(...this.getPWScript());
-    // scripts.push(...this.getRecorderScripts());
-
-    // const popupHandlers = config?.popupHandlers ?? [];
-    // const disableHighlight = config?.disableHighlight ?? false;
-    // const disableMultipleLocators = config?.disableMultipleLocators ?? false;
-
-    // const inlineScript = `
-    // window.__bvt_Recorder.setPopupHandlers(${JSON.stringify(popupHandlers)});
-    // window.__bvt_Recorder.setDisableHighlight(${JSON.stringify(disableHighlight)});
-    // window.__bvt_Recorder.setImproviseLocators(${JSON.stringify(!disableMultipleLocators)});
-    // `
-    // scripts.push(inlineScript);
-    // return scripts;
+    return getInitScript(config, {
+      sdkLanguage: "javascript",
+      testIdAttributeName: "blinq-test-id",
+      stableRafCount: 0,
+      browserName: this.browser?.browserType().name(),
+      inputFileRoleTextbox: false,
+      customEngines: [],
+      isUnderTest: true,
+    });
   }
 
   async _initBrowser({ url }) {
     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");
@@ -334,8 +307,9 @@ export class BVTRecorder {
         console.error("Error reading ai_config.json", error);
       }
     }
+    this.config = ai_config;
     const initScripts = {
-      recorderCjs: injectedScriptSource,
+      // recorderCjs: injectedScriptSource,
       scripts: [
         this.getInitScripts(ai_config),
         `\ndelete Object.getPrototypeOf(navigator).webdriver;${process.env.WINDOW_DEBUGGER ? "window.debug=true;\n" : ""}`,
@@ -347,11 +321,40 @@ export class BVTRecorder {
     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":
+              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;
+          }
+        }
+      },
+      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();
@@ -462,6 +465,75 @@ export class BVTRecorder {
       }
     });
   }
+
+  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;
@@ -470,29 +542,70 @@ export class BVTRecorder {
 
     try {
       const result = await client.send("Page.getNavigationHistory");
-      // console.log("result", result);
+      // 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;
+      // 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");
+      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)) {
-      // console.log("User initiated transition");
-      this.sendEvent(this.events.onGoto, { url: transition.userTypedURL });
+
+    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;
     }
   }
 
@@ -621,6 +734,11 @@ export class BVTRecorder {
     delete process.env.TEMP_RUN;
     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();
   }
@@ -697,40 +815,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",
+      CURRENT_STEP_ID: step.id,
     };
 
     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;
@@ -741,15 +880,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);
@@ -765,7 +899,15 @@ export class BVTRecorder {
     };
   }
   async getStepsAndCommandsForScenario({ name, featureName }) {
-    return this.scenariosStepsMap.get(name) || [];
+    const steps = this.scenariosStepsMap.get(name) || [];
+    for (const step of steps) {
+      if (step.isImplemented) {
+        step.commands = this.getCommandsForImplementedStep({ stepName: step.text });
+      } else {
+        step.commands = [];
+      }
+    }
+    return steps;
     // return getStepsAndCommandsForScenario({
     //   name,
     //   featureName,
@@ -773,6 +915,7 @@ export class BVTRecorder {
     //   map: this.scenariosStepsMap,
     // });
   }
+
   async generateStepName({ commands, stepsNames, parameters, map }) {
     return await this.namesService.generateStepName({ commands, stepsNames, parameters, map });
   }
@@ -855,9 +998,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))) {
@@ -896,6 +1039,7 @@ 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);
@@ -924,6 +1068,7 @@ export class BVTRecorder {
         ..._s,
         keyword: step.keyword.trim(),
       };
+      parseRouteFiles(this.projectDir, _step);
       steps.push(_step);
     }
     return {
@@ -963,7 +1108,7 @@ export class BVTRecorder {
     }
     return result;
   }
-  async cleanup() {
+  async cleanup({ tags }) {
     const noopStep = {
       text: "Noop",
       isImplemented: true,
@@ -977,6 +1122,7 @@ export class BVTRecorder {
         {
           step: noopStep,
           parametersMap: {},
+          tags: tags || [],
         },
         {
           skipAfter: false,
@@ -1015,6 +1161,47 @@ 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) => {