@mablhq/mabl-cli 1.12.38 → 1.13.14

package/api/basicApiClient.js

@@ -28,6 +28,7 @@ const httpUtil_1 = require("../util/httpUtil");
 const axios_1 = __importDefault(require("axios"));
 const os = __importStar(require("os"));
 const async_retry_1 = __importDefault(require("async-retry"));
+const asyncUtil_1 = require("../util/asyncUtil");
 const MABL_ENTITY_VERSION_HEADER = 'x-mabl-entity-version';
 const DEFAULT_MAX_TOTAL_RETRY_TIME_MILLISECONDS = 300000;
 const DEFAULT_MIN_RETRY_TIMEOUT_MILLISECONDS = 100;
@@ -64,6 +65,9 @@ class BasicApiClient {
                 'x-mabl-user-platform': `${os.platform()}-${os.release()}`,
             },
         };
+        if (options.userAgentOverride) {
+            config.headers[httpUtil_1.USER_AGENT_HEADER] = options.userAgentOverride;
+        }
         this.httpClient = axios_1.default.create(config);
         this.retryConfig = options.retryConfig;
     }
@@ -129,20 +133,26 @@ class BasicApiClient {
             maxRetryTime: (_h = (_g = this.retryConfig) === null || _g === void 0 ? void 0 : _g.maxRetryTimeMillis) !== null && _h !== void 0 ? _h : DEFAULT_MAX_TOTAL_RETRY_TIME_MILLISECONDS,
             forever: false,
         };
-        return async_retry_1.default(async (bail) => requestFunc().catch((error) => {
+        return asyncUtil_1.promiseWithTimeout(async_retry_1.default(async (bail) => {
             var _a, _b;
-            const statusCode = (_a = error.statusCode) !== null && _a !== void 0 ? _a : (_b = error.response) === null || _b === void 0 ? void 0 : _b.status;
-            if (statusCode === 429 ||
-                statusCode === 502 ||
-                statusCode === 503 ||
-                statusCode === 504) {
-                throw error;
+            try {
+                return await requestFunc();
             }
-            else {
-                bail(error);
-                return {};
+            catch (error) {
+                const axiosError = error;
+                const statusCode = (_a = axiosError.code) !== null && _a !== void 0 ? _a : (_b = axiosError.response) === null || _b === void 0 ? void 0 : _b.status;
+                if (statusCode === 429 ||
+                    statusCode === 502 ||
+                    statusCode === 503 ||
+                    statusCode === 504) {
+                    throw error;
+                }
+                else {
+                    bail(error);
+                    return {};
+                }
             }
-        }), retryOptions);
+        }, retryOptions), DEFAULT_MAX_TOTAL_RETRY_TIME_MILLISECONDS + 1000, 'Retryable API request');
     }
 }
 exports.BasicApiClient = BasicApiClient;

package/api/mablApiClientFactory.js

@@ -45,6 +45,7 @@ class MablApiClientFactory {
                 proxyUrl: httpConfig.proxyHost,
                 sslVerify: httpConfig.sslVerify,
                 retryConfig: RETRY_CONFIG,
+                userAgentOverride: opts.userAgentOverride,
             });
         }
         const authProvider = new authenticationProvider_1.AuthenticationProvider();

package/browserLauncher/browserLauncherFactory.js

@@ -15,7 +15,7 @@ class BrowserLauncherFactory {
         var _a;
         return (_a = process.env.MABL_RUNNER) === null || _a === void 0 ? void 0 : _a.toLowerCase();
     }
-    static createRunner(runnerType = runnerType_1.RunnerType.Puppeteer, loggerFunc) {
+    static createRunner(runnerType = runnerType_1.RunnerType.Playwright, loggerFunc) {
         const runnerFromEnv = BrowserLauncherFactory.getRunnerFromEnvironment();
         const runner = runnerFromEnv ? runnerFromEnv : runnerType;
         loggerFunc = loggerFunc !== null && loggerFunc !== void 0 ? loggerFunc : ((line) => logUtils_1.logCliOutput(loggingProvider_1.LogLevel.Info, line));

package/browserLauncher/playwrightBrowserLauncher/playwrightBrowser.js

@@ -29,6 +29,7 @@ const browserLauncher_1 = require("../browserLauncher");
 const playwrightPage_1 = require("./playwrightPage");
 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) {
         super();
@@ -49,6 +50,9 @@ class PlaywrightBrowser extends events_1.default {
             fs_extra_1.default.mkdirSync(path_1.default.join(this.downloadDirectory));
         }
     }
+    getRunnerType() {
+        return runnerType_1.RunnerType.Playwright;
+    }
     makeCdpCall(method, paramArgs) {
         return this.cdpSession.send(method, paramArgs);
     }

package/browserLauncher/playwrightBrowserLauncher/playwrightDom.js

@@ -19,13 +19,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlaywrightElementHandle = exports.PlaywrightJsHandle = exports.DEFAULT_TEXT_INPUT_TIMEOUT_MS = void 0;
+exports.PlaywrightElementHandle = exports.PlaywrightJsHandle = exports.NAVIGATION_ERROR_MESSAGE = void 0;
 const playwright = __importStar(require("@playwright/test"));
+const types_1 = require("../types");
 const utils_1 = require("../utils");
 const logUtils_1 = require("../../util/logUtils");
 const elementHandle_1 = require("../elementHandle");
 const testsUtil_1 = require("../../commands/tests/testsUtil");
-exports.DEFAULT_TEXT_INPUT_TIMEOUT_MS = 30000;
+exports.NAVIGATION_ERROR_MESSAGE = 'waiting for scheduled navigations to finish';
 class PlaywrightJsHandle {
     constructor(handle, page) {
         this.handle = handle;
@@ -125,15 +126,40 @@ class PlaywrightElementHandle extends PlaywrightJsHandle {
     async boundingBox() {
         return utils_1.mapIfNotNull(await this.element.boundingBox(), (boundingBox) => boundingBox);
     }
-    click(options) {
-        var _a, _b;
-        return this.element.click({
-            clickCount: (_a = options === null || options === void 0 ? void 0 : options.clickCount) !== null && _a !== void 0 ? _a : 1,
-            force: (_b = options === null || options === void 0 ? void 0 : options.force) !== null && _b !== void 0 ? _b : true,
-        });
+    async click(options) {
+        var _a, _b, _c, _d;
+        const trial = (_a = options === null || options === void 0 ? void 0 : options.trial) !== null && _a !== void 0 ? _a : false;
+        try {
+            await this.element.click({
+                clickCount: (_b = options === null || options === void 0 ? void 0 : options.clickCount) !== null && _b !== void 0 ? _b : 1,
+                force: (_c = options === null || options === void 0 ? void 0 : options.force) !== null && _c !== void 0 ? _c : !trial,
+                timeout: (_d = options === null || options === void 0 ? void 0 : options.timeout) !== null && _d !== void 0 ? _d : types_1.DefaultTimeouts.quickActionTimeoutMs,
+                trial,
+            });
+        }
+        catch (error) {
+            if (error.message.includes(exports.NAVIGATION_ERROR_MESSAGE)) {
+                logUtils_1.logInternal(`Action timed out due to navigation timeout. ${error.toString()}`);
+                return;
+            }
+            throw error;
+        }
     }
-    doubleClick() {
-        return this.element.dblclick();
+    async doubleClick(options) {
+        var _a, _b, _c;
+        try {
+            const trial = (_a = options === null || options === void 0 ? void 0 : options.trial) !== null && _a !== void 0 ? _a : false;
+            return this.element.dblclick({
+                force: (_b = options === null || options === void 0 ? void 0 : options.force) !== null && _b !== void 0 ? _b : !trial,
+                timeout: (_c = options === null || options === void 0 ? void 0 : options.timeout) !== null && _c !== void 0 ? _c : types_1.DefaultTimeouts.quickActionTimeoutMs,
+                trial,
+            });
+        }
+        catch (error) {
+            if (error.message.includes(exports.NAVIGATION_ERROR_MESSAGE)) {
+                logUtils_1.logInternal(`Action timed out due to navigation timeout. ${error.toString()}`);
+            }
+        }
     }
     async clickablePoint() {
         var _a;
@@ -175,7 +201,7 @@ class PlaywrightElementHandle extends PlaywrightJsHandle {
         var _a;
         let timeout;
         const newTimeout = text.length * ((_a = options === null || options === void 0 ? void 0 : options.delay) !== null && _a !== void 0 ? _a : 1) * 2;
-        if (newTimeout > exports.DEFAULT_TEXT_INPUT_TIMEOUT_MS) {
+        if (newTimeout > types_1.DefaultTimeouts.defaultTextInputTimeoutMs) {
             timeout = newTimeout;
         }
         return timeout;
@@ -239,7 +265,7 @@ class PlaywrightElementHandle extends PlaywrightJsHandle {
     }
     async makeCdpCall(method, paramArgs) {
         var _a;
-        return ((_a = this.cdpSession) !== null && _a !== void 0 ? _a : (await this.page.getCdpSession())).send(method, paramArgs);
+        return ((_a = this.cdpSession) !== null && _a !== void 0 ? _a : this.page.getCdpSession()).send(method, paramArgs);
     }
 }
 exports.PlaywrightElementHandle = PlaywrightElementHandle;

package/browserLauncher/playwrightBrowserLauncher/playwrightPage.js

@@ -69,6 +69,7 @@ class PlaywrightPage extends events_1.default {
     }
     async waitForInitialization() {
         this.openerPage = await utils_1.mapIfNotNull(await this.page.opener(), (page) => this.browser.getOrCreatePage(page));
+        this.fallbackCdpSession = await this.createFallbackCdpSession();
     }
     on(event, listener) {
         this.wireEvents(event);
@@ -81,56 +82,62 @@ class PlaywrightPage extends events_1.default {
         return this;
     }
     wireEvents(event) {
-        if (event === browserLauncher_1.PageEvent.RequestWillBeSentExtraInfo &&
-            !this.listenerCount(event)) {
-            void this.getCdpSession().then((session) => session.on('Network.requestWillBeSentExtraInfo', (event) => {
-                this.emit(browserLauncher_1.PageEvent.RequestWillBeSentExtraInfo, event);
-            }));
-        }
-        if (event === browserLauncher_1.PageEvent.Response && !this.listenerCount(event)) {
-            this.page.on('response', (event) => {
-                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));
-            });
-        }
-        if (event === browserLauncher_1.PageEvent.FrameAttached && !this.listenerCount(event)) {
-            this.page.on('frameattached', (frame) => {
-                this.emit(browserLauncher_1.PageEvent.FrameAttached, this.getOrCreateFrame(frame));
-            });
-        }
-        if (event === browserLauncher_1.PageEvent.Console && !this.listenerCount(event)) {
-            this.page.on('console', (console) => {
-                this.emit(browserLauncher_1.PageEvent.Console, new wrappers_1.PlaywrightWrappedConsoleMessage(console, this));
-            });
-        }
-        if (event === browserLauncher_1.PageEvent.PageError && !this.listenerCount(event)) {
-            this.page.on('pageerror', (error) => {
-                this.emit(browserLauncher_1.PageEvent.PageError, error);
-            });
-        }
-        if (event === browserLauncher_1.PageEvent.Error && !this.listenerCount(event)) {
-            this.page.on('crash', (error) => {
-                this.emit(browserLauncher_1.PageEvent.Error, error);
-            });
-        }
-        if (event === browserLauncher_1.PageEvent.TracingBufferUsage && !this.listenerCount(event)) {
-            void this.getCdpSession().then((session) => session.on('Tracing.bufferUsage', (tracing) => {
-                this.emit(browserLauncher_1.PageEvent.TracingBufferUsage, tracing);
-            }));
+        try {
+            if (event === browserLauncher_1.PageEvent.RequestWillBeSentExtraInfo &&
+                !this.listenerCount(event)) {
+                this.getCdpSession().on('Network.requestWillBeSentExtraInfo', (event) => {
+                    this.emit(browserLauncher_1.PageEvent.RequestWillBeSentExtraInfo, event);
+                });
+            }
+            if (event === browserLauncher_1.PageEvent.Response && !this.listenerCount(event)) {
+                this.page.on('response', (event) => {
+                    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));
+                });
+            }
+            if (event === browserLauncher_1.PageEvent.FrameAttached && !this.listenerCount(event)) {
+                this.page.on('frameattached', (frame) => {
+                    this.emit(browserLauncher_1.PageEvent.FrameAttached, this.getOrCreateFrame(frame));
+                });
+            }
+            if (event === browserLauncher_1.PageEvent.Console && !this.listenerCount(event)) {
+                this.page.on('console', (console) => {
+                    this.emit(browserLauncher_1.PageEvent.Console, new wrappers_1.PlaywrightWrappedConsoleMessage(console, this));
+                });
+            }
+            if (event === browserLauncher_1.PageEvent.PageError && !this.listenerCount(event)) {
+                this.page.on('pageerror', (error) => {
+                    this.emit(browserLauncher_1.PageEvent.PageError, error);
+                });
+            }
+            if (event === browserLauncher_1.PageEvent.Error && !this.listenerCount(event)) {
+                this.page.on('crash', (error) => {
+                    this.emit(browserLauncher_1.PageEvent.Error, error);
+                });
+            }
+            if (event === browserLauncher_1.PageEvent.TracingBufferUsage &&
+                !this.listenerCount(event)) {
+                this.getCdpSession().on('Tracing.bufferUsage', (tracing) => {
+                    this.emit(browserLauncher_1.PageEvent.TracingBufferUsage, tracing);
+                });
+            }
+            if (event === browserLauncher_1.PageEvent.TracingComplete && !this.listenerCount(event)) {
+                this.getCdpSession().on('Tracing.tracingComplete', (tracingComplete) => {
+                    this.emit(browserLauncher_1.PageEvent.TracingComplete, tracingComplete);
+                });
+            }
         }
-        if (event === browserLauncher_1.PageEvent.TracingComplete && !this.listenerCount(event)) {
-            void this.getCdpSession().then((session) => session.on('Tracing.tracingComplete', (tracingComplete) => {
-                this.emit(browserLauncher_1.PageEvent.TracingComplete, tracingComplete);
-            }));
+        catch (error) {
+            logUtils_1.logInternal(`Unable to register event ${event.toString()}. Error: ${error}`);
         }
     }
     async screenshot(clip) {
@@ -329,9 +336,9 @@ class PlaywrightPage extends events_1.default {
         throw new Error('PlaywrightPage.setExtraHTTPHeaders not implemented');
     }
     makeCdpCall(method, paramArgs) {
-        return this.getCdpSession().then((session) => session.send(method, paramArgs));
+        return this.getCdpSession().send(method, paramArgs);
     }
-    async getCdpSession() {
+    getCdpSession() {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         if (((_c = (_b = (_a = this.getPageImpl()) === null || _a === void 0 ? void 0 : _a._delegate) === null || _b === void 0 ? void 0 : _b._mainFrameSession) === null || _c === void 0 ? void 0 : _c._client) === undefined) {
             const undefinedField = ((_e = (_d = this.getPageImpl()) === null || _d === void 0 ? void 0 : _d._delegate) === null || _e === void 0 ? void 0 : _e._mainFrameSession) !== undefined
@@ -342,13 +349,10 @@ class PlaywrightPage extends events_1.default {
             logUtils_1.logInternal(`Unable to get the CDP Session of the page (${undefinedField} is undefined).
         Creating a fallback session. Some functionality might not work as expected.`);
         }
-        return ((_k = (_j = (_h = (_g = this.getPageImpl()) === null || _g === void 0 ? void 0 : _g._delegate) === null || _h === void 0 ? void 0 : _h._mainFrameSession) === null || _j === void 0 ? void 0 : _j._client) !== null && _k !== void 0 ? _k : this.getOrCreateFallbackCdpSession());
+        return ((_k = (_j = (_h = (_g = this.getPageImpl()) === null || _g === void 0 ? void 0 : _g._delegate) === null || _h === void 0 ? void 0 : _h._mainFrameSession) === null || _j === void 0 ? void 0 : _j._client) !== null && _k !== void 0 ? _k : this.fallbackCdpSession);
     }
-    async getOrCreateFallbackCdpSession() {
-        if (this.fallbackCdpSession === undefined) {
-            this.fallbackCdpSession = await this.browser.defaultContext.newCDPSession(this.page);
-        }
-        return this.fallbackCdpSession;
+    createFallbackCdpSession() {
+        return this.browser.defaultContext.newCDPSession(this.page);
     }
     async getWindowInfo() {
         return this.makeCdpCall('Browser.getWindowForTarget', { targetId: this.getPageId() });

package/browserLauncher/puppeteerBrowserLauncher/puppeteerBrowser.js

@@ -9,6 +9,7 @@ const puppeteer_core_1 = __importDefault(require("puppeteer-core"));
 const events_1 = __importDefault(require("events"));
 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) {
         var _a;
@@ -38,6 +39,9 @@ class PuppeteerBrowser extends events_1.default {
             state: event.state,
         }));
     }
+    getRunnerType() {
+        return runnerType_1.RunnerType.Puppeteer;
+    }
     getDownloadDirectory() {
         return this.downloadDirectory;
     }

package/browserLauncher/puppeteerBrowserLauncher/puppeteerElementHandle.js

@@ -35,9 +35,15 @@ class PuppeteerElementHandle extends puppeteerJsHandle_1.PuppeteerJsHandle {
         return this.element.hover();
     }
     click(options) {
+        if (options === null || options === void 0 ? void 0 : options.trial) {
+            return Promise.resolve();
+        }
         return this.element.click(options);
     }
-    async doubleClick() {
+    async doubleClick(options) {
+        if (options === null || options === void 0 ? void 0 : options.trial) {
+            return Promise.resolve();
+        }
         await this.element.click();
         await testsUtil_1.sleep(msBetweenClicks);
         return this.element.click({ clickCount: 2 });

package/browserLauncher/types.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WaitForOptions = exports.LifecycleEvent = void 0;
+exports.WaitForOptions = exports.LifecycleEvent = exports.DefaultTimeouts = void 0;
+class DefaultTimeouts {
+}
+exports.DefaultTimeouts = DefaultTimeouts;
+DefaultTimeouts.quickActionTimeoutMs = 5000;
+DefaultTimeouts.defaultTextInputTimeoutMs = 30000;
 var LifecycleEvent;
 (function (LifecycleEvent) {
     LifecycleEvent["DomContentLoaded"] = "domcontentloaded";