@dev-blinq/cucumber_client 1.0.1690-dev → 1.0.1692-dev

package/bin/client/recorderv3/step_utils.js

@@ -1,7 +1,6 @@
-import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "fs";
-import path from "path";
-import url from "url";
-import logger from "../../logger.js";
+import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
+import path from "node:path";
+import url from "node:url";
 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";
@@ -9,8 +8,9 @@ import { Step } from "../cucumber/feature.js";
 import { locateDefinitionPath, StepsDefinitions } from "../cucumber/steps_definitions.js";
 import { Recording } from "../recording.js";
 import { generateApiCode } from "../code_gen/api_codegen.js";
-import { tmpdir } from "os";
-import { createHash } from "crypto";
+import { tmpdir } from "node:os";
+import { createHash } from "node:crypto";
+import { getErrorMessage } from "../utils/socket_logger.js";
 
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
@@ -48,7 +48,7 @@ const replaceLastOccurence = (str, search, replacement) => {
   return str.substring(0, lastIndex) + replacement + str.substring(lastIndex + search.length);
 };
 
-const _toRecordingStep = (cmd, stepText) => {
+export const _toRecordingStep = (cmd, stepText) => {
   switch (cmd.type) {
     case "hover_element": {
       return {
@@ -495,7 +495,15 @@ function makeStepTextUnique(step, stepsDefinitions) {
   step.text = stepText;
 }
 
-export async function saveRecording({ step, cucumberStep, codePage, projectDir, stepsDefinitions, parametersMap }) {
+export async function saveRecording({
+  step,
+  cucumberStep,
+  codePage,
+  projectDir,
+  stepsDefinitions,
+  parametersMap,
+  logger,
+}) {
   if (step.commands && Array.isArray(step.commands)) {
     step.commands = step.commands.map((cmd) => toRecordingStep(cmd, parametersMap, step.text));
   }
@@ -506,21 +514,19 @@ export async function saveRecording({ step, cucumberStep, codePage, projectDir,
       rmSync(routesPath, { recursive: true });
     }
     mkdirSync(routesPath, { recursive: true });
-    saveRoutes({ step, folderPath: routesPath });
+    saveRoutes({ step, folderPath: routesPath }, logger);
   } else {
     if (existsSync(routesPath)) {
-      // remove the folder
       try {
         rmSync(routesPath, { recursive: true });
-        //
       } catch (error) {
-        //
+        logger.error(`Error removing temp routes folder: ${getErrorMessage(error)}`);
       }
       routesPath = path.join(projectDir, "data", "routes");
       if (!existsSync(routesPath)) {
         mkdirSync(routesPath, { recursive: true });
       }
-      saveRoutes({ step, folderPath: routesPath });
+      saveRoutes({ step, folderPath: routesPath }, logger);
     }
   }
 
@@ -529,7 +535,7 @@ export async function saveRecording({ step, cucumberStep, codePage, projectDir,
   }
 
   if (step.isImplemented && step.shouldOverride) {
-    let stepDef = stepsDefinitions.findMatchingStep(step.text);
+    const stepDef = stepsDefinitions.findMatchingStep(step.text);
     codePage = getCodePage(stepDef.file);
   } else {
     const isUtilStep = makeStepTextUnique(step, stepsDefinitions);
@@ -555,21 +561,20 @@ export async function saveRecording({ step, cucumberStep, codePage, projectDir,
       rmSync(routesPath, { recursive: true });
     }
     mkdirSync(routesPath, { recursive: true });
-    saveRoutes({ step, folderPath: routesPath });
+    saveRoutes({ step, folderPath: routesPath }, logger);
   } else {
     if (existsSync(routesPath)) {
-      // remove the folder
       try {
         rmSync(routesPath, { recursive: true });
       } catch (error) {
-        //
+        logger.error(`Error removing temp routes folder: ${getErrorMessage(error)}`);
       }
     }
     routesPath = path.join(projectDir, "data", "routes");
     if (!existsSync(routesPath)) {
       mkdirSync(routesPath, { recursive: true });
     }
-    saveRoutes({ step, folderPath: routesPath });
+    saveRoutes({ step, folderPath: routesPath }, logger);
   }
 
   cucumberStep.text = step.text;
@@ -639,7 +644,6 @@ export async function saveRecording({ step, cucumberStep, codePage, projectDir,
     const generateCodeResult = generateCode(recording, codePage, userData, projectDir, methodName);
     console.log("Generated code for step:", step.text);
     if (generateCodeResult.noCode === true) {
-      logger.log("No code generated for step: " + step.text);
       return generateCodeResult.page;
     }
     codePage = generateCodeResult.page;
@@ -749,7 +753,7 @@ export const getCommandsForImplementedStep = (stepName, stepsDefinitions, stepPa
     const file = step?.file;
     const locatorsJson = getLocatorsJson(file);
     if (!step) {
-      throw new Error("Step definition not found" + stepName);
+      throw new Error(`Step definition not found: ${stepName}`);
     }
     isImplemented = true;
     const { codeCommands, codePage, elements, parametersNames, error } =
@@ -833,7 +837,7 @@ export async function executeStep({ stepsDefinitions, cucumberStep, context, cod
   }
 }
 
-export async function updateStepDefinitions({ scenario, featureName, projectDir }) {
+export async function updateStepDefinitions({ scenario, featureName, projectDir, logger }) {
   // set the candidate step definition file name
   // set the utils file path
   const utilsFilePath = path.join(projectDir, "features", "step_definitions", "utils.mjs");
@@ -867,32 +871,25 @@ export async function updateStepDefinitions({ scenario, featureName, projectDir
     if ((step.isImplemented && !step.shouldOverride) || step.commands.length === 0) {
       let routesPath = path.join(tmpdir(), `blinq_temp_routes`);
       if (process.env.TEMP_RUN === "true") {
-        console.log("Save routes in temp folder for running:", routesPath);
         if (existsSync(routesPath)) {
-          console.log("Removing existing temp_routes_folder:", routesPath);
           routesPath = path.join(tmpdir(), `blinq_temp_routes`);
           rmSync(routesPath, { recursive: true });
         }
         mkdirSync(routesPath, { recursive: true });
-        console.log("Created temp_routes_folder:", routesPath);
-        saveRoutes({ step, folderPath: routesPath });
+        saveRoutes({ step, folderPath: routesPath }, logger);
       } else {
-        console.log("Saving routes in project directory:", projectDir);
         if (existsSync(routesPath)) {
-          // remove the folder
           try {
             rmSync(routesPath, { recursive: true });
-            console.log("Removed temp_routes_folder:", routesPath);
           } catch (error) {
-            console.error("Error removing temp_routes folder", error);
+            logger.error(`Error removing temp routes folder: ${getErrorMessage(error)}`);
           }
         }
         routesPath = path.join(projectDir, "data", "routes");
-        console.log("Saving routes to:", routesPath);
         if (!existsSync(routesPath)) {
           mkdirSync(routesPath, { recursive: true });
         }
-        saveRoutes({ step, folderPath: routesPath });
+        saveRoutes({ step, folderPath: routesPath }, logger);
       }
       if (step.commands && Array.isArray(step.commands)) {
         step.commands = step.commands.map((cmd) => toRecordingStep(cmd, scenario.parametersMap));
@@ -902,7 +899,6 @@ export async function updateStepDefinitions({ scenario, featureName, projectDir
     const cucumberStep = getCucumberStep({ step });
     const pageName = generatePageName(step.startFrame?.url ?? "default");
     const stepDefsFilePath = locateDefinitionPath(featureFolder, pageName);
-    // path.join(stepDefinitionFolderPath, pageName + "_page.mjs");
     let codePage = getCodePage(stepDefsFilePath);
     codePage = await saveRecording({
       step,
@@ -923,7 +919,7 @@ export async function updateStepDefinitions({ scenario, featureName, projectDir
   writeFileSync(utilsFilePath, utilsContent, "utf8");
 }
 
-export function saveRoutes({ step, folderPath }) {
+export function saveRoutes({ step, folderPath }, logger) {
   const routeItems = step.routeItems;
   if (!routeItems || routeItems.length === 0) {
     return;
@@ -946,21 +942,18 @@ export function saveRoutes({ step, folderPath }) {
     };
   });
 
-  const routesFilePath = path.join(folderPath, stepNameHash + ".json");
-  console.log("Routes file path:", routesFilePath);
+  const routesFilePath = path.join(folderPath, `${stepNameHash}.json`);
   const routesData = {
     template,
     routes: routeItemsWithFilters,
   };
-  console.log("Routes data to save:", routesData);
 
   if (!existsSync(folderPath)) {
     mkdirSync(folderPath, { recursive: true });
   }
   try {
     writeFileSync(routesFilePath, JSON.stringify(routesData, null, 2), "utf8");
-    console.log("Saved routes to", routesFilePath);
   } catch (error) {
-    console.error("Failed to save routes to", routesFilePath, "Error:", error);
+    logger.error(`Error saving routes to ${routesFilePath}: ${getErrorMessage(error)}`);
   }
 }

package/bin/client/recorderv3/update_feature.js

@@ -1,8 +1,9 @@
-import { existsSync, readFileSync, writeFileSync } from "fs";
-import path from "path";
+import { existsSync, readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
 import { getDefaultPrettierConfig } from "../code_cleanup/utils.js";
 import prettier from "prettier";
-export function containsScenario({ featureFileContent, scenarioName }) {
+
+function containsScenario({ featureFileContent, scenarioName }) {
   const lines = featureFileContent.split("\n");
   for (const line of lines) {
     const trimmedLine = line.trim();
@@ -14,7 +15,7 @@ export function containsScenario({ featureFileContent, scenarioName }) {
   }
 }
 
-export function testStringForRegex(text) {
+function testStringForRegex(text) {
   const regexEndPattern = /\/([gimuy]*)$/;
   if (text.startsWith("/")) {
     const match = regexEndPattern.test(text);
@@ -31,7 +32,7 @@ export function testStringForRegex(text) {
   return false;
 }
 
-const escapeNonPrintables = (text) => {
+function escapeNonPrintables(text) {
   const t = text.replace(/\n/g, "\\n").replace(/\t/g, "\\t"); // .replace(/\|/g, "\\|");
   let result = "";
   // replace \ with \\ and | with \|
@@ -60,8 +61,9 @@ const escapeNonPrintables = (text) => {
     }
   }
   return result;
-};
-export function getCommandContent(command) {
+}
+
+function getCommandContent(command) {
   switch (command.type) {
     case "click_element": {
       return `${command.count === 2 ? "Double click" : "Click"} on ${escapeNonPrintables(command.element.name)}`;
@@ -108,15 +110,15 @@ export function getCommandContent(command) {
   }
 }
 
-export function getExamplesContent(parametersMap, datasets) {
+function getExamplesContent(parametersMap, datasets) {
   if (datasets && datasets.length > 0) {
-    let result = ''
+    let result = "";
     const keys = Object.keys(parametersMap);
     result += "\t\tExamples:\n";
 
     result += `\t\t| ${keys.join(" | ")} |\n`;
     for (const dataset of datasets) {
-      result += `\t\t| ${dataset.data.map(d => escapeNonPrintables(d.value)).join(" | ")} |\n`;
+      result += `\t\t| ${dataset.data.map((d) => escapeNonPrintables(d.value)).join(" | ")} |\n`;
     }
     return result;
   }
@@ -155,19 +157,19 @@ function getTagsContent(scenario, featureFileObject) {
   return tagsContent;
 }
 
-export function getScenarioContent({ scenario }, featureFileObject) {
+function getScenarioContent({ scenario }, featureFileObject) {
   const prametersMap = scenario.parametersMap ?? {};
   const isParmatersMapEmpty = Object.keys(prametersMap).length === 0;
   let scenarioContent = isParmatersMapEmpty ? `Scenario: ${scenario.name}\n` : `Scenario Outline: ${scenario.name}\n`;
 
-  let tagsContent = getTagsContent(scenario, featureFileObject);
+  const tagsContent = getTagsContent(scenario, featureFileObject);
 
-  scenarioContent = "\t" + tagsContent + "\n" + scenarioContent;
+  scenarioContent = `\t${tagsContent}\n${scenarioContent}`;
 
   for (const step of scenario.steps) {
     const commands = step.commands ?? [];
-    let commentContents = commands.map(getCommandContent).map(escapeNonPrintables);
-    let commentContent = commentContents.filter((content) => content.length > 0).join(", ");
+    const commentContents = commands.map(getCommandContent).map(escapeNonPrintables);
+    const commentContent = commentContents.filter((content) => content.length > 0).join(", ");
 
     if (commentContent) {
       scenarioContent += `\t# ${commentContent}\n`;
@@ -179,14 +181,15 @@ export function getScenarioContent({ scenario }, featureFileObject) {
   }
   return scenarioContent;
 }
-export const escapeString = (str) => {
+
+function escapeString(str) {
   // Step 1: Replace all literal newline characters with a temporary placeholder
   const placeholder = "\\n";
   str = str.replace(/\n/g, placeholder);
   return str;
-};
+}
 
-const GherkinToObject = (gherkin) => {
+function GherkinToObject(gherkin) {
   const obj = {
     featureName: "",
     scenarios: [],
@@ -222,7 +225,7 @@ const GherkinToObject = (gherkin) => {
   }
 
   const getScenario = () => {
-    let scenario = {
+    const scenario = {
       name: "",
       tags: [],
       steps: [],
@@ -299,7 +302,7 @@ const GherkinToObject = (gherkin) => {
     skipEmptyLines();
   }
   return obj;
-};
+}
 
 // remove lines starting with "Scenario:" or "Scenario Outline:" that contain the scenario name until the next scenario and then append the new scenario content
 // assumes that there are no multiple scenarios with the same name and having comments and tags in each scenario
@@ -333,14 +336,14 @@ function updateExistingScenario({
       continue;
     }
 
-    let scenarioHeader = `${scenario.hasParams ? "Scenario Outline" : "Scenario"}: ${scenario.name}`;
+    const scenarioHeader = `${scenario.hasParams ? "Scenario Outline" : "Scenario"}: ${scenario.name}`;
     let tagsLine;
 
     if (scenario.tags?.length > 0) {
       tagsLine = scenario.tags.map((t) => `@${t}`).join(" ");
     }
 
-    if (tagsLine) results.push("\t" + tagsLine);
+    if (tagsLine) results.push(`\t${tagsLine}`);
     results.push(`\t${scenarioHeader}`);
 
     for (const step of scenario.steps) {
@@ -359,8 +362,8 @@ function updateExistingScenario({
   return results.join("\n");
 }
 
-export async function updateFeatureFile({ featureName, scenario, override, projectDir }) {
-  const featureFilePath = path.join(projectDir, "features", featureName + ".feature");
+async function updateFeatureFile({ featureName, scenario, override, projectDir, logger }) {
+  const featureFilePath = path.join(projectDir, "features", `${featureName}.feature`);
   const isFeatureFileExists = existsSync(featureFilePath);
   const scenarioContent = getScenarioContent(
     { scenario },
@@ -391,13 +394,13 @@ export async function updateFeatureFile({ featureName, scenario, override, proje
             plugins: ["prettier-plugin-gherkin"],
           });
         } catch (error) {
-          console.error("Error formatting feature file content with Prettier:", error);
+          logger.error("Error formatting feature file content with Prettier:", error);
         }
         writeFileSync(featureFilePath, updatedFeatureFileContent);
         return;
       }
     }
-    let updatedFeatureFileContent = featureFileContent + "\n" + scenarioContent;
+    let updatedFeatureFileContent = `${featureFileContent}\n${scenarioContent}`;
     try {
       updatedFeatureFileContent = await prettier.format(updatedFeatureFileContent, {
         ...prettierConfig,
@@ -405,7 +408,7 @@ export async function updateFeatureFile({ featureName, scenario, override, proje
         plugins: ["prettier-plugin-gherkin"],
       });
     } catch (error) {
-      console.error("Error formatting feature file content with Prettier:", error);
+      logger.error("Error formatting feature file content with Prettier:", error);
     }
     writeFileSync(featureFilePath, updatedFeatureFileContent);
   } else {
@@ -417,8 +420,22 @@ export async function updateFeatureFile({ featureName, scenario, override, proje
         plugins: ["prettier-plugin-gherkin"],
       });
     } catch (error) {
-      console.error("Error formatting feature file content with Prettier:", error);
+      logger.error("Error formatting feature file content with Prettier:", error);
     }
     writeFileSync(featureFilePath, featureFileContent);
   }
 }
+
+export {
+  containsScenario,
+  testStringForRegex,
+  escapeNonPrintables,
+  getCommandContent,
+  getExamplesContent,
+  getTagsContent,
+  getScenarioContent,
+  escapeString,
+  GherkinToObject,
+  updateExistingScenario,
+  updateFeatureFile,
+};

package/bin/client/utils/app_dir.js

@@ -0,0 +1,21 @@
+import path from "node:path";
+import os from "node:os";
+function getAppDataDir(project_id) {
+    if (process.env.BLINQ_APPDATA_DIR) {
+        return path.join(process.env.BLINQ_APPDATA_DIR, "blinq.io", project_id);
+    }
+    let appDataDir;
+    switch (process.platform) {
+        case "win32":
+            appDataDir = path.join(process.env.APPDATA, "blinq.io", project_id);
+            break;
+        case "darwin":
+            appDataDir = path.join(os.homedir(), "Library", "Application Support", "blinq.io", project_id);
+            break;
+        default:
+            appDataDir = path.join(os.homedir(), ".config", "blinq.io", project_id);
+            break;
+    }
+    return appDataDir;
+}
+export { getAppDataDir };

package/bin/client/utils/socket_logger.js

@@ -1,3 +1,19 @@
+function getErrorMessage(err) {
+    if (typeof err === "string") {
+        return err;
+    }
+    else if (err instanceof Error) {
+        return err.message;
+    }
+    else {
+        try {
+            return JSON.stringify(err);
+        }
+        catch {
+            return String(err);
+        }
+    }
+}
 /**
  * SocketLogger - Singleton for structured socket-based logging.
  *
@@ -10,8 +26,8 @@
 export class SocketLogger {
     static instance;
     socket = null;
-    defaultContext = "";
-    defaultEventName = "recorder.log";
+    defaultContext = "BVTRecorder";
+    defaultEventName = "BVTRecorder.log";
     constructor() { }
     static getInstance() {
         if (!SocketLogger.instance) {
@@ -24,7 +40,7 @@ export class SocketLogger {
         this.defaultContext = opts?.context || "";
         this.defaultEventName = opts?.eventName || "recorder.log";
     }
-    log(level, message, extra, eventName, context) {
+    log(level, message, extra, context) {
         if (!this.socket || typeof this.socket.emit !== "function")
             return;
         const data = typeof message === "object" ? message : { message };
@@ -32,39 +48,47 @@ export class SocketLogger {
         try {
             dataSize = Buffer.byteLength(JSON.stringify(data || ""), "utf8");
         }
-        catch (e) {
+        catch {
             dataSize = -1;
         }
         const eventPayload = {
             level,
             context: context || this.defaultContext,
-            data: JSON.stringify(data),
+            data: JSON.stringify({
+                ...data,
+                errorMessage: level === "error" && data ? getErrorMessage(data) : undefined,
+            }),
             timestamp: new Date().toISOString(),
             dataSize,
             ...extra,
         };
         try {
             if (this.socket) {
-                this.socket.emit(eventName || this.defaultEventName, eventPayload);
+                this.socket.emit(this.defaultEventName, eventPayload);
             }
+            console.log(`${context ?? this.defaultContext} [${level.toUpperCase()}]:`, {
+                ...data,
+                ...extra,
+            });
         }
         catch (e) {
             console.error("Socket logging error:", e);
             console.log("Socket event payload:", eventPayload);
         }
     }
-    info(msg, ext) {
-        this.log("info", msg, ext);
+    info(msg, ext, ctx) {
+        this.log("info", msg, ext, ctx);
     }
-    warn(msg, ext) {
-        this.log("warn", msg, ext);
+    warn(msg, ext, ctx) {
+        this.log("warn", msg, ext, ctx);
     }
-    debug(msg, ext) {
-        this.log("debug", msg, ext);
+    debug(msg, ext, ctx) {
+        this.log("debug", msg, ext, ctx);
     }
-    error(msg, ext) {
-        this.log("error", msg, ext);
+    error(msg, ext, ctx) {
+        this.log("error", msg, ext, ctx);
     }
 }
 const socketLoggerInstance = SocketLogger.getInstance();
 export default socketLoggerInstance;
+export { getErrorMessage };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dev-blinq/cucumber_client",
-  "version": "1.0.1690-dev",
+  "version": "1.0.1692-dev",
   "description": " ",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",
@@ -14,6 +14,8 @@
     "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",
+    "test:unit": "vitest run",
+    "test:unit:watch": "vitest watch",
     "clean_old": "rimraf -g build1 && rimraf -g types1",
     "clean": "rimraf -g build && rimraf -g types",
     "build_old": "npm run clean_old && npm run pack_old",
@@ -70,6 +72,8 @@
     "readline-sync": "^1.4.10",
     "ts-node": "^10.9.2",
     "tsup": "^8.5.0",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.2",
+    "vite-tsconfig-paths": "^6.0.4",
+    "vitest": "^2.1.4"
   }
 }

package/bin/client/recorderv3/app_dir.js

@@ -1,23 +0,0 @@
-import path from "path";
-import os from "os";
-
-export const getAppDataDir = (project_id) => {
-  if (process.env.BLINQ_APPDATA_DIR) {
-    return path.join(process.env.BLINQ_APPDATA_DIR, "blinq.io", project_id);
-  }
-
-  let appDataDir;
-
-  switch (process.platform) {
-    case "win32":
-      appDataDir = path.join(process.env.APPDATA, "blinq.io", project_id);
-      break;
-    case "darwin":
-      appDataDir = path.join(os.homedir(), "Library", "Application Support", "blinq.io", project_id);
-      break;
-    default:
-      appDataDir = path.join(os.homedir(), ".config", "blinq.io", project_id);
-      break;
-  }
-  return appDataDir;
-};