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

package/bin/assets/templates/utils_template.txt

@@ -12,7 +12,7 @@ import path from "path";
  * @param {string} text the text to verify exists in page
  * @protect
  */
-async function verifyTextExistsInPage(text) {
+export async function verifyTextExistsInPage(text) {
   await context.web.verifyTextExistInPage(text, null, this);
 }
 Then("Verify the text {string} can be found in the page", verifyTextExistsInPage);
@@ -22,7 +22,7 @@ Then("Verify the text {string} can be found in the page", verifyTextExistsInPage
  * @param {string} elementDescription element description
  * @protect
  */
-async function clickOnElement(elementDescription) {
+export async function clickOnElement(elementDescription) {
   await context.web.simpleClick(elementDescription, null, null, this);
 }
 When("click on {string}", clickOnElement);
@@ -36,7 +36,7 @@ When("Click {string}", clickOnElement);
  * @param {string} value value to fill the element with
  * @protect
  */
-async function fillElement(elementDescription, value) {
+export async function fillElement(elementDescription, value) {
   await context.web.simpleClickType(elementDescription, value, null, null, this);
 }
 When("fill {string} with {string}", fillElement);
@@ -47,7 +47,7 @@ When("Fill {string} with {string}", fillElement);
  * @param {string} text the text to verify does not exist in page
  * @protect
  */
-async function verifyTextNotExistsInPage(text) {
+export async function verifyTextNotExistsInPage(text) {
   await context.web.waitForTextToDisappear(text, null, this);
 }
 Then("Verify the text {string} cannot be found in the page", verifyTextNotExistsInPage);
@@ -57,7 +57,7 @@ Then("Verify the text {string} cannot be found in the page", verifyTextNotExists
  * @param {string} url URL to navigate
  * @protect
  */
-async function navigateTo(url) {
+export async function navigateTo(url) {
   await context.web.goto(url, this);
 }
 When("Navigate to {string}", navigateTo);
@@ -66,7 +66,7 @@ When("Navigate to {string}", navigateTo);
  * Navigate to the current page
  * @protect
  */
-async function browserNavigateBack() {
+export async function browserNavigateBack() {
   await context.web.goBack({}, this);
 }
 Then("Browser navigate back", browserNavigateBack);
@@ -75,7 +75,7 @@ Then("Browser navigate back", browserNavigateBack);
  * Navigate forward in browser history
  * @protect
  */
-async function browserNavigateForward() {
+export async function browserNavigateForward() {
   await context.web.goForward({}, this);
 }
 Then("Browser navigate forward", browserNavigateForward);
@@ -85,7 +85,7 @@ Then("Browser navigate forward", browserNavigateForward);
  * @param {string} filePath the file path or empty to store in the test data file
  * @protect
  */
-async function storeBrowserSession(filePath) {
+export async function storeBrowserSession(filePath) {
   await context.web.saveStoreState(filePath, this);
 }
 When("Store browser session {string}", storeBrowserSession);
@@ -95,7 +95,7 @@ When("Store browser session {string}", storeBrowserSession);
  * @param {string} filePath the file path or empty
  * @protect
  */
-async function resetBrowserSession(filePath) {
+export async function resetBrowserSession(filePath) {
   await context.web.restoreSaveState(filePath, this);
 }
 When("Reset browser session {string}", resetBrowserSession);
@@ -107,7 +107,7 @@ When("Reset browser session {string}", resetBrowserSession);
  * @param {string} textToVerify the target text to verify
  * @protect
  */
-async function verifyTextRelatedToText(textAnchor, climb, textToVerify) {
+export async function verifyTextRelatedToText(textAnchor, climb, textToVerify) {
   await context.web.verifyTextRelatedToText(textAnchor, climb, textToVerify, null, this);
 }
 Then(
@@ -120,7 +120,7 @@ Then(
  * @requestName the name of the bruno request file
  * @protect
  */
-async function runBrunoRequest(requestName) {
+export async function runBrunoRequest(requestName) {
   await executeBrunoRequest(requestName, {}, context, this);
 }
 When("Bruno - {string}", runBrunoRequest);
@@ -131,7 +131,7 @@ When("bruno - {string}", runBrunoRequest);
  * @param {string} fileName the downloaded file to verify
  * @protect
  */
-async function verify_the_downloaded_file_exists(fileName) {
+export async function verify_the_downloaded_file_exists(fileName) {
   const downloadFolder = path.join(context.reportFolder, "downloads");
   const downloadFile = path.join(downloadFolder, fileName);
   await verifyFileExists(downloadFile, {}, context, this);
@@ -148,7 +148,7 @@ When("Noop", async function () {});
  * @param {string} url URL to be verified against current URL
  * @protect
  */
-async function verify_page_url(url) {
+export async function verify_page_url(url) {
   await context.web.verifyPagePath(url, {}, this);
 }
 Then("Verify the page url is {string}", verify_page_url);
@@ -158,7 +158,7 @@ Then("Verify the page url is {string}", verify_page_url);
  * @param {string} title Title to be verified against current Title
  * @protect
  */
-async function verify_page_title(title) {
+export async function verify_page_title(title) {
   await context.web.verifyPageTitle(title, {}, this);
 }
 Then("Verify the page title is {string}", verify_page_title);
@@ -170,7 +170,7 @@ Then("Verify the page title is {string}", verify_page_title);
  * @param {world} - Optional world context
  * @returns Promise that resolves after the specified duration
  */
-async function sleep(duration) {
-  await context.web.sleep(duration, {}, null);
+export async function sleep(duration) {
+  await context.web.sleep(duration, {}, this);
 }
 Then("Sleep for {string} ms", { timeout: -1 }, sleep);

package/bin/client/code_cleanup/utils.js

@@ -10,7 +10,7 @@ import * as t from "@babel/types";
 import { CucumberExpression, ParameterTypeRegistry } from "@cucumber/cucumber-expressions";
 import { existsSync, readFileSync, writeFileSync } from "fs";
 import { getAiConfig } from "../code_gen/page_reflection.js";
-import socketLogger from "../utils/socket_logger.js";
+import socketLogger, { getErrorMessage } from "../utils/socket_logger.js";
 
 const STEP_KEYWORDS = new Set(["Given", "When", "Then"]);
 
@@ -308,18 +308,27 @@ export function getDefaultPrettierConfig() {
       const configContent = readFileSync(prettierConfigPath, "utf-8");
       prettierConfig = JSON.parse(configContent);
     } catch (error) {
-      socketLogger.error("Error parsing Prettier config file", error);
-      console.error(`Error parsing Prettier config file: ${error}`);
+      socketLogger.error(
+        `Error parsing Prettier config file: ${getErrorMessage(error)}`,
+        undefined,
+        "getDefaultPrettierConfig"
+      );
     }
   } else {
     // save the default config to .prettierrc
     try {
       writeFileSync(prettierConfigPath, JSON.stringify(prettierConfig, null, 2), "utf-8");
-      socketLogger.info(`Created default Prettier config at ${prettierConfigPath}`);
-      console.log(`Created default Prettier config at ${prettierConfigPath}`);
+      socketLogger.info(
+        `Created default Prettier config at ${prettierConfigPath}`,
+        undefined,
+        "getDefaultPrettierConfig"
+      );
     } catch (error) {
-      socketLogger.error(`Error writing Prettier config file: ${error}`);
-      console.error(`Error writing Prettier config file: ${error}`);
+      socketLogger.error(
+        `Error writing Prettier config file: ${getErrorMessage(error)}`,
+        undefined,
+        "getDefaultPrettierConfig"
+      );
     }
   }
   return prettierConfig;

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";