@dev-blinq/cucumber_client 1.0.1420-dev → 1.0.1422-dev

package/bin/client/cucumber_selector.js

@@ -117,6 +117,10 @@ if (deleteMjsFiles) {
 const utilsPath = path.join(__dirname, "../assets/templates/utils_template.txt");
 const utilsContent = fs.readFileSync(utilsPath, "utf8");
 const utilsFileName = stepsPath + "/utils.mjs";
+// if stepsPath directory doesn't exist create it
+if (!fs.existsSync(stepsPath)) {
+  fs.mkdirSync(stepsPath, { recursive: true });
+}
 fs.writeFileSync(utilsFileName, utilsContent, "utf8");
 // copy hooks file to the steps directory
 const hooksTemplateFilePath = path.join(__dirname, "../assets/templates/_hooks_template.txt");

package/bin/client/project.js

@@ -1,220 +1,204 @@
+// project.ts
 import { writeFileSync, readFileSync, readdirSync, existsSync, mkdirSync } from "fs";
-import { CodePage } from "./code_gen/page_reflection.js";
-
-import logger from "../logger.js";
 import path from "path";
 import { fileURLToPath } from "url";
+// Keep the .js extensions because the compiled runtime modules are ESM .js files.
+import { CodePage } from "./code_gen/page_reflection.js";
+import logger from "../logger.js";
 import { findFilesWithExtension } from "./cucumber/steps_definitions.js";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
-
-class Project {
-  environment = null;
-  pages = [];
-  constructor(rootFolder) {
-    this.rootFolder = rootFolder;
-    this.stepsFolder = path.join(rootFolder, "features", "step_definitions");
-  }
-
-  async load() {
-    this.pages = [];
-    // load env.json from the project root folder
-    let envFile = "";
-    const envArgVal = checkForEnvArg();
-    if (envArgVal) {
-      envFile = envArgVal;
-    } else if (process.env["BLINQ_ENV"]) {
-      envFile = process.env["BLINQ_ENV"];
-    } else if (existsSync(path.join(this.rootFolder, "env.json"))) {
-      envFile = path.join(this.rootFolder, "env.json");
-    } else {
-      //list all the files in the environments directory use the first json file
-      let files = readdirSync(path.join(this.rootFolder, "environments"));
-      for (let i = 0; i < files.length; i++) {
-        let file = files[i];
-        if (file.endsWith(".json")) {
-          envFile = path.join(this.rootFolder, "environments", file);
-          break;
-        }
-      }
-    }
-    // const envFile = path.join(this.rootFolder, "env.json");
-    if (!existsSync(envFile) || envFile === "") {
-      throw new Error(
-        `
-  ======================================================
-  env.json file not found in the project root folder
-  or in the environments folder
-  ======================================================
-  `
-      );
-    }
-    let envFileContent = readFileSync(envFile, "utf8");
-    try {
-      this.environment = JSON.parse(envFileContent);
-    } catch (e) {
-      throw new Error(
-        `
-        ======================================================
-        unable to parse environment file
-        ${e}
-        ======================================================
-        `
-      );
+function checkForEnvArg() {
+    for (const arg of process.argv.slice(2)) {
+        if (arg.startsWith("--")) {
+            const [key, value] = arg.split("=");
+            if (key.slice(2) === "env") {
+                return value ?? null;
+            }
+        }
     }
-    if (!this.environment.baseUrl) {
-      throw new Error(
-        `
-  ======================================================
-  baseUrl not found in env.json file
-  or in the environments folder
-  ======================================================
-  `
-      );
+    return null;
+}
+function generatePrompt(promptFile, parameters, chat = true) {
+    let promptFileContent = readFileSync(promptFile, "utf8");
+    for (const key in parameters) {
+        const value = parameters[key];
+        promptFileContent = promptFileContent.replaceAll(`{${key}}`, value);
     }
-    // list all the files in the project /features/step_definitions folder with mjs extension
-    if (!existsSync(this.stepsFolder)) {
-      return;
+    if (!chat)
+        return { promptFileContent };
+    const messages = [];
+    const parts = promptFileContent.split("####");
+    for (let i = 0; i < parts.length; i++) {
+        if (!parts[i].trim())
+            continue;
+        const role = parts[i];
+        const prompt = parts[i + 1];
+        messages.push({ role, content: (prompt ?? "").trim() });
+        i++;
     }
-    try {
-      // load the utils_template and save it to the project step_definitions folder
-      const utilsPath = path.join(__dirname, "../assets/templates/utils_template.txt");
-      const utilsContent = readFileSync(utilsPath, "utf8");
-      const utilsFileName = this.stepsFolder + "/utils.mjs";
-      writeFileSync(utilsFileName, utilsContent, "utf8");
-      const hooksTemplateFilePath = path.join(__dirname, "../assets", "templates", "_hooks_template.txt");
-      if (existsSync(hooksTemplateFilePath)) {
-        const hooksFilePath = path.join(this.stepsFolder, "_hooks.mjs");
-        const hooksContent = readFileSync(hooksTemplateFilePath, "utf8");
-        writeFileSync(hooksFilePath, hooksContent, "utf8");
-      }
-    } catch (e) {
-      logger.error("Error loading utils_template");
+    return { messages, promptFileContent };
+}
+class Project {
+    rootFolder;
+    stepsFolder;
+    environment = null;
+    pages = [];
+    constructor(rootFolder) {
+        this.rootFolder = rootFolder;
+        this.stepsFolder = path.join(rootFolder, "features", "step_definitions");
     }
-
-    const files = findFilesWithExtension(this.stepsFolder, "mjs");
-
-    //let files = readdirSync(this.stepsFolder);
-
-    for (let i = 0; i < files.length; i++) {
-      let file = files[i];
-      if (file.startsWith("_")) {
-        continue;
-      }
-      if (file.endsWith(".mjs")) {
-        let fullFileName = this.rootFolder + "/features/step_definitions/" + file;
-
-        // create a new CodePage object for each file
-        let page = new CodePage(fullFileName);
-        page.generateModel();
-        this.pages.push(page);
-      }
+    async load() {
+        this.pages = [];
+        // Resolve env file path
+        let envFile = "";
+        const envArgVal = checkForEnvArg();
+        if (envArgVal) {
+            envFile = envArgVal;
+        }
+        else if (process.env["BLINQ_ENV"]) {
+            envFile = process.env["BLINQ_ENV"];
+        }
+        else if (existsSync(path.join(this.rootFolder, "env.json"))) {
+            envFile = path.join(this.rootFolder, "env.json");
+        }
+        else {
+            // pick the first .json from environments/
+            const envDir = path.join(this.rootFolder, "environments");
+            const files = existsSync(envDir) ? readdirSync(envDir) : [];
+            for (let i = 0; i < files.length; i++) {
+                const file = files[i];
+                if (file.endsWith(".json")) {
+                    envFile = path.join(envDir, file);
+                    break;
+                }
+            }
+        }
+        if (!existsSync(envFile) || envFile === "") {
+            throw new Error(`
+======================================================
+env.json file not found in the project root folder
+or in the environments folder
+======================================================
+`);
+        }
+        const envFileContent = readFileSync(envFile, "utf8");
+        try {
+            this.environment = JSON.parse(envFileContent);
+        }
+        catch (e) {
+            throw new Error(`
+======================================================
+unable to parse environment file
+${e}
+======================================================
+`);
+        }
+        if (!this.environment.baseUrl) {
+            throw new Error(`
+======================================================
+baseUrl not found in env.json file
+or in the environments folder
+======================================================
+`);
+        }
+        // Prepare step_definitions utilities
+        if (!existsSync(this.stepsFolder)) {
+            return this.environment.name;
+        }
+        try {
+            const utilsPath = path.join(__dirname, "../assets/templates/utils_template.txt");
+            const utilsContent = readFileSync(utilsPath, "utf8");
+            const utilsFileName = path.join(this.stepsFolder, "utils.mjs");
+            writeFileSync(utilsFileName, utilsContent, "utf8");
+            const hooksTemplateFilePath = path.join(__dirname, "../assets", "templates", "_hooks_template.txt");
+            if (existsSync(hooksTemplateFilePath)) {
+                const hooksFilePath = path.join(this.stepsFolder, "_hooks.mjs");
+                const hooksContent = readFileSync(hooksTemplateFilePath, "utf8");
+                writeFileSync(hooksFilePath, hooksContent, "utf8");
+            }
+        }
+        catch {
+            logger.error("Error loading utils_template");
+        }
+        const files = findFilesWithExtension(this.stepsFolder, "mjs");
+        for (let i = 0; i < files.length; i++) {
+            const file = files[i];
+            if (file.startsWith("_"))
+                continue;
+            if (file.endsWith(".mjs")) {
+                const fullFileName = path.join(this.rootFolder, "features", "step_definitions", file);
+                const page = new CodePage(fullFileName);
+                page.generateModel();
+                this.pages.push(page);
+            }
+        }
+        return this.environment.name;
     }
-    return this.environment.name;
-  }
-  getPagesNames() {
-    let result = [];
-    this.pages.forEach((page) => {
-      result.push(page.getName());
-    });
-    return result;
-  }
-  findMethodInPages(methodName) {
-    for (const page of this.pages) {
-      for (const method of page.methods) {
-        if (method.name === methodName) {
-          return { page, method };
-        }
-      }
+    getPagesNames() {
+        const result = [];
+        this.pages.forEach((page) => result.push(page.getName()));
+        return result;
     }
-    return { page: null, method: null };
-  }
-
-  getProjectSignature() {
-    let result = [];
-    this.pages.forEach((page) => {
-      page.getMethodsNames().forEach((methodName) => {
-        result.push(page.getMethodInCommandFormat(methodName));
-      });
-    });
-    return result;
-  }
-  getPage(pageName, createEmpty = false) {
-    for (let i = 0; i < this.pages.length; i++) {
-      if (this.pages[i].getName().toLowerCase() === pageName.toLowerCase()) {
-        return this.pages[i];
-      }
+    findMethodInPages(methodName) {
+        for (const page of this.pages) {
+            for (const method of page.methods) {
+                if (method.name === methodName) {
+                    return { page, method };
+                }
+            }
+        }
+        return { page: null, method: null };
     }
-    if (createEmpty) {
-      let distFileName = this.stepsFolder + "/" + pageName + "_page.mjs";
-      let page = new CodePage(distFileName);
-      page.generateModel();
-      this.setPage(pageName, page);
-      return page;
+    getProjectSignature() {
+        const result = [];
+        this.pages.forEach((page) => {
+            page.getMethodsNames().forEach((methodName) => {
+                result.push(page.getMethodInCommandFormat(methodName));
+            });
+        });
+        return result;
     }
-    return null;
-  }
-  setPage(pageName, page) {
-    for (let i = 0; i < this.pages.length; i++) {
-      if (this.pages[i].getName().toLowerCase() === pageName.toLowerCase()) {
-        this.pages[i] = page;
-      }
+    getPage(pageName, createEmpty = false) {
+        for (let i = 0; i < this.pages.length; i++) {
+            if (this.pages[i].getName().toLowerCase() === pageName.toLowerCase()) {
+                return this.pages[i];
+            }
+        }
+        if (createEmpty) {
+            const distFileName = path.join(this.stepsFolder, `${pageName}_page.mjs`);
+            const page = new CodePage(distFileName);
+            page.generateModel();
+            this.setPage(pageName, page);
+            return page;
+        }
+        return null;
     }
-  }
-  createNewPage(name, _path) {
-    let distFileName = this.stepsFolder + "/" + name + "_page.mjs";
-    if (existsSync(distFileName)) {
-      logger.error("Page already exists: " + distFileName);
-      throw new Error("Page already exists: " + name + " - " + name + "_page.mjs");
+    setPage(pageName, page) {
+        for (let i = 0; i < this.pages.length; i++) {
+            if (this.pages[i].getName().toLowerCase() === pageName.toLowerCase()) {
+                this.pages[i] = page;
+            }
+        }
     }
-    if (!existsSync(this.stepsFolder)) {
-      mkdirSync(this.stepsFolder, { recursive: true });
+    createNewPage(name, _path) {
+        const distFileName = path.join(this.stepsFolder, `${name}_page.mjs`);
+        if (existsSync(distFileName)) {
+            logger.error("Page already exists: " + distFileName);
+            throw new Error(`Page already exists: ${name} - ${name}_page.mjs`);
+        }
+        if (!existsSync(this.stepsFolder)) {
+            mkdirSync(this.stepsFolder, { recursive: true });
+        }
+        const map = {
+            name,
+            path: _path ? `"${_path}"` : "null",
+            name_upper: name.charAt(0).toUpperCase() + name.slice(1),
+        };
+        const { promptFileContent } = generatePrompt(path.join(__dirname, "../assets/templates/page_template.txt"), map, false);
+        writeFileSync(distFileName, promptFileContent, "utf8");
+        // refresh pages list
+        void this.load();
     }
-    let map = {
-      name,
-      path: _path ? `"${_path}"` : "null",
-      name_upper: name.charAt(0).toUpperCase() + name.slice(1),
-    };
-
-    let content = generatePrompt(
-      path.join(__dirname, "../assets/templates/page_template.txt"),
-      map,
-      false
-    ).promptFileContent;
-    writeFileSync(distFileName, content, "utf8");
-    this.load();
-  }
 }
-const generatePrompt = (promptFile, parameters, chat = true) => {
-  let promptFileContent = readFileSync(promptFile, "utf8");
-  for (const key in parameters) {
-    const value = parameters[key];
-    promptFileContent = promptFileContent.replaceAll(`{${key}}`, value);
-  }
-  if (!chat) return { promptFileContent };
-  const messages = [];
-  const parts = promptFileContent.split("####");
-  for (let i = 0; i < parts.length; i++) {
-    if (!parts[i].trim()) continue;
-    const role = parts[i];
-    const prompt = parts[i + 1];
-    messages.push({ role, content: prompt.trim() });
-    //    console.error("####prompt####", `role ${role}ֿֿ`);
-    //    console.error(prompt.trim());
-    i++;
-  }
-  return { messages, promptFileContent };
-};
-
-const checkForEnvArg = () => {
-  for (let arg of process.argv.slice(2)) {
-    if (arg.startsWith("--")) {
-      const [key, value] = arg.split("=");
-      if (key.slice(2) === "env") {
-        return value;
-      }
-    }
-  }
-  return null;
-};
-export { Project };
+export { Project, generatePrompt, checkForEnvArg };

package/bin/logger.js

@@ -17,8 +17,8 @@ function formatWithInspect(val) {
 let alignColorsAndTime = null;
 let fileRotateTransport = null;
 let errorFileRotateTransport = null;
-export let logger = null;
 function initLogger() {
+  let logger = null;
   try {
     alignColorsAndTime = format.combine(
       format.timestamp({
@@ -59,9 +59,10 @@ function initLogger() {
     console.log(error);
     logger = console;
   }
+  return logger;
 }
 
-initLogger();
+export const logger = initLogger();
 const changeToTaskLogger = (logFile) => {
   logger.remove(fileRotateTransport);
   fileRotateTransport.filename = logFile;