automation_model 1.0.405-dev → 1.0.405-stage

package/lib/stable_browser.js

@@ -2,9 +2,9 @@
 import { expect } from "@playwright/test";
 import dayjs from "dayjs";
 import fs from "fs";
+import { Jimp } from "jimp";
 import path from "path";
 import reg_parser from "regex-parser";
-import sharp from "sharp";
 import { findDateAlternatives, findNumberAlternatives } from "./analyze_helper.js";
 import { getDateTimeValue } from "./date_time.js";
 import drawRectangle from "./drawRect.js";
@@ -13,6 +13,9 @@ 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";
+import { getContext } from "./init_browser.js";
 const Types = {
     CLICK: "click_element",
     NAVIGATE: "navigate",
@@ -37,16 +40,22 @@ const Types = {
     SET_DATE_TIME: "set_date_time",
     SET_VIEWPORT: "set_viewport",
     VERIFY_VISUAL: "verify_visual",
+    LOAD_DATA: "load_data",
+    SET_INPUT: "set_input",
 };
+export const apps = {};
 class StableBrowser {
-    constructor(browser, page, logger = null, context = null) {
+    constructor(browser, page, logger = null, context = null, world = null) {
         this.browser = browser;
         this.page = page;
         this.logger = logger;
         this.context = context;
+        this.world = world;
         this.project_path = null;
         this.webLogFile = null;
+        this.networkLogger = null;
         this.configuration = null;
+        this.appName = "main";
         if (!this.logger) {
             this.logger = console;
         }
@@ -72,23 +81,34 @@ class StableBrowser {
             this.logger.error("unable to read ai_config.json");
         }
         const logFolder = path.join(this.project_path, "logs", "web");
-        this.webLogFile = this.getWebLogFile(logFolder);
-        this.registerConsoleLogListener(page, context, this.webLogFile);
-        this.registerRequestListener();
+        this.world = world;
         context.pages = [this.page];
         context.pageLoading = { status: false };
+        this.registerEventListeners(this.context);
+    }
+    registerEventListeners(context) {
+        this.registerConsoleLogListener(this.page, context);
+        this.registerRequestListener(this.page, context, this.webLogFile);
+        if (!context.pageLoading) {
+            context.pageLoading = { status: false };
+        }
         context.playContext.on("page", async function (page) {
             context.pageLoading.status = true;
             this.page = page;
             context.page = page;
             context.pages.push(page);
             page.on("close", async () => {
-                if (this.context && this.context.pages && this.context.pages.length > 0) {
+                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;
-                    let title = await this.page.title();
-                    console.log("Switched to page " + title);
+                    try {
+                        let title = await this.page.title();
+                        console.log("Switched to page " + title);
+                    }
+                    catch (error) {
+                        console.error("Error on page close", error);
+                    }
                 }
             });
             try {
@@ -101,6 +121,36 @@ class StableBrowser {
             context.pageLoading.status = false;
         }.bind(this));
     }
+    async switchApp(appName) {
+        // check if the current app (this.appName) is the same as the new app
+        if (this.appName === appName) {
+            return;
+        }
+        let navigate = false;
+        if (!apps[appName]) {
+            let newContext = await getContext(null, false, this.logger, appName, false, this);
+            navigate = true;
+            apps[appName] = {
+                context: newContext,
+                browser: newContext.browser,
+                page: newContext.page,
+            };
+        }
+        const tempContext = {};
+        this._copyContext(this, tempContext);
+        this._copyContext(apps[appName], this);
+        apps[this.appName] = tempContext;
+        this.appName = appName;
+        if (navigate) {
+            await this.goto(this.context.environment.baseUrl);
+            await this.waitForPageLoad();
+        }
+    }
+    _copyContext(from, to) {
+        to.browser = from.browser;
+        to.page = from.page;
+        to.context = from.context;
+    }
     getWebLogFile(logFolder) {
         if (!fs.existsSync(logFolder)) {
             fs.mkdirSync(logFolder, { recursive: true });
@@ -112,37 +162,63 @@ class StableBrowser {
         const fileName = nextIndex + ".json";
         return path.join(logFolder, fileName);
     }
-    registerConsoleLogListener(page, context, logFile) {
+    registerConsoleLogListener(page, context) {
         if (!this.context.webLogger) {
             this.context.webLogger = [];
         }
         page.on("console", async (msg) => {
-            this.context.webLogger.push({
+            var _a;
+            const obj = {
                 type: msg.type(),
                 text: msg.text(),
                 location: msg.location(),
                 time: new Date().toISOString(),
-            });
-            await fs.promises.writeFile(logFile, JSON.stringify(this.context.webLogger, null, 2));
+            };
+            this.context.webLogger.push(obj);
+            (_a = this.world) === null || _a === void 0 ? void 0 : _a.attach(JSON.stringify(obj), { mediaType: "application/json+log" });
         });
     }
-    registerRequestListener() {
-        this.page.on("request", async (data) => {
+    registerRequestListener(page, context, logFile) {
+        if (!this.context.networkLogger) {
+            this.context.networkLogger = [];
+        }
+        page.on("request", async (data) => {
+            var _a;
+            const startTime = new Date().getTime();
             try {
-                const pageUrl = new URL(this.page.url());
+                const pageUrl = new URL(page.url());
                 const requestUrl = new URL(data.url());
                 if (pageUrl.hostname === requestUrl.hostname) {
                     const method = data.method();
-                    if (method === "POST" || method === "GET" || method === "PUT" || method === "DELETE" || method === "PATCH") {
+                    if (["POST", "GET", "PUT", "DELETE", "PATCH"].includes(method)) {
                         const token = await data.headerValue("Authorization");
                         if (token) {
-                            this.context.authtoken = token;
+                            context.authtoken = token;
                         }
                     }
                 }
+                const response = await data.response();
+                const endTime = new Date().getTime();
+                const obj = {
+                    url: data.url(),
+                    method: data.method(),
+                    postData: data.postData(),
+                    error: data.failure() ? data.failure().errorText : null,
+                    duration: endTime - startTime,
+                    startTime,
+                };
+                context.networkLogger.push(obj);
+                (_a = this.world) === null || _a === void 0 ? void 0 : _a.attach(JSON.stringify(obj), { mediaType: "application/json+network" });
             }
             catch (error) {
                 console.error("Error in request listener", error);
+                context.networkLogger.push({
+                    error: "not able to listen",
+                    message: error.message,
+                    stack: error.stack,
+                    time: new Date().toISOString(),
+                });
+                // await fs.promises.writeFile(logFile, JSON.stringify(context.networkLogger, null, 2));
             }
         });
     }
@@ -212,9 +288,7 @@ class StableBrowser {
     }
     _getLocator(locator, scope, _params) {
         locator = this._fixLocatorUsingParams(locator, _params);
-        if (locator.type === "pw_selector") {
-            return scope.locator(locator.selector);
-        }
+        let locatorReturn;
         if (locator.role) {
             if (locator.role[1].nameReg) {
                 locator.role[1].name = reg_parser(locator.role[1].nameReg);
@@ -223,20 +297,42 @@ class StableBrowser {
             // 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]);
+            locatorReturn = scope.getByRole(locator.role[0], locator.role[1]);
         }
         if (locator.css) {
-            return scope.locator(locator.css);
+            locatorReturn = scope.locator(locator.css);
         }
-        if ((locator === null || locator === void 0 ? void 0 : locator.engine) && (locator === null || locator === void 0 ? void 0 : locator.score) <= 520) {
-            let selector = locator.selector.replace(/"/g, '\\"');
-            if (locator.engine === "internal:att") {
-                selector = `[${selector}]`;
+        // 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" });
             }
-            const locator = scope.locator(`${locator.engine}="${selector}"`);
-            return locator;
         }
-        throw new Error("unknown locator type");
+        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");
+        }
+        return locatorReturn;
     }
     async _locateElmentByTextClimbCss(scope, text, climb, css, _params) {
         let result = await this._locateElementByText(scope, this._fixUsingParams(text, _params), "*", false, true, _params);
@@ -447,6 +543,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 };
                 }
             }
@@ -455,7 +553,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";
@@ -475,9 +573,30 @@ 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);
+                        if (frameLocator.index) {
+                            framescope = framescope.nth(frameLocator.index);
+                        }
+                        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];
@@ -641,6 +760,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";
@@ -654,14 +776,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();
@@ -714,7 +836,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) {
@@ -778,7 +900,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) {
@@ -840,7 +962,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();
@@ -949,6 +1071,72 @@ class StableBrowser {
             });
         }
     }
+    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();
+        const info = {};
+        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);
+            await this.scrollIfNeeded(element, info);
+            ({ screenshotId, screenshotPath } = await this._screenShot(options, world, info));
+            await this._highlightElements(element);
+            try {
+                await element.evaluateHandle((el, value) => {
+                    el.value = value;
+                }, value);
+            }
+            catch (error) {
+                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.evaluateHandle((el, value) => {
+                    el.value = value;
+                });
+            }
+        }
+        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;
+        }
+        finally {
+            const endTime = Date.now();
+            this._reportToWorld(world, {
+                element_name: selectors.element_name,
+                type: Types.SET_INPUT,
+                text: `Set input value`,
+                value: value,
+                screenshotId,
+                result: error
+                    ? {
+                        status: "FAILED",
+                        startTime,
+                        endTime,
+                        message: error === null || error === void 0 ? void 0 : error.message,
+                    }
+                    : {
+                        status: "PASSED",
+                        startTime,
+                        endTime,
+                    },
+                info: info,
+            });
+        }
+    }
     async setDateTime(selectors, value, format = null, enter = false, _params = null, options = {}, world = null) {
         this._validateSelectors(selectors);
         const startTime = Date.now();
@@ -990,7 +1178,8 @@ class StableBrowser {
             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(err, { info: info });
                 await element.click();
@@ -1176,7 +1365,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));
@@ -1395,7 +1584,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;
@@ -1443,6 +1632,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;
@@ -1470,7 +1682,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);
@@ -1650,30 +1862,29 @@ 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;
         }
         let screenshotBuffer = Buffer.from(data, "base64");
-        const sharpBuffer = sharp(screenshotBuffer);
-        const metadata = await sharpBuffer.metadata();
-        //check if you are on retina display and reduce the quality of the image
-        if (metadata.width > viewportWidth || metadata.height > viewportHeight) {
-            screenshotBuffer = await sharpBuffer
-                .resize(viewportWidth, viewportHeight, {
-                fit: sharp.fit.inside,
-                withoutEnlargement: true,
-            })
-                .toBuffer();
-        }
-        fs.writeFileSync(screenshotPath, screenshotBuffer);
+        let image = await Jimp.read(screenshotBuffer);
+        // Get the image dimensions
+        const { width, height } = image.bitmap;
+        // Resize the image to fit within the viewport dimensions without enlarging
+        if (width > viewportWidth || height > viewportHeight) {
+            image = image.resize({ w: viewportWidth, h: viewportHeight }); // Resize the image while maintaining aspect ratio
+            await image.write(screenshotPath);
+        }
+        else {
+            fs.writeFileSync(screenshotPath, screenshotBuffer);
+        }
         await client.detach();
     }
     async verifyElementExistInPage(selectors, _params = null, options = {}, world = null) {
@@ -2482,13 +2693,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(".");
         }
@@ -2631,33 +2842,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) {