@mablhq/mabl-cli 1.17.0 → 1.17.6

package/browserLauncher/playwrightBrowserLauncher/playwrightBrowserLauncher.js

@@ -23,20 +23,22 @@ class PlaywrightBrowserLauncher {
             :
                 null;
         const defaultContext = await test_1.chromium.launchPersistentContext(options.userDataDir, {
-            ignoreHTTPSErrors: true,
-            headless: options.headless,
+            acceptDownloads: true,
             args: options.args,
-            ignoreDefaultArgs: options.ignoreDefaultArgs,
+            bypassCSP: options.bypassContentSecurityPolicy,
+            deviceScaleFactor: (_a = options.defaultDeviceDescriptor) === null || _a === void 0 ? void 0 : _a.deviceScaleFactor,
             downloadsPath: options.downloadPath,
             executablePath: options.executablePath,
-            viewport,
-            acceptDownloads: true,
-            httpCredentials: options.credentials,
             extraHTTPHeaders: options.extraHttpHeaders,
-            isMobile: (_a = options.defaultDeviceDescriptor) === null || _a === void 0 ? void 0 : _a.isMobile,
-            deviceScaleFactor: (_b = options.defaultDeviceDescriptor) === null || _b === void 0 ? void 0 : _b.deviceScaleFactor,
-            hasTouch: (_c = options.defaultDeviceDescriptor) === null || _c === void 0 ? void 0 : _c.hasTouch,
+            hasTouch: (_b = options.defaultDeviceDescriptor) === null || _b === void 0 ? void 0 : _b.hasTouch,
+            headless: options.headless,
+            httpCredentials: options.credentials,
+            ignoreDefaultArgs: options.ignoreDefaultArgs,
+            ignoreHTTPSErrors: true,
+            isMobile: (_c = options.defaultDeviceDescriptor) === null || _c === void 0 ? void 0 : _c.isMobile,
             timeout: BROWSER_LAUNCH_TIMEOUT_MS,
+            userAgent: options.userAgent,
+            viewport,
         });
         return new playwrightBrowser_1.PlaywrightBrowser(defaultContext, path_1.default.join(options.downloadPath, 'final'), '');
     }

package/browserLauncher/puppeteerBrowserLauncher/puppeteerBrowser.js

@@ -11,12 +11,13 @@ const puppeteerBrowserLauncher_1 = require("./puppeteerBrowserLauncher");
 const puppeteerPage_1 = require("./puppeteerPage");
 const runnerType_1 = require("../runnerType");
 class PuppeteerBrowser extends events_1.default {
-    constructor(browser, downloadDirectory, credentials) {
+    constructor(browser, downloadDirectory, credentials, userAgent) {
         var _a;
         super();
         this.browser = browser;
         this.downloadDirectory = downloadDirectory;
         this.credentials = credentials;
+        this.userAgent = userAgent;
         this.puppeteerPages = new Map();
         (_a = this.browser
             .process()) === null || _a === void 0 ? void 0 : _a.on('close', () => this.emit(browserLauncher_1.BrowserEvent.BrowserDestroyed));

package/browserLauncher/puppeteerBrowserLauncher/puppeteerBrowserLauncher.js

@@ -18,7 +18,7 @@ class PuppeteerBrowserLauncher {
         const browser = new puppeteerBrowser_1.PuppeteerBrowser(await puppeteer_core_1.default.launch({
             ignoreHTTPSErrors: true,
             ...options,
-        }), options.downloadPath, options.credentials);
+        }), options.downloadPath, options.credentials, options.userAgent);
         if (options.downloadPath) {
             await browser.setDownloadBehavior(options.downloadPath);
         }

package/browserLauncher/puppeteerBrowserLauncher/puppeteerPage.js

@@ -59,6 +59,9 @@ class PuppeteerPage extends events_1.default {
         if (this.browser.credentials !== undefined) {
             await this.page.authenticate(this.browser.credentials);
         }
+        if (this.browser.userAgent) {
+            await this.page.setUserAgent(this.browser.userAgent);
+        }
         const opener = await ((_a = this.page.target().opener()) === null || _a === void 0 ? void 0 : _a.page());
         this.openerPage = await (0, utils_1.mapIfNotNull)(opener, (page) => this.browser.getOrCreatePage(page));
     }

package/commands/constants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommandArgVariables = exports.CommandArgUrlApi = exports.CommandArgUrlApp = exports.CommandArgUrl = exports.CommandArgTrainerVersion = exports.CommandArgTo = exports.CommandArgSilent = exports.CommandArgRevision = 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.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 = void 0;
+exports.CommandArgUrlApi = exports.CommandArgUrlApp = exports.CommandArgUrl = exports.CommandArgTrainerVersion = exports.CommandArgTo = exports.CommandArgSilent = exports.CommandArgRevision = 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 = void 0;
 const browserTypes_1 = require("./browserTypes");
 exports.CommandArgApiKey = 'api-key';
 exports.CommandArgApplicationId = 'application-id';
@@ -22,6 +22,7 @@ exports.CommandArgFrom = 'from';
 exports.CommandArgFromPlanId = 'from-plan-id';
 exports.CommandArgHelp = 'help';
 exports.CommandArgHttpHeaders = 'http-headers';
+exports.CommandArgUserAgent = 'user-agent';
 exports.CommandArgId = 'id';
 exports.CommandArgTestFile = 'test-file';
 exports.CommandArgTestRunId = 'run-id';

package/commands/tests/testsUtil.js

@@ -138,15 +138,17 @@ async function createBrowserWithAuthedExtension(accessToken, browserWidth, brows
 }
 exports.createBrowserWithAuthedExtension = createBrowserWithAuthedExtension;
 async function launchBrowserInstance(chromePath, launchArgs, userDataDir, headless, credentials, options) {
-    const { defaultDeviceDescriptor, extraHttpHeaders, ignoreDefaultArgs, runnerType, loggerFunc, } = options || {};
+    const { bypassContentSecurityPolicy, defaultDeviceDescriptor, extraHttpHeaders, ignoreDefaultArgs, runnerType, loggerFunc, userAgent, } = options || {};
     let browser;
     try {
         browser = await maybeLaunchBrowser(chromePath, launchArgs, userDataDir, headless, credentials, {
+            bypassContentSecurityPolicy,
             defaultDeviceDescriptor,
             extraHttpHeaders,
             ignoreDefaultArgs,
             runnerType,
             loggerFunc,
+            userAgent,
         });
     }
     catch (error) {
@@ -154,6 +156,7 @@ async function launchBrowserInstance(chromePath, launchArgs, userDataDir, headle
             launchArgs.push('--no-sandbox');
             messaging_1.mablEventEmitter.log('Unable to initialize browser with standard settings, attempting to run with --no-sandbox setting', Date.now(), logLineMessaging_1.LogLineColor.yellow);
             return maybeLaunchBrowser(chromePath, launchArgs, userDataDir, headless, credentials, {
+                bypassContentSecurityPolicy,
                 defaultDeviceDescriptor,
                 ignoreDefaultArgs,
                 runnerType,
@@ -168,8 +171,9 @@ async function launchBrowserInstance(chromePath, launchArgs, userDataDir, headle
     return browser;
 }
 function maybeLaunchBrowser(chromePath, launchArgs, userDataDir, headless, credentials, options) {
-    const { defaultDeviceDescriptor, extraHttpHeaders, ignoreDefaultArgs, runnerType, loggerFunc, } = options || {};
+    const { bypassContentSecurityPolicy, defaultDeviceDescriptor, extraHttpHeaders, ignoreDefaultArgs, runnerType, loggerFunc, userAgent, } = options || {};
     return browserLauncher_1.BrowserLauncherFactory.createRunner(runnerType, loggerFunc).launch({
+        bypassContentSecurityPolicy,
         defaultDeviceDescriptor,
         executablePath: chromePath,
         extraHttpHeaders,
@@ -179,6 +183,7 @@ function maybeLaunchBrowser(chromePath, launchArgs, userDataDir, headless, crede
         userDataDir,
         downloadPath: createDownloadDirectory(),
         credentials,
+        userAgent,
     });
 }
 async function prepareChromePreferencesDirectory(browserPreferences) {
@@ -203,7 +208,7 @@ function removeTempBrowserPreferencesDirectory(tempDirPath) {
     }
 }
 async function createBrowser(browserWidth, browserHeight, headless, containerTesting, tempBrowserPreferencesDirectory, options) {
-    const { credentials, browserPath, disableIsolation, extraHttpHeaders, ignoreCertificateErrors, emulationConfig, enableExtensions, runnerType, loggerFunc, resourcesDirectoryOverride, } = options || {};
+    const { bypassContentSecurityPolicy, credentials, browserPath, disableIsolation, extraHttpHeaders, ignoreCertificateErrors, emulationConfig, enableExtensions, runnerType, loggerFunc, resourcesDirectoryOverride, userAgent, } = options || {};
     const chromePath = browserPath !== null && browserPath !== void 0 ? browserPath : findChrome();
     if (!chromePath.length) {
         messaging_1.mablEventEmitter.log(chalk.yellow('Could not find a local install of Chrome to use, please ensure you have it installed and try again'));
@@ -227,11 +232,13 @@ async function createBrowser(browserWidth, browserHeight, headless, containerTes
         ignoreDefaultArgs = ['--disable-extensions'];
     }
     const maybeBrowser = await launchBrowserInstance(chromePath, launchArgs, tempBrowserPreferencesDirectory, headless, credentials, {
+        bypassContentSecurityPolicy,
         defaultDeviceDescriptor,
         extraHttpHeaders,
         ignoreDefaultArgs,
         runnerType,
         loggerFunc,
+        userAgent: userAgent !== null && userAgent !== void 0 ? userAgent : emulationConfig === null || emulationConfig === void 0 ? void 0 : emulationConfig.device_config.user_agent,
     });
     if (!maybeBrowser) {
         throw new Error('Unable to start Chrome session');
@@ -244,9 +251,6 @@ function addLaunchArgs(launchArgs, browserWidth, browserHeight, fakeMicrophoneMe
     var _a, _b;
     const defaultDeviceDescriptor = (0, mobileEmulationUtil_1.getDeviceDescriptorForEmulation)(emulationConfig);
     launchArgs.push(`--window-size=${(_a = defaultDeviceDescriptor === null || defaultDeviceDescriptor === void 0 ? void 0 : defaultDeviceDescriptor.width) !== null && _a !== void 0 ? _a : browserWidth},${(_b = defaultDeviceDescriptor === null || defaultDeviceDescriptor === void 0 ? void 0 : defaultDeviceDescriptor.height) !== null && _b !== void 0 ? _b : browserHeight}`);
-    if (emulationConfig === null || emulationConfig === void 0 ? void 0 : emulationConfig.device_config.user_agent) {
-        launchArgs.push(`--user-agent=${emulationConfig === null || emulationConfig === void 0 ? void 0 : emulationConfig.device_config.user_agent}`);
-    }
     launchArgs.push('--use-fake-ui-for-media-stream');
     launchArgs.push('--use-fake-device-for-media-stream');
     launchArgs.push(`--use-file-for-fake-audio-capture=${fakeMicrophoneMediaPath}`);
@@ -281,6 +285,7 @@ async function createBrowserForExecutionEngine(browserWidth, browserHeight, head
         defaultDeviceDescriptor,
         runnerType,
         loggerFunc,
+        userAgent: emulationConfig === null || emulationConfig === void 0 ? void 0 : emulationConfig.device_config.user_agent,
     });
     if (!maybeBrowser) {
         throw new Error('Unable to start Chrome session');

package/commands/tests/tests_cmds/run.js

@@ -149,6 +149,10 @@ exports.builder = (yargs) => {
         .option(constants_1.CommandArgHttpHeaders, {
         describe: 'Space delimited HTTP headers added to browser requests (e.g. "x-header:foo")',
         type: 'array',
+    })
+        .option(constants_1.CommandArgUserAgent, {
+        describe: 'Emulates a custom user-agent (e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4651.0 Safari/537.36")',
+        type: 'string',
     })
         .option(constants_1.CommandArgTestInteractionSpeed, {
         describe: 'Set the speed that mabl interacts with webpages. Overrides test run settings if specified.',
@@ -200,6 +204,7 @@ async function run(parsed) {
         testFile: parsed[constants_1.CommandArgTestFile],
         runId: parsed['run-id'],
         url: parsed.url,
+        userAgent: parsed[constants_1.CommandArgUserAgent],
         width: parsed.width,
         workspaceId,
     };