@mablhq/mabl-cli 1.29.19 → 1.32.2

package/Globals.js

@@ -1,6 +1,30 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Globals = void 0;
+const os = __importStar(require("os"));
 class Globals {
     static getFindOverallTimeoutMs() {
         return Globals.findOverallTimeoutMs;
@@ -14,7 +38,28 @@ class Globals {
     static setPlaywrightInteractionWarningMs(timeout) {
         Globals.playwrightInteractionWarningMs = timeout;
     }
+    static getUploadDirectory() {
+        return Globals.uploadDirectory;
+    }
+    static setUploadDirectory(dir) {
+        Globals.uploadDirectory = dir;
+    }
+    static getUploadDirectoryPrefix() {
+        return Globals.uploadDirectoryPrefix;
+    }
+    static setUploadDirectoryPrefix(prefix) {
+        Globals.uploadDirectoryPrefix = prefix;
+    }
+    static getTestMaxAgeMs() {
+        return Globals.testMaxAgeMs;
+    }
+    static setTestMaxAgeMs(age) {
+        Globals.testMaxAgeMs = age;
+    }
 }
 exports.Globals = Globals;
 Globals.findOverallTimeoutMs = 18.5 * 60 * 1000;
 Globals.playwrightInteractionWarningMs = 30 * 1000;
+Globals.uploadDirectory = os.tmpdir();
+Globals.uploadDirectoryPrefix = `mablTestRunUploads-`;
+Globals.testMaxAgeMs = 1000 * 60 * 60 * 24;

package/api/basicApiClient.js

@@ -65,6 +65,8 @@ class BasicApiClient {
         }
         config.timeout =
             (_d = (_b = options.requestTimeoutMillis) !== null && _b !== void 0 ? _b : (_c = options.retryConfig) === null || _c === void 0 ? void 0 : _c.requestTimeoutMillis) !== null && _d !== void 0 ? _d : DEFAULT_RETRYABLE_REQUEST_TIMEOUT_MILLISECONDS;
+        config.maxBodyLength = Infinity;
+        config.maxContentLength = Infinity;
         switch (options.authType) {
             case types_1.AuthType.ApiKey:
                 config.auth = {

package/api/featureSet.js

@@ -4,6 +4,7 @@ exports.FeatureSet = exports.FindImplementationVersion = void 0;
 const types_1 = require("../browserLauncher/types");
 const ACCESSIBILITY_CHECK_FEATURE_FLAG = 'accessibility_checks';
 const SMARTER_WAIT_FEATURE_FLAG = 'smarter_wait';
+const EXECUTION_SCREENCAST_MODE = 'execution_screencast_mode';
 var FindImplementationVersion;
 (function (FindImplementationVersion) {
     FindImplementationVersion[FindImplementationVersion["V1"] = 0] = "V1";
@@ -24,5 +25,8 @@ class FeatureSet {
     hasAccessibilityChecksEnabled() {
         return this.featureFlags.has(ACCESSIBILITY_CHECK_FEATURE_FLAG);
     }
+    isExecutionScreencastModeEnabled() {
+        return this.featureFlags.has(EXECUTION_SCREENCAST_MODE);
+    }
 }
 exports.FeatureSet = FeatureSet;

package/api/mablApiClient.js

@@ -453,7 +453,7 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
             throw toApiError(`Failed to get Branches`, error);
         }
     }
-    async getUploadFileUrl(fileId) {
+    async getFileUploadUrl(fileId) {
         try {
             return await this.makeGetRequest(`${this.baseApiUrl}/files/fileUpload/url/${fileId}`);
         }
@@ -609,6 +609,14 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
         requestBody.actions = actions;
         return requestBody;
     }
+    async getTestRunsForPlan(planRunId) {
+        try {
+            return this.makeGetRequest(`${this.baseApiUrl}/journeyRuns/planRun/${planRunId}`);
+        }
+        catch (error) {
+            throw toApiError(`Failed to retrieve tests for plan`, error);
+        }
+    }
     async postPlanRun(organizationId, testId, branchName, browserTypes, appUrl, apiUrl, deploymentId, credentialsId, deploymentIds, basicAuthCredentialsId) {
         try {
             const requestBody = this.buildAdHocPlanRunRequestBody(organizationId, testId, browserTypes, branchName, appUrl, apiUrl, deploymentId, credentialsId, deploymentIds, basicAuthCredentialsId);

package/browserLauncher/playwrightBrowserLauncher/playwrightBrowser.js

@@ -34,8 +34,9 @@ const playwrightPage_1 = require("./playwrightPage");
 const types_1 = require("../types");
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const loggingProvider_1 = require("../../providers/logging/loggingProvider");
 class PlaywrightBrowser extends events_1.default {
-    constructor(defaultContext, downloadDirectory, browserWSEndpoint, disableFocusEmulation) {
+    constructor(defaultContext, downloadDirectory, browserWSEndpoint, enableScreencastMode, disableFocusEmulation) {
         super();
         this.defaultContext = defaultContext;
         this.downloadDirectory = downloadDirectory;
@@ -54,9 +55,16 @@ class PlaywrightBrowser extends events_1.default {
         if (!fs_extra_1.default.existsSync(path_1.default.join(this.downloadDirectory))) {
             fs_extra_1.default.mkdirSync(path_1.default.join(this.downloadDirectory));
         }
+        loggingProvider_1.logger.debug(`Screencast mode is ${enableScreencastMode ? 'enabled' : 'disabled'}`);
+        if (enableScreencastMode) {
+            this.defaultContext.on('page', async (page) => this.enableScreencastMode(page));
+            this.defaultContext.pages().forEach(async (page) => {
+                await this.enableScreencastMode(page);
+            });
+        }
     }
-    static async create(defaultContext, downloadDirectory, browserWSEndpoint, disableFocusEmulation) {
-        const browser = new PlaywrightBrowser(defaultContext, downloadDirectory, browserWSEndpoint, disableFocusEmulation);
+    static async create(defaultContext, downloadDirectory, browserWSEndpoint, enableScreencastMode, disableFocusEmulation) {
+        const browser = new PlaywrightBrowser(defaultContext, downloadDirectory, browserWSEndpoint, enableScreencastMode, disableFocusEmulation);
         await browser.setDownloadBehavior();
         return browser;
     }
@@ -127,6 +135,15 @@ class PlaywrightBrowser extends events_1.default {
             eventsEnabled: true,
         });
     }
+    async enableScreencastMode(page) {
+        const cdp = await this.defaultContext.newCDPSession(page);
+        cdp.on('Page.screencastFrame', async (params) => {
+            await cdp
+                .send('Page.screencastFrameAck', { sessionId: params.sessionId })
+                .catch(() => { });
+        });
+        await cdp.send('Page.startScreencast', {});
+    }
     onPageClose(page) {
         this.playwrightPages.delete(page.getPageId());
         this.emit(browserLauncher_1.BrowserEvent.PageDestroyed, page);

package/browserLauncher/playwrightBrowserLauncher/playwrightBrowserLauncher.js

@@ -8,10 +8,6 @@ const playwrightBrowser_1 = require("./playwrightBrowser");
 const simplePlaywrightLogger_1 = require("./simplePlaywrightLogger");
 const BROWSER_LAUNCH_TIMEOUT_MS = 60000;
 class PlaywrightBrowserLauncher {
-    async connect(options, currentDownloadPath) {
-        const browser = await test_1.chromium.connect(options.browserWSEndpoint);
-        return playwrightBrowser_1.PlaywrightBrowser.create(browser.contexts()[0], currentDownloadPath, options.browserWSEndpoint);
-    }
     async launch(options) {
         var _a, _b, _c, _d;
         const viewport = options.defaultDeviceDescriptor
@@ -54,7 +50,7 @@ class PlaywrightBrowserLauncher {
             userAgent: (_d = options.userAgent) !== null && _d !== void 0 ? _d : options.defaultUserAgent,
             viewport,
         });
-        return playwrightBrowser_1.PlaywrightBrowser.create(defaultContext, options.downloadPath, '', options.disableFocusEmulation);
+        return playwrightBrowser_1.PlaywrightBrowser.create(defaultContext, options.downloadPath, '', options.enableScreencastModeForScreenshotTimeouts, options.disableFocusEmulation);
     }
 }
 exports.PlaywrightBrowserLauncher = PlaywrightBrowserLauncher;

package/commands/tests/testsUtil.js

@@ -26,14 +26,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toBasicHttpAuthenticationCredentials = exports.generateChromiumPreferencesFile = exports.logTestInfoIfPresent = exports.milliSecondsToSeconds = exports.calculateTotalTimeSeconds = exports.extractTestRunConfig = exports.pullDownTestRunConfig = exports.validateRunCommandWithLabels = exports.validateRunEditCommand = exports.downloadUploadFile = exports.sleep = exports.editTheTest = exports.runTheTest = exports.prepareTrainerForSplitPlayback = exports.createTrainingSession = exports.cleanUpInitialPages = exports.getExtensionBackgroundPageWithCliTool = exports.createBrowserForExecutionEngine = exports.addExecutionEngineLaunchArgs = exports.createBrowser = exports.prepareChromePreferencesDirectory = exports.findChrome = exports.searchForChrome = exports.getFinalUrl = exports.getTempChromePrefDirectory = void 0;
+exports.toBasicHttpAuthenticationCredentials = exports.generateChromiumPreferencesFile = exports.logTestInfoIfPresent = exports.milliSecondsToSeconds = exports.calculateTotalTimeSeconds = exports.extractTestRunConfig = exports.pullDownTestRunConfig = exports.validateRunCommandWithLabels = exports.validateRunEditCommand = exports.cleanupTestResources = exports.sleep = exports.editTheTest = exports.runTheTest = exports.prepareTrainerForSplitPlayback = exports.createTrainingSession = exports.cleanUpInitialPages = exports.getExtensionBackgroundPageWithCliTool = exports.createBrowserForExecutionEngine = exports.addExecutionEngineLaunchArgs = exports.createBrowser = exports.prepareChromePreferencesDirectory = exports.findChrome = exports.searchForChrome = exports.getFinalUrl = exports.getTempChromePrefDirectory = void 0;
 const async_retry_1 = __importDefault(require("async-retry"));
-const axios_1 = __importDefault(require("axios"));
 const cli_table3_1 = __importDefault(require("cli-table3"));
 const fs = __importStar(require("fs-extra"));
 const os = __importStar(require("os"));
 const path = __importStar(require("path"));
-const stream_1 = require("stream");
 const browserLauncher_1 = require("../../browserLauncher/browserLauncher");
 const trainingSessionActions_1 = require("../../core/messaging/actions/trainingSessionActions");
 const logLineMessaging_1 = require("../../core/messaging/logLineMessaging");
@@ -41,12 +39,13 @@ const messaging_1 = require("../../core/messaging/messaging");
 const env_1 = require("../../env/env");
 const cliConfigProvider_1 = require("../../providers/cliConfigProvider");
 const loggingProvider_1 = require("../../providers/logging/loggingProvider");
-const httpUtil_1 = require("../../util/httpUtil");
 const resourceUtil_1 = require("../../util/resourceUtil");
 const configKeys_1 = require("../config/config_cmds/configKeys");
 const constants_1 = require("../constants");
 const mobileEmulationUtil_1 = require("./mobileEmulationUtil");
 const trainerUtil_1 = require("./tests_cmds/trainerUtil");
+const logUtils_1 = require("../../util/logUtils");
+const fileUploadUtil_1 = require("../../util/fileUploadUtil");
 const chalk = require('chalk');
 const chromeFinder = require('chrome-launcher/dist/chrome-finder');
 const launchUtils = require('chrome-launcher/dist/utils');
@@ -212,6 +211,7 @@ async function createBrowser(browserWidth, browserHeight, headless, containerTes
         ignoreDefaultArgs,
         userAgent: (_a = options === null || options === void 0 ? void 0 : options.userAgent) !== null && _a !== void 0 ? _a : emulationConfig === null || emulationConfig === void 0 ? void 0 : emulationConfig.device_config.user_agent,
         defaultUserAgent: options === null || options === void 0 ? void 0 : options.defaultUserAgent,
+        enableScreencastModeForScreenshotTimeouts: false,
     });
     if (!maybeBrowser) {
         throw new Error('Unable to start Chrome session');
@@ -496,46 +496,19 @@ function handleExtensionMessage(message, trainingBrowser) {
             break;
     }
 }
-async function downloadUploadFile(fileUploadUrl, fileUpload, downloadDirectory, mablApiClient) {
-    let client;
-    if (mablApiClient) {
-        client = mablApiClient.httpClient;
-    }
-    else {
-        client = axios_1.default.create(await (0, httpUtil_1.currentProxyConfig)());
-    }
+function cleanupTestResources(testContext) {
     try {
-        const finalDirectory = path.normalize(`${downloadDirectory}/${fileUpload.id}`);
-        try {
-            fs.mkdirSync(finalDirectory);
-        }
-        catch (error) {
-            if (!error.message.includes('file already exists')) {
-                throw error;
-            }
-        }
-        const finalPath = path.normalize(`${finalDirectory}/${fileUpload.name}`);
-        const writer = fs.createWriteStream(finalPath);
-        const response = await client.get(fileUploadUrl, {
-            responseType: 'stream',
-        });
-        if (response.data.pipe) {
-            response.data.pipe(writer);
+        if (testContext) {
+            testContext.getFileUploadDirs().forEach((dir) => (0, fileUploadUtil_1.removeUploadDirs)(dir));
+            testContext.clearFileUploadDirs();
         }
-        else if (!(response.status >= 400)) {
-            stream_1.Readable.from(response.data).pipe(writer);
-        }
-        return new Promise((resolve, reject) => {
-            writer.on('finish', () => resolve(finalPath));
-            writer.on('error', reject);
-        });
     }
-    catch (error) {
-        loggingProvider_1.logger.error(chalk.red.bold('Error encountered downloading file for File Upload Step replay'));
-        throw error;
+    catch (e) {
+        const msg = `WARNING: error received when cleaning up after tests: ${e.message}`;
+        (0, logUtils_1.logCliOutput)(loggingProvider_1.LogLevel.Warn, msg);
     }
 }
-exports.downloadUploadFile = downloadUploadFile;
+exports.cleanupTestResources = cleanupTestResources;
 function validateRunEditCommand(idArg, testRunIdArg) {
     if (!idArg && !testRunIdArg) {
         throw new Error(chalk.red(`Please specify a test ID (--${constants_1.CommandArgId}) or test run ID (--${constants_1.CommandArgTestRunId})\n`));
@@ -599,6 +572,7 @@ async function pullDownTestRunConfig(testRunId, apiClient) {
         filterHttpRequests: false,
         importedVariables: (_k = journeyRun.journey_parameters) === null || _k === void 0 ? void 0 : _k.imported_variables,
         pageLoadWait: (_l = journeyRun.journey_parameters) === null || _l === void 0 ? void 0 : _l.page_load_wait,
+        runId: journeyRun.id,
         testId: (_m = journeyRun.journey) === null || _m === void 0 ? void 0 : _m.invariant_id,
         url: (_p = (_o = journeyRun.journey_parameters) === null || _o === void 0 ? void 0 : _o.deployment) === null || _p === void 0 ? void 0 : _p.uri,
     };
@@ -623,6 +597,7 @@ async function extractTestRunConfig(executionMessage, apiClient) {
         filterHttpRequests: true,
         importedVariables: (_l = journeyRun.journey_parameters) === null || _l === void 0 ? void 0 : _l.imported_variables,
         pageLoadWait: (_m = journeyRun.journey_parameters) === null || _m === void 0 ? void 0 : _m.page_load_wait,
+        runId: journeyRun.id,
         runnerType: maybeRunnerType,
         testId: (_o = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey) === null || _o === void 0 ? void 0 : _o.invariant_id,
         url: (_q = (_p = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _p === void 0 ? void 0 : _p.deployment) === null || _q === void 0 ? void 0 : _q.uri,

package/commands/tests/tests_cmds/run-cloud.js

@@ -180,22 +180,27 @@ async function runInCloud(parsed) {
     loggingProvider_1.logger.info(chalk.white('---'));
     const resultUrls = [];
     for (const test of tests) {
-        const urls = await executeRunCloudTest(test, browsers, branchName, apiClient, maybeDeploymentId, maybeUrlApp, maybeUrlApi, credentialsId, applicationId, environmentId, basicAuthCredentialsId);
-        resultUrls.push(...urls);
+        const testRuns = await executeRunCloudTest(test, browsers, branchName, apiClient, maybeDeploymentId, maybeUrlApp, maybeUrlApi, credentialsId, applicationId, environmentId, basicAuthCredentialsId);
+        testRuns.forEach((testRun) => resultUrls.push(`${env_1.BASE_APP_URL}/workspaces/${testRun.organization_id}/test/journey-runs/${testRun.id}`));
         loggingProvider_1.logger.info(chalk.white('---'));
     }
     let outputUrl;
-    if (resultUrls.length > 1) {
-        outputUrl = `${env_1.BASE_APP_URL}/workspaces/${workspaceId}/output`;
-        loggingProvider_1.logger.info(`See mabl results page to view tests [${chalk.magenta(outputUrl)}]`);
-    }
-    else {
+    if (resultUrls.length === 1) {
         outputUrl = resultUrls[0];
         loggingProvider_1.logger.info(`See mabl test output page for results [${chalk.magenta(outputUrl)}]`);
     }
+    else {
+        let filter = '';
+        if (labelsInclude.length === 1) {
+            filter = `?labels=${labelsInclude[0]}`;
+        }
+        outputUrl = `${env_1.BASE_APP_URL}/workspaces/${workspaceId}/output${filter}`;
+        loggingProvider_1.logger.info(`See mabl results page to view tests [${chalk.magenta(outputUrl)}]`);
+    }
     return outputUrl;
 }
 async function executeRunCloudTest(test, browsers, branchName, apiClient, maybeDeploymentId, appUrl, apiUrl, credentialsId, applicationId, environmentId, basicAuthCredentialsId) {
+    var _a;
     const effectiveAppUrl = appUrl !== null && appUrl !== void 0 ? appUrl : test === null || test === void 0 ? void 0 : test.url;
     const workspaceId = test.organization_id;
     const testId = test.invariant_id;
@@ -222,9 +227,8 @@ async function executeRunCloudTest(test, browsers, branchName, apiClient, maybeD
         deploymentIds = foundDeployments.map((deployment) => deployment.id);
     }
     const planRun = await apiClient.postPlanRun(workspaceId, testId, branchName, browsers, effectiveAppUrl, apiUrl, maybeDeploymentId, credentialsId, deploymentIds, basicAuthCredentialsId);
-    return planRun.scripts
-        ? planRun.scripts.map((script) => `${env_1.BASE_APP_URL}/workspaces/${planRun.organization_id}/test/journey-runs/${script.id}`)
-        : [];
+    const testRunsQueryResult = await apiClient.getTestRunsForPlan(planRun.id);
+    return (_a = testRunsQueryResult.test_script_executions) !== null && _a !== void 0 ? _a : [];
 }
 async function getJourneysForLabels(workspaceId, branchName, branchChangesOnly, labelsInclude, labelsExclude, limit, prompt, apiClient) {
     var _a;

package/commands/tests/tests_cmds/run.js

@@ -8,6 +8,7 @@ const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
 const mablApi_1 = require("../../../mablApi");
 const reporter_1 = require("../../../reporters/reporter");
 const browserTypes_1 = require("../../browserTypes");
+const execution_1 = require("../../../execution");
 const chalk = require('chalk');
 const execution = require('../../../execution/index');
 exports.command = `run`;
@@ -236,8 +237,16 @@ async function run(parsed) {
         workspaceId,
     };
     loggingProvider_1.logger.info('Warming up test runner...');
-    const mablTestRunner = await execution.createMablTestRunner(testRunnerConfig);
-    const results = await mablTestRunner.run();
+    const mablTestsRunner = await execution.createMablTestRunner(testRunnerConfig);
+    const results = await mablTestsRunner.run();
+    if ((mablTestsRunner === null || mablTestsRunner === void 0 ? void 0 : mablTestsRunner.mablTestRunners) !== undefined) {
+        mablTestsRunner.mablTestRunners
+            .filter((tr) => tr instanceof execution_1.MablTestRunner)
+            .forEach((tr) => {
+            const testContext = tr.testContext;
+            (0, testsUtil_1.cleanupTestResources)(testContext);
+        });
+    }
     loggingProvider_1.logger.logNewLine();
     loggingProvider_1.logger.info(`Test count: ${results.numTotalTests}`);
     loggingProvider_1.logger.info(`Passed: ${results.numPassedTests}`);

package/core/messaging/logLineMessaging.js

@@ -21,6 +21,7 @@ function registerConsoleLoggerForOutput(eventEmitter) {
     eventEmitter
         .getOutputEventChannel()
         .on(messaging_1.EventChannelMessageType.outputLogLine, (line, timestamp, color, metadata) => {
+        var _a;
         const formatted = color ? chalk_1.default[color](line) : line;
         if ((metadata === null || metadata === void 0 ? void 0 : metadata.shouldOutputInConsole) === false) {
             return;
@@ -30,7 +31,8 @@ function registerConsoleLoggerForOutput(eventEmitter) {
             formattedTimestamp = `${moment
                 .unix(timestamp / 1000)
                 .format('LTS')} - `;
-            loggingProvider_1.logger.info(`${chalk_1.default.yellow(formattedTimestamp)}${formatted}`);
+            const stepNumberPrefix = (_a = metadata === null || metadata === void 0 ? void 0 : metadata.stepNumberPrefix) !== null && _a !== void 0 ? _a : '';
+            loggingProvider_1.logger.info(`${chalk_1.default.yellow(formattedTimestamp)}${stepNumberPrefix}${formatted}`);
         }
         else {
             loggingProvider_1.logger.info(formatted);