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

package/bin/client/recorderv3/update_feature.js

@@ -1,6 +1,7 @@
 import { existsSync, readFileSync, writeFileSync } from "fs";
 import path from "path";
-
+import { getDefaultPrettierConfig } from "../code_cleanup/utils.js";
+import prettier from "prettier";
 export function containsScenario({ featureFileContent, scenarioName }) {
   const lines = featureFileContent.split("\n");
   for (const line of lines) {
@@ -63,7 +64,7 @@ const escapeNonPrintables = (text) => {
 export function getCommandContent(command) {
   switch (command.type) {
     case "click_element": {
-      return `click on ${escapeNonPrintables(command.element.name)}`;
+      return `${command.count === 2 ? "Double click" : "Click"} on ${escapeNonPrintables(command.element.name)}`;
     }
     case "fill_element": {
       return `fill ${escapeNonPrintables(command.element.name)} with ${escapeNonPrintables(command.parameters[0])}${command.parameters[1] ? ` and press enter key` : ""}`;
@@ -81,7 +82,7 @@ export function getCommandContent(command) {
       return `verify the element ${escapeNonPrintables(command.element.name)} contains text ${escapeNonPrintables(command.parameters[0])}`;
     }
     case "context_click": {
-      return `click on ${escapeNonPrintables(command.label)} in the context of ${escapeNonPrintables(command.value)}`;
+      return `${command.count === 2 ? "Double click" : "Click"} on ${escapeNonPrintables(command.label)} in the context of ${escapeNonPrintables(command.value)}`;
     }
     case "hover_element": {
       return `hover over ${escapeNonPrintables(command.element.name)}`;
@@ -98,6 +99,9 @@ export function getCommandContent(command) {
     case "verify_page_snapshot": {
       return `verify page snapshot stored in ${command.parameters[0]}`;
     }
+    case "parameterized_click": {
+      return `${command.count === 2 ? "Parameterized double click" : "Parameterized click"} on ${escapeNonPrintables(command.element.name)}`;
+    }
     default: {
       return "";
     }
@@ -209,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++;
@@ -239,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;
@@ -273,7 +275,6 @@ const GherkinToObject = (gherkin) => {
   while (idx < lines.length) {
     const scenario = getScenario();
     if (scenario === -1) break;
-
     if (scenario.error) {
       return {
         error: scenario.error,
@@ -299,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(" ")}`;
@@ -323,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 }) {
@@ -333,6 +332,8 @@ export async function updateFeatureFile({ featureName, scenario, override, proje
     { scenario },
     isFeatureFileExists ? GherkinToObject(readFileSync(featureFilePath, "utf8")) : undefined
   );
+  const prettierConfig = getDefaultPrettierConfig();
+  // Format the code using Prettier
 
   if (isFeatureFileExists) {
     const featureFileContent = readFileSync(featureFilePath, "utf8");
@@ -341,7 +342,7 @@ export async function updateFeatureFile({ featureName, scenario, override, proje
       if (!override) {
         throw new Error(`Scenario "${scenario.name}" already exists in feature "${featureName}"`);
       } else {
-        const updatedFeatureFileContent = updateExistingScenario({
+        let updatedFeatureFileContent = updateExistingScenario({
           featureFileContent,
           scenarioName: scenario.name,
           scenarioContent,
@@ -349,14 +350,41 @@ export async function updateFeatureFile({ featureName, scenario, override, proje
         if (updatedFeatureFileContent === "error") {
           throw new Error(`Error while parsing feature file: Invalid gherkin`);
         }
+        try {
+          updatedFeatureFileContent = await prettier.format(updatedFeatureFileContent, {
+            ...prettierConfig,
+            parser: "gherkin",
+            plugins: ["prettier-plugin-gherkin"],
+          });
+        } catch (error) {
+          console.error("Error formatting feature file content with Prettier:", error);
+        }
         writeFileSync(featureFilePath, updatedFeatureFileContent);
         return;
       }
     }
-    const updatedFeatureFileContent = featureFileContent + "\n" + scenarioContent;
+    let updatedFeatureFileContent = featureFileContent + "\n" + scenarioContent;
+    try {
+      updatedFeatureFileContent = await prettier.format(updatedFeatureFileContent, {
+        ...prettierConfig,
+        parser: "gherkin",
+        plugins: ["prettier-plugin-gherkin"],
+      });
+    } catch (error) {
+      console.error("Error formatting feature file content with Prettier:", error);
+    }
     writeFileSync(featureFilePath, updatedFeatureFileContent);
   } else {
-    const featureFileContent = `Feature: ${featureName}\n${scenarioContent}`;
+    let featureFileContent = `Feature: ${featureName}\n${scenarioContent}`;
+    try {
+      featureFileContent = await prettier.format(featureFileContent, {
+        ...prettierConfig,
+        parser: "gherkin",
+        plugins: ["prettier-plugin-gherkin"],
+      });
+    } catch (error) {
+      console.error("Error formatting feature file content with Prettier:", error);
+    }
     writeFileSync(featureFilePath, featureFileContent);
   }
 }

package/bin/client/recording.js

@@ -8,7 +8,11 @@ const Types = {
   API: "api",
   CLICK: "click_element",
   CLICK_SIMPLE: "click_simple",
+  PARAMETERIZED_CLICK: "parameterized_click",
+  CONTEXT_CLICK: "context_click",
   NAVIGATE: "navigate",
+  GO_BACK: "browser_go_back",
+  GO_FORWARD: "browser_go_forward",
   FILL: "fill_element",
   FILL_SIMPLE: "fill_simple",
   EXECUTE: "execute_page_method",
@@ -30,6 +34,7 @@ const Types = {
   SET_COMBO: "set_combo",
   HOVER: "hover_element",
   EXTRACT_ATTRIBUTE: "extract_attribute",
+  EXTRACT_PROPERTY: "extract_property",
   CLOSE_PAGE: "close_page",
   SET_DATE_TIME: "set_date_time",
   SET_VIEWPORT: "set_viewport",
@@ -41,11 +46,13 @@ const Types = {
   SET_INPUT: "set_input",
   WAIT_FOR_USER_INPUT: "wait_for_user_input",
   VERIFY_ATTRIBUTE: "verify_element_attribute",
+  VERIFY_PROPERTY: "verify_element_property",
   FILL_UNKNOWN: "fill_unknown",
   VERIFY_TEXT_RELATED_TO_TEXT: "verify_text_in_relation",
   VERIFY_FILE_EXISTS: "verify_file_exists",
   SET_INPUT_FILES: "set_input_files",
   VERIFY_PAGE_SNAPSHOT: "verify_page_snapshot",
+  CONDITIONAL_WAIT: "conditional_wait",
 };
 class Recording {
   steps = [];

package/bin/client/run_cucumber.js

@@ -1,4 +1,4 @@
-import { existsSync, mkdirSync, writeFileSync } from "fs";
+import { existsSync, mkdirSync, writeFileSync, readFileSync } from "fs";
 import logger from "../logger.js";
 import path from "path";
 import { scenarioResolution } from "./cucumber/feature.js";
@@ -131,6 +131,10 @@ const runCucumber = async (
   } else if (!process.env.NODE_ENV_BLINQ) {
     serviceUrl = "https://logic.blinq.io";
     logger.info("Running in prod mode");
+  } else if (process.env.WHITELABEL === "true") {
+    // if it's a whitelabel it will use "api" instead of "logic"
+    serviceUrl = process.env.NODE_ENV_BLINQ;
+    logger.info("Running in custom mode: " + serviceUrl);
   } else {
     serviceUrl = process.env.NODE_ENV_BLINQ.replace("api", "logic");
     logger.info("Running in custom mode: " + serviceUrl);
@@ -236,6 +240,15 @@ const runCucumber = async (
 
     let scenarioId = findNextIdInFolder("./reports");
     let scenarioPath = "./reports" + "/" + scenarioId;
+    const dataFilePath = path.join(scenarioPath, "data.json");
+    mkdirSync(path.dirname(dataFilePath), { recursive: true });
+    if (process.env.NODE_ENV_BLINQ === "local") {
+      let dataPath = aiAgent.project.rootFolder + "/data/data.json";
+      if (existsSync(dataPath)) {
+        const poolData = JSON.parse(readFileSync(dataPath, "utf-8"));
+        writeFileSync(dataFilePath, JSON.stringify(poolData, null, 2), "utf-8");
+      }
+    }
     result.scenarioPath = scenarioPath;
     aiAgent.initTestData(envFile, path.join(scenarioPath, "data.json"));
     let featureFileRelative = path.relative(projectDir, fullFeatureFilePath);
@@ -346,7 +359,7 @@ const runCucumber = async (
           await aiAgent.createNewStepLocal(
             featureName,
             cucumberStep,
-            feature,
+            feature.comments,
             userData,
             first,
             previousTasks,
@@ -396,6 +409,7 @@ const runCucumber = async (
         logger.error(e.stack);
         message = e.message + "\n" + e.stack;
       }
+      aiAgent.scenarioReport.updateLastCommand({ status: false, error: message });
       // Write logs to file on error
       const logsFilePath = path.join(result.scenarioPath, "editorLogs.log");
       writeLogsToFile(logsFilePath);

package/bin/client/scenario_report.js

@@ -7,6 +7,8 @@ import { getJsonReport } from "./bvt_json_report.js";
 import axios from "axios";
 import { getRunsServiceBaseURL } from "./utils/index.js";
 import { axiosClient } from "./utils/axiosClient.js";
+import { promisify } from "util";
+import { exec } from "child_process";
 
 const BATCH_SIZE = 10;
 const MAX_RETRIES = 3;
@@ -31,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;
 };
 
@@ -319,6 +316,12 @@ class ScenarioReport {
       baseUrl = process.env.NODE_ENV_BLINQ.replace("api", "app");
     }
     const reportLink = baseUrl + "/" + projectId + "/scenario-report/" + scenarioId;
+    try {
+      const status = getJsonReport(this).result.status;
+      publishReportLinkToGuacServer(reportLink, status === "PASSED");
+    } catch (err) {
+      logger.error(`Failed to publish report link to guac server: ${err}`);
+    }
     logger.info(`Report link :- ${reportLink}`);
   }
 
@@ -474,5 +477,14 @@ class ScenarioReport {
     }
   }
 }
-
+function publishReportLinkToGuacServer(reportLink, status) {
+  try {
+    if (existsSync("/tmp/report_publish.sh")) {
+      const execAsync = promisify(exec);
+      execAsync("sh /tmp/report_publish.sh " + reportLink + " " + status);
+    }
+  } catch (error) {
+    logger.error("Error while publishing report link to Guac server: " + error);
+  }
+}
 export { ScenarioReport, findNextIdInFolder };

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,22 +1,26 @@
 {
   "name": "@dev-blinq/cucumber_client",
-  "version": "1.0.1210-dev",
-  "description": "",
+  "version": "1.0.1210-stage",
+  "description": " ",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",
   "type": "module",
   "scripts": {
-    "pack": "mkdir build && mkdir build/bin && cp -R ./src/* ./build/bin && cp ./package.json ./build",
+    "pack": "npm run bundle && mkdir build && mkdir build/bin && cp -R ./src/* ./build/bin && cp ./package.json ./build",
     "test": "node ./test/test.js",
     "tests_prod": "rm -rf results.json && cross-env NODE_ENV_BLINQ=prod TOKEN=xxx npx mocha --parallel --jobs=10 ./tests",
     "tests": "node ./multi_test_runner.js",
     "lint": "eslint ./src/**/*.js",
     "clean": "rm -rf ./build",
     "build": "npm run clean && npm run pack",
+    "build:watch": "npx nodemon --watch src/client --exec 'npm run build'",
     "update_logic": "rm -rf ../logic/node_modules/@dev-blinq && mkdir ../logic/node_modules/@dev-blinq && mkdir ../logic/node_modules/@dev-blinq/cucumber_client && mkdir ../logic/node_modules/@dev-blinq/cucumber_client/bin && mkdir ../logic/node_modules/@dev-blinq/cucumber_client/node_modules && cp -R ./build/* ../logic/node_modules/@dev-blinq/cucumber_client/bin && cp -R ./node_modules/* ../logic/node_modules/@dev-blinq/cucumber_client/node_modules && cp ./package.json ../logic/node_modules/@dev-blinq/cucumber_client/",
     "version-bump": "npm version prepatch --preid=dev",
-    "scripts_regression": "cross-env HEADLESS=true npx mocha --bail --parallel --jobs=12 ./scripts_regression/ --timeout 120000",
-    "runtime_reg": "cross-env HEADLESS=true npx mocha --bail --parallel --jobs=12 ./runtime_regression/ --timeout 4800000"
+    "scripts_regression": "npm run bundle && cross-env HEADLESS=true npx mocha --bail --parallel --jobs=12 ./scripts_regression/ --timeout 120000",
+    "runtime_reg": "npm run bundle && cross-env HEADLESS=true npx mocha --bail --parallel --jobs=12 ./runtime_regression/ --timeout 4800000",
+    "bundle": "npx tsup",
+    "bundle:watch": "npx tsup --watch",
+    "regenerate_baselines": "rm -rf ./scripts_regression/locators_baseline/*  ./scripts_regression/commands_baseline/* && npm run scripts_regression && npm run scripts_regression"
   },
   "author": "",
   "license": "ISC",
@@ -26,9 +30,9 @@
     "@babel/traverse": "^7.27.1",
     "@babel/types": "^7.27.1",
     "@cucumber/tag-expressions": "^6.1.1",
-    "@dev-blinq/cucumber-js": "1.0.172-dev",
+    "@dev-blinq/cucumber-js": "1.0.93-stage",
     "@faker-js/faker": "^8.1.0",
-    "automation_model": "1.0.729-dev",
+    "automation_model": "1.0.708-stage",
     "axios": "^1.7.4",
     "chokidar": "^3.6.0",
     "create-require": "^1.1.1",
@@ -43,6 +47,7 @@
     "patch-package": "^8.0.0",
     "playwright-core": "1.52.0",
     "prettier": "^3.2.5",
+    "prettier-plugin-gherkin": "^3.1.2",
     "pureimage": "0.4.9",
     "socket.io": "^4.7.5",
     "socket.io-client": "^4.7.5",
@@ -59,6 +64,8 @@
     "eslint": "^8.50.0",
     "http-server": "^14.1.1",
     "mocha": "^10.2.0",
-    "readline-sync": "^1.4.10"
+    "readline-sync": "^1.4.10",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3"
   }
 }