@mablhq/mabl-cli 1.25.19 → 1.29.0

package/api/basicApiClient.js

@@ -58,6 +58,7 @@ class BasicApiClient {
         const config = (0, httpUtil_1.axiosProxyConfig)({
             sslVerify: (_a = options.sslVerify) !== null && _a !== void 0 ? _a : DEFAULT_SSL_VERIFY,
             proxyHost: options.proxyUrl,
+            proxyType: options.proxyType,
         });
         if (!config.headers) {
             config.headers = {};

package/api/entities/Browser.js

@@ -4,6 +4,7 @@ exports.Browser = void 0;
 var Browser;
 (function (Browser) {
     Browser["chrome"] = "chrome";
+    Browser["edge"] = "edge";
     Browser["firefox"] = "firefox";
     Browser["internet_explorer"] = "internet_explorer";
     Browser["safari"] = "safari";

package/api/featureSet.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FeatureSet = exports.FindImplementationVersion = void 0;
-const runnerType_1 = require("../browserLauncher/runnerType");
+const types_1 = require("../browserLauncher/types");
 const ACCESSIBILITY_CHECK_FEATURE_FLAG = 'accessibility_checks';
 const SMARTER_WAIT_FEATURE_FLAG = 'smarter_wait';
 var FindImplementationVersion;
@@ -14,7 +14,7 @@ class FeatureSet {
         this.featureFlags = featureFlags;
     }
     getRunnerType() {
-        return runnerType_1.RunnerType.Playwright;
+        return types_1.RunnerType.Playwright;
     }
     getFindImplementationVersion() {
         return this.featureFlags.has(SMARTER_WAIT_FEATURE_FLAG)

package/api/mablApiClient.js

@@ -745,6 +745,20 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
             throw toApiError(`Failed to get feature flags for workspace ${workspaceId}`, error);
         }
     }
+    async getUsers(workspaceId, limit) {
+        try {
+            const userQueryString = queryString.stringify({
+                organization_id: workspaceId,
+                limit,
+            });
+            const users = await this.makeGetRequest(`${this.baseApiUrl}/users/?${userQueryString}`).then((result) => { var _a; return (_a = result.users) !== null && _a !== void 0 ? _a : []; });
+            sortTemporallyAscending(users);
+            return users;
+        }
+        catch (error) {
+            throw toApiError(`Failed to get users`, error);
+        }
+    }
 }
 exports.MablApiClient = MablApiClient;
 function sortTemporallyAscending(entities) {

package/api/mablApiClientFactory.js

@@ -32,11 +32,11 @@ class MablApiClientFactory {
         });
     }
     static async createApiClient(opts) {
-        const { proxyHost, sslVerify } = (await cliConfigProvider_1.CliConfigProvider.getCliConfig()).http
-            .mabl;
+        const { mabl } = (await cliConfigProvider_1.CliConfigProvider.getCliConfig()).http;
         const optsFromCliHttpConfig = {
-            proxyUrl: proxyHost,
-            sslVerify,
+            proxyUrl: mabl.proxyHost,
+            sslVerify: mabl.sslVerify,
+            proxyType: mabl.proxyType,
         };
         if (opts) {
             return new mablApiClient_1.MablApiClient({
@@ -68,6 +68,7 @@ class MablApiClientFactory {
             token: accessToken,
             proxyUrl: httpConfig.proxyHost,
             sslVerify: httpConfig.sslVerify,
+            proxyType: httpConfig.proxyType,
         });
     }
     static throwUserAuthTypeError() {

package/browserLauncher/browserLauncherFactory.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BrowserLauncherFactory = void 0;
 const playwrightBrowserLauncher_1 = require("./playwrightBrowserLauncher/playwrightBrowserLauncher");
-const runnerType_1 = require("./runnerType");
+const types_1 = require("./types");
 const logUtils_1 = require("../util/logUtils");
 const loggingProvider_1 = require("../providers/logging/loggingProvider");
 const chalk_1 = __importDefault(require("chalk"));
@@ -14,12 +14,12 @@ class BrowserLauncherFactory {
         var _a;
         return (_a = process.env.MABL_RUNNER) === null || _a === void 0 ? void 0 : _a.toLowerCase();
     }
-    static createRunner(runnerType = runnerType_1.RunnerType.Playwright, loggerFunc) {
+    static createRunner(runnerType = types_1.RunnerType.Playwright, loggerFunc) {
         const runnerFromEnv = BrowserLauncherFactory.getRunnerFromEnvironment();
         const runner = runnerFromEnv ? runnerFromEnv : runnerType;
         loggerFunc =
             loggerFunc !== null && loggerFunc !== void 0 ? loggerFunc : ((line) => (0, logUtils_1.logCliOutput)(loggingProvider_1.LogLevel.Info, line));
-        if (runner === runnerType_1.RunnerType.Playwright) {
+        if (runner === types_1.RunnerType.Playwright) {
             loggerFunc(chalk_1.default.cyan(`Browser launcher:`, chalk_1.default.magenta('Playwright')));
             return new playwrightBrowserLauncher_1.PlaywrightBrowserLauncher();
         }

package/browserLauncher/playwrightBrowserLauncher/playwrightBrowser.js

@@ -31,9 +31,9 @@ const events_1 = __importDefault(require("events"));
 const playwright = __importStar(require("@playwright/test"));
 const browserLauncher_1 = require("../browserLauncher");
 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 runnerType_1 = require("../runnerType");
 class PlaywrightBrowser extends events_1.default {
     constructor(defaultContext, downloadDirectory, browserWSEndpoint, disableFocusEmulation) {
         super();
@@ -61,7 +61,7 @@ class PlaywrightBrowser extends events_1.default {
         return browser;
     }
     getRunnerType() {
-        return runnerType_1.RunnerType.Playwright;
+        return types_1.RunnerType.Playwright;
     }
     makeCdpCall(method, paramArgs) {
         return this.cdpSession.send(method, paramArgs);

package/browserLauncher/playwrightBrowserLauncher/playwrightBrowserLauncher.js

@@ -2,7 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlaywrightBrowserLauncher = void 0;
 const test_1 = require("@playwright/test");
+const browserTypes_1 = require("../../commands/browserTypes");
+const loggingProvider_1 = require("../../providers/logging/loggingProvider");
 const playwrightBrowser_1 = require("./playwrightBrowser");
+const simplePlaywrightLogger_1 = require("./simplePlaywrightLogger");
 const BROWSER_LAUNCH_TIMEOUT_MS = 60000;
 class PlaywrightBrowserLauncher {
     async connect(options, currentDownloadPath) {
@@ -10,7 +13,7 @@ class PlaywrightBrowserLauncher {
         return playwrightBrowser_1.PlaywrightBrowser.create(browser.contexts()[0], currentDownloadPath, options.browserWSEndpoint);
     }
     async launch(options) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         const viewport = options.defaultDeviceDescriptor
             ? {
                 width: options.defaultDeviceDescriptor.width,
@@ -18,13 +21,26 @@ class PlaywrightBrowserLauncher {
             }
             :
                 null;
+        const playwrightLogger = options.providerLogger
+            ? simplePlaywrightLogger_1.SimplePlaywrightLogger.createWarningLogger(options.providerLogger)
+            : undefined;
+        if (!options.userDataDir) {
+            loggingProvider_1.logger.error('User data directory is required to launch a persistent chromium context and was not provided with LaunchOptions [{}]', options);
+            throw new Error('User data directory is required to launch a persistent chromium context');
+        }
+        if (!options.downloadPath) {
+            loggingProvider_1.logger.error('Download path is required to launch a persistent chromium context and was not provided with LaunchOptions [{}]', options);
+            throw new Error('Download path is required to launch a persistent chromium context and was not provided with LaunchOptions');
+        }
         const defaultContext = await test_1.chromium.launchPersistentContext(options.userDataDir, {
             acceptDownloads: true,
             args: options.args,
             bypassCSP: options.bypassContentSecurityPolicy,
+            channel: browserTypes_1.SupportedBrowserTypeProperties[options.browserType]
+                .browserReleaseChannel,
             deviceScaleFactor: (_a = options.defaultDeviceDescriptor) === null || _a === void 0 ? void 0 : _a.deviceScaleFactor,
             downloadsPath: options.downloadPath,
-            executablePath: options.executablePath,
+            executablePath: options.browserPath,
             extraHTTPHeaders: options.extraHttpHeaders,
             hasTouch: (_b = options.defaultDeviceDescriptor) === null || _b === void 0 ? void 0 : _b.hasTouch,
             headless: options.headless,
@@ -32,9 +48,10 @@ class PlaywrightBrowserLauncher {
             ignoreDefaultArgs: options.ignoreDefaultArgs,
             ignoreHTTPSErrors: true,
             isMobile: (_c = options.defaultDeviceDescriptor) === null || _c === void 0 ? void 0 : _c.isMobile,
+            logger: playwrightLogger,
             proxy: options.proxy,
             timeout: BROWSER_LAUNCH_TIMEOUT_MS,
-            userAgent: options.userAgent,
+            userAgent: (_d = options.userAgent) !== null && _d !== void 0 ? _d : options.defaultUserAgent,
             viewport,
         });
         return playwrightBrowser_1.PlaywrightBrowser.create(defaultContext, options.downloadPath, '', options.disableFocusEmulation);

package/browserLauncher/playwrightBrowserLauncher/playwrightDom.js

@@ -305,26 +305,29 @@ class PlaywrightElementHandle extends PlaywrightJsHandle {
         return (0, pureUtil_1.isNullish)(result) ? undefined : result;
     }
     async getElementText() {
+        const innerText = await this.getInnerText();
+        return innerText ? innerText : this.getSlotText();
+    }
+    async getInnerText() {
+        const result = await this.element.evaluate((el) => el.innerText);
+        return (0, pureUtil_1.isNullish)(result) ? undefined : result;
+    }
+    async getSlotText() {
         const result = await this.element.evaluate((el) => {
-            var _a;
-            function extractFromSlot(element) {
-                const slots = element.querySelectorAll('slot');
-                if (slots.length !== 1) {
-                    return '';
-                }
-                const textNode = slots
-                    .item(0)
-                    .assignedNodes()
-                    .find((node) => node.nodeType === Node.TEXT_NODE);
-                return textNode ? textNode.data : '';
+            const slots = el.querySelectorAll('slot');
+            if (slots.length !== 1) {
+                return '';
             }
-            return (_a = (el.innerText || extractFromSlot(el))) !== null && _a !== void 0 ? _a : '';
+            const textNode = slots
+                .item(0)
+                .assignedNodes()
+                .find((node) => node.nodeType === Node.TEXT_NODE);
+            return textNode === null || textNode === void 0 ? void 0 : textNode.data;
         });
         return (0, pureUtil_1.isNullish)(result) ? undefined : result;
     }
-    async getInnerText() {
-        const result = await this.element.innerText();
-        return (0, pureUtil_1.isNullish)(result) ? undefined : result;
+    async isInShadowRoot() {
+        return this.element.evaluate((el) => el.getRootNode().nodeName === '#document-fragment');
     }
     getActionTimeout(options) {
         var _a;

package/browserLauncher/playwrightBrowserLauncher/simplePlaywrightLogger.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimplePlaywrightLogger = void 0;
+class SimplePlaywrightLogger {
+    constructor(logger, severityAllowList) {
+        this.logger = logger;
+        this.severityAllowList = severityAllowList;
+    }
+    static createWarningLogger(logger) {
+        return new SimplePlaywrightLogger(logger, new Set(['error', 'warning']));
+    }
+    isEnabled(_name, severity) {
+        return this.severityAllowList.has(severity);
+    }
+    log(name, severity, message, args, _hints) {
+        const msg = `[Playwright:${name}:${severity}] ${message} ${args}`;
+        switch (severity) {
+            case 'error':
+                this.logger.error(msg);
+                break;
+            case 'warning':
+                this.logger.warn(msg);
+                break;
+            case 'info':
+                this.logger.info(msg);
+                break;
+            case 'verbose':
+                this.logger.verbose(msg);
+                break;
+            default:
+                this.logger.info(msg);
+                break;
+        }
+    }
+}
+exports.SimplePlaywrightLogger = SimplePlaywrightLogger;

package/browserLauncher/types.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WaitForOptions = exports.LifecycleEvent = exports.DefaultTimeouts = void 0;
+exports.WaitForOptions = exports.LifecycleEvent = exports.RunnerType = exports.DefaultTimeouts = void 0;
 class DefaultTimeouts {
 }
 exports.DefaultTimeouts = DefaultTimeouts;
 DefaultTimeouts.defaultTrialTimeoutMs = 5000;
 DefaultTimeouts.defaultWaitTimeoutMs = 5000;
 DefaultTimeouts.defaultActionTimeoutMs = 0;
+var RunnerType;
+(function (RunnerType) {
+    RunnerType["Playwright"] = "playwright";
+})(RunnerType = exports.RunnerType || (exports.RunnerType = {}));
 var LifecycleEvent;
 (function (LifecycleEvent) {
     LifecycleEvent["DomContentLoaded"] = "domcontentloaded";

package/cli.js

@@ -60,6 +60,7 @@ yargs
     .commandDir('./commands/plans')
     .commandDir('./commands/tests')
     .commandDir('./commands/test-runs')
+    .commandDir('./commands/users')
     .commandDir('./commands/workspaces')
     .demandCommand(1, '')
     .recommendCommands()

package/commands/browserTypes.js

@@ -1,10 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BrowserTypes = void 0;
-var BrowserTypes;
-(function (BrowserTypes) {
-    BrowserTypes["Chrome"] = "chrome";
-    BrowserTypes["Firefox"] = "firefox";
-    BrowserTypes["InternetExplorer"] = "internet_explorer";
-    BrowserTypes["Safari"] = "safari";
-})(BrowserTypes = exports.BrowserTypes || (exports.BrowserTypes = {}));
+exports.DefaultBrowserProperties = exports.SupportedBrowserTypeProperties = exports.BrowserType = void 0;
+var BrowserType;
+(function (BrowserType) {
+    BrowserType["Chrome"] = "chrome";
+    BrowserType["Edge"] = "edge";
+    BrowserType["Firefox"] = "firefox";
+    BrowserType["InternetExplorer"] = "internet_explorer";
+    BrowserType["Safari"] = "safari";
+})(BrowserType = exports.BrowserType || (exports.BrowserType = {}));
+exports.SupportedBrowserTypeProperties = {
+    chrome: { browserName: 'chrome', browserReleaseChannel: 'chrome' },
+    edge: { browserName: 'edge', browserReleaseChannel: 'msedge' },
+    firefox: { browserName: 'firefox', browserReleaseChannel: 'firefox' },
+    safari: {
+        browserName: 'safari',
+        browserReleaseChannel: 'webkit',
+    },
+};
+exports.DefaultBrowserProperties = exports.SupportedBrowserTypeProperties.chrome;

package/commands/config/config_cmds/configKeys.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidProxyMode = exports.proxyModes = exports.validConfigKeyChoices = exports.configKeys = void 0;
+exports.isValidProxyType = exports.isValidProxyMode = exports.proxyTypes = exports.proxyModes = exports.validConfigKeyChoices = exports.configKeys = void 0;
 exports.configKeys = Object.freeze({
     browserPath: 'browser.path',
     enableSourceControlMetadataCollection: 'alpha.scm_metadata.enable',
@@ -8,6 +8,7 @@ exports.configKeys = Object.freeze({
     proxy: 'http.proxy',
     sslVerify: 'http.sslVerify',
     proxyMode: 'http.proxyMode',
+    proxyType: 'http.proxyType',
 });
 exports.validConfigKeyChoices = Object.values(exports.configKeys);
 exports.proxyModes = [
@@ -16,7 +17,12 @@ exports.proxyModes = [
     'all',
     'none',
 ];
+exports.proxyTypes = ['legacy', 'current'];
 function isValidProxyMode(value) {
     return exports.proxyModes.indexOf(value) !== -1;
 }
 exports.isValidProxyMode = isValidProxyMode;
+function isValidProxyType(value) {
+    return exports.proxyTypes.indexOf(value) !== -1;
+}
+exports.isValidProxyType = isValidProxyType;

package/commands/config/config_cmds/set.js

@@ -55,6 +55,12 @@ async function setConfig(parsed) {
             }
             await cliConfigProvider_1.CliConfigProvider.setConfigProperty(key, value);
             break;
+        case configKeys_1.configKeys.proxyType:
+            if (!(0, configKeys_1.isValidProxyType)(value)) {
+                throw new Error(`Invalid proxy type. The value must be one of ${JSON.stringify(configKeys_1.proxyTypes)}`);
+            }
+            await cliConfigProvider_1.CliConfigProvider.setConfigProperty(key, value);
+            break;
         default:
             throw new Error(`<${exports.configKeyCommandArg}> value not one of supported types: ${JSON.stringify(configKeys_1.validConfigKeyChoices)}`);
     }

package/commands/constants.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommandArgUrlApp = exports.CommandArgUrl = exports.CommandArgTrainerVersion = exports.CommandArgTo = exports.CommandArgSilent = exports.CommandArgRevision = exports.CommandArgMaxHeartbeatAge = exports.CommandArgPlanId = exports.CommandArgContentTypes = exports.CommandArgPreview = exports.CommandArgOutputFilePath = exports.CommandArgOutput = exports.CommandArgNoPrompt = exports.CommandArgPrompt = exports.CommandArgPortNumber = exports.CommandArgName = exports.CommandArgMablBranchChangesOnly = exports.CommandArgMablBranch = exports.CommandArgMablAutoLogin = exports.CommandArgMablAutoBranch = exports.CommandArgLinkBypass = exports.CommandArgLinkLabel = exports.CommandArgLimitOutput = exports.CommandArgLabels = exports.CommandArgLabelsInclude = exports.CommandArgLabelsExclude = exports.CommandArgTestInteractionSpeed = exports.CommandArgTestRunId = exports.CommandArgTestFile = exports.CommandArgId = exports.CommandArgUserAgent = exports.CommandArgHttpHeaders = exports.CommandArgHelp = exports.CommandArgFromPlanId = exports.CommandArgFrom = exports.CommandArgFormat = exports.CommandArgFastFailure = exports.CommandArgOverrideEnvironmentId = exports.CommandArgEnvironmentId = exports.CommandArgEnableLink = exports.CommandArgDetailLevel = exports.CommandArgDescription = exports.CommandArgDeploymentId = exports.CommandArgDecrypt = exports.CommandArgDataTables = exports.CommandArgCredentials = exports.CommandArgBasicAuthCredentials = exports.CommandArgBrowsers = exports.CommandArgApplicationId = exports.CommandArgApiKey = void 0;
-exports.BrowserTypeSelections = exports.DefaultBrowserType = exports.DefaultBranchName = exports.DefaultOutputFormatChoices = exports.DetailLevelFormats = exports.ReporterOptions = exports.OutputFormats = exports.CommandArgAliases = exports.CommandArgBrowserEnableExtensions = exports.CommandArgBrowserIgnoreCertificateErrors = exports.CommandArgBrowserDisableIsolation = exports.ListTimeFormat = exports.CommandArgReporterOptions = exports.CommandArgReporter = exports.CommandArgWorkspaceId = exports.CommandArgVersion = exports.CommandArgVariables = exports.CommandArgUrlApi = void 0;
+exports.CommandArgUrl = exports.CommandArgTrainerVersion = exports.CommandArgTo = exports.CommandArgSilent = exports.CommandArgRevision = exports.CommandArgMaxHeartbeatAge = exports.CommandArgPlanId = exports.CommandArgContentTypes = exports.CommandArgPreview = exports.CommandArgOutputFilePath = exports.CommandArgOutput = exports.CommandArgNoPrompt = exports.CommandArgPrompt = exports.CommandArgPortNumber = exports.CommandArgName = exports.CommandArgMablBranchChangesOnly = exports.CommandArgMablBranch = exports.CommandArgMablAutoLogin = exports.CommandArgMablAutoBranch = exports.CommandArgLinkBypass = exports.CommandArgLinkLabel = exports.CommandArgLimitOutput = exports.CommandArgLabels = exports.CommandArgLabelsInclude = exports.CommandArgLabelsExclude = exports.CommandArgTestInteractionSpeed = exports.CommandArgTestRunId = exports.CommandArgTestFile = exports.CommandArgId = exports.CommandArgUserAgent = exports.CommandArgHttpHeaders = exports.CommandArgHelp = exports.CommandArgFromPlanId = exports.CommandArgFrom = exports.CommandArgFormat = exports.CommandArgFastFailure = exports.CommandArgOverrideEnvironmentId = exports.CommandArgEnvironmentId = exports.CommandArgEnableLink = exports.CommandArgDetailLevel = exports.CommandArgDescription = exports.CommandArgDeploymentId = exports.CommandArgDecrypt = exports.CommandArgDataTables = exports.CommandArgCredentials = exports.CommandArgBasicAuthCredentials = exports.CommandArgBrowsers = exports.CommandArgBrowser = exports.CommandArgApplicationId = exports.CommandArgApiKey = void 0;
+exports.BrowserTypeSelections = exports.DefaultBrowserType = exports.DefaultBranchName = exports.DefaultOutputFormatChoices = exports.DetailLevelFormats = exports.ReporterOptions = exports.OutputFormats = exports.CommandArgAliases = exports.CommandArgBrowserEnableExtensions = exports.CommandArgBrowserIgnoreCertificateErrors = exports.CommandArgBrowserDisableIsolation = exports.ListTimeFormat = exports.CommandArgReporterOptions = exports.CommandArgReporter = exports.CommandArgWorkspaceId = exports.CommandArgVersion = exports.CommandArgVariables = exports.CommandArgUrlApi = exports.CommandArgUrlApp = void 0;
 const browserTypes_1 = require("./browserTypes");
 exports.CommandArgApiKey = 'api-key';
 exports.CommandArgApplicationId = 'application-id';
+exports.CommandArgBrowser = 'browser';
 exports.CommandArgBrowsers = 'browsers';
 exports.CommandArgBasicAuthCredentials = 'basic-auth-credentials-id';
 exports.CommandArgCredentials = 'credentials-id';
@@ -107,10 +108,11 @@ exports.DefaultOutputFormatChoices = [
     OutputFormats.Yaml,
 ];
 exports.DefaultBranchName = 'master';
-exports.DefaultBrowserType = browserTypes_1.BrowserTypes.Chrome;
+exports.DefaultBrowserType = browserTypes_1.BrowserType.Chrome;
 exports.BrowserTypeSelections = [
-    browserTypes_1.BrowserTypes.Chrome,
-    browserTypes_1.BrowserTypes.Firefox,
-    browserTypes_1.BrowserTypes.InternetExplorer,
-    browserTypes_1.BrowserTypes.Safari,
+    browserTypes_1.BrowserType.Chrome,
+    browserTypes_1.BrowserType.Edge,
+    browserTypes_1.BrowserType.Firefox,
+    browserTypes_1.BrowserType.InternetExplorer,
+    browserTypes_1.BrowserType.Safari,
 ].map((browser) => browser.toString());