@dev-blinq/cucumber_client 1.0.1239-stage → 1.0.1240-stage

package/bin/client/code_cleanup/utils.js

@@ -7,10 +7,11 @@ const { default: traverse } = pkg;
 import pkg1 from "@babel/generator";
 const { default: generate } = pkg1;
 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";
+
 const STEP_KEYWORDS = new Set(["Given", "When", "Then"]);
 
 /**
@@ -307,14 +308,17 @@ 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}`);
     }
   } 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}`);
     } catch (error) {
+      socketLogger.error(`Error writing Prettier config file: ${error}`);
       console.error(`Error writing Prettier config file: ${error}`);
     }
   }

package/bin/client/code_gen/playwright_codeget.js

@@ -4,6 +4,7 @@ import { StepsDefinitions } from "../cucumber/steps_definitions.js";
 import path from "path";
 import { CodePage } from "./page_reflection.js";
 import { convertToIdentifier, escapeNonPrintables } from "./utils.js";
+import socketLogger from "../utils/socket_logger.js";
 const findElementIdentifier = (node, step, userData, elements) => {
   if (node.key) {
     // incase of rerunning implemented steps
@@ -725,6 +726,7 @@ const generateCode = (recording, codePage, userData, projectDir, methodName) =>
   }
   let elements = {};
   if (!codePage) {
+    socketLogger.info("CodePage is null");
     console.log("codePage is null");
   } else {
     elements = codePage.getVariableDeclarationAsObject("elements");

package/bin/client/cucumber/feature.js

@@ -8,6 +8,7 @@ import { parseStepTextParameters, toCucumberExpression, unEscapeNonPrintables }
 import stream from "stream";
 import { testStringForRegex } from "../recorderv3/update_feature.js";
 import { generateTestData } from "./feature_data.js";
+import socketLogger from "../utils/socket_logger.js";
 class DataTable {
   constructor(dataTableDocument) {
     if (!dataTableDocument) {
@@ -544,6 +545,9 @@ const scenarioResolution = async (featureFilePath) => {
         fs.rmSync(tmpDir, { recursive: true });
       }
     } catch (e) {
+      socketLogger.error(
+        `An error has occurred while removing the temp folder at ${tmpDir}. Please remove it manually. Error: ${e}`
+      );
       console.error(
         `An error has occurred while removing the temp folder at ${tmpDir}. Please remove it manually. Error: ${e}`
       );

package/bin/client/recorderv3/bvt_recorder.js

@@ -12,11 +12,9 @@ import { updateFeatureFile } from "./update_feature.js";
 import { parseStepTextParameters } from "../cucumber/utils.js";
 import { AstBuilder, GherkinClassicTokenMatcher, Parser } from "@cucumber/gherkin";
 import chokidar from "chokidar";
-import logger from "../../logger.js";
 import { unEscapeNonPrintables } from "../cucumber/utils.js";
 import { findAvailablePort } from "../utils/index.js";
-import { Step } from "../cucumber/feature.js";
-
+import socketLogger from "../utils/socket_logger.js";
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
 const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
@@ -45,7 +43,6 @@ async function evaluate(frame, script) {
 async function findNestedFrameSelector(frame, obj) {
   try {
     const parent = frame.parentFrame();
-    if (parent) console.log(`Parent frame: ${JSON.stringify(parent)}`);
     if (!parent) return { children: obj };
     const frameElement = await frame.frameElement();
     if (!frameElement) return;
@@ -54,6 +51,7 @@ async function findNestedFrameSelector(frame, obj) {
     }, frameElement);
     return findNestedFrameSelector(parent, { children: obj, selectors });
   } catch (e) {
+    socketLogger.error(`Error in findNestedFrameSelector: ${e}`);
     console.error(e);
   }
 }
@@ -150,6 +148,7 @@ const transformAction = (action, el, isVerify, isPopupCloseClick, isInHoverMode,
       };
     }
     default: {
+      socketLogger.error(`Action not supported: ${action.name}`);
       console.log("action not supported", action);
       throw new Error("action not supported");
     }
@@ -161,6 +160,7 @@ const transformAction = (action, el, isVerify, isPopupCloseClick, isInHoverMode,
  * @property {string} projectDir
  * @property {string} TOKEN
  * @property {(name:string, data:any)=> void} sendEvent
+ * @property {Object} logger
  */
 export class BVTRecorder {
   #currentURL = "";
@@ -174,7 +174,6 @@ export class BVTRecorder {
    */
   constructor(initialState) {
     Object.assign(this, initialState);
-    this.logger = logger;
     this.screenshotMap = new Map();
     this.snapshotMap = new Map();
     this.scenariosStepsMap = new Map();
@@ -187,7 +186,6 @@ export class BVTRecorder {
     this.pageSet = new Set();
     this.pageMetaDataSet = new Set();
     this.lastKnownUrlPath = "";
-    // TODO: what is world?
     this.world = { attach: () => {} };
     this.shouldTakeScreenshot = true;
     this.watcher = null;
@@ -210,7 +208,7 @@ export class BVTRecorder {
     __bvt_recordCommand: async ({ frame, page, context }, event) => {
       this.#activeFrame = frame;
       const nestFrmLoc = await findNestedFrameSelector(frame);
-      console.log(`Time taken for action: ${event.statistics.time}`);
+      this.logger.info(`Time taken for action: ${event.statistics.time}`);
       await this.onAction({ ...event, nestFrmLoc });
     },
     __bvt_getMode: async () => {
@@ -229,8 +227,7 @@ export class BVTRecorder {
       await this.onClosePopup();
     },
     __bvt_log: async (src, message) => {
-      // this.logger.info(message);
-      console.log(`Inside Browser: ${message}`);
+      this.logger.info(`Inside Browser: ${message}`);
     },
     __bvt_getObject: (_src, obj) => {
       this.processObject(obj);
@@ -304,7 +301,7 @@ export class BVTRecorder {
       try {
         ai_config = JSON.parse(readFileSync(ai_config_file, "utf8"));
       } catch (error) {
-        console.error("Error reading ai_config.json", error);
+        this.logger.error("Error reading ai_config.json", error);
       }
     }
     this.config = ai_config;
@@ -316,10 +313,7 @@ export class BVTRecorder {
       ],
     };
 
-    let startTime = Date.now();
     const bvtContext = await initContext(url, false, false, this.world, 450, initScripts, this.envName);
-    let stopTime = Date.now();
-    this.logger.info(`Browser launched in ${(stopTime - startTime) / 1000} s`);
     this.bvtContext = bvtContext;
     this.stepRunner = new BVTStepRunner({
       projectDir: this.projectDir,
@@ -327,23 +321,18 @@ export class BVTRecorder {
         if (data && data.type) {
           switch (data.type) {
             case "cmdExecutionStart":
-              console.log("Sending cmdExecutionStart event for cmdId:", data);
               this.sendEvent(this.events.cmdExecutionStart, data);
               break;
             case "cmdExecutionSuccess":
-              console.log("Sending cmdExecutionSuccess event for cmdId:", data);
               this.sendEvent(this.events.cmdExecutionSuccess, data);
               break;
             case "cmdExecutionError":
-              console.log("Sending cmdExecutionError event for cmdId:", data);
               this.sendEvent(this.events.cmdExecutionError, data);
               break;
             case "interceptResults":
-              console.log("Sending interceptResults event");
               this.sendEvent(this.events.interceptResults, data);
               break;
             default:
-              console.warn("Unknown command execution status type:", data.type);
               break;
           }
         }
@@ -382,13 +371,15 @@ export class BVTRecorder {
         }
         return;
       } catch (error) {
-        console.error("Error evaluting in context:", error);
+        // console.error("Error evaluting in context:", error);
+        this.logger.error("Error evaluating in context:", error);
       }
     }
   }
 
   getMode() {
-    console.log("getMode", this.#mode);
+    // console.log("getMode", this.#mode);
+    this.logger.info("Current mode:", this.#mode);
     return this.#mode;
   }
 
@@ -430,6 +421,8 @@ export class BVTRecorder {
           this.sendEvent(this.events.onBrowserClose);
         }
       } catch (error) {
+        this.logger.error("Error in page close event");
+        this.logger.error(error);
         console.error("Error in page close event");
         console.error(error);
       }
@@ -440,8 +433,10 @@ export class BVTRecorder {
         if (frame !== page.mainFrame()) return;
         this.handlePageTransition();
       } catch (error) {
+        this.logger.error("Error in handlePageTransition event");
+        this.logger.error(error);
         console.error("Error in handlePageTransition event");
-        // console.error(error);
+        console.error(error);
       }
       try {
         if (frame !== this.#activeFrame) return;
@@ -460,6 +455,8 @@ export class BVTRecorder {
         // await this._setRecordingMode(frame);
         // await this._initPage(page);
       } catch (error) {
+        this.logger.error("Error in frame navigate event");
+        this.logger.error(error);
         console.error("Error in frame navigate event");
         // console.error(error);
       }
@@ -542,13 +539,9 @@ export class BVTRecorder {
 
     try {
       const result = await client.send("Page.getNavigationHistory");
-      // console.log("Navigation History:", result);
       const entries = result.entries;
       const currentIndex = result.currentIndex;
 
-      // ignore if currentIndex is not the last entry
-      // if (currentIndex !== entries.length - 1) return;
-
       const currentEntry = entries[currentIndex];
       const transitionInfo = this.analyzeTransitionType(entries, currentIndex, currentEntry);
       this.previousIndex = currentIndex;
@@ -561,6 +554,8 @@ export class BVTRecorder {
         navigationAction: transitionInfo.action,
       };
     } catch (error) {
+      this.logger.error("Error in getCurrentTransition event");
+      this.logger.error(error);
       console.error("Error in getTransistionType event", error);
     } finally {
       await client.detach();
@@ -629,6 +624,8 @@ export class BVTRecorder {
         // add listener for frame navigation on new tab
         this._addFrameNavigateListener(page);
       } catch (error) {
+        this.logger.error("Error in page event");
+        this.logger.error(error);
         console.error("Error in page event");
         console.error(error);
       }
@@ -670,6 +667,7 @@ export class BVTRecorder {
       const { data } = await client.send("Page.captureScreenshot", { format: "png" });
       return data;
     } catch (error) {
+      this.logger.error("Error in taking browser screenshot");
       console.error("Error in taking browser screenshot", error);
     } finally {
       await client.detach();
@@ -839,6 +837,7 @@ export class BVTRecorder {
       BLINQ_ENV: this.envName,
       STORE_DETAILED_NETWORK_DATA: listenNetwork ? "true" : "false",
       CURRENT_STEP_ID: step.id,
+      DEBUG: "blinq:route",
     };
 
     this.bvtContext.navigate = true;
@@ -967,10 +966,11 @@ export class BVTRecorder {
     if (existsSync(_getDataFile(this.world, this.bvtContext, this.web))) {
       try {
         const testData = JSON.parse(readFileSync(_getDataFile(this.world, this.bvtContext, this.web), "utf8"));
-        this.logger.info("Test data", testData);
+        // this.logger.info("Test data", testData);
         this.sendEvent(this.events.getTestData, testData);
       } catch (e) {
-        this.logger.error("Error reading test data file", e);
+        // this.logger.error("Error reading test data file", e);
+        console.log("Error reading test data file", e);
       }
     }
 
@@ -979,10 +979,12 @@ export class BVTRecorder {
     this.watcher.on("all", async (event, path) => {
       try {
         const testData = JSON.parse(await readFile(_getDataFile(this.world, this.bvtContext, this.web), "utf8"));
-        this.logger.info("Test data", testData);
+        // this.logger.info("Test data", testData);
+        console.log("Test data changed", testData);
         this.sendEvent(this.events.getTestData, testData);
       } catch (e) {
-        this.logger.error("Error reading test data file", e);
+        // this.logger.error("Error reading test data file", e);
+        console.log("Error reading test data file", e);
       }
     });
   }
@@ -1015,7 +1017,7 @@ export class BVTRecorder {
       .filter((file) => file.endsWith(".feature"))
       .map((file) => path.join(this.projectDir, "features", file));
     try {
-      const parsedFiles = featureFiles.map((file) => parseFeatureFile(file));
+      const parsedFiles = featureFiles.map((file) => this.parseFeatureFile(file));
       const output = {};
       parsedFiles.forEach((file) => {
         if (!file.feature) return;
@@ -1043,7 +1045,7 @@ export class BVTRecorder {
   loadExistingScenario({ featureName, scenarioName }) {
     const step_definitions = loadStepDefinitions(this.projectDir);
     const featureFilePath = path.join(this.projectDir, "features", featureName);
-    const gherkinDoc = parseFeatureFile(featureFilePath);
+    const gherkinDoc = this.parseFeatureFile(featureFilePath);
     const scenario = gherkinDoc.feature.children.find((child) => child.scenario.name === scenarioName)?.scenario;
 
     const steps = [];
@@ -1202,20 +1204,21 @@ export class BVTRecorder {
     await this.cleanupExecution({ tags });
     await this.initExecution({ tags });
   }
-}
 
-const parseFeatureFile = (featureFilePath) => {
-  try {
-    let id = 0;
-    const uuidFn = () => (++id).toString(16);
-    const builder = new AstBuilder(uuidFn);
-    const matcher = new GherkinClassicTokenMatcher();
-    const parser = new Parser(builder, matcher);
-    const source = readFileSync(featureFilePath, "utf8");
-    const gherkinDocument = parser.parse(source);
-    return gherkinDocument;
-  } catch (e) {
-    console.log(e);
+  parseFeatureFile(featureFilePath) {
+    try {
+      let id = 0;
+      const uuidFn = () => (++id).toString(16);
+      const builder = new AstBuilder(uuidFn);
+      const matcher = new GherkinClassicTokenMatcher();
+      const parser = new Parser(builder, matcher);
+      const source = readFileSync(featureFilePath, "utf8");
+      const gherkinDocument = parser.parse(source);
+      return gherkinDocument;
+    } catch (e) {
+      this.logger.error(`Error parsing feature file: ${featureFilePath}`);
+      console.log(e);
+    }
+    return {};
   }
-  return {};
-};
+}

package/bin/client/recorderv3/index.js

@@ -4,6 +4,7 @@ import { BVTRecorder } from "./bvt_recorder.js";
 import { compareWithScenario } from "../code_gen/duplication_analysis.js";
 import { getAppDataDir } from "./app_dir.js";
 import { readdir } from "fs/promises";
+import socketLogger from "../utils/socket_logger.js";
 
 let port = process.env.EDITOR_PORT || 3003;
 const WS_URL = "http://localhost:" + port;
@@ -16,7 +17,9 @@ class PromisifiedSocketServer {
   init() {
     this.socket.on("request", async (data) => {
       const { event, input, id, roomId, socketId } = data;
-      console.log("request", { event, input, id, roomId, socketId });
+      if (event !== "recorderWindow.getCurrentChromiumPath") {
+        socketLogger.info("Received request", { event, input, id, roomId, socketId });
+      }
       try {
         const handler = this.routes[event];
         if (!handler) {
@@ -24,17 +27,12 @@ class PromisifiedSocketServer {
           return;
         }
         const response = await handler(input);
-        // console.log("response", { id, value: response, roomId, socketId });
+        if (event !== "recorderWindow.getCurrentChromiumPath") {
+          socketLogger.info(`Sending response`, { event, id, value: response, roomId, socketId });
+        }
         this.socket.emit("response", { id, value: response, roomId, socketId });
       } catch (error) {
-        console.log("request", JSON.stringify({ event, input, id, roomId, socketId }));
-        console.error("response", { id, error, roomId, socketId });
-        // console.error({
-        //   message: error?.message,
-        //   code: error?.code,
-        //   info: error?.info,
-        //   stack: error?.stack,
-        // })
+        socketLogger.error("Error handling request", { event, input, id, roomId, socketId, error });
         this.socket.emit("response", {
           id,
           error: {
@@ -51,45 +49,17 @@ class PromisifiedSocketServer {
   }
 }
 
-function memorySizeOf(obj) {
-  var bytes = 0;
-
-  function sizeOf(obj) {
-    if (obj !== null && obj !== undefined) {
-      switch (typeof obj) {
-        case "number":
-          bytes += 8;
-          break;
-        case "string":
-          bytes += obj.length * 2;
-          break;
-        case "boolean":
-          bytes += 4;
-          break;
-        case "object":
-          var objClass = Object.prototype.toString.call(obj).slice(8, -1);
-          if (objClass === "Object" || objClass === "Array") {
-            for (var key in obj) {
-              if (!obj.hasOwnProperty(key)) continue;
-              sizeOf(obj[key]);
-            }
-          } else bytes += obj.toString().length * 2;
-          break;
-      }
-    }
-    return bytes;
-  }
-  return sizeOf(obj);
-}
-
 const init = ({ envName, projectDir, roomId, TOKEN }) => {
-  console.log("connecting to " + WS_URL);
+  console.log("Connecting to " + WS_URL);
   const socket = io(WS_URL);
+  socketLogger.init(socket, { context: "BVTRecorder", eventName: "BVTRecorder.log" });
   socket.on("connect", () => {
-    console.log("connected to server");
+    socketLogger.info("Connected to BVTRecorder server");
+    console.log("Connected to BVTRecorder server");
   });
   socket.on("disconnect", () => {
-    console.log("disconnected from server");
+    socketLogger.info("Disconnected from server");
+    console.log("Disconnected from server");
   });
   socket.emit("joinRoom", { id: roomId, window: "cucumber_client/bvt_recorder" });
   const recorder = new BVTRecorder({
@@ -97,20 +67,19 @@ const init = ({ envName, projectDir, roomId, TOKEN }) => {
     projectDir,
     TOKEN,
     sendEvent: (event, data) => {
-      console.log("Size of data", memorySizeOf(data), "bytes");
-      console.log("----", event, data, "roomId", roomId);
+      socketLogger.info("Sending event", { event, data, roomId });
       socket.emit(event, data, roomId);
-      console.log("Successfully sent event", event, "to room", roomId);
     },
+    logger: socketLogger,
   });
   recorder
     .openBrowser()
     .then(() => {
-      // console.log("BVTRecorder.browserOpened");
+      socketLogger.info("BVTRecorder.browserOpened");
       socket.emit("BVTRecorder.browserOpened", null, roomId);
     })
     .catch((e) => {
-      console.error("BVTRecorder.browserLaunchFailed", e);
+      socketLogger.error("BVTRecorder.browserLaunchFailed", e);
       socket.emit("BVTRecorder.browserLaunchFailed", e, roomId);
     });
   const timeOutForFunction = async (promise, timeout = 5000) => {
@@ -121,6 +90,7 @@ const init = ({ envName, projectDir, roomId, TOKEN }) => {
       return res;
     } catch (error) {
       console.error(error);
+      socketLogger.error(error);
       throw error;
     }
   };
@@ -130,10 +100,13 @@ const init = ({ envName, projectDir, roomId, TOKEN }) => {
       return recorder
         .openBrowser(input)
         .then(() => {
+          socketLogger.info("BVTRecorder.browserOpened");
+          console.info("BVTRecorder.browserOpened");
           socket.emit("BVTRecorder.browserOpened", { roomId, window: "cucumber_client/bvt_recorder" });
         })
         .catch((e) => {
-          console.error(e);
+          socketLogger.error("Error opening browser", e);
+          console.error("BVTRecorder.browserLaunchFailed", e);
           socket.emit("BVTRecorder.browserLaunchFailed", { roomId, window: "cucumber_client/bvt_recorder" });
         });
     },
@@ -144,10 +117,12 @@ const init = ({ envName, projectDir, roomId, TOKEN }) => {
       return recorder
         .reOpenBrowser(input)
         .then(() => {
-          // console.log("BVTRecorder.browserOpened");
+          socketLogger.info("BVTRecorder.browserOpened");
+          console.log("BVTRecorder.browserOpened");
           socket.emit("BVTRecorder.browserOpened", null, roomId);
         })
         .catch((e) => {
+          socketLogger.info("BVTRecorder.browserLaunchFailed");
           console.error("BVTRecorder.browserLaunchFailed", e);
           socket.emit("BVTRecorder.browserLaunchFailed", null, roomId);
         });
@@ -247,9 +222,7 @@ const init = ({ envName, projectDir, roomId, TOKEN }) => {
     "recorderWindow.getSnapshotFiles": async (input) => {
       const snapshotFolder = recorder.getSnapshotFolder();
       if (snapshotFolder) {
-        // Get the list of filenames in the snapshot folder
         const files = await readdir(snapshotFolder);
-        // Filter the files to only include .png files
         const ymlFiles = files.filter((file) => file.endsWith(".yml") || file.endsWith(".yaml"));
         return { folder: snapshotFolder, files: ymlFiles };
       } else return { folder: null, files: [] };
@@ -318,7 +291,6 @@ try {
   showUsage(error, usage);
 }
 try {
-  // console.log({ envName, projectDir, featureName, scenarioName, stepIndex, roomId })
   init({
     envName,
     projectDir,

package/bin/client/recorderv3/services.js

@@ -15,20 +15,7 @@ export class NamesService {
     if (!screenshot && commands.length > 1) {
       screenshot = this.screenshotMap.get(commands[commands.length - 2].inputID);
     }
-    this.logger.info(
-      "data: " +
-        JSON.stringify(
-          {
-            commands,
-            stepsNames,
-            parameters,
-            map,
-          },
-          null,
-          2
-        )
-    );
-    // get screenshot for the last command
+
     const url = `${getRunsServiceBaseURL()}/generate-step-information/generate`;
     const TIMEOUT = 120; // 2 minutes
     const { data } = await axiosClient({
@@ -65,6 +52,7 @@ export class NamesService {
         }
       } catch (error) {
         if (i === TIMEOUT - 1) {
+          this.logger.error("Timeout while generating step details: ", error);
           console.error("Timeout while generating step details: ", error);
         }
       }
@@ -96,7 +84,6 @@ export class NamesService {
       scenario: scenarioAsText,
     };
 
-    this.logger.info("data: " + JSON.stringify(genObject, null, 2));
     // get screenshot for the last command
     const url = `${getRunsServiceBaseURL()}/generate-step-information/generate_scenario_feature`;
     const TIMEOUT = 120; // 2 minutes
@@ -140,6 +127,7 @@ export class NamesService {
     if (result.status !== 200) {
       return { success: false, message: "Error while generating step details" };
     }
+
     return result.data;
   }
 

package/bin/client/utils/socket_logger.js

@@ -0,0 +1,132 @@
+/**
+ * @typedef {Object} SocketLoggerEventPayload
+ * @property {string} level        Log level (e.g. "info", "warn", "error", "debug")
+ * @property {string} context      Log context/subsystem (e.g. "BVTRecorder")
+ * @property {*}      data         The log message payload (string, object, etc)
+ * @property {string} timestamp    ISO string when the log was emitted
+ * @property {number} dataSize     Size of data in bytes (-1 if unknown)
+ */
+
+/**
+ * @typedef {Object} SocketLoggerInitOptions
+ * @property {string=} context     Default context for all logs (optional)
+ * @property {string=} eventName   Default event name (default: "recorder.log")
+ */
+
+/**
+ * SocketLogger - Singleton for structured socket-based logging.
+ *
+ * @namespace SocketLogger
+ * @property {function(import('socket.io-client').Socket|import('socket.io').Socket, SocketLoggerInitOptions=):void} init
+ * @property {function(string, (string|*), Object=, string=, string=):void} log
+ * @property {function((string|*), Object=):void} info
+ * @property {function((string|*), Object=):void} warn
+ * @property {function((string|*), Object=):void} debug
+ * @property {function((string|*), Object=):void} error
+ *
+ * @example
+ *   import logger from "./socket_logger.js";
+ *   logger.init(socket, { context: "BVTRecorder" });
+ *   logger.info("Step started", { step: 2 });
+ *   logger.error("Failed!", { error: "bad stuff" });
+ */
+const SocketLogger = (function () {
+  /** @type {import('socket.io-client').Socket|import('socket.io').Socket|null} */
+  let socket = null;
+  /** @type {string} */
+  let defaultContext = "";
+  /** @type {string} */
+  let defaultEventName = "recorder.log";
+
+  /**
+   * Initialize the logger (call once).
+   * @param {import('socket.io-client').Socket|import('socket.io').Socket} sock
+   * @param {SocketLoggerInitOptions=} opts
+   */
+  function init(sock, opts) {
+    socket = sock;
+    defaultContext = (opts && opts.context) || "";
+    defaultEventName = (opts && opts.eventName) || "recorder.log";
+  }
+
+  /**
+   * Low-level log method (most users use info/warn/debug/error).
+   * @param {string} level         Log level ("info", "warn", "debug", "error")
+   * @param {string|*} message     The log message or object
+   * @param {Object=} extra        Extra fields (will be merged into log payload)
+   * @param {string=} eventName    Override event name for this log (default: "recorder.log")
+   * @param {string=} context      Override log context for this log (default: set in init)
+   */
+  function log(level, message, extra, eventName, context) {
+    if (!socket || typeof socket.emit !== "function") return;
+    /** @type {*} */
+    var data = typeof message === "object" ? message : { message: message };
+    /** @type {number} */
+    var dataSize = 0;
+    try {
+      dataSize = Buffer.byteLength(JSON.stringify(data || ""), "utf8");
+    } catch (e) {
+      dataSize = -1;
+    }
+    /** @type {SocketLoggerEventPayload} */
+    var eventPayload = Object.assign(
+      {
+        level: level,
+        context: context || defaultContext,
+        data: data,
+        timestamp: new Date().toISOString(),
+        dataSize: dataSize,
+      },
+      extra || {}
+    );
+    // @ts-ignore
+    try {
+      if (socket) {
+        socket.emit(eventName || defaultEventName, eventPayload);
+      }
+    } catch (e) {
+      console.error("Socket logging error:", e);
+      console.log("Socket event payload:", eventPayload);
+    }
+  }
+
+  /**
+   * Write an info-level log event.
+   * @param {string|*} msg      The message or object
+   * @param {Object=} ext       Any extra fields/metadata
+   */
+  function info(msg, ext) {
+    log("info", msg, ext);
+  }
+
+  /**
+   * Write a warn-level log event.
+   * @param {string|*} msg      The message or object
+   * @param {Object=} ext       Any extra fields/metadata
+   */
+  function warn(msg, ext) {
+    log("warn", msg, ext);
+  }
+
+  /**
+   * Write a debug-level log event.
+   * @param {string|*} msg      The message or object
+   * @param {Object=} ext       Any extra fields/metadata
+   */
+  function debug(msg, ext) {
+    log("debug", msg, ext);
+  }
+
+  /**
+   * Write an error-level log event.
+   * @param {string|*} msg      The message or object
+   * @param {Object=} ext       Any extra fields/metadata
+   */
+  function error(msg, ext) {
+    log("error", msg, ext);
+  }
+
+  return { init, log, info, warn, debug, error };
+})();
+
+export default SocketLogger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dev-blinq/cucumber_client",
-  "version": "1.0.1239-stage",
+  "version": "1.0.1240-stage",
   "description": " ",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",