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

package/bin/client/code_cleanup/utils.js

@@ -10,6 +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";
 const STEP_KEYWORDS = new Set(["Given", "When", "Then"]);
 
 /**
@@ -293,7 +294,11 @@ export function removeUnusedElementsKeys(ast, supportFilePath) {
  * @param {Array<{keyword: string, pattern: string}>} stepDefinitions
  */
 export async function removeUnusedStepDefinitions(filePath, stepDefinitions) {
-  const supportFilePath = filePath.replace(".mjs", ".json");
+  let supportFilePath = filePath.replace(".mjs", ".json");
+  const config = getAiConfig();
+  if (config && config.locatorsMetadataDir) {
+    supportFilePath = path.join(config.locatorsMetadataDir, path.basename(supportFilePath));
+  }
   const ast = await parse(filePath);
   removeStepDefinitions(stepDefinitions, ast);
   removeUnusedDeclarations(ast);

package/bin/client/code_gen/index.js

@@ -58,6 +58,9 @@ for (let i = 0; i < scenarioReport.stepsProgress.length; i++) {
   page.addCucumberStep(keyword, step.cucumberLine, methodName, step.recording.steps.length);
 
   page.removeUnusedElements();
+  if (generateCodeResult.locatorsMetadata) {
+    page.addLocatorsMetadata(generateCodeResult.locatorsMetadata);
+  }
   await page.save();
   set.add(page.sourceFileName);
 }

package/bin/client/code_gen/page_reflection.js

@@ -22,6 +22,18 @@ function unescapeFromComment(text) {
     .replace(/\*\\/g, "*/") // Unescape comment-closing sequence
     .replace(/\\\\/g, "\\"); // Unescape backslashes
 }
+let ai_config = null;
+export function getAiConfig() {
+  if (ai_config) {
+    return ai_config;
+  }
+  try {
+    ai_config = JSON.parse(readFileSync("ai_config.json", "utf8"));
+  } catch (e) {
+    ai_config = {};
+  }
+  return ai_config;
+}
 class CodePage {
   constructor(sourceFileName = null) {
     this.sourceFileName = sourceFileName;
@@ -224,13 +236,12 @@ this.imports[2].node.source.value
                 params = paramsObj.map((param) => param.name);
               }
               firstFind = false;
-            } 
+            }
             stepPaths.push(method.path);
-
           }
         }
         if (foundMethod) {
-          templates.push({ pattern, methodName, params, stepType, paths: stepPaths});
+          templates.push({ pattern, methodName, params, stepType, paths: stepPaths });
         }
       }
     }
@@ -481,7 +492,16 @@ this.imports[2].node.source.value
   }
   addLocatorsMetadata(locatorsMetadata) {
     // create a file name based on the source file name replace .mjs with .json
-    const locatorsMetadataFileName = this.sourceFileName.replace(".mjs", ".json");
+    let locatorsMetadataFileName = this.sourceFileName.replace(".mjs", ".json");
+    const config = getAiConfig();
+    if (config && config.locatorsMetadataDir) {
+      // if config.locatorsMetadataDir is set, use it to create the file path
+      locatorsMetadataFileName = path.join(config.locatorsMetadataDir, path.basename(locatorsMetadataFileName));
+      // check if the directory exists, if not create it
+      if (!existsSync(path.dirname(locatorsMetadataFileName))) {
+        mkdirSync(path.dirname(locatorsMetadataFileName), { recursive: true });
+      }
+    }
     let metadata = {};
     // try to read the file to metadata, protect with try catch
     try {
@@ -782,7 +802,7 @@ function getPath(comment) {
   if (index === -1) {
     return null;
   }
-  return comment.substring(index).split('\n')[0].substring(6);
+  return comment.substring(index).split("\n")[0].substring(6);
 }
 
 class CodePart {

package/bin/client/code_gen/playwright_codeget.js

@@ -62,6 +62,12 @@ const _isCodeGenerationStep = (step) => {
   }
   return false;
 };
+// Note: this function is used to exclude a key from an object
+// Please move it to utils and use it as a reusable function  ...
+function excludeKey(obj, keyToRemove) {
+  const { [keyToRemove]: _, ...rest } = obj;
+  return rest;
+}
 const splitToLocatorsGroups = (locators) => {
   const no_text = locators.locators.filter((locator) => locator.mode === "NO_TEXT");
   const ignore_digit = locators.locators.filter((locator) => locator.mode === "IGNORE_DIGIT");
@@ -131,7 +137,8 @@ const _generateCodeFromCommand = (step, elements, userData) => {
     if (!elementIdentifier) {
       elementIdentifier = findElementIdentifier(node, step, userData, elements);
     }
-    elements[elementIdentifier] = locatorObject;
+    const withoutAllStrategyLocators = excludeKey(locatorObject, "allStrategyLocators");
+    elements[elementIdentifier] = withoutAllStrategyLocators;
     elementsChanged = true;
   }
   let optionElement = null;

package/bin/client/local_agent.js

@@ -655,6 +655,7 @@ class LocalAgent {
 
             let page = agent.project.getPage(agent.pageName, true);
             const generateCodeResult = generateCode(recording, page, userData, agent.project.rootFolder, methodName);
+
             if (generateCodeResult.simple === true) {
               agent.sendDone("generateStepCode", null);
               break;
@@ -707,6 +708,9 @@ class LocalAgent {
                 cucumberStep: agent.cucumberStep,
               },
             });
+            if (generateCodeResult.locatorsMetadata) {
+              page.addLocatorsMetadata(generateCodeResult.locatorsMetadata);
+            }
             await page.save();
             agent.scenarioReport.updateLastStep({
               recording: command.data.recording,

package/bin/client/recorderv3/step_utils.js

@@ -2,7 +2,7 @@ import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
 import path from "path";
 import url from "url";
 import logger from "../../logger.js";
-import { CodePage } from "../code_gen/page_reflection.js";
+import { CodePage, getAiConfig } from "../code_gen/page_reflection.js";
 import { generateCode, generatePageName } from "../code_gen/playwright_codeget.js";
 import { invertCodeToCommand } from "../code_gen/code_inversion.js";
 import { Step } from "../cucumber/feature.js";
@@ -187,7 +187,17 @@ export async function saveRecording({ step, cucumberStep, codePage, projectDir,
 
 const getLocatorsJson = (file) => {
   if (!file) return {};
-  const locatorsFilePath = file.replace(".mjs", ".json");
+  let locatorsFilePath = file.replace(".mjs", ".json");
+  const originLocatorsFilePath = locatorsFilePath;
+  const config = getAiConfig();
+  if (config && config.locatorsMetadataDir) {
+    // if config.locatorsMetadataDir is set, use it to create the file path
+    locatorsFilePath = path.join(config.locatorsMetadataDir, path.basename(locatorsFilePath));
+    if (!existsSync(locatorsFilePath)) {
+      // if the file does not exist in the config directory, use the original path
+      locatorsFilePath = originLocatorsFilePath;
+    }
+  }
   if (!existsSync(locatorsFilePath)) {
     return {};
   }

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";
@@ -236,6 +236,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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dev-blinq/cucumber_client",
-  "version": "1.0.1224-dev",
+  "version": "1.0.1226-dev",
   "description": "",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",
@@ -28,7 +28,7 @@
     "@cucumber/tag-expressions": "^6.1.1",
     "@dev-blinq/cucumber-js": "1.0.172-dev",
     "@faker-js/faker": "^8.1.0",
-    "automation_model": "1.0.735-dev",
+    "automation_model": "1.0.737-dev",
     "axios": "^1.7.4",
     "chokidar": "^3.6.0",
     "create-require": "^1.1.1",