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

package/bin/client/recorderv3/wbr_entry.js

@@ -0,0 +1,61 @@
+import { io } from "socket.io-client";
+import { BVTRecorderInit } from "./bvt_init.js";
+import { loadArgs, showUsage, validateCLIArg } from "../cli_helpers.js";
+const requiredEnvVars = ["PROJECT_ID", "BLINQ_TOKEN", "SESSION_ID", "WORKER_WS_SERVER_URL", "REMOTE_ORIGINS_URL"];
+function validateEnvVariables() {
+    const missingVars = requiredEnvVars.filter((varName) => !process.env[varName]);
+    if (missingVars.length > 0) {
+        throw new Error(`Missing required environment variables: ${missingVars.join(", ")}`);
+    }
+    else {
+        console.log("All required environment variables are set.");
+        requiredEnvVars.forEach((varName) => {
+            console.log(`${varName}: ${process.env[varName]}`);
+        });
+    }
+}
+function getEnvironmentConfig() {
+    const args = loadArgs();
+    const projectDir = args[0] || process.env.PROJECT_ID;
+    const envName = args[1]?.split("=")[1] || process.env.ENV_NAME;
+    const roomId = args[2] || process.env.SESSION_ID;
+    const shouldTakeScreenshot = args[3] || process.env.SHOULD_TAKE_SCREENSHOT;
+    const TOKEN = process.env.BLINQ_TOKEN;
+    try {
+        validateCLIArg(projectDir, "projectDir");
+        validateCLIArg(envName, "envName");
+        validateCLIArg(roomId, "roomId");
+        validateCLIArg(shouldTakeScreenshot, "shouldTakeScreenshot");
+        if (!TOKEN) {
+            throw new Error("BLINQ_TOKEN env variable not set");
+        }
+    }
+    catch (error) {
+        const usage = `Usage: node bvt_recorder.js <projectDir> <envName> <roomId>`;
+        if (error instanceof Error) {
+            showUsage(error, usage);
+        }
+        else {
+            const unknownError = new Error("An unknown error occurred");
+            showUsage(unknownError, usage);
+        }
+    }
+    return { envName, projectDir, roomId, TOKEN };
+}
+function initWebBVTRecorder() {
+    const socket = io(process.env.WORKER_WS_SERVER_URL, {
+        path: "/ws",
+        transports: ["websocket", "polling"],
+        reconnection: true,
+    });
+    validateEnvVariables();
+    const { envName, projectDir, roomId, TOKEN } = getEnvironmentConfig();
+    BVTRecorderInit({
+        envName: envName,
+        projectDir,
+        roomId,
+        TOKEN,
+        socket: socket,
+    });
+}
+initWebBVTRecorder();

package/bin/client/recording.js

@@ -53,6 +53,7 @@ const Types = {
   SET_INPUT_FILES: "set_input_files",
   VERIFY_PAGE_SNAPSHOT: "verify_page_snapshot",
   CONDITIONAL_WAIT: "conditional_wait",
+  SLEEP: "sleep",
 };
 class Recording {
   steps = [];

package/bin/client/upload-service.js

@@ -12,6 +12,7 @@ class ScenarioUploadService {
       this.runsApiBaseURL + "/scenarios/create",
       {
         name,
+        branch: process.env.GIT_BRANCH ? process.env.GIT_BRANCH : "main",
       },
       {
         headers: {
@@ -37,7 +38,7 @@ class ScenarioUploadService {
       },
     });
 
-    if(response.status === 401) {
+    if (response.status === 401) {
       throw new Error("Your trial plan has ended. Cannot upload reports and perform retraining");
     }
 
@@ -63,7 +64,7 @@ class ScenarioUploadService {
       }
     );
 
-    if(response.status === 403) {
+    if (response.status === 403) {
       throw new Error("Your trial plan has ended. Cannot upload reports and perform retraining");
     }
 

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: JSON.stringify(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/bin/index.js

@@ -1,4 +1,5 @@
 export * from "./client/code_gen/page_reflection.js";
+
 export * from "./client/code_gen/playwright_codeget.js";
 export * from "./client/cucumber/feature.js";
 export * from "./client/cucumber/project_to_document.js";
@@ -13,5 +14,7 @@ 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";
+export * from "./client/recorderv3/step_utils.js";
+export * from "./client/recorderv3/update_feature.js";
+export * from "./client/recorderv3/bvt_init.js";

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;