@dev-blinq/cucumber-js 1.0.106 → 1.0.107-stage

package/lib/formatter/helpers/report_generator.d.ts

@@ -1,40 +1,40 @@
-import * as messages from "@cucumber/messages";
+import * as messages from '@cucumber/messages';
 type JsonTimestamp = number;
-type JsonStepType = "Unknown" | "Context" | "Action" | "Outcome" | "Conjunction";
+type JsonStepType = 'Unknown' | 'Context' | 'Action' | 'Outcome' | 'Conjunction' | 'After' | 'Before';
 export type JsonResultUnknown = {
-    status: "UNKNOWN";
+    status: 'UNKNOWN';
 };
 type JsonResultSkipped = {
-    status: "SKIPPED";
+    status: 'SKIPPED';
 };
 type JsonResultUndefined = {
-    status: "UNDEFINED";
+    status: 'UNDEFINED';
 };
 type JsonResultAmbiguous = {
-    status: "AMBIGUOUS";
+    status: 'AMBIGUOUS';
 };
 export type JsonResultStarted = {
-    status: "STARTED";
+    status: 'STARTED';
     startTime: JsonTimestamp;
 };
 type JsonResultPending = {
-    status: "PENDING";
+    status: 'PENDING';
     startTime: JsonTimestamp;
     endTime: JsonTimestamp;
 };
 export type JsonResultPassed = {
-    status: "PASSED";
+    status: 'PASSED';
     startTime: JsonTimestamp;
     endTime: JsonTimestamp;
 };
 export type JsonResultFailed = {
-    status: "FAILED";
+    status: 'FAILED';
     startTime: JsonTimestamp;
     endTime: JsonTimestamp;
     message?: string;
 };
 export type JsonFixedByAi = {
-    status: "FIXED_BY_AI";
+    status: 'FIXED_BY_AI';
     startTime: JsonTimestamp;
     endTime: JsonTimestamp;
 };
@@ -68,6 +68,7 @@ export type JsonStep = {
     ariaSnapshot: string;
     traceFilePath?: string;
     brunoData?: any;
+    interceptResults?: any;
 };
 export type RetrainStats = {
     result: JsonTestResult;
@@ -146,7 +147,9 @@ export default class ReportGenerator {
     getLogFileContent(): any;
     private getTestCaseResult;
     private onTestCaseFinished;
+    private readonly retryCount;
     private uploadTestCase;
+    private tryUpload;
     private writeTestCaseReportToDisk;
     private onTestRunFinished;
 }

package/lib/formatter/helpers/report_generator.js

@@ -34,16 +34,16 @@ const upload_serivce_1 = require("./upload_serivce");
 const fs_extra_1 = require("fs-extra");
 // type JsonException = messages.Exception
 const object_path_1 = __importDefault(require("object-path"));
-const URL = process.env.NODE_ENV_BLINQ === "dev"
-    ? "https://dev.api.blinq.io/api/runs"
-    : process.env.NODE_ENV_BLINQ === "local"
-        ? "http://localhost:5001/api/runs"
-        : process.env.NODE_ENV_BLINQ === "stage"
-            ? "https://stage.api.blinq.io/api/runs"
-            : process.env.NODE_ENV_BLINQ === "prod"
-                ? "https://api.blinq.io/api/runs"
+const URL = process.env.NODE_ENV_BLINQ === 'dev'
+    ? 'https://dev.api.blinq.io/api/runs'
+    : process.env.NODE_ENV_BLINQ === 'local'
+        ? 'http://localhost:5001/api/runs'
+        : process.env.NODE_ENV_BLINQ === 'stage'
+            ? 'https://stage.api.blinq.io/api/runs'
+            : process.env.NODE_ENV_BLINQ === 'prod'
+                ? 'https://api.blinq.io/api/runs'
                 : !process.env.NODE_ENV_BLINQ
-                    ? "https://api.blinq.io/api/runs"
+                    ? 'https://api.blinq.io/api/runs'
                     : `${process.env.NODE_ENV_BLINQ}/api/runs`;
 const REPORT_SERVICE_URL = (_a = process.env.REPORT_SERVICE_URL) !== null && _a !== void 0 ? _a : URL;
 const BATCH_SIZE = 10;
@@ -53,12 +53,12 @@ class ReportGenerator {
     constructor() {
         this.report = {
             result: {
-                status: "UNKNOWN",
+                status: 'UNKNOWN',
             },
             testCases: [],
             env: {
-                name: "",
-                baseUrl: "",
+                name: '',
+                baseUrl: '',
             },
         };
         this.gherkinDocumentMap = new Map();
@@ -73,45 +73,47 @@ class ReportGenerator {
         this.networkLog = [];
         this.stepLogs = [];
         this.stepNetworkLogs = [];
-        this.runName = "";
-        this.ariaSnapshot = "";
-        this.initialAriaSnapshot = "";
+        this.runName = '';
+        this.ariaSnapshot = '';
+        this.initialAriaSnapshot = '';
         this.testCaseLog = [];
         this.loggingOverridden = false; // Flag to track if logging is overridden
         this.reportFolder = null;
         this.uploadService = new upload_serivce_1.RunUploadService(REPORT_SERVICE_URL, REPORT_SERVICE_TOKEN);
+        this.retryCount = 3;
     }
     async handleMessage(envelope, reRunId) {
-        if (envelope.meta && "runName" in envelope.meta) {
+        if (envelope.meta && 'runName' in envelope.meta) {
             this.runName = envelope.meta.runName;
         }
         const type = Object.keys(envelope)[0];
         switch (type) {
             // case "meta": { break}
             // case "source": { break}
-            case "parseError": {
+            case 'parseError': {
                 const parseError = envelope[type];
                 this.handleParseError(parseError);
                 break;
             }
-            case "gherkinDocument": {
+            case 'gherkinDocument': {
                 const doc = envelope[type];
                 this.onGherkinDocument(doc);
                 break;
             }
-            case "pickle": {
+            case 'pickle': {
                 const pickle = envelope[type];
                 this.onPickle(pickle);
                 break;
             }
             // case "stepDefinition": { break}
             // case "hook": { break} // Before Hook
-            case "testRunStarted": {
+            case 'testRunStarted': {
                 const testRunStarted = envelope[type];
                 this.onTestRunStarted(testRunStarted);
+                await this.uploadService.createStatus('running');
                 break;
             }
-            case "testCase": {
+            case 'testCase': {
                 const testCase = envelope[type];
                 // Initialize the log storage
                 this.testCaseLog = [];
@@ -135,36 +137,36 @@ class ReportGenerator {
                 this.onTestCase(testCase);
                 break;
             }
-            case "testCaseStarted": {
+            case 'testCaseStarted': {
                 const testCaseStarted = envelope[type];
                 this.onTestCaseStarted(testCaseStarted);
                 break;
             }
-            case "testStepStarted": {
+            case 'testStepStarted': {
                 const testStepStarted = envelope[type];
                 this.onTestStepStarted(testStepStarted);
                 break;
             }
-            case "attachment": {
+            case 'attachment': {
                 const attachment = envelope[type];
                 this.onAttachment(attachment);
                 break;
             }
-            case "testStepFinished": {
+            case 'testStepFinished': {
                 const testStepFinished = envelope[type];
                 this.onTestStepFinished(testStepFinished);
                 break;
             }
-            case "testCaseFinished": {
+            case 'testCaseFinished': {
                 const testCaseFinished = envelope[type];
                 // Call the onTestCaseFinished method
                 const result = await this.onTestCaseFinished(testCaseFinished, reRunId);
                 return result;
             }
             // case "hook": { break} // After Hook
-            case "testRunFinished": {
+            case 'testRunFinished': {
                 const testRunFinished = envelope[type];
-                this.onTestRunFinished(testRunFinished);
+                await this.onTestRunFinished(testRunFinished);
                 break;
             }
             // case "parameterType" : { break}
@@ -178,7 +180,7 @@ class ReportGenerator {
         const { message } = parseError;
         const timestamp = new Date().getTime();
         this.report.result = {
-            status: "FAILED",
+            status: 'FAILED',
             startTime: timestamp,
             endTime: timestamp,
             message: message,
@@ -221,7 +223,7 @@ class ReportGenerator {
     }
     onTestRunStarted(testRunStarted) {
         this.report.result = {
-            status: "STARTED",
+            status: 'STARTED',
             startTime: this.getTimeStamp(testRunStarted.timestamp),
         };
     }
@@ -254,7 +256,8 @@ class ReportGenerator {
             for (const tableRow of examples.tableBody) {
                 if (tableRow.id === exampleId) {
                     for (let i = 0; i < examples.tableHeader.cells.length; i++) {
-                        parameters[examples.tableHeader.cells[i].value] = tableRow.cells[i].value;
+                        parameters[examples.tableHeader.cells[i].value] =
+                            tableRow.cells[i].value;
                     }
                 }
             }
@@ -292,7 +295,7 @@ class ReportGenerator {
                 text: step.text,
                 commands: [],
                 result: {
-                    status: "UNKNOWN",
+                    status: 'UNKNOWN',
                 },
                 networkData: [],
                 webLog: [],
@@ -309,7 +312,7 @@ class ReportGenerator {
             parameters,
             steps,
             result: {
-                status: "STARTED",
+                status: 'STARTED',
                 startTime: this.getTimeStamp(timestamp),
             },
             webLog: [],
@@ -330,25 +333,25 @@ class ReportGenerator {
             return;
         const stepProgess = this.stepReportMap.get(testStep.pickleStepId);
         stepProgess.result = {
-            status: "STARTED",
+            status: 'STARTED',
             startTime: this.getTimeStamp(timestamp),
         };
     }
     onAttachment(attachment) {
         const { testStepId, body, mediaType } = attachment;
-        if (mediaType === "text/plain") {
-            this.reportFolder = body.replaceAll("\\", "/");
+        if (mediaType === 'text/plain') {
+            this.reportFolder = body.replaceAll('\\', '/');
             return;
         }
-        if (mediaType === "application/json+snapshot-before") {
+        if (mediaType === 'application/json+snapshot-before') {
             this.initialAriaSnapshot = body;
             return;
         }
-        if (mediaType === "application/json+snapshot-after") {
+        if (mediaType === 'application/json+snapshot-after') {
             this.ariaSnapshot = body;
             return;
         }
-        if (mediaType === "application/json+env") {
+        if (mediaType === 'application/json+env') {
             const data = JSON.parse(body);
             this.report.env = data;
             this.report.testCases.map((testCase) => {
@@ -356,14 +359,14 @@ class ReportGenerator {
                 return testCase;
             });
         }
-        if (mediaType === "application/json+log") {
+        if (mediaType === 'application/json+log') {
             const log = JSON.parse(body);
             if (this.logs.length < 1000) {
                 this.logs.push(log);
                 this.stepLogs.push(log);
             }
         }
-        if (mediaType === "application/json+network") {
+        if (mediaType === 'application/json+network') {
             const networkLog = JSON.parse(body);
             if (this.networkLog.length < 1000)
                 this.networkLog.push(networkLog);
@@ -373,29 +376,38 @@ class ReportGenerator {
         if (testStep.pickleStepId === undefined)
             return;
         const stepProgess = this.stepReportMap.get(testStep.pickleStepId);
-        if (mediaType === "application/json") {
+        if (mediaType === 'application/json') {
             const command = JSON.parse(body);
             stepProgess.commands.push(command);
         }
-        else if (mediaType === "application/json+trace") {
+        else if (mediaType === 'application/json+trace') {
             const data = JSON.parse(body);
             stepProgess.traceFilePath = data.traceFilePath;
         }
-        if (mediaType === "application/json+bruno") {
+        if (mediaType === 'application/json+bruno') {
             try {
                 const data = JSON.parse(body);
                 stepProgess.brunoData = data;
             }
             catch (error) {
-                console.error("Error parsing bruno data:", error);
+                console.error('Error parsing bruno data:', error);
+            }
+        }
+        if (mediaType === 'application/json+intercept-results') {
+            try {
+                const data = JSON.parse(body);
+                stepProgess.interceptResults = data;
+            }
+            catch (error) {
+                console.error('Error parsing intercept results:', error);
             }
         }
     }
     getFailedTestStepResult({ commands, startTime, endTime, result, }) {
         for (const command of commands) {
-            if (command.result.status === "FAILED") {
+            if (command.result.status === 'FAILED') {
                 return {
-                    status: "FAILED",
+                    status: 'FAILED',
                     message: command.result.message,
                     startTime,
                     endTime,
@@ -403,7 +415,7 @@ class ReportGenerator {
             }
         }
         return {
-            status: "FAILED",
+            status: 'FAILED',
             startTime,
             endTime,
             message: result.message,
@@ -413,26 +425,51 @@ class ReportGenerator {
         const { testStepId, testStepResult, timestamp } = testStepFinished;
         const testStep = this.testStepMap.get(testStepId);
         if (testStep.pickleStepId === undefined) {
-            if (testStepResult.status === "FAILED") {
+            if (testStepResult.status === 'FAILED') {
+                const testCase = this.testCaseReportMap.get(testStepFinished.testCaseStartedId);
+                const type = testCase.steps[0].result.status === 'UNKNOWN' ? 'Before' : 'After';
+                const hookStep = {
+                    ariaSnapshot: null,
+                    commands: [],
+                    keyword: type,
+                    data: {},
+                    networkData: [],
+                    result: {
+                        status: 'FAILED',
+                        message: testStepResult.message,
+                        startTime: this.getTimeStamp(timestamp),
+                        endTime: this.getTimeStamp(timestamp),
+                    },
+                    text: 'Failed hook',
+                    type,
+                    webLog: [],
+                };
+                if (type === 'Before') {
+                    testCase.steps = [hookStep, ...testCase.steps];
+                }
+                else {
+                    testCase.steps = [...testCase.steps, hookStep];
+                }
+                this.testCaseReportMap.set(testStepFinished.testCaseStartedId, testCase);
                 console.error(`Before/After hook failed with message: ${testStepResult.message}`);
             }
             return;
         }
-        if (testStepResult.status === "UNDEFINED") {
+        if (testStepResult.status === 'UNDEFINED') {
             const step = this.stepReportMap.get(testStep.pickleStepId);
-            const stepName = step ? step.keyword + " " + step.text : "Undefined step";
+            const stepName = step ? step.keyword + ' ' + step.text : 'Undefined step';
             const undefinedCommand = {
                 testStepId: testStepId,
                 body: JSON.stringify({
-                    type: "error",
-                    text: "Undefined step: " + stepName,
+                    type: 'error',
+                    text: 'Undefined step: ' + stepName,
                     result: {
-                        status: "FAILED",
+                        status: 'FAILED',
                         startTime: this.getTimeStamp(timestamp),
                         endTime: this.getTimeStamp(timestamp),
                     },
                 }),
-                mediaType: "application/json",
+                mediaType: 'application/json',
                 contentEncoding: messages.AttachmentContentEncoding.IDENTITY,
             };
             this.onAttachment(undefinedCommand);
@@ -445,14 +482,14 @@ class ReportGenerator {
             if (reportFolder === null) {
                 throw new Error('"reportFolder" is "null". Failed to run BVT hooks. Please retry after running "Generate All" or "Record Scenario" ');
             }
-            if (fs_1.default.existsSync(path_1.default.join(reportFolder, "data.json"))) {
-                data = JSON.parse(fs_1.default.readFileSync(path_1.default.join(reportFolder, "data.json"), "utf8"));
+            if (fs_1.default.existsSync(path_1.default.join(reportFolder, 'data.json'))) {
+                data = JSON.parse(fs_1.default.readFileSync(path_1.default.join(reportFolder, 'data.json'), 'utf8'));
             }
         }
         catch (error) {
-            console.log("Error reading data.json");
+            console.log('Error reading data.json');
         }
-        if (testStepResult.status === "FAILED") {
+        if (testStepResult.status === 'FAILED') {
             stepProgess.result = this.getFailedTestStepResult({
                 commands: stepProgess.commands,
                 startTime: prevStepResult.startTime,
@@ -470,7 +507,7 @@ class ReportGenerator {
         stepProgess.webLog = this.stepLogs;
         stepProgess.networkData = this.stepNetworkLogs;
         stepProgess.ariaSnapshot = this.ariaSnapshot;
-        this.ariaSnapshot = "";
+        this.ariaSnapshot = '';
         this.stepNetworkLogs = [];
         this.stepLogs = [];
         if (Object.keys(data).length > 0) {
@@ -479,18 +516,20 @@ class ReportGenerator {
             const parameters = this.testCaseReportMap.get(id).parameters;
             const _parameters = {};
             Object.keys(parameters).map((key) => {
-                if (parameters[key].startsWith("{{") && parameters[key].endsWith("}}")) {
-                    const path = parameters[key].slice(2, -2).split(".");
-                    let value = String(object_path_1.default.get(data, path));
+                var _a;
+                if (parameters[key].startsWith('{{') &&
+                    parameters[key].endsWith('}}')) {
+                    const path = parameters[key].slice(2, -2).split('.');
+                    let value = String((_a = object_path_1.default.get(data, path)) !== null && _a !== void 0 ? _a : parameters[key]);
                     if (value) {
-                        if (value.startsWith("secret:")) {
-                            value = "secret:****";
+                        if (value.startsWith('secret:')) {
+                            value = 'secret:****';
                         }
-                        else if (value.startsWith("totp:")) {
-                            value = "totp:****";
+                        else if (value.startsWith('totp:')) {
+                            value = 'totp:****';
                         }
-                        else if (value.startsWith("mask:")) {
-                            value = "mask:****";
+                        else if (value.startsWith('mask:')) {
+                            value = 'mask:****';
                         }
                         _parameters[key] = value;
                     }
@@ -523,7 +562,7 @@ class ReportGenerator {
         if (process.env.PROJECT_PATH) {
             projectPath = process.env.PROJECT_PATH;
         }
-        const logFolder = path_1.default.join(projectPath, "logs", "web");
+        const logFolder = path_1.default.join(projectPath, 'logs', 'web');
         if (!fs_1.default.existsSync(logFolder)) {
             return [];
         }
@@ -535,7 +574,7 @@ class ReportGenerator {
             return [];
         }
         try {
-            const logFileContent = fs_1.default.readFileSync(path_1.default.join(logFolder, `${nextId - 1}.json`), "utf8");
+            const logFileContent = fs_1.default.readFileSync(path_1.default.join(logFolder, `${nextId - 1}.json`), 'utf8');
             return JSON.parse(logFileContent);
         }
         catch (error) {
@@ -543,25 +582,31 @@ class ReportGenerator {
         }
     }
     getTestCaseResult(steps) {
+        if (steps[0] && steps[0].result.status === 'SKIPPED') {
+            return {
+                status: 'FAILED',
+                message: 'Test skipped due to failure in before hooks',
+            };
+        }
         for (const step of steps) {
             switch (step.result.status) {
-                case "FAILED":
+                case 'FAILED':
                     return {
                         status: step.result.status,
                         message: step.result.message,
                         // exception: step.result.exception,
                     };
-                case "AMBIGUOUS":
-                case "UNDEFINED":
-                case "PENDING":
+                case 'AMBIGUOUS':
+                case 'UNDEFINED':
+                case 'PENDING':
                     return {
-                        status: "FAILED",
+                        status: 'FAILED',
                         message: `step "${step.text}" is ${step.result.status}`,
                     };
             }
         }
         return {
-            status: "PASSED",
+            status: 'PASSED',
         };
     }
     async onTestCaseFinished(testCaseFinished, reRunId) {
@@ -570,6 +615,9 @@ class ReportGenerator {
         const prevResult = testProgress.result;
         const steps = Object.values(testProgress.steps);
         const result = this.getTestCaseResult(steps);
+        if (result.status === 'PASSED' && reRunId) {
+            this.uploadService.updateProjectAnalytics(process.env.PROJECT_ID);
+        }
         const endTime = this.getTimeStamp(timestamp);
         testProgress.result = {
             ...result,
@@ -579,7 +627,7 @@ class ReportGenerator {
         testProgress.webLog = this.logs;
         testProgress.networkLog = this.networkLog;
         testProgress.initialAriaSnapshot = this.initialAriaSnapshot;
-        this.initialAriaSnapshot = "";
+        this.initialAriaSnapshot = '';
         this.networkLog = [];
         this.logs = [];
         if (this.testCaseLog && this.testCaseLog.length > 0) {
@@ -609,18 +657,39 @@ class ReportGenerator {
         }
     }
     async uploadTestCase(testCase, rerunId) {
-        let runId = "";
-        let projectId = "";
+        let data = null;
+        for (let attempt = 1; attempt <= this.retryCount; attempt++) {
+            try {
+                data = await this.tryUpload(testCase, rerunId);
+                break;
+            }
+            catch (e) {
+                console.error(`Attempt ${attempt} to upload testcase failed:`, e);
+                if (attempt === this.retryCount) {
+                    console.error('All retry attempts failed, failed to upload testcase.');
+                }
+                else {
+                    const waitTime = 1000 * 2 ** (attempt - 1); //? exponential backoff: 1s, 2s, 4s...
+                    await new Promise((r) => setTimeout(r, waitTime));
+                }
+            }
+        }
+        return data;
+    }
+    async tryUpload(testCase, rerunId) {
+        let runId = '';
+        let projectId = '';
         if (!process.env.UPLOADING_TEST_CASE) {
-            process.env.UPLOADING_TEST_CASE = "[]";
+            process.env.UPLOADING_TEST_CASE = '[]';
         }
         const anyRemArr = JSON.parse(process.env.UPLOADING_TEST_CASE);
         const randomID = Math.random().toString(36).substring(7);
         anyRemArr.push(randomID);
-        let data;
         process.env.UPLOADING_TEST_CASE = JSON.stringify(anyRemArr);
         try {
-            if (process.env.RUN_ID && process.env.PROJECT_ID && !process.env.IGNORE_ENV_VARIABLES) {
+            if (process.env.RUN_ID &&
+                process.env.PROJECT_ID &&
+                !process.env.IGNORE_ENV_VARIABLES) {
                 runId = process.env.RUN_ID;
                 projectId = process.env.PROJECT_ID;
             }
@@ -633,24 +702,21 @@ class ReportGenerator {
                     process.env.PROJECT_ID = projectId;
                 }
             }
-            data = await this.uploadService.uploadTestCase(testCase, runId, projectId, this.reportFolder, rerunId);
+            const data = await this.uploadService.uploadTestCase(testCase, runId, projectId, this.reportFolder, rerunId);
             this.writeTestCaseReportToDisk(testCase);
-        }
-        catch (e) {
-            console.error("Error uploading test case:", e);
+            return data;
         }
         finally {
             const arrRem = JSON.parse(process.env.UPLOADING_TEST_CASE);
             arrRem.splice(arrRem.indexOf(randomID), 1);
             process.env.UPLOADING_TEST_CASE = JSON.stringify(arrRem);
         }
-        return data ? data : null;
     }
     writeTestCaseReportToDisk(testCase) {
         var _a;
         const reportFolder = (_a = this.reportFolder) !== null && _a !== void 0 ? _a : process.env.TESTCASE_REPORT_FOLDER_PATH;
         if (!reportFolder) {
-            console.error("Report folder is not defined");
+            console.error('Report folder is not defined');
             return;
         }
         try {
@@ -666,19 +732,20 @@ class ReportGenerator {
             fs_1.default.writeFileSync(path_1.default.join(reportFolder, `${i}`, `network.json`), JSON.stringify(networkLog, null, 2));
         }
         catch (error) {
-            console.error("Error writing test case report to disk:", error);
+            console.error('Error writing test case report to disk:', error);
         }
     }
-    onTestRunFinished(testRunFinished) {
+    async onTestRunFinished(testRunFinished) {
         const { timestamp, success, message } = testRunFinished;
         const prevResult = this.report.result;
         this.report.result = {
-            status: success ? "PASSED" : "FAILED",
+            status: success ? 'PASSED' : 'FAILED',
             startTime: prevResult.startTime,
             endTime: this.getTimeStamp(timestamp),
             message,
             // exception,
         };
+        await this.uploadService.createStatus(success ? 'passed' : 'failed');
     }
 }
 exports.default = ReportGenerator;