@dev-blinq/cucumber_client 1.0.1353-dev → 1.0.1355-dev

package/bin/client/cli_helpers.js

@@ -1,17 +1,15 @@
-
 const validateCLIArg = (arg, name) => {
   if (!arg) {
-    throw new Error(`${name} is required`)
+    throw new Error(`${name} is required`);
   }
-}
+};
 const showUsage = (error, usage) => {
-  console.error(error.message)
-  console.info(usage)
-  process.exit(1)
-}
-const loadArgs = ()=>{
-  const args = process.argv.slice(2)
-  return args
-}
-
-export { validateCLIArg, loadArgs, showUsage };
+  console.error(error.message);
+  console.info(usage);
+  process.exit(1);
+};
+const loadArgs = () => {
+  const args = process.argv.slice(2);
+  return args;
+};
+export { validateCLIArg, loadArgs, showUsage };

package/bin/client/cucumber/feature.js

@@ -1,11 +1,13 @@
+import { IdGenerator } from "@cucumber/messages";
+import { AstBuilder, GherkinClassicTokenMatcher, Parser, compile } from "@cucumber/gherkin";
 import { loadConfiguration, loadSupport, runCucumber } from "@dev-blinq/cucumber-js/api";
 import fs from "fs";
-
+import os from "os";
+import path from "path";
 import { parseStepTextParameters, toCucumberExpression, unEscapeNonPrintables } from "./utils.js";
-import { AstBuilder, GherkinClassicTokenMatcher, Parser, compile } from "@cucumber/gherkin";
-import { IdGenerator } from "@cucumber/messages";
+import stream from "stream";
 import { testStringForRegex } from "../recorderv3/update_feature.js";
-import path from 'path';
+import { generateTestData } from "./feature_data.js";
 class DataTable {
   constructor(dataTableDocument) {
     if (!dataTableDocument) {
@@ -449,29 +451,7 @@ class Scenario {
     return this.scenarioText;
   }
 }
-const scenarioResolution = async (featureFilePath) => {
-  if (!fs.existsSync(featureFilePath)) {
-    throw new Error(`Feature file ${featureFilePath} does not exist`);
-  }
-  const newId = IdGenerator.uuid();
-  const builder = new AstBuilder(newId);
-  const matcher = new GherkinClassicTokenMatcher();
-
-  const parser = new Parser(builder, matcher);
-
-  // normalize the path to start with featuers/ if it's not cut the featureFielPath to only the part after features/
-  let uri = featureFilePath.startsWith("features/")
-    ? featureFilePath
-    : "features/" + featureFilePath.split("features/")[1];
 
-  const featureFileContent = fs.readFileSync(featureFilePath, "utf8");
-  const gherkinDocument = parser.parse(featureFileContent, newId);
-
-  const feature = new Feature(gherkinDocument, featureFileContent);
-  //const scenario = feature.getScenario(scenarioName);
-  //return scenario;
-  return feature;
-};
 const getDocumentAndPickel = (featureName, featureContent, scenarioName) => {
   const newId = IdGenerator.uuid();
   const builder = new AstBuilder(newId);
@@ -484,12 +464,85 @@ const getDocumentAndPickel = (featureName, featureContent, scenarioName) => {
 
   const gherkinDocument = parser.parse(featureContent, newId);
   const pickles = compile(gherkinDocument, uri, newId);
-
   // Step 3: Find the specific scenario Pickle
   const pickle = pickles.find((pickle) => {
     return pickle.name === scenarioName;
   });
   return { gherkinDocument, pickle };
 };
+const scenarioResolution = async (featureFilePath) => {
+  if (!fs.existsSync(featureFilePath)) {
+    throw new Error(`Feature file ${featureFilePath} does not exist`);
+  }
+  const featureFileContent = fs.readFileSync(featureFilePath, "utf8");
+  let tmpDir = null;
+  try {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "ai-qa"));
+    const tmpFeaturePath = path.join(tmpDir, "features");
+    fs.mkdirSync(tmpFeaturePath);
+    const tmpFeatureFilePath = path.join(tmpFeaturePath, path.basename(featureFilePath));
+    let result = generateTestData(featureFilePath);
+    if (result.changed) {
+      fs.writeFileSync(tmpFeatureFilePath, result.newContent);
+      console.log("Fake data was generated for this scenario");
+      console.log("Variables:");
+      for (let key in result.variables) {
+        console.log(`${key}: ${result.variables[key].fake}`);
+      }
+      console.log("Other fake data:");
+      for (let i = 0; i < result.otherFakeData.length; i++) {
+        console.log(`${result.otherFakeData[i].var}: ${result.otherFakeData[i].fake}`);
+      }
+    } else {
+      fs.copyFileSync(featureFilePath, tmpFeatureFilePath);
+    }
+    const writable = new stream.Writable({
+      write: function (chunk, encoding, next) {
+        //console.log(chunk.toString());
+        next();
+      },
+    });
+    const environment = { cwd: tmpDir, stdout: writable, stderr: writable };
+    // load configuration from a particular file, and override a specific option
+    const provided = {
+      default: "--publish-quiet",
+      require: [tmpDir],
+      failFast: false,
+    };
 
+    let gherkinDocument = null;
+    const { runConfiguration } = await loadConfiguration({ provided }, environment);
+    // load the support code upfront
+    const support = await loadSupport(runConfiguration, environment);
+    // run cucumber, using the support code we loaded already
+    await runCucumber({ ...runConfiguration, support }, environment, function (event) {
+      // if (event.source) {
+      //   scenarioInfo.source = event.source.data;
+      // }
+      // if (event.pickle && event.pickle.name === scenarioName) {
+      //   scenarioInfo.pickle = event.pickle;
+      // }
+      if (event.gherkinDocument) {
+        gherkinDocument = event.gherkinDocument;
+      }
+      //console.log(event);
+      //console.log(JSON.stringify(event, null, 2));
+      // console.log("");
+    });
+    const feature = new Feature(gherkinDocument, featureFileContent);
+    //const scenario = feature.getScenario(scenarioName);
+    //return scenario;
+    return feature;
+  } finally {
+    try {
+      if (tmpDir) {
+        fs.rmSync(tmpDir, { recursive: true });
+      }
+    } catch (e) {
+      console.error(
+        `An error has occurred while removing the temp folder at ${tmpDir}. Please remove it manually. Error: ${e}`
+      );
+    }
+  }
+};
 export { Feature, Scenario, Step, DataTable, Examples, scenarioResolution, getDocumentAndPickel };

package/bin/client/local_agent.js

@@ -971,7 +971,7 @@ class LocalAgent {
   async createNewStepLocal(
     featureName,
     cucumberStep,
-    feature,
+    comments,
     userData,
     firstStep,
     previousTasks,
@@ -1087,7 +1087,7 @@ class LocalAgent {
             previousTasks,
             scenarioDocument,
             scenarioStepIndex,
-            comments: feature.comments,
+            comments,
             featureFileText,
             recover,
             dumpConfig: this.dumpConfig,

package/bin/client/project.js

@@ -104,7 +104,7 @@ class Project {
         this.pages.push(page);
       }
     }
-    return envFile;
+    return this.environment.name;
   }
   getPagesNames() {
     let result = [];

package/bin/client/recorderv3/bvt_recorder.js

@@ -50,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) {
@@ -269,7 +269,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 }) => {
@@ -335,6 +334,7 @@ export class BVTRecorder {
         console.error("Error reading ai_config.json", error);
       }
     }
+    this.config = ai_config;
     const initScripts = {
       // recorderCjs: injectedScriptSource,
       scripts: [
@@ -623,6 +623,7 @@ export class BVTRecorder {
         this.pageSet.add(page);
 
         await page.waitForLoadState("domcontentloaded");
+
         // add listener for frame navigation on new tab
         this._addFrameNavigateListener(page);
       } catch (error) {
@@ -712,7 +713,6 @@ export class BVTRecorder {
     if (this.shouldTakeScreenshot) {
       await this.storeScreenshot(event);
     }
-
     this.sendEvent(this.events.onNewCommand, cmdEvent);
     this._updateUrlPath();
   }
@@ -852,6 +852,7 @@ export class BVTRecorder {
           parametersMap,
           envPath: this.envName,
           tags,
+          config: this.config,
         },
         this.bvtContext,
         {
@@ -906,6 +907,7 @@ export class BVTRecorder {
     //   map: this.scenariosStepsMap,
     // });
   }
+
   async generateStepName({ commands, stepsNames, parameters, map }) {
     return await this.namesService.generateStepName({ commands, stepsNames, parameters, map });
   }
@@ -1189,8 +1191,8 @@ 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 });
   }
 }
 

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++}`;
@@ -289,17 +288,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);

package/bin/client/recorderv3/network.js

@@ -1,8 +1,18 @@
+/**
+ * @typedef {Object} NetworkEvent
+ * @property {import('playwright').Request} request
+ * @property {import('playwright').Response|null} response
+ * @property {string} id
+ * @property {number} timestamp
+ * @property {string} status - 'completed', 'failed'
+ */
+
 class NetworkMonitor {
   constructor() {
     this.networkId = 0;
-    this.networkEvents = new Map();
+    /** @type {Map<string, NetworkEvent>} */
     this.requestIdMap = new Map();
+    this.networkEvents = new Map();
     /** @type {Map<import('playwright').Page, {responseListener: Function, requestFailedListener: Function}>} */
     this.pageListeners = new Map();
   }
@@ -12,7 +22,6 @@ class NetworkMonitor {
    * @param {import('playwright').Page} page
    */
   addNetworkEventListener(page) {
-
     // Create the listener functions
     const responseListener = async (response) => {
       const request = response.request();
@@ -201,7 +210,6 @@ class NetworkMonitor {
       // Try to get response body safely (only for successful responses)
       if (response && networkEvent.status === "completed") {
         try {
-
           const isBinary =
             !response.headers()["content-type"]?.includes("application/json") &&
             !response.headers()["content-type"]?.includes("text");
@@ -229,7 +237,6 @@ class NetworkMonitor {
         marshalledEvent.failureReason = request.failure()?.errorText || "Unknown error";
       }
 
-
       console.log("Marshalled network event:", marshalledEvent);
 
       return marshalledEvent;
@@ -246,7 +253,18 @@ class NetworkMonitor {
     }
   }
 
+  /**
+   *@returns {Promise<Object[]>}
+   * Get all marshalled network events
+   * This is useful for sending to the server or saving to a file.
+   *   */
+  async getAllMarshalledNetworkEvents() {
+    const events = this.getAllNetworkEvents();
+    const marshalledEvents = await Promise.all(events.map((event) => this.marshallNetworkEvent(event)));
+    return marshalledEvents;
+  }
 
+  /**
    * Get marshalled network events since this ID
    * @returns {Promise<Object[]>}
    * @param {number} sinceId
@@ -263,7 +281,6 @@ class NetworkMonitor {
    * @param {number} endId
    * @returns {Promise<Object[]>}
    */
-
   async getMarshalledNetworkEventsInRange(startId, endId) {
     const events = this.getNetworkEventsInRange(startId, endId);
     const marshalledEvents = await Promise.all(events.map((event) => this.marshallNetworkEvent(event)));

package/bin/client/recorderv3/step_runner.js

@@ -1,6 +1,5 @@
 import { existsSync, mkdirSync, rmSync, writeFileSync } from "fs";
 import path from "path";
-import fs from "fs";
 import { generatePageName } from "../code_gen/playwright_codeget.js";
 import {
   executeStep,
@@ -12,6 +11,7 @@ import {
   saveRoutes,
 } from "./step_utils.js";
 import { escapeString, getExamplesContent } from "./update_feature.js";
+import fs from "fs";
 import { locateDefinitionPath } from "../cucumber/steps_definitions.js";
 import { tmpdir } from "os";
 
@@ -78,7 +78,7 @@ export class BVTStepRunner {
     return tFilePath;
   }
 
-  executeStepRemote = async ({ feature_file_path, scenario, tempFolderPath, stepText }, options) => {
+  executeStepRemote = async ({ feature_file_path, scenario, tempFolderPath, stepText, config }, options) => {
     const { skipAfter = true, skipBefore = true } = options || {};
     const environment = {
       ...process.env,
@@ -110,7 +110,7 @@ export class BVTStepRunner {
         // ignore afterAll/after hooks
         support.afterTestCaseHookDefinitions = [];
       }
-      if (skipBefore) {
+      if (skipBefore && !config.legacySyntax) {
         // ignore beforeAll/before hooks
         support.beforeTestCaseHookDefinitions = support.beforeTestCaseHookDefinitions.filter((hook) => {
           return hook.uri.endsWith("utils.mjs");
@@ -135,9 +135,7 @@ export class BVTStepRunner {
           }
           if (testStepResult.status === "UNDEFINED") {
             if (!errorMesssage) {
-              errorMesssage = stepText
-                ? `step ${JSON.stringify(stepText)} is ${testStepResult.status}`
-                : testStepResult.message;
+              errorMesssage = `step ${JSON.stringify(stepText)} is ${testStepResult.status}`;
               if (info) {
                 errInfo = info;
               }
@@ -193,7 +191,7 @@ export class BVTStepRunner {
     }
   };
 
-  async runStep({ step, parametersMap, envPath, tags }, bvtContext, options) {
+  async runStep({ step, parametersMap, envPath, tags, config }, bvtContext, options) {
     let cmdIDs = (step.commands || []).map((cmd) => cmd.cmdId);
     if (bvtContext.web) {
       bvtContext.web.getCmdId = () => {
@@ -250,7 +248,7 @@ export class BVTStepRunner {
     } else {
       let routesPath = path.join(tmpdir(), `blinq_temp_routes`);
       if (process.env.TEMP_RUN === "true") {
-        console.log("Save routes in temp folder for running:", routesPath);
+        // console.log("Save routes in temp folder for running:", routesPath);
         if (existsSync(routesPath)) {
           console.log("Removing existing temp_routes_folder:", routesPath);
           rmSync(routesPath, { recursive: true });
@@ -283,12 +281,13 @@ export class BVTStepRunner {
     const stepExecController = new AbortController();
     this.#currentStepController = stepExecController;
     const { result, info } = await withAbort(async () => {
-      return this.executeStepRemote(
+      return await this.executeStepRemote(
         {
           feature_file_path,
           tempFolderPath,
           stepText: step.text,
           scenario: "Temp Scenario",
+          config,
         },
         options
       );

package/bin/client/recorderv3/update_feature.js

@@ -213,14 +213,12 @@ const GherkinToObject = (gherkin) => {
       steps: [],
     };
     while (idx < lines.length && lines[idx].startsWith("@")) {
-      skipEmptyLines();
       const tags = [...lines[idx].matchAll(/@([^@]+)/g)].map((match) => match[1].trim());
       scenario.tags.push(...(tags ?? []));
       idx++;
+      skipEmptyLines();
     }
 
-    skipEmptyLines();
-
     if (idx < lines.length && (lines[idx].startsWith("Scenario:") || lines[idx].startsWith("Scenario Outline:"))) {
       scenario.name = lines[idx].substring(lines[idx].indexOf(":") + 1).trim();
       idx++;
@@ -243,32 +241,32 @@ const GherkinToObject = (gherkin) => {
       !lines[idx].startsWith("@")
     ) {
       const line = lines[idx++];
-      if (line.startsWith("#")) {
-        const comment = line;
-        if (comment) {
-          const command = {
-            type: "comment",
-            text: comment,
-          };
-          scenario.steps.push(command);
-        }
-      } else if (line.startsWith("Examples:")) {
-        obj.hasParams = true;
-        const command = {
+      let command;
+      if (line.startsWith("Examples:")) {
+        scenario.hasParams = true;
+        command = {
           type: "examples",
           lines: [],
         };
-
         while (idx < lines.length && lines[idx].startsWith("|")) {
           const line = lines[idx++];
           command.lines.push(line);
         }
       } else {
-        scenario.steps.push({
-          type: "step",
-          text: line,
-        });
+        if (line.startsWith("#")) {
+          command = {
+            type: "comment",
+            text: line,
+          };
+        } else {
+          command = {
+            type: "step",
+            text: line,
+          };
+        }
       }
+      scenario.steps.push(command);
+      skipEmptyLines();
     }
 
     return scenario;
@@ -277,7 +275,6 @@ const GherkinToObject = (gherkin) => {
   while (idx < lines.length) {
     const scenario = getScenario();
     if (scenario === -1) break;
-
     if (scenario.error) {
       return {
         error: scenario.error,
@@ -303,8 +300,7 @@ function updateExistingScenario({ featureFileContent, scenarioName, scenarioCont
       skipScenarioIndex = i;
       continue;
     }
-    let scenarioContent = `${featureFileObject.hasParams ? "Scenario Outline" : "Scenario"}: ${scenario.name}`;
-
+    let scenarioContent = `${scenario.hasParams ? "Scenario Outline" : "Scenario"}: ${scenario.name}`;
     let tagsLine;
     if (scenario.tags?.length > 0) {
       tagsLine = `${scenario.tags.map((t) => `@${t}`).join(" ")}`;
@@ -327,7 +323,6 @@ function updateExistingScenario({ featureFileContent, scenarioName, scenarioCont
   if (skipScenarioIndex !== -1) {
     finalContent = results.join("\n") + "\n" + scenarioContent;
   }
-
   return finalContent;
 }
 export async function updateFeatureFile({ featureName, scenario, override, projectDir }) {

package/bin/client/run_cucumber.js

@@ -359,7 +359,7 @@ const runCucumber = async (
           await aiAgent.createNewStepLocal(
             featureName,
             cucumberStep,
-            feature,
+            feature.comments,
             userData,
             first,
             previousTasks,

package/bin/client/scenario_report.js

@@ -33,17 +33,12 @@ const findNextIdInFolder = (folder) => {
 // get temp file path from --temp-file arg
 const getTempFilePath = () => {
   let tempFilePath = null;
-
   for (const arg of process.argv) {
     const [key, path] = arg.split("=");
     if (key === "--temp-file" && !!path) {
       tempFilePath = path;
     }
   }
-
-  if (tempFilePath === null) {
-    tempFilePath = process.env.TEMP_FILE_PATH;
-  }
   return tempFilePath;
 };
 

package/bin/client/test_scenario.js

@@ -267,7 +267,6 @@ try {
     }
     if (validatePath !== "null") {
       await prevrunResult.context.stable.verifyPagePath(validatePath);
-
     }
     //finalCompare = true;
   } catch (e) {

package/bin/index.js

@@ -13,4 +13,5 @@ export * from "./client/cucumber/feature_data.js";
 export * from "./client/cucumber/steps_definitions.js";
 export * from "./client/profiler.js";
 export * from "./client/code_cleanup/utils.js";
+
 export * from "./client/code_cleanup/find_step_definition_references.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dev-blinq/cucumber_client",
-  "version": "1.0.1353-dev",
-  "description": "",
+  "version": "1.0.1355-dev",
+  "description": " ",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",
   "type": "module",
@@ -53,6 +53,7 @@
     "socket.io-client": "^4.7.5",
     "tunnel": "^0.0.6",
     "unzipper": "^0.12.3",
+    "win-ca": "^3.5.1",
     "winston": "^3.10.0",
     "winston-daily-rotate-file": "^4.7.1",
     "ws": "^8.16.0",
@@ -65,7 +66,6 @@
     "mocha": "^10.2.0",
     "readline-sync": "^1.4.10",
     "tsup": "^8.5.0",
-    "typescript": "^5.8.3",
-    "win-ca": "^3.5.1"
+    "typescript": "^5.8.3"
   }
 }