automation_model 1.0.396-dev → 1.0.396-stage

package/lib/stable_browser.js

@@ -13,6 +13,8 @@ import { getTableCells, getTableData } from "./table_analyze.js";
 import objectPath from "object-path";
 import { decrypt } from "./utils.js";
 import csv from "csv-parser";
+import { Readable } from "node:stream";
+import readline from "readline";
 const Types = {
     CLICK: "click_element",
     NAVIGATE: "navigate",
@@ -28,6 +30,7 @@ const Types = {
     SELECT: "select_combobox",
     VERIFY_PAGE_PATH: "verify_page_path",
     TYPE_PRESS: "type_press",
+    PRESS: "press_key",
     HOVER: "hover_element",
     CHECK: "check_element",
     UNCHECK: "uncheck_element",
@@ -36,6 +39,8 @@ const Types = {
     SET_DATE_TIME: "set_date_time",
     SET_VIEWPORT: "set_viewport",
     VERIFY_VISUAL: "verify_visual",
+    LOAD_DATA: "load_data",
+    SET_INPUT: "set_input",
 };
 class StableBrowser {
     constructor(browser, page, logger = null, context = null) {
@@ -81,9 +86,20 @@ class StableBrowser {
             this.page = page;
             context.page = page;
             context.pages.push(page);
-            this.webLogFile = this.getWebLogFile(logFolder);
-            this.registerConsoleLogListener(page, context, this.webLogFile);
-            this.registerRequestListener();
+            page.on("close", async () => {
+                if (this.context && this.context.pages && this.context.pages.length > 1) {
+                    this.context.pages.pop();
+                    this.page = this.context.pages[this.context.pages.length - 1];
+                    this.context.page = this.page;
+                    try {
+                        let title = await this.page.title();
+                        console.log("Switched to page " + title);
+                    }
+                    catch (error) {
+                        console.error("Error on page close", error);
+                    }
+                }
+            });
             try {
                 await this.waitForPageLoad();
                 console.log("Switch page: " + (await page.title()));
@@ -178,24 +194,78 @@ class StableBrowser {
         }
         return text;
     }
-    _getLocator(locator, scope, _params) {
-        if (locator.type === "pw_selector") {
-            return scope.locator(locator.selector);
+    _fixLocatorUsingParams(locator, _params) {
+        // check if not null
+        if (!locator) {
+            return locator;
+        }
+        // clone the locator
+        locator = JSON.parse(JSON.stringify(locator));
+        this.scanAndManipulate(locator, _params);
+        return locator;
+    }
+    _isObject(value) {
+        return value && typeof value === "object" && value.constructor === Object;
+    }
+    scanAndManipulate(currentObj, _params) {
+        for (const key in currentObj) {
+            if (typeof currentObj[key] === "string") {
+                // Perform string manipulation
+                currentObj[key] = this._fixUsingParams(currentObj[key], _params);
+            }
+            else if (this._isObject(currentObj[key])) {
+                // Recursively scan nested objects
+                this.scanAndManipulate(currentObj[key], _params);
+            }
         }
+    }
+    _getLocator(locator, scope, _params) {
+        locator = this._fixLocatorUsingParams(locator, _params);
+        let locatorReturn;
         if (locator.role) {
             if (locator.role[1].nameReg) {
                 locator.role[1].name = reg_parser(locator.role[1].nameReg);
                 delete locator.role[1].nameReg;
             }
-            if (locator.role[1].name) {
-                locator.role[1].name = this._fixUsingParams(locator.role[1].name, _params);
-            }
-            return scope.getByRole(locator.role[0], locator.role[1]);
+            // if (locator.role[1].name) {
+            //   locator.role[1].name = this._fixUsingParams(locator.role[1].name, _params);
+            // }
+            locatorReturn = scope.getByRole(locator.role[0], locator.role[1]);
         }
         if (locator.css) {
-            return scope.locator(this._fixUsingParams(locator.css, _params));
+            locatorReturn = scope.locator(locator.css);
+        }
+        // handle role/name locators
+        // locator.selector will be something like: textbox[name="Username"i]
+        if (locator.engine === "internal:role") {
+            // extract the role, name and the i/s flags using regex
+            const match = locator.selector.match(/(.*)\[(.*)="(.*)"(.*)\]/);
+            if (match) {
+                const role = match[1];
+                const name = match[3];
+                const flags = match[4];
+                locatorReturn = scope.getByRole(role, { name }, { exact: flags === "i" });
+            }
+        }
+        if (locator === null || locator === void 0 ? void 0 : locator.engine) {
+            if (locator.engine === "css") {
+                locatorReturn = scope.locator(locator.selector);
+            }
+            else {
+                let selector = locator.selector;
+                if (locator.engine === "internal:attr") {
+                    if (!selector.startsWith("[")) {
+                        selector = `[${selector}]`;
+                    }
+                }
+                locatorReturn = scope.locator(`${locator.engine}=${selector}`);
+            }
+        }
+        if (!locatorReturn) {
+            console.error(locator);
+            throw new Error("Locator undefined");
         }
-        throw new Error("unknown locator type");
+        return locatorReturn;
     }
     async _locateElmentByTextClimbCss(scope, text, climb, css, _params) {
         let result = await this._locateElementByText(scope, this._fixUsingParams(text, _params), "*", false, true, _params);
@@ -406,6 +476,8 @@ class StableBrowser {
                 if (result.foundElements.length > 0) {
                     let dialogCloseLocator = result.foundElements[0].locator;
                     await dialogCloseLocator.click();
+                    // wait for the dialog to close
+                    await dialogCloseLocator.waitFor({ state: "hidden" });
                     return { rerun: true };
                 }
             }
@@ -414,7 +486,7 @@ class StableBrowser {
     }
     async _locate(selectors, info, _params, timeout = 30000) {
         for (let i = 0; i < 3; i++) {
-            info.log += "attempt " + i + ": totoal locators " + selectors.locators.length + "\n";
+            info.log += "attempt " + i + ": total locators " + selectors.locators.length + "\n";
             for (let j = 0; j < selectors.locators.length; j++) {
                 let selector = selectors.locators[j];
                 info.log += "searching for locator " + j + ":" + JSON.stringify(selector) + "\n";
@@ -434,9 +506,27 @@ class StableBrowser {
         //let arrayMode = Array.isArray(selectors);
         let scope = this.page;
         if (selectors.iframe_src || selectors.frameLocators) {
+            const findFrame = (frame, framescope) => {
+                for (let i = 0; i < frame.selectors.length; i++) {
+                    let frameLocator = frame.selectors[i];
+                    if (frameLocator.css) {
+                        framescope = framescope.frameLocator(frameLocator.css);
+                        break;
+                    }
+                }
+                if (frame.children) {
+                    return findFrame(frame.children, framescope);
+                }
+                return framescope;
+            };
             info.log += "searching for iframe " + selectors.iframe_src + "/" + selectors.frameLocators + "\n";
             while (true) {
                 let frameFound = false;
+                if (selectors.nestFrmLoc) {
+                    scope = findFrame(selectors.nestFrmLoc, scope);
+                    frameFound = true;
+                    break;
+                }
                 if (selectors.frameLocators) {
                     for (let i = 0; i < selectors.frameLocators.length; i++) {
                         let frameLocator = selectors.frameLocators[i];
@@ -600,6 +690,9 @@ class StableBrowser {
     async click(selectors, _params, options = {}, world = null) {
         this._validateSelectors(selectors);
         const startTime = Date.now();
+        if (options && options.context) {
+            selectors.locators[0].text = options.context;
+        }
         const info = {};
         info.log = "***** click on " + selectors.element_name + " *****\n";
         info.operation = "click";
@@ -613,14 +706,14 @@ class StableBrowser {
             ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
             try {
                 await this._highlightElements(element);
-                await element.click({ timeout: 5000 });
+                await element.click();
                 await new Promise((resolve) => setTimeout(resolve, 1000));
             }
             catch (e) {
                 // await this.closeUnexpectedPopups();
                 info.log += "click failed, will try again" + "\n";
                 element = await this._locate(selectors, info, _params);
-                await element.click({ timeout: 10000, force: true });
+                await element.dispatchEvent("click");
                 await new Promise((resolve) => setTimeout(resolve, 1000));
             }
             await this.waitForPageLoad();
@@ -673,7 +766,7 @@ class StableBrowser {
             ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
             try {
                 await this._highlightElements(element);
-                await element.setChecked(checked, { timeout: 5000 });
+                await element.setChecked(checked);
                 await new Promise((resolve) => setTimeout(resolve, 1000));
             }
             catch (e) {
@@ -737,7 +830,7 @@ class StableBrowser {
             ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
             try {
                 await this._highlightElements(element);
-                await element.hover({ timeout: 10000 });
+                await element.hover();
                 await new Promise((resolve) => setTimeout(resolve, 1000));
             }
             catch (e) {
@@ -799,7 +892,7 @@ class StableBrowser {
             ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
             try {
                 await this._highlightElements(element);
-                await element.selectOption(values, { timeout: 5000 });
+                await element.selectOption(values);
             }
             catch (e) {
                 //await this.closeUnexpectedPopups();
@@ -908,71 +1001,45 @@ class StableBrowser {
             });
         }
     }
-    async setDateTime(selectors, value, format = null, enter = false, _params = null, options = {}, world = null) {
+    async setInputValue(selectors, value, _params = null, options = {}, world = null) {
+        // set input value for non fillable inputs like date, time, range, color, etc.
         this._validateSelectors(selectors);
         const startTime = Date.now();
-        let error = null;
-        let screenshotId = null;
-        let screenshotPath = null;
         const info = {};
-        info.log = "";
-        info.operation = Types.SET_DATE_TIME;
+        info.log = "***** set input value " + selectors.element_name + " *****\n";
+        info.operation = "setInputValue";
         info.selectors = selectors;
+        value = this._fixUsingParams(value, _params);
         info.value = value;
+        let error = null;
+        let screenshotId = null;
+        let screenshotPath = null;
         try {
             value = await this._replaceWithLocalData(value, this);
             let element = await this._locate(selectors, info, _params);
-            //insert red border around the element
             await this.scrollIfNeeded(element, info);
             ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
             await this._highlightElements(element);
             try {
-                await element.click();
-                await new Promise((resolve) => setTimeout(resolve, 500));
-                if (format) {
-                    value = dayjs(value).format(format);
-                    await element.fill(value);
-                }
-                else {
-                    const dateTimeValue = await getDateTimeValue({ value, element });
-                    await element.evaluateHandle((el, dateTimeValue) => {
-                        el.value = ""; // clear input
-                        el.value = dateTimeValue;
-                    }, dateTimeValue);
-                }
-                if (enter) {
-                    await new Promise((resolve) => setTimeout(resolve, 2000));
-                    await this.page.keyboard.press("Enter");
-                    await this.waitForPageLoad();
-                }
+                await element.evaluateHandle((el, value) => {
+                    el.value = value;
+                }, value);
             }
             catch (error) {
-                //await this.closeUnexpectedPopups();
-                this.logger.error("setting date time input failed " + JSON.stringify(info));
-                this.logger.info("Trying again")(({ screenshotId, screenshotPath } = await this._screenShot(options, world, info)));
+                this.logger.error("setInputValue failed, will try again");
+                ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
                 info.screenshotPath = screenshotPath;
                 Object.assign(error, { info: info });
-                await element.click();
-                await new Promise((resolve) => setTimeout(resolve, 500));
-                if (format) {
-                    value = dayjs(value).format(format);
-                    await element.fill(value);
-                }
-                else {
-                    const dateTimeValue = await getDateTimeValue({ value, element });
-                    await element.evaluateHandle((el, dateTimeValue) => {
-                        el.value = ""; // clear input
-                        el.value = dateTimeValue;
-                    }, dateTimeValue);
-                }
-                if (enter) {
-                    await new Promise((resolve) => setTimeout(resolve, 2000));
-                    await this.page.keyboard.press("Enter");
-                    await this.waitForPageLoad();
-                }
+                await element.evaluateHandle((el, value) => {
+                    el.value = value;
+                });
             }
         }
-        catch (error) {
+        catch (e) {
+            this.logger.error("setInputValue failed " + info.log);
+            ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
+            info.screenshotPath = screenshotPath;
+            Object.assign(e, { info: info });
             error = e;
             throw e;
         }
@@ -980,10 +1047,10 @@ class StableBrowser {
             const endTime = Date.now();
             this._reportToWorld(world, {
                 element_name: selectors.element_name,
-                type: Types.SET_DATE_TIME,
-                screenshotId,
+                type: Types.SET_INPUT,
+                text: `Set input value`,
                 value: value,
-                text: `setDateTime input with value: ${value}`,
+                screenshotId,
                 result: error
                     ? {
                         status: "FAILED",
@@ -1000,7 +1067,7 @@ class StableBrowser {
             });
         }
     }
-    async setDateTime(selectors, value, enter = false, _params = null, options = {}, world = null) {
+    async setDateTime(selectors, value, format = null, enter = false, _params = null, options = {}, world = null) {
         this._validateSelectors(selectors);
         const startTime = Date.now();
         let error = null;
@@ -1012,6 +1079,7 @@ class StableBrowser {
         info.selectors = selectors;
         info.value = value;
         try {
+            value = await this._replaceWithLocalData(value, this);
             let element = await this._locate(selectors, info, _params);
             //insert red border around the element
             await this.scrollIfNeeded(element, info);
@@ -1020,28 +1088,51 @@ class StableBrowser {
             try {
                 await element.click();
                 await new Promise((resolve) => setTimeout(resolve, 500));
-                const dateTimeValue = await getDateTimeValue({ value, element });
-                await element.evaluateHandle((el, dateTimeValue) => {
-                    el.value = ""; // clear input
-                    el.value = dateTimeValue;
-                }, dateTimeValue);
+                if (format) {
+                    value = dayjs(value).format(format);
+                    await element.fill(value);
+                }
+                else {
+                    const dateTimeValue = await getDateTimeValue({ value, element });
+                    await element.evaluateHandle((el, dateTimeValue) => {
+                        el.value = ""; // clear input
+                        el.value = dateTimeValue;
+                    }, dateTimeValue);
+                }
+                if (enter) {
+                    await new Promise((resolve) => setTimeout(resolve, 2000));
+                    await this.page.keyboard.press("Enter");
+                    await this.waitForPageLoad();
+                }
             }
-            catch (error) {
+            catch (err) {
                 //await this.closeUnexpectedPopups();
                 this.logger.error("setting date time input failed " + JSON.stringify(info));
-                this.logger.info("Trying again")(({ screenshotId, screenshotPath } = await this._screenShot(options, world, info)));
+                this.logger.info("Trying again");
+                ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
                 info.screenshotPath = screenshotPath;
-                Object.assign(error, { info: info });
+                Object.assign(err, { info: info });
                 await element.click();
                 await new Promise((resolve) => setTimeout(resolve, 500));
-                const dateTimeValue = await getDateTimeValue({ value, element });
-                await element.evaluateHandle((el, dateTimeValue) => {
-                    el.value = ""; // clear input
-                    el.value = dateTimeValue;
-                }, dateTimeValue);
+                if (format) {
+                    value = dayjs(value).format(format);
+                    await element.fill(value);
+                }
+                else {
+                    const dateTimeValue = await getDateTimeValue({ value, element });
+                    await element.evaluateHandle((el, dateTimeValue) => {
+                        el.value = ""; // clear input
+                        el.value = dateTimeValue;
+                    }, dateTimeValue);
+                }
+                if (enter) {
+                    await new Promise((resolve) => setTimeout(resolve, 2000));
+                    await this.page.keyboard.press("Enter");
+                    await this.waitForPageLoad();
+                }
             }
         }
-        catch (error) {
+        catch (e) {
             error = e;
             throw e;
         }
@@ -1091,20 +1182,32 @@ class StableBrowser {
             await this.scrollIfNeeded(element, info);
             ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
             await this._highlightElements(element);
-            try {
-                let currentValue = await element.inputValue();
-                if (currentValue) {
-                    await element.fill("");
+            if (options === null || options === undefined || !options.press) {
+                try {
+                    let currentValue = await element.inputValue();
+                    if (currentValue) {
+                        await element.fill("");
+                    }
+                }
+                catch (e) {
+                    this.logger.info("unable to clear input value");
                 }
             }
-            catch (e) {
-                this.logger.info("unable to clear input value");
-            }
-            try {
-                await element.click({ timeout: 5000 });
+            if (options === null || options === undefined || options.press) {
+                try {
+                    await element.click({ timeout: 5000 });
+                }
+                catch (e) {
+                    await element.dispatchEvent("click");
+                }
             }
-            catch (e) {
-                await element.dispatchEvent("click");
+            else {
+                try {
+                    await element.focus();
+                }
+                catch (e) {
+                    await element.dispatchEvent("focus");
+                }
             }
             await new Promise((resolve) => setTimeout(resolve, 500));
             const valueSegment = _value.split("&&");
@@ -1192,7 +1295,7 @@ class StableBrowser {
             let element = await this._locate(selectors, info, _params);
             ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
             await this._highlightElements(element);
-            await element.fill(value, { timeout: 10000 });
+            await element.fill(value);
             await element.dispatchEvent("change");
             if (enter) {
                 await new Promise((resolve) => setTimeout(resolve, 2000));
@@ -1411,7 +1514,7 @@ class StableBrowser {
             return info;
         }
         catch (e) {
-            //await this.closeUnexpectedPopups();
+            await this.closeUnexpectedPopups();
             this.logger.error("verify element contains text failed " + info.log);
             ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
             info.screenshotPath = screenshotPath;
@@ -1459,6 +1562,29 @@ class StableBrowser {
         }
         return dataFile;
     }
+    async waitForUserInput(message, world = null) {
+        if (!message) {
+            message = "# Wait for user input. Press any key to continue";
+        }
+        else {
+            message = "# Wait for user input. " + message;
+        }
+        message += "\n";
+        const value = await new Promise((resolve) => {
+            const rl = readline.createInterface({
+                input: process.stdin,
+                output: process.stdout,
+            });
+            rl.question(message, (answer) => {
+                rl.close();
+                resolve(answer);
+            });
+        });
+        if (value) {
+            this.logger.info(`{{userInput}} was set to: ${value}`);
+        }
+        this.setTestData({ userInput: value }, world);
+    }
     setTestData(testData, world = null) {
         if (!testData) {
             return;
@@ -1486,7 +1612,7 @@ class StableBrowser {
         const data = fs.readFileSync(filePath, "utf8");
         const results = [];
         return new Promise((resolve, reject) => {
-            const readableStream = new stream.Readable();
+            const readableStream = new Readable();
             readableStream._read = () => { }; // _read is required but you can noop it
             readableStream.push(data);
             readableStream.push(null);
@@ -1666,13 +1792,13 @@ class StableBrowser {
         ])));
         const { data } = await client.send("Page.captureScreenshot", {
             format: "png",
-            clip: {
-                x: 0,
-                y: 0,
-                width: viewportWidth,
-                height: viewportHeight,
-                scale: 1,
-            },
+            // clip: {
+            //   x: 0,
+            //   y: 0,
+            //   width: viewportWidth,
+            //   height: viewportHeight,
+            //   scale: 1,
+            // },
         });
         if (!screenshotPath) {
             return data;
@@ -1861,11 +1987,14 @@ class StableBrowser {
                 //}
                 if ((result && result.data, result.data.status === true)) {
                     let codeOrUrlFound = false;
+                    let emailCode = null;
+                    let emailUrl = null;
                     // check if a code is returned
                     if (result.data.content && result.data.content.code) {
                         let code = result.data.content.code;
                         this.setTestData({ emailCode: code }, world);
                         this.logger.info("set test data: emailCode = " + code);
+                        emailCode = code;
                         codeOrUrlFound = true;
                     }
                     // check if a url is returned
@@ -1873,6 +2002,7 @@ class StableBrowser {
                         let url = result.data.content.url;
                         this.setTestData({ emailUrl: url }, world);
                         this.logger.info("set test data: emailUrl = " + url);
+                        emailUrl = url;
                         codeOrUrlFound = true;
                     }
                     if (codeOrUrlFound) {
@@ -2494,13 +2624,13 @@ class StableBrowser {
         }
         catch (e) {
             if (e.label === "networkidle") {
-                console.log("waitted for the network to be idle timeout");
+                console.log("waited for the network to be idle timeout");
             }
             else if (e.label === "load") {
-                console.log("waitted for the load timeout");
+                console.log("waited for the load timeout");
             }
             else if (e.label === "domcontentloaded") {
-                console.log("waitted for the domcontent loaded timeout");
+                console.log("waited for the domcontent loaded timeout");
             }
             console.log(".");
         }
@@ -2535,13 +2665,6 @@ class StableBrowser {
         const info = {};
         try {
             await this.page.close();
-            if (this.context && this.context.pages && this.context.pages.length > 0) {
-                this.context.pages.pop();
-                this.page = this.context.pages[this.context.pages.length - 1];
-                this.context.page = this.page;
-                let title = await this.page.title();
-                console.log("Switched to page " + title);
-            }
         }
         catch (e) {
             console.log(".");
@@ -2650,33 +2773,18 @@ class StableBrowser {
     }
     async scrollIfNeeded(element, info) {
         try {
-            let didScroll = await element.evaluate((node) => {
-                const rect = node.getBoundingClientRect();
-                if (rect &&
-                    rect.top >= 0 &&
-                    rect.left >= 0 &&
-                    rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) &&
-                    rect.right <= (window.innerWidth || document.documentElement.clientWidth)) {
-                    return false;
-                }
-                else {
-                    node.scrollIntoView({
-                        behavior: "smooth",
-                        block: "center",
-                        inline: "center",
-                    });
-                    return true;
-                }
+            await element.scrollIntoViewIfNeeded({
+                timeout: 2000,
             });
-            if (didScroll) {
-                await new Promise((resolve) => setTimeout(resolve, 500));
-                if (info) {
-                    info.box = await element.boundingBox();
-                }
+            await new Promise((resolve) => setTimeout(resolve, 500));
+            if (info) {
+                info.box = await element.boundingBox({
+                    timeout: 1000,
+                });
             }
         }
         catch (e) {
-            console.log("scroll failed");
+            console.log("#-#");
         }
     }
     _reportToWorld(world, properties) {