@mablhq/mabl-cli 2.16.4 → 2.19.13

package/api/mablApiClient.js

@@ -13,9 +13,10 @@ const query_string_1 = __importDefault(require("query-string"));
 const featureSet_1 = require("./featureSet");
 class MablApiClient extends basicApiClient_1.BasicApiClient {
     constructor(options) {
-        var _a;
+        var _a, _b;
         super(options);
-        this.baseApiUrl = (_a = options.apiUrl) !== null && _a !== void 0 ? _a : env_1.BASE_API_URL;
+        this.baseApiUrl =
+            (_b = (_a = options.apiUrl) !== null && _a !== void 0 ? _a : process.env.MABL_API_URL) !== null && _b !== void 0 ? _b : env_1.BASE_API_URL;
     }
     async getPlan(planId) {
         try {

package/browserEngines/chromiumBrowserEngine.js

@@ -65,9 +65,11 @@ class ChromiumBrowserEngine {
         }
         if (options.disableIsolation) {
             disableFeaturesFlags.push('IsolateOrigins');
+            disableFeaturesFlags.push('site-per-process');
+        }
+        if (disableFeaturesFlags.length) {
+            commandLineArgs.push(`--disable-features=${disableFeaturesFlags.join(',')}`);
         }
-        disableFeaturesFlags.push('site-per-process');
-        commandLineArgs.push(`--disable-features=${disableFeaturesFlags.join(',')}`);
         if (options.autoOpenDevtoolsForTabs) {
             commandLineArgs.push('--auto-open-devtools-for-tabs');
         }

package/browserLauncher/pageEvent.js

@@ -8,7 +8,6 @@ var PageEvent;
     PageEvent["FrameAttached"] = "frameattached";
     PageEvent["FrameNavigated"] = "framenavigated";
     PageEvent["PageError"] = "pageerror";
-    PageEvent["Request"] = "request";
     PageEvent["RequestWillBeSentExtraInfo"] = "requestwillbesentextrainfo";
     PageEvent["Response"] = "response";
     PageEvent["SecondaryWorldCreated"] = "secondaryworldcreated";

package/browserLauncher/playwrightBrowserLauncher/playwrightHttpRequest.js

@@ -32,6 +32,7 @@ class PlaywrightHttpRequest {
         this.page = page;
         this.request = request;
         this.route = route;
+        this.requestIntercepted = false;
         try {
             this.documentId = playwright._toImpl(this.request)._documentId;
         }
@@ -45,15 +46,9 @@ class PlaywrightHttpRequest {
         if (this.route === undefined) {
             throw new Error('Unable to abort an unrouted request');
         }
+        this.requestIntercepted = true;
         return (_a = this.route) === null || _a === void 0 ? void 0 : _a.abort();
     }
-    continue() {
-        var _a;
-        if (this.route === undefined) {
-            throw new Error('Unable to continue an unrouted request');
-        }
-        return (_a = this.route) === null || _a === void 0 ? void 0 : _a.continue();
-    }
     frame() {
         return this.page.getOrCreateFrame(this.request.frame());
     }
@@ -65,6 +60,7 @@ class PlaywrightHttpRequest {
         if (this.route === undefined) {
             throw new Error('Unable to respond an unrouted request');
         }
+        this.requestIntercepted = true;
         return (_a = this.route) === null || _a === void 0 ? void 0 : _a.fulfill(response);
     }
     url() {
@@ -73,5 +69,8 @@ class PlaywrightHttpRequest {
     headers() {
         return this.request.allHeaders();
     }
+    wasIntercepted() {
+        return this.requestIntercepted;
+    }
 }
 exports.PlaywrightHttpRequest = PlaywrightHttpRequest;

package/browserLauncher/playwrightBrowserLauncher/playwrightPage.js

@@ -48,6 +48,7 @@ class PlaywrightPage extends events_1.default {
         this.browser = browser;
         this.delegate = delegate;
         this.playwrightFrames = new Map();
+        this.requestListeners = [];
         const guid = page._guid;
         this.pageId = (_a = delegate.getTargetId()) !== null && _a !== void 0 ? _a : guid;
         page.off('dialog', this.acceptDialogs);
@@ -75,6 +76,26 @@ class PlaywrightPage extends events_1.default {
             }
         });
     }
+    addRequestListener(listener) {
+        if (this.requestListeners.length === 0) {
+            void this.page.route('**/*', async (route) => {
+                const listeners = this.requestListeners;
+                if (listeners.length === 0) {
+                    void route.continue();
+                    return;
+                }
+                const request = new playwrightHttpRequest_1.PlaywrightHttpRequest(this, route.request(), route);
+                for (const listener of listeners) {
+                    await listener(request);
+                    if (request.wasIntercepted()) {
+                        return;
+                    }
+                }
+                await route.continue();
+            });
+        }
+        this.requestListeners.push(listener);
+    }
     createCDPSession() {
         return this.delegate.createCDPSession();
     }
@@ -108,11 +129,6 @@ class PlaywrightPage extends events_1.default {
                     this.emit(browserLauncher_1.PageEvent.Response, new playwrightHttpResponse_1.PlaywrightHttpResponse(this, event));
                 });
             }
-            if (event === browserLauncher_1.PageEvent.Request && !this.listenerCount(event)) {
-                void this.page.route('**/*', (route) => {
-                    this.emit(browserLauncher_1.PageEvent.Request, new playwrightHttpRequest_1.PlaywrightHttpRequest(this, route.request(), route));
-                });
-            }
             if (event === browserLauncher_1.PageEvent.FrameNavigated && !this.listenerCount(event)) {
                 this.page.on('framenavigated', (frame) => {
                     this.emit(browserLauncher_1.PageEvent.FrameNavigated, this.getOrCreateFrame(frame));

package/commands/auth/auth_cmds/activate-key.js

@@ -9,11 +9,18 @@ exports.command = `activate-key <${constants_1.CommandArgApiKey}>`;
 exports.describe = 'Activate auth by api key';
 exports.builder = {};
 exports.builder = (yargs) => {
-    yargs.positional(constants_1.CommandArgApiKey, {
+    yargs
+        .positional(constants_1.CommandArgApiKey, {
         describe: 'API key (escape leading dashes with "\\" (e.g. "\\-yourKey")',
         type: 'string',
         nargs: 1,
         demand: 'API key argument required',
+    })
+        .option('skip-workspace', {
+        describe: 'Set to skip validating and setting the workspace',
+        default: false,
+        hidden: true,
+        type: 'boolean',
     });
 };
 exports.handler = (0, util_1.failWrapper)(activateApiKey);
@@ -23,7 +30,9 @@ async function activateApiKey(parsed) {
     const cleanApiKey = apiKey.replace(/^\\+/, '');
     const mablApi = await mablApiClientFactory_1.MablApiClientFactory.createApiClientFromApiKey(cleanApiKey);
     const apiKeyDetails = await mablApi.getApiKeyDetails();
-    const apiKeyWorkspace = await mablApi.getWorkspace(apiKeyDetails.workspace_id);
-    await cliConfigProvider_1.CliConfigProvider.setWorkspace(apiKeyWorkspace);
+    if (!parsed['skip-workspace']) {
+        const apiKeyWorkspace = await mablApi.getWorkspace(apiKeyDetails.workspace_id);
+        await cliConfigProvider_1.CliConfigProvider.setWorkspace(apiKeyWorkspace);
+    }
     return auth.activateApiKey(cleanApiKey);
 }

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

@@ -35,10 +35,11 @@ const runUtils_1 = require("./runUtils");
 const MobileAppFileCache_1 = require("../../../util/MobileAppFileCache");
 const fs = __importStar(require("fs"));
 const resourceUtil_1 = require("../../../util/resourceUtil");
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
 const chalk = require('chalk');
 const execution = require('../../../execution/index');
 exports.command = `run-mobile`;
-exports.describe = false;
+exports.describe = 'Run a mobile test locally';
 exports.builder = (yargs) => {
     yargs
         .example('$0 tests run-mobile --id <id> --app-file <path> --platform <platform>', 'run mobile test locally by id')
@@ -71,6 +72,10 @@ exports.builder = (yargs) => {
         hidden: true,
         type: 'string',
         choices: [constants_1.ReporterOptions.Mochawesome],
+    })
+        .option(constants_1.CommandArgTestRunId, {
+        describe: 'The id of the test run to pull config from',
+        type: 'string',
     })
         .option(constants_1.CommandArgReporterOptions, {
         describe: 'Reporter options as comma separated key/values pairs. e.g. "reportDir=path/to,json=true"',
@@ -81,27 +86,33 @@ exports.builder = (yargs) => {
         describe: 'Full name of the device to use for the test',
         hidden: false,
         type: 'string',
+    })
+        .option(constants_1.CommandArgLabelsInclude, {
+        describe: 'Space delimited test labels. Run tests that match any label.',
+        type: 'array',
+        conflicts: [constants_1.CommandArgId],
+    })
+        .option(constants_1.CommandArgLabelsExclude, {
+        describe: 'Space delimited test labels. Exclude tests that match any label.',
+        type: 'array',
+        conflicts: [constants_1.CommandArgId],
     })
         .implies(constants_1.CommandArgReporterOptions, constants_1.CommandArgReporter)
-        .middleware(inferMobilePlatform);
+        .middleware(inferMobilePlatform)
+        .check((argv) => {
+        (0, testsUtil_1.validateRunCommandWithLabels)(argv[constants_1.CommandArgId], argv[constants_1.CommandArgLabelsInclude], argv[constants_1.CommandArgLabelsExclude], argv[constants_1.CommandArgTestRunId], argv[constants_1.CommandArgFromPlanId], true, undefined);
+        validateMobileCommand(argv[constants_1.CommandArgMobileAppFile], argv[constants_1.CommandArgMobileAppFileId]);
+        return true;
+    });
 };
 const exitCodeOnError = 1;
 exports.handler = (0, util_1.failWrapper)(run, exitCodeOnError);
-function validateMobileCommand(id, appFile, appFileId, platform) {
-    if (!id || (!appFile && !appFileId) || !platform) {
-        loggingProvider_1.logger.error(chalk.red(`Please provide the arguments --${constants_1.CommandArgId}, --${constants_1.CommandArgMobileAppFile} or --${constants_1.CommandArgMobileAppFileId}, and --${constants_1.CommandArgMobilePlatform}`));
-        return false;
-    }
+function validateMobileCommand(appFile, appFileId) {
     if (appFile && appFileId) {
-        loggingProvider_1.logger.error(chalk.red(`Only one of { --${constants_1.CommandArgMobileAppFile}, --${constants_1.CommandArgMobileAppFileId} } may be specified`));
-        return false;
+        throw new Error(`Only one of { --${constants_1.CommandArgMobileAppFile}, --${constants_1.CommandArgMobileAppFileId} } may be specified`);
     }
-    return true;
 }
 async function run(parsed) {
-    if (!validateMobileCommand(parsed[constants_1.CommandArgId], parsed[constants_1.CommandArgMobileAppFile], parsed[constants_1.CommandArgMobileAppFileId], parsed[constants_1.CommandArgMobilePlatform])) {
-        process.exit(1);
-    }
     const commandStartTime = Date.now();
     let workspaceId;
     try {
@@ -115,11 +126,22 @@ async function run(parsed) {
         loggingProvider_1.logger.error(`[ERROR] Missing the mobile tools for running tests, run ${chalk.magenta('mabl config install mobile-tools')} to install them`);
         return;
     }
-    const platformName = (0, execution_1.parsePlatformName)(parsed[constants_1.CommandArgMobilePlatform]);
+    let platformName;
+    if (parsed[constants_1.CommandArgTestRunId]) {
+        const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+        const testRun = await apiClient.getJourneyRun(parsed[constants_1.CommandArgTestRunId]);
+        platformName = (0, runUtils_1.getPlatformFromTestRun)(testRun);
+    }
+    else {
+        platformName = (0, execution_1.parsePlatformName)(parsed[constants_1.CommandArgMobilePlatform]);
+    }
     await validateSystemRequirements(platformName, parsed[constants_1.CommandArgMobileDeviceName]);
     const testRunnerConfig = {
         _cliCreated: true,
         filterHttpRequests: false,
+        labelsExclude: parsed[constants_1.CommandArgLabelsExclude],
+        labelsInclude: parsed[constants_1.CommandArgLabelsInclude],
+        runId: parsed[constants_1.CommandArgTestRunId],
         testId: parsed.id,
         workspaceId,
         mobileConfig: {

package/commands/tests/tests_cmds/runUtils.js

@@ -3,11 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logTestResults = void 0;
+exports.getPlatformFromTestRun = exports.logTestResults = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
 const reporter_1 = require("../../../reporters/reporter");
 const testsUtil_1 = require("../testsUtil");
+const execution_1 = require("../../../execution");
 async function logTestResults(results, parsed, commandStartTime, rerunCommandTemplate) {
     loggingProvider_1.logger.logNewLine();
     loggingProvider_1.logger.info(`Test count: ${results.numTotalTests}`);
@@ -48,3 +49,12 @@ exports.logTestResults = logTestResults;
 function getTestResultDescription(result) {
     return `${result.testName}${result.scenarioName ? ` - Scenario: ${result.scenarioName}` : ''}`;
 }
+function getPlatformFromTestRun(testRun) {
+    var _a, _b;
+    const platform = (_b = (_a = testRun.journey_parameters) === null || _a === void 0 ? void 0 : _a.mobile_device) === null || _b === void 0 ? void 0 : _b.platform;
+    if (!platform) {
+        throw new Error(`Unable to determine mobile platform from test run: ${testRun.id}`);
+    }
+    return (0, execution_1.parsePlatformName)(platform);
+}
+exports.getPlatformFromTestRun = getPlatformFromTestRun;

package/core/messaging/actions/MobileTrainingActions.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MobileTrainingActionsEventEmitter = exports.MobileTrainingMessageType = void 0;
+const messaging_1 = require("../messaging");
+var MobileTrainingMessageType;
+(function (MobileTrainingMessageType) {
+    MobileTrainingMessageType["foundElement"] = "mobileFoundElement";
+})(MobileTrainingMessageType = exports.MobileTrainingMessageType || (exports.MobileTrainingMessageType = {}));
+class MobileTrainingActionsEventEmitter {
+    static emitFoundElementInfo(foundElement, isACandidateElement) {
+        return messaging_1.mablEventEmitter.dispatch(new messaging_1.MablCoreAction(MobileTrainingMessageType.foundElement, {
+            boundingBox: foundElement.boundingBox,
+            isACandidateElement,
+        }));
+    }
+}
+exports.MobileTrainingActionsEventEmitter = MobileTrainingActionsEventEmitter;