sefiutils 1.0.51 → 1.0.54

package/src/localSetup.ts

@@ -2,14 +2,17 @@ import dotenv from "dotenv";
 dotenv.config() // read ".env"
 
 import { Builder, Capabilities, WebDriver } from "selenium-webdriver";
-import { getRemoteAddressAndPort, setBrowserWindowSize, setViewPortSize } from "./seUtils";
 import { debug, verbose } from "./log";
+import { getRemoteAddressAndPort, setBrowserWindowSize } from "./seUtils";
+import { Options } from "selenium-webdriver/chrome";
 
-export const LOCAL_SETUP_TIMEOUT = 20000;
+export const LOCAL_SETUP_TIMEOUT = process.env.VSCODE_INSPECTOR_OPTIONS ? 999999 : 20000;
+// console.log("LOCAL_SETUP_TIMEOUT: ", LOCAL_SETUP_TIMEOUT);
+// console.log("VSCODE_INSPECTOR_OPTIONS: ", process.env.VSCODE_INSPECTOR_OPTIONS);
 
 export async function localSetup(page: string, width = 500, height = 500, acceptUntrustedCertificates = true): Promise<WebDriver> {
     debug(() => `localSetup("${page}", ${width}, ${height}, ${acceptUntrustedCertificates}), getWebDriver ...`);
-    const driver = await getWebDriver(acceptUntrustedCertificates);
+    const driver = await getWebDriver(acceptUntrustedCertificates, width, height);
     verbose(() => `Driver started, load page: ${page}`);
     await driver.get(page);
     debug(() => `Page loaded, set browser window size: ${width}x${height}`);
@@ -27,37 +30,42 @@ export async function localSetup(page: string, width = 500, height = 500, accept
  * ```
  * are to be called.
 */
-async function getWebDriver(acceptUntrustedCertificates: boolean) {
+async function getWebDriver(acceptUntrustedCertificates: boolean, width?: number, height?: number) {
     const browser = (process.env.SEFI_BROWSER as "chrome" | "firefox" | "remote") || "remote";
 
     debug(() => `Use browser: ${browser}`);
     try {
         if (browser === "chrome") {
-            return await setUpWebDriverChrome(acceptUntrustedCertificates);
+            return await setUpWebDriverChrome(acceptUntrustedCertificates, width, height);
         } else if (browser === "firefox") {
-            return await setUpWebDriverFirefox(acceptUntrustedCertificates);
+            return await setUpWebDriverFirefox(acceptUntrustedCertificates, width, height);
         } else if (browser === "remote") {
-            return await setUpWebDriverInDocker(acceptUntrustedCertificates);
+            return await setUpWebDriverInDocker(acceptUntrustedCertificates, width, height);
         } else {
             throw new Error(`Unknown browser: ${browser}`);
         }
     } catch (err) {
-        console.error(`Error setting up driver: ${err}`);
+        console.error(`Error setting up driver for ${browser}: ${err}`);
         throw err;
     }
 }
 
 
-async function setUpWebDriverInDocker(acceptUntrustedCertificates: boolean) {
-    debug("Dynamic import of selenium-webdriver/firefox");
-    debug("Remote browser, load firefox webdriver");
+async function setUpWebDriverInDocker(acceptUntrustedCertificates: boolean, width?: number, height?: number) {
+    debug("Dynamic import of selenium-webdriver/firefox for remote browser");
     const firefox = await import('selenium-webdriver/firefox');
 
-    const { address } = getRemoteAddressAndPort();
+    const { address, port } = getRemoteAddressAndPort();
     const start = Date.now();
 
     const options = new firefox.Options().addArguments("-headless");
     options.setAcceptInsecureCerts(acceptUntrustedCertificates);
+    if (width && height) { // cf. https://github.com/SeleniumHQ/selenium/pull/6075
+        options.addArguments("--width=" + width);
+        options.addArguments("--height=" + height);
+        process.env.MOZ_HEADLESS_WIDTH = String(width);
+        process.env.MOZ_HEADLESS_HEIGHT = String(height);
+    }
 
     debug(() => `Start headless firefox, remote server at ${address}`)
     const driver = await new Builder()
@@ -71,8 +79,8 @@ async function setUpWebDriverInDocker(acceptUntrustedCertificates: boolean) {
         return `Driver resolved and connected, required ${duration}s.`
     });
     return driver;
-}
 
+}
 
 /**
  * To be called in the beforeAll() function of a test suite.
@@ -83,14 +91,17 @@ async function setUpWebDriverInDocker(acceptUntrustedCertificates: boolean) {
  * ```
  * are to be called.
  */
-async function setUpWebDriverChrome(acceptUntrustedCertificates: boolean) {
+async function setUpWebDriverChrome(acceptUntrustedCertificates: boolean, width?: number, height?: number) {
     debug("Dynamic import of chromedriver and selenium-webdriver/chrome");
     //@ts-ignore
     await import('chromedriver');
     const chrome = await import('selenium-webdriver/chrome');
 
-    const options = new chrome.Options().addArguments("--headless=new");
+    const options: Options = (new chrome.Options().addArguments("--headless=new")) as Options;
     options.setAcceptInsecureCerts(acceptUntrustedCertificates);
+    if (width && height) { // cf. https://www.geeksforgeeks.org/how-to-set-browser-width-and-height-in-selenium-webdriver/
+        options.addArguments("--window-size=" + width + "," + height);
+    }
 
     debug(() => `Start headless chrome`)
     const driver = await new Builder()
@@ -109,13 +120,20 @@ async function setUpWebDriverChrome(acceptUntrustedCertificates: boolean) {
  * ```
  * are to be called.
  */
-async function setUpWebDriverFirefox(acceptUntrustedCertificates: boolean) {
+async function setUpWebDriverFirefox(acceptUntrustedCertificates: boolean, width?: number, height?: number) {
     debug("Dynamic import of geckodriver and selenium-webdriver/firefox");
     //@ts-ignore
     await import('geckodriver'); // installed geckodriver will cause remote configuration to fail in docker...
     const firefox = await import('selenium-webdriver/firefox');
 
-    const options = new firefox.Options().addArguments("-headless");
+    const options = new firefox.Options();
+    options.addArguments("-headless");
+    if (width && height) { // cf. https://github.com/SeleniumHQ/selenium/pull/6075
+        options.addArguments("--width=" + width);
+        options.addArguments("--height=" + height);
+        process.env.MOZ_HEADLESS_WIDTH = String(width);
+        process.env.MOZ_HEADLESS_HEIGHT = String(height);
+    }
     options.setAcceptInsecureCerts(acceptUntrustedCertificates);
 
     debug(() => `Start headless firefox`)

package/src/seUtils.ts

@@ -407,16 +407,8 @@ export async function isInViewPort(driver: WebDriver, id: string) {
  * Sets the window so that the {@link getViewPortSize} matches the given width and height.
  */
 export async function setBrowserWindowSize(driver: WebDriver, width: number, height: number): Promise<void> {
-    // const rect = await driver.manage().window().getRect();
     await waitForSetRect(driver, width, height);
-    // await driver.manage().window().setRect({ width: width, height: height });
-    // return waitFor(async () => {
-    //     const rectAfter = await driver.manage().window().getRect();
-
-    //     if (check && (rectAfter.width != width || rectAfter.height != height)) {
-    //         throw new Error(`Cannot set window to size (${width}, ${height}). Size is probably too small or too large, got ${rectAfter.width}/${rectAfter.height},  was before ${rect.width}/${rect.height}.`);
-    //     }
-    // });
+    
 }
 
 async function waitForSetRect(driver: WebDriver, width: number, height: number): Promise<void> {
@@ -900,3 +892,21 @@ export function editDistance(a: string, b: string, maxDistance: number) {
 
     return d[a.length][b.length];
 }
+
+/**
+ * Returns true if the two web elements are equal, i.e. have the same id or same tag, location, and size.
+ */
+export async function equalWebElements(a: WebElement|null|undefined, b: WebElement|null|undefined) {
+    if (a===b) return true;
+    if (!a || !b) return false;
+    const aId = await a.getId();
+    const bId = await b.getId();
+    if (aId) return aId === bId;
+    const aLocation = await a.getLocation();
+    const bLocation = await b.getLocation();
+    const aSize = await a.getSize();
+    const bSize = await b.getSize();
+    const aTag = await a.getTagName();
+    const bTag = await b.getTagName();
+    return aTag===bTag && aLocation.x === bLocation.x && aLocation.y === bLocation.y && aSize.width === bSize.width && aSize.height === bSize.height;
+}

package/lib/execScripts/dom.js

@@ -1,15 +0,0 @@
-function getButtonsAndHRefs() {
-    const clickable = [];
-    const elements = document.getElementsByTagName("*");
-    for (let i = 0; i < elements.length; i++) {
-        const e = elements[i];
-        if ( ((e.onclick || e.onClick) && !Object.keys(e).find(key => key.startsWith("__reactContainer$")))
-            || (e.tagName==='A' && e.href)
-            || (e.tagName==='BUTTON' && e.type!=='hidden')
-            || (e.tagName==='INPUT' && ["button", "submit"].includes(e.type?.toLowerCase()))
-            ) {
-            clickable.push(e);
-        }
-    }
-    return clickable;
-}