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

package/bin/client/code_gen/code_inversion.js

@@ -1,5 +1,9 @@
 import { Types } from "../recording.js";
 import Walker from "node-source-walk";
+/**
+ * @typedef {import("../types/locators").Locator} Locator
+ * @typedef {import("../types/locators").LocatorBundle} LocatorBundle
+ */
 
 const extractElementIdentifier = (node) => {
   // Check for elements["someIdentifier"] pattern
@@ -86,6 +90,34 @@ const parseDataSource = (paramNode, stepParams) => {
   // }
   throw new Error("Unknown parameter type");
 };
+
+const parseOptions = (optionsNode) => {
+  const properties = optionsNode.properties;
+  const options = {};
+  for (const prop of properties) {
+    let key = "";
+    if (prop.key.type === "Identifier") {
+      key = prop.key.name;
+    } else if (prop.key.type === "StringLiteral") {
+      key = prop.key.value;
+    }
+    if (key === "context") continue;
+    options[key] = prop.value.value;
+  }
+  return options;
+};
+
+const parseOptionsFromCallNode = (call, index) => {
+  if (call.arguments[index] && call.arguments[index].type === "ObjectExpression") {
+    return parseOptions(call.arguments[index]);
+  }
+  return null;
+};
+/**
+ * @param {any} call
+ * @param {Record<string, { locators?: Locator[] | LocatorBundle }>} elements
+ * @param {any[]} stepParams
+ */
 const invertStableCommand = (call, elements, stepParams) => {
   const methodName = call.callee.property.name;
   const step = { type: null, parameters: [], element: null, locators: null };
@@ -104,6 +136,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataSource = inputParam.dataSource;
         step.dataKey = inputParam.dataKey;
       }
+      step.options = parseOptionsFromCallNode(call, 3);
       break;
     }
 
@@ -130,6 +163,8 @@ const invertStableCommand = (call, elements, stepParams) => {
           step.count = clickCountProp.value.value;
         }
       }
+
+      step.options = parseOptionsFromCallNode(call, 2);
       break;
 
     case "setDateTime": {
@@ -147,6 +182,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = dateParam.dataKey;
         step.parameters = [toVariableName(dateParam.dataKey), format, enterParam];
       }
+      step.options = parseOptionsFromCallNode(call, 5);
       break;
     }
 
@@ -163,6 +199,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = selectParam.dataKey;
         step.parameters = [toVariableName(selectParam.dataKey)];
       }
+      step.options = parseOptionsFromCallNode(call, 3);
       break;
     }
 
@@ -176,6 +213,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = text.dataKey;
         step.parameters = [toVariableName(text.dataKey)];
       }
+      step.options = parseOptionsFromCallNode(call, 2);
       break;
     }
     case "waitForTextToDisappear": {
@@ -188,6 +226,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = text.dataKey;
         step.parameters = [toVariableName(text.dataKey)];
       }
+      step.options = parseOptionsFromCallNode(call, 2);
       break;
     }
 
@@ -203,6 +242,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = text.dataKey;
         step.parameters = [toVariableName(text.dataKey), climb ?? null];
       }
+      step.options = parseOptionsFromCallNode(call, 4);
       break;
     }
     case "extractAttribute": {
@@ -233,6 +273,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.regex = "";
         step.trimSpaces = false;
       }
+      step.options = parseOptionsFromCallNode(call, 4);
       break;
     }
     case "verifyAttribute": {
@@ -249,6 +290,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = value.dataKey;
         step.parameters = [attribute, toVariableName(value.dataKey)];
       }
+      step.options = parseOptionsFromCallNode(call, 4);
       break;
     }
 
@@ -277,6 +319,7 @@ const invertStableCommand = (call, elements, stepParams) => {
           step.parameters = [toVariableName(fillParam.dataKey), enterValue];
         }
       }
+      step.options = parseOptionsFromCallNode(call, 4);
       break;
 
     case "loadTestDataAsync": {
@@ -307,23 +350,28 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = url.dataKey;
         step.parameters = [toVariableName(url.dataKey)];
       }
+      step.options = parseOptionsFromCallNode(call, 2);
       break;
     }
 
     case "goBack":
       step.type = Types.GO_BACK;
+      step.options = parseOptionsFromCallNode(call, 0);
       break;
 
     case "goForward":
       step.type = Types.GO_FORWARD;
+      step.options = parseOptionsFromCallNode(call, 0);
       break;
 
     case "reloadPage":
       step.type = Types.RELOAD;
+      step.options = parseOptionsFromCallNode(call, 0);
       break;
 
     case "closePage":
       step.type = Types.CLOSE_PAGE;
+      step.options = parseOptionsFromCallNode(call, 0);
       break;
 
     case "simpleClick":
@@ -341,12 +389,15 @@ const invertStableCommand = (call, elements, stepParams) => {
     case "hover":
       step.type = Types.HOVER;
       step.element = extractElement(call.arguments[0]);
+      step.options = parseOptionsFromCallNode(call, 2);
       break;
 
     case "setCheck":
       step.type = Types.CHECK;
       step.element = extractElement(call.arguments[0]);
       step.check = call.arguments[1].value;
+      ///
+      step.options = parseOptionsFromCallNode(call, 3);
       break;
 
     case "setViewportSize": {
@@ -354,12 +405,14 @@ const invertStableCommand = (call, elements, stepParams) => {
       const width = call.arguments[0].value;
       const height = call.arguments[1].value;
       step.parameters = [width, height];
+      step.options = parseOptionsFromCallNode(call, 2);
       break;
     }
 
     case "visualVerification": {
       step.type = Types.VISUAL_VERIFICATION;
       step.parameters = [call.arguments[0].value];
+      step.options = parseOptionsFromCallNode(call, 1);
       break;
     }
     case "waitForUserInput": {
@@ -370,6 +423,7 @@ const invertStableCommand = (call, elements, stepParams) => {
     case "extractEmailData": {
       step.type = Types.MAIL_GET_CODE_OR_URL;
       step.parameters = [call.arguments[0].value];
+      step.options = parseOptionsFromCallNode(call, 1);
       break;
     }
     case "verifyTextRelatedToText": {
@@ -383,6 +437,7 @@ const invertStableCommand = (call, elements, stepParams) => {
       const textToVerify =
         textToVerifyParse.type === "literal" ? textToVerifyParse.value : toVariableName(textToVerifyParse.dataKey);
       step.parameters = [textAnchor, climb, textToVerify];
+      step.options = parseOptionsFromCallNode(call, 3);
       break;
     }
     case "setInputFiles": {
@@ -396,6 +451,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = fileParam.dataKey;
         step.parameters = [toVariableName(fileParam.dataKey)];
       }
+      step.options = parseOptionsFromCallNode(call, 3);
       break;
     }
     case "snapshotValidation": {
@@ -405,6 +461,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.parameters = [inputParam.value];
       }
       step.selectors = call.arguments[0].value;
+      step.options = parseOptionsFromCallNode(call, 3);
       break;
     }
     case "verifyPageTitle": {
@@ -417,6 +474,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = text.dataKey;
         step.parameters = [toVariableName(text.dataKey)];
       }
+      step.options = parseOptionsFromCallNode(call, 1);
       break;
     }
     case "verifyPagePath": {
@@ -429,6 +487,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = path.dataKey;
         step.parameters = [toVariableName(path.dataKey)];
       }
+      step.options = parseOptionsFromCallNode(call, 1);
       break;
     }
     case "verifyProperty": {
@@ -443,6 +502,7 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.dataKey = value.dataKey;
         step.parameters = [property, toVariableName(value.dataKey)];
       }
+      step.options = parseOptionsFromCallNode(call, 4);
       break;
     }
     case "extractProperty": {
@@ -473,15 +533,79 @@ const invertStableCommand = (call, elements, stepParams) => {
         step.regex = "";
         step.trimSpaces = false;
       }
+      step.options = parseOptionsFromCallNode(call, 4);
+      break;
+    }
+
+    case "conditionalWait": {
+      step.type = Types.CONDITIONAL_WAIT;
+      step.element = extractElement(call.arguments[0]);
+      const condition = call.arguments[1].value;
+
+      const _timeout = parseDataSource(call.arguments[2], stepParams);
+      let timeout = 30;
+      if (_timeout.type === "literal") {
+        if (isNaN(_timeout.value)) {
+          throw new Error(`Timeout value must be a number, got ${_timeout.value}`);
+        }
+        timeout = Number(_timeout.value) * 1000;
+      } else {
+        step.dataSource = _timeout.dataSource;
+        step.dataKey = _timeout.dataKey;
+        timeout = toVariableName(_timeout.dataKey);
+      }
+      // step.timeout = timeout;
+      // step.value = "true";
+      step.parameters = [timeout, condition, step.value];
+      // step.condition = condition;
+      step.options = parseOptionsFromCallNode(call, 4);
+      break;
+    }
+
+    case "sleep": {
+      step.type = Types.SLEEP;
+      const duration = parseDataSource(call.arguments[0], stepParams);
+      if (duration.type === "literal") {
+        if (isNaN(duration.value)) {
+          throw new Error(`Sleep duration must be a number, got ${duration.value}`);
+        }
+        step.parameters = [Number(duration.value)];
+      } else {
+        step.dataSource = duration.dataSource;
+        step.dataKey = duration.dataKey;
+        step.parameters = [toVariableName(duration.dataKey)];
+      }
+      step.options = parseOptionsFromCallNode(call, 1);
       break;
     }
+    case "verify_file_exists": {
+      step.type = Types.VERIFY_FILE_EXISTS;
+      const filePath = parseDataSource(call.arguments[0], stepParams);
+      if (filePath.type === "literal") {
+        step.parameters = [filePath.value];
+      } else {
+        step.dataSource = filePath.dataSource;
+        step.dataKey = filePath.dataKey;
+        step.parameters = [toVariableName(filePath.dataKey)];
+      }
+      step.options = parseOptionsFromCallNode(call, 1);
+      break;
+    }
+
+    // case "verifyPagePath":
+    //   {
+    //     step.type = Types.VERIFY_PAGE_PATH;
+    //     step.parameters = [call.arguments[0].value];
+    //     break;
+    //   }
     default:
       return; // Skip if no matching method
   }
 
   // Set locators if element exists
   if (step.element && elements[step.element.key]) {
-    step.locators = elements[step.element.key];
+    const locBundle = elements[step.element.key];
+    step.locators = locBundle;
   }
 
   if (step.type === Types.CLICK) {

package/bin/client/code_gen/duplication_analysis.js

@@ -4,6 +4,7 @@ import path from "path";
 import { CodePage } from "./page_reflection.js";
 import { compareElements, generateSignature } from "./function_signature.js";
 import { updateStepDefinitions } from "../recorderv3/step_utils.js";
+import socketLoggerInstance from "../utils/socket_logger.js";
 /**
  * DuplicationAnalizer class
  * How to use:
@@ -101,7 +102,7 @@ async function compareWithScenario(projectDir, scenario) {
   analyzerExisting.load();
   // generate a temporary folder
   const folder = fs.mkdtempSync(path.join(os.tmpdir(), "blinq-"));
-  await updateStepDefinitions({ scenario, featureName: "temp", projectDir: folder });
+  await updateStepDefinitions({ scenario, featureName: "temp", projectDir: folder, logger: socketLoggerInstance });
   const analyzerScenario = new DuplicationAnalizer(folder);
   analyzerScenario.load();
   const compareResults = [];

package/bin/client/code_gen/function_signature.js

@@ -11,6 +11,12 @@ async function verify_the_opportunity_name_was_created(_name) {
   }
 */
 
+import strip from "strip-comments";
+/**
+ * @typedef {import("../types/locators").Locator} Locator
+ * @typedef {import("../types/locators").LocatorBundle} LocatorBundle
+ */
+
 function generateSignature(page, functionName) {
   let functionCode = null;
   let method = null;
@@ -28,6 +34,8 @@ function generateSignature(page, functionName) {
   method.node.body.parent.params.forEach((param) => {
     parameters.push(param.name);
   });
+  const strippedFunctionCode = strip(functionCode);
+  functionCode = strippedFunctionCode !== "" ? strippedFunctionCode : functionCode;
   let lines = functionCode.split("\n");
   // trim all lines
   lines = lines.map((line) => line.trim());

package/bin/client/code_gen/index.js

@@ -1,4 +1,8 @@
 import fs from "fs";
+/**
+ * @typedef {import("../types/locators").Locator} Locator
+ * @typedef {import("../types/locators").LocatorBundle} LocatorBundle
+ */
 
 import { Project } from "../project.js";
 import { generateCode } from "./playwright_codeget.js";

package/bin/client/code_gen/page_reflection.js

@@ -170,7 +170,7 @@ export class CodePage {
                 this.generateModel(fileContentNew);
             }
             catch (e) {
-                logger.info("failed to format the code");
+                logger.error("failed to format the code");
                 logger.debug(e);
             }
             if (!existsSync(this.sourceFileName)) {
@@ -288,6 +288,11 @@ export class CodePage {
             codePart.name = node.id.name;
         }
     }
+    findKey(funcString, key) {
+        const sourceRegex = new RegExp(`${key}:\\s*(.*)`);
+        const match = funcString.match(sourceRegex);
+        return match ? match[1] : null;
+    }
     collectAllTemplates() {
         const templates = [];
         if (this.cucumberCalls.length > 0) {
@@ -300,10 +305,12 @@ export class CodePage {
                 const stepType = cucumberCall["stepType"];
                 let firstFind = true;
                 const stepPaths = [];
+                let source = null;
                 for (let j = 0; j < this.methods.length; j++) {
                     const method = this.methods[j];
                     if (method.name === methodName) {
                         if (firstFind) {
+                            source = this.findKey(method.codePart, "source");
                             foundMethod = true;
                             const paramsObj = (method.node?.params ?? []);
                             if (paramsObj && paramsObj.length > 0) {
@@ -315,7 +322,7 @@ export class CodePage {
                     }
                 }
                 if (foundMethod) {
-                    templates.push({ pattern, methodName, params, stepType, paths: stepPaths });
+                    templates.push({ pattern, methodName, params, stepType, paths: stepPaths, source });
                 }
             }
         }
@@ -363,6 +370,39 @@ export class CodePage {
             return result;
         }
     }
+    addInfraCommandUtil(methodName, description, stepVariables, stepCodeLines, renamedText, previousText, parametersMap, protectStep = false, source = null, codePath = "") {
+        let code = "\n";
+        code += "/**\n";
+        code += ` * ${description}\n`;
+        const tags = [];
+        if (protectStep)
+            tags.push("@protect");
+        if (source)
+            tags.push(`@${source}`);
+        if (tags.length > 0)
+            code += ` * ${tags.join(" ")}\n`;
+        if (codePath !== null)
+            code += ` * @path=${escapeForComment(codePath)}\n`;
+        const matches = previousText.match(/"[^"]*"/g);
+        const countInMethodName = matches ? matches.length : 0;
+        code += " */\n";
+        code += `async function ${methodName} (${new Array(countInMethodName)
+            .fill(0)
+            .map((v, index) => `param${index}`)
+            .join(", ")}){\n`;
+        code += `// source: ${source}\n`;
+        code += `// implemented_at: ${new Date().toISOString()}\n`;
+        stepCodeLines.forEach((line) => (code += `  ${line}\n`));
+        if (renamedText === "verify_page_title" || renamedText === "verify_page_url") {
+            const parameters = stepVariables.map((v) => parametersMap[v.text.replace(/[<>]/g, "")]);
+            code += `await ${renamedText}(${parameters.map((v) => (isNaN(Number(v)) ? `"${v}"` : Number(v))).join(", ")});\n`;
+        }
+        else {
+            code += `await ${renamedText}(${stepVariables.map((v) => (isNaN(Number(v.text)) ? `"${v.text}"` : Number(v.text))).join(", ")});\n`;
+        }
+        code += "}\n";
+        return this._injectMethod(methodName, code);
+    }
     addInfraCommand(methodName, description, stepVarables, stepCodeLines, protectStep = false, source = null, codePath = "") {
         let code = "\n";
         code += "/**\n";
@@ -415,6 +455,46 @@ export class CodePage {
         code += "}\n";
         return this._injectMethod(methodName, code);
     }
+    _replaceSelectedCode(code, injectIndexEnd) {
+        const newFileContent = this.fileContent.substring(0, injectIndexEnd - 2) +
+            "\n  " +
+            code +
+            "\n}\n" +
+            this.fileContent.substring(injectIndexEnd);
+        this._init();
+        this.generateModel(newFileContent);
+    }
+    _injectOneCommand(methodName, code) {
+        const result = { methodName };
+        code = code.trim();
+        const existMethod = this.methods.find((m) => m.name === methodName);
+        if (!existMethod) {
+            throw new Error(`method ${methodName} not found for injection`);
+        }
+        const oldCode = existMethod.codePart.trim();
+        this._replaceSelectedCode(code, existMethod.end);
+        result.status = CodeStatus.UPDATED;
+        result.oldCode = oldCode;
+        result.newCode = code;
+        return result;
+    }
+    _removeSelectedCode(commands, injectIndexStart, injectIndexEnd) {
+        let newFileContent = this.fileContent.substring(injectIndexStart, injectIndexEnd);
+        commands.forEach((cmd) => {
+            newFileContent = newFileContent.replace(cmd, "");
+        });
+        newFileContent =
+            this.fileContent.substring(0, injectIndexStart) + newFileContent + this.fileContent.substring(injectIndexEnd);
+        this._init();
+        this.generateModel(newFileContent);
+    }
+    _removeCommands(methodName, commands) {
+        const existMethod = this.methods.find((m) => m.name === methodName);
+        if (!existMethod) {
+            throw new Error(`method ${methodName} not found for removal`);
+        }
+        this._removeSelectedCode(commands, existMethod.start, existMethod.end);
+    }
     _injectMethod(methodName, code) {
         const result = { methodName };
         code = code.trim();
@@ -487,11 +567,12 @@ export class CodePage {
         if (!element || !element.locators)
             return element;
         const clone = JSON.parse(JSON.stringify(element));
-        for (let i = 0; i < (clone.locators?.length ?? 0); i++) {
-            const locator = clone.locators[i];
-            if (locator.score)
-                delete locator.score;
+        const locatorsArray = Array.isArray(clone.locators) ? clone.locators : [];
+        for (let i = 0; i < locatorsArray.length; i++) {
+            if (locatorsArray[i].score)
+                delete locatorsArray[i].score;
         }
+        clone.locators = Array.isArray(clone.locators) ? locatorsArray : [];
         return clone;
     }
     insertElements(elements) {
@@ -621,7 +702,7 @@ export class CodePage {
         let locatorsMetadataFileName = this.sourceFileName.replace(".mjs", ".json");
         const config = getAiConfig();
         if (config && config.locatorsMetadataDir) {
-            locatorsMetadataFileName = path.join(config.locatorsMetadataDir, path.basename(locatorsMetadataFileName));
+            locatorsMetadataFileName = locatorsMetadataFileName.replace(path.join("features", "step_definitions"), path.join(config.locatorsMetadataDir));
             if (!existsSync(path.dirname(locatorsMetadataFileName))) {
                 mkdirSync(path.dirname(locatorsMetadataFileName), { recursive: true });
             }
@@ -633,7 +714,7 @@ export class CodePage {
             }
         }
         catch {
-            logger.info("failed to read locators metadata file", locatorsMetadataFileName);
+            logger.error("failed to read locators metadata file", locatorsMetadataFileName);
         }
         const keys = Object.keys(locatorsMetadata);
         keys.forEach((key) => {
@@ -643,7 +724,7 @@ export class CodePage {
             writeFileSync(locatorsMetadataFileName, JSON.stringify(metadata, null, 2), "utf8");
         }
         catch {
-            logger.info("failed to write locators metadata file", locatorsMetadataFileName);
+            logger.error("failed to write locators metadata file", locatorsMetadataFileName);
         }
     }
     _getVariableStartEnd(variableName) {