@dev-blinq/cucumber_client 1.0.1464-stage → 1.0.1465-stage

package/bin/client/recorderv3/bvt_init.js

@@ -4,8 +4,10 @@ import { compareWithScenario } from "../code_gen/duplication_analysis.js";
 import { getAppDataDir } from "../utils/app_dir.js";
 import { readdir } from "fs/promises";
 import socketLogger, { getErrorMessage, responseSize } from "../utils/socket_logger.js";
+import { MIXPANEL_EVENTS, mixpanelTrackEvent } from "./mixpanel.js";
 const port = process.env.EDITOR_PORT || 3003;
 const WS_URL = process.env.WORKER_WS_SERVER_URL || "http://localhost:" + port;
+const userId = process.env.USER_ID || "";
 const SocketIOEvents = {
     REQUEST: "request",
     RESPONSE: "response",
@@ -94,6 +96,7 @@ async function BVTRecorderInit({ envName, projectDir, roomId, TOKEN, socket = nu
             socket.emit(event, data, roomId);
         },
         logger: socketLogger,
+        userId,
     });
     // emit connected event for every 50 ms until connection_ack message is recieved
     let connected = false;
@@ -106,6 +109,7 @@ async function BVTRecorderInit({ envName, projectDir, roomId, TOKEN, socket = nu
     }, 50);
     const promisifiedSocketServer = new PromisifiedSocketServer(socket, {
         "recorderWindow.connectionAck": async (input) => {
+            mixpanelTrackEvent(MIXPANEL_EVENTS.RECORDER_CONNECTED, userId);
             connected = true;
             clearInterval(interval);
         },
@@ -113,6 +117,7 @@ async function BVTRecorderInit({ envName, projectDir, roomId, TOKEN, socket = nu
             return recorder
                 .openBrowser(input)
                 .then(() => {
+                mixpanelTrackEvent(MIXPANEL_EVENTS.CHROMIUM_LOADED, userId);
                 socketLogger.info("BVTRecorder.browserOpened");
                 socket.emit("BVTRecorder.browserOpened", { roomId, window: "cucumber_client/bvt_recorder" });
             })
@@ -295,7 +300,7 @@ async function BVTRecorderInit({ envName, projectDir, roomId, TOKEN, socket = nu
         },
         "recorderWindow.generateLocatorSummaries": async (input) => {
             return await recorder.generateLocatorSummaries(input);
-        }
+        },
     });
     socket.on("targetBrowser.command.event", async (input) => {
         return recorder.onAction(input);

package/bin/client/recorderv3/bvt_recorder.js

@@ -7,7 +7,7 @@ import { getImplementedSteps, parseRouteFiles } from "./implemented_steps.js";
 import { NamesService, PublishService } from "./services.js";
 import { BVTStepRunner } from "./step_runner.js";
 import { readFile, rm, writeFile } from "node:fs/promises";
-import { loadStepDefinitions, getCommandsForImplementedStep, _toRecordingStep, getCucumberStep, getCodePage, toMethodName } from "./step_utils.js";
+import { loadStepDefinitions, getCommandsForImplementedStep, _toRecordingStep, getCucumberStep, getCodePage, toMethodName, } from "./step_utils.js";
 import { parseStepTextParameters } from "../cucumber/utils.js";
 import { AstBuilder, GherkinClassicTokenMatcher, Parser } from "@cucumber/gherkin";
 import chokidar from "chokidar";
@@ -20,6 +20,7 @@ import { chromium } from "playwright-core";
 import { axiosClient } from "../utils/axiosClient.js";
 import { _generateCodeFromCommand } from "../code_gen/playwright_codeget.js";
 import { Recording } from "../recording.js";
+import { MIXPANEL_EVENTS, mixpanelTrackEvent } from "./mixpanel.js";
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 export function getInitScript(config, options) {
@@ -188,6 +189,7 @@ export class BVTRecorder {
     TOKEN;
     sendEvent;
     logger;
+    userId;
     screenshotMap = new Map();
     snapshotMap = new Map();
     scenariosStepsMap = new Map();
@@ -232,6 +234,7 @@ export class BVTRecorder {
         this.TOKEN = initialState.TOKEN;
         this.sendEvent = initialState.sendEvent;
         this.logger = initialState.logger;
+        this.userId = initialState.userId;
         this.namesService = new NamesService({
             screenshotMap: this.screenshotMap,
             TOKEN: this.TOKEN,
@@ -801,6 +804,7 @@ export class BVTRecorder {
         // const
     }
     async onAction(event) {
+        mixpanelTrackEvent(MIXPANEL_EVENTS.STEP_IN_SCENARIO, this.userId);
         this._updateUrlPath();
         // const locators = this.overlayLocators(event);
         const cmdEvent = {
@@ -978,7 +982,7 @@ export class BVTRecorder {
                 envPath: this.envName,
                 tags,
                 config: this.config,
-                AICode
+                AICode,
             }, this.bvtContext, {
                 skipAfter,
                 skipBefore,
@@ -1227,9 +1231,9 @@ export class BVTRecorder {
             datasets,
         };
     }
-    async generateLocatorSummaries({ allStrategyLocators, element_name }) {
+    async generateLocatorSummaries({ allStrategyLocators, element_name, }) {
         const input = {
-            [element_name ?? "element"]: allStrategyLocators
+            [element_name ?? "element"]: allStrategyLocators,
         };
         const result = await this.namesService.generateLocatorDescriptions({ locatorsObj: input });
         return result[element_name ?? "element"];

package/bin/client/recorderv3/mixpanel.js

@@ -0,0 +1,39 @@
+import mixpanel from "mixpanel";
+let mixpanelClient = null;
+let mixPaneltoken = getMixpanelToken();
+function getMixpanelToken() {
+    if (process.env.MIXPANEL_TOKEN) {
+        const token = process.env.MIXPANEL_TOKEN;
+        delete process.env.MIXPANEL_TOKEN;
+        return token;
+    }
+    return null;
+}
+if (mixPaneltoken && process.env.NODE_ENV_BLINQ === "prod") {
+    mixpanelClient = mixpanel.init(mixPaneltoken, {
+        debug: true,
+    });
+    console.log("✅Mixpanel client initialized.");
+}
+else {
+    console.info("MIXPANEL_TOKEN is not defined.");
+}
+export function mixpanelTrackEvent(event, distinctId, properties = {}) {
+    if (mixpanelClient === null)
+        return;
+    mixpanelClient.track(event, {
+        distinct_id: distinctId,
+        env: process.env.NODE_ENV_BLINQ || "local",
+        ...properties,
+    });
+}
+export function mixpanelTrackEventIdentifyUser(distinctId, properties = {}) {
+    if (mixpanelClient === null)
+        return;
+    mixpanelClient.people.set(distinctId, properties);
+}
+export const MIXPANEL_EVENTS = {
+    STEP_IN_SCENARIO: "There is a step in the scenario",
+    RECORDER_CONNECTED: "Recorder session initiated",
+    CHROMIUM_LOADED: "Chromium loaded",
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dev-blinq/cucumber_client",
-  "version": "1.0.1464-stage",
+  "version": "1.0.1465-stage",
   "description": " ",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",
@@ -50,6 +50,7 @@
     "http-proxy-agent": "^7.0.0",
     "https-proxy-agent": "^7.0.2",
     "jszip": "^3.10.1",
+    "mixpanel": "^0.20.0",
     "node-source-walk": "^6.0.2",
     "object-path": "^0.11.8",
     "open": "^10.1.0",