@dev-blinq/cucumber_client 1.0.1362-stage → 1.0.1363-stage

package/bin/client/code_gen/playwright_codeget.js

@@ -5,6 +5,8 @@ import path from "path";
 import { CodePage } from "./page_reflection.js";
 import { convertToIdentifier, escapeNonPrintables } from "./utils.js";
 import socketLogger from "../utils/socket_logger.js";
+import fs from "fs";
+
 const findElementIdentifier = (node, step, userData, elements) => {
   if (node.key) {
     // incase of rerunning implemented steps
@@ -366,7 +368,7 @@ const _generateCodeFromCommand = (step, elements, userData) => {
       codeLines.push(line);
       break;
     }
-    case Types.VERIFY_PAGE_SNAPSHOT:
+    case Types.VERIFY_PAGE_SNAPSHOT: {
       comment = step.nestFrmLoc
         ? `// Verify page snapshot ${step.parameters[0]} in the frame ${step.selectors.iframe_src}`
         : `// Verify page snapshot ${step.parameters[0]}`;
@@ -375,7 +377,24 @@ const _generateCodeFromCommand = (step, elements, userData) => {
       codeLines.push(line);
       line = `await context.web.snapshotValidation(frameLocator, _param_0 , _params, ${JSON.stringify(options)}, this);`;
       codeLines.push(line);
+
+      const data = step.data;
+      if (data) {
+        try {
+          const { snapshot, fileName, filePath } = data;
+          const folderPath = process.env.BVT_TEMP_SNAPSHOTS_FOLDER ?? filePath;
+          const filePathWithName = path.join(folderPath, fileName);
+          if (!fs.existsSync(folderPath)) {
+            fs.mkdirSync(folderPath, { recursive: true });
+          }
+          fs.writeFileSync(filePathWithName, snapshot, "utf-8");
+        } catch (e) {
+          console.log(`Error saving snapshot file: ${e}`);
+          throw e;
+        }
+      }
       break;
+    }
     case Types.VERIFY_PAGE_CONTAINS_TEXT:
       line = "await context.web.verifyTextExistInPage( ";
       input = `${escapeNonPrintables(JSON.stringify(step.parameters[0]))}`;

package/bin/client/recorderv3/bvt_recorder.js

@@ -4,7 +4,7 @@ import { existsSync, readdirSync, readFileSync, rmSync } from "fs";
 import path from "path";
 import url from "url";
 import { getImplementedSteps, parseRouteFiles } from "./implemented_steps.js";
-import { NamesService } from "./services.js";
+import { NamesService, PublishService } from "./services.js";
 import { BVTStepRunner } from "./step_runner.js";
 import { readFile, writeFile } from "fs/promises";
 import { updateStepDefinitions, loadStepDefinitions, getCommandsForImplementedStep } from "./step_utils.js";
@@ -197,6 +197,7 @@ export class BVTRecorder {
       projectDir: this.projectDir,
       logger: this.logger,
     });
+    this.workspaceService = new PublishService(this.TOKEN);
     this.pageSet = new Set();
     this.pageMetaDataSet = new Set();
     this.lastKnownUrlPath = "";
@@ -204,6 +205,10 @@ export class BVTRecorder {
     this.shouldTakeScreenshot = true;
     this.watcher = null;
     this.networkEventsFolder = path.join(tmpdir(), "blinq_network_events");
+
+    this.tempProjectFolder = `${tmpdir()}/bvt_temp_project_${Math.floor(Math.random() * 1000000)}`;
+    this.tempSnapshotsFolder = path.join(this.tempProjectFolder, "data/snapshots");
+
     if (existsSync(this.networkEventsFolder)) {
       rmSync(this.networkEventsFolder, { recursive: true, force: true });
     }
@@ -912,6 +917,8 @@ export class BVTRecorder {
       TEMP_RUN: true,
       REPORT_FOLDER: this.bvtContext.reportFolder,
       BLINQ_ENV: this.envName,
+      DEBUG: "blinq:route",
+      BVT_TEMP_SNAPSHOTS_FOLDER: this.tempSnapshotsFolder,
     };
 
     this.bvtContext.navigate = true;
@@ -958,10 +965,23 @@ export class BVTRecorder {
       this.bvtContext.navigate = false;
     }
   }
-  async saveScenario({ scenario, featureName, override, isSingleStep }) {
-    await updateStepDefinitions({ scenario, featureName, projectDir: this.projectDir }); // updates mjs files
-    if (!isSingleStep) await updateFeatureFile({ featureName, scenario, override, projectDir: this.projectDir }); // updates gherkin files
-    await this.cleanup({ tags: scenario.tags });
+  async saveScenario({ scenario, featureName, override, isSingleStep, branch, isEditing }) {
+    // await updateStepDefinitions({ scenario, featureName, projectDir: this.projectDir }); // updates mjs files
+    // if (!isSingleStep) await updateFeatureFile({ featureName, scenario, override, projectDir: this.projectDir }); // updates gherkin files
+    const res = await this.workspaceService.saveScenario({
+      scenario,
+      featureName,
+      override,
+      isSingleStep,
+      branch,
+      isEditing,
+      projectId: path.basename(this.projectDir),
+    });
+    if (res.success) {
+      await this.cleanup({ tags: scenario.tags });
+    } else {
+      throw new Error(res.message || "Error saving scenario");
+    }
   }
   async getImplementedSteps() {
     const stepsAndScenarios = await getImplementedSteps(this.projectDir);

package/bin/client/recorderv3/services.js

@@ -149,3 +149,65 @@ export class NamesService {
     return result.data;
   }
 }
+export class PublishService {
+  constructor(TOKEN) {
+    this.TOKEN = TOKEN;
+  }
+  async saveScenario({ scenario, featureName, override, branch, isEditing, projectId }) {
+    const url = path.join(`${getRunsServiceBaseURL()}`, "..", "workspace/publish-recording");
+    const result = await axiosClient({
+      url,
+      method: "POST",
+      data: {
+        scenario,
+        featureName,
+        override,
+      },
+      params: {
+        branch,
+      },
+      headers: {
+        Authorization: `Bearer ${this.TOKEN}`,
+        "X-Source": "recorder",
+      },
+    });
+    if (result.status !== 200) {
+      return { success: false, message: "Error while saving scenario" };
+    }
+    try {
+      this.updateProjectMetadata({
+        featureName,
+        scenarioName: scenario.name,
+        projectId,
+        branch,
+        isEditing,
+      });
+    } catch (error) {
+      // log the error but do not block the scenario saving
+    }
+    return { success: true, data: result.data };
+  }
+  async updateProjectMetadata({ featureName, scenarioName, projectId, branch, isEditing }) {
+    try {
+      await axiosClient({
+        method: "POST",
+        url: `${getRunsServiceBaseURL()}/project/updateProjectMetadata`,
+        data: {
+          featureName,
+          scenarioName,
+          eventType: isEditing ? "editScenario" : "createScenario",
+          projectId,
+          branch: branch,
+        },
+        headers: {
+          Authorization: `Bearer ${this.TOKEN}`,
+          "X-Source": "recorder",
+        },
+      });
+    } catch (error) {
+      // logger.error("Failed to update project metadata: " + error.message);
+      // @ts-ignore
+      console.error("run_recorder", `Failed to update project metadata: ${error.message ?? error}`);
+    }
+  }
+}

package/bin/client/recorderv3/step_utils.js

@@ -296,6 +296,7 @@ const _toRecordingStep = (cmd) => {
         type: "verify_page_snapshot",
         parameters: [cmd.value],
         selectors: cmd.selectors,
+        data: cmd.data,
       };
     }
     default: {

package/bin/client/utils/socket_logger.js

@@ -73,7 +73,7 @@ const SocketLogger = (function () {
       {
         level: level,
         context: context || defaultContext,
-        data: data,
+        data: JSON.stringify(data),
         timestamp: new Date().toISOString(),
         dataSize: dataSize,
       },

package/bin/index.js

@@ -16,3 +16,6 @@ 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";

package/package.json

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