@cloudscape-design/browser-test-tools 3.0.76 → 3.0.77

package/browsers/browser-creator.d.ts

@@ -1,6 +1,4 @@
-/// <reference types="webdriverio/async" />
-import { RemoteOptions } from 'webdriverio';
-import { Capabilities } from './capabilities';
+import { Options } from '@wdio/types';
 export interface WebDriverOptions {
     width: number;
     height: number;
@@ -8,7 +6,7 @@ export interface WebDriverOptions {
     implicitTimeout: number;
     scriptTimeout: number;
     baseUrl?: string;
-    logLevel: RemoteOptions['logLevel'];
+    logLevel: Options.WebDriverLogTypes;
     capabilities?: Record<string, any>;
 }
 export default abstract class BrowserCreator {
@@ -18,5 +16,5 @@ export default abstract class BrowserCreator {
     protected setupBrowser(overrides: Partial<WebDriverOptions>): Promise<WebdriverIO.Browser>;
     getBrowser(options: Partial<WebDriverOptions>): Promise<WebdriverIO.Browser>;
     protected abstract __getBrowserUrl(): Promise<URL>;
-    protected abstract __getCapabilities(): Capabilities;
+    protected abstract __getCapabilities(): WebdriverIO.Capabilities;
 }

package/browsers/browser-creator.js

@@ -1,10 +1,10 @@
 "use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
 const webdriverio_1 = require("webdriverio");
 const merge_1 = __importDefault(require("lodash/merge"));
 const exceptions_1 = require("../exceptions");
@@ -41,7 +41,8 @@ class BrowserCreator {
         });
         await browser.setTimeout({ implicit: options.implicitTimeout, script: options.scriptTimeout });
         if (!browser.isMobile) {
-            await browser.$('body').then(body => body.moveTo({ xOffset: 0, yOffset: 0 }));
+            const body = await browser.$('body');
+            await body.moveTo({ xOffset: 0, yOffset: 0 });
             await browser.setWindowSize(options.width, options.height);
         }
         return browser;

package/browsers/browserstack.d.ts

@@ -1,8 +1,6 @@
-/// <reference types="webdriverio/async" />
 /// <reference types="node" />
 import { URL } from 'url';
 import BrowserCreator, { WebDriverOptions } from './browser-creator';
-import { Capabilities } from './capabilities';
 type BrowserstackCredentials = {
     user: string;
     key: string;
@@ -16,6 +14,6 @@ export type BrowserstackOptions = {
 export default class BrowserStackBrowserCreator extends BrowserCreator {
     getBrowser(options: Partial<WebDriverOptions>): Promise<WebdriverIO.Browser>;
     __getBrowserUrl(): Promise<URL>;
-    protected __getCapabilities(): Capabilities;
+    protected __getCapabilities(): WebdriverIO.Capabilities;
 }
 export {};

package/browsers/browserstack.js

@@ -41,7 +41,7 @@ const browsers = {
         // Leave blank so we get the latest version. 'beta' is also a valid option
         // browserVersion: '69.0',
         'bstack:options': {
-            seleniumVersion: '3.14.0',
+            seleniumVersion: '4.25.0',
             os: 'Windows',
             osVersion: '10',
         },

package/browsers/capabilities.d.ts

@@ -1,6 +1,4 @@
-import { RemoteOptions } from 'webdriverio';
-export type Capabilities = RemoteOptions['capabilities'];
-declare const defaultCapabilities: Record<string, Capabilities>;
-export declare function getCapability(browserName: string, capabilities: Record<string, Capabilities>): Capabilities;
+declare const defaultCapabilities: Record<string, WebdriverIO.Capabilities>;
+export declare function getCapability(browserName: string, capabilities: Record<string, WebdriverIO.Capabilities>): WebdriverIO.Capabilities;
 export declare function mergeCapabilities<T>(src: T, overrides: Partial<T>): T;
 export default defaultCapabilities;

package/browsers/capabilities.js

@@ -1,11 +1,11 @@
 "use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mergeCapabilities = exports.getCapability = void 0;
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
 const lodash_1 = __importDefault(require("lodash"));
 const exceptions_1 = require("../exceptions");
 const defaultCapabilities = {
@@ -64,6 +64,7 @@ const defaultCapabilities = {
     Firefox: {
         browserName: 'firefox',
         'moz:firefoxOptions': {
+            args: ['-headless'],
             prefs: {
                 'fission.webContentIsolationStrategy': 0,
                 'fission.bfcacheInParent': false,

package/browsers/devicefarm-mobile.d.ts

@@ -1,8 +1,7 @@
 /// <reference types="node" />
 import { URL } from 'url';
 import BrowserCreator from './browser-creator';
-import { Capabilities } from './capabilities';
 export default class MobileBrowserCreator extends BrowserCreator {
     __getBrowserUrl(): Promise<URL>;
-    __getCapabilities(): Capabilities;
+    __getCapabilities(): WebdriverIO.Capabilities;
 }

package/browsers/devicefarm.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { URL } from 'url';
 import BrowserCreator from './browser-creator';
-import { Capabilities } from './capabilities';
 export interface DevicefarmOptions {
     retryCount?: number;
     projectArn: string;
@@ -9,5 +8,5 @@ export interface DevicefarmOptions {
 }
 export default class DevicefarmBrowserCreator extends BrowserCreator {
     protected __getBrowserUrl(): Promise<URL>;
-    protected __getCapabilities(): Capabilities;
+    protected __getCapabilities(): WebdriverIO.Capabilities;
 }

package/browsers/local.d.ts

@@ -1,8 +1,7 @@
 /// <reference types="node" />
 import { URL } from 'url';
 import BrowserCreator from './browser-creator';
-import { Capabilities } from './capabilities';
 export default class LocalBrowserCreator extends BrowserCreator {
     __getBrowserUrl(): Promise<URL>;
-    __getCapabilities(): Capabilities;
+    __getCapabilities(): WebdriverIO.Capabilities;
 }

package/browsers/local.js

@@ -42,15 +42,23 @@ const localBrowsers = {
                 },
             },
         },
+        // Workaround for https://github.com/webdriverio/webdriverio/issues/13440
+        // Reference: https://webdriver.io/blog/2024/08/15/webdriverio-v9-release/#new-features
+        'wdio:enforceWebDriverClassic': true,
     }),
     ChromeHeadlessIntegration: (0, capabilities_1.mergeCapabilities)(capabilities_1.default.ChromeHeadless, {
         'goog:chromeOptions': {
             args: ['--force-prefers-reduced-motion'],
         },
+        // Workaround for https://github.com/webdriverio/webdriverio/issues/13440
+        // Reference: https://webdriver.io/blog/2024/08/15/webdriverio-v9-release/#new-features
+        'wdio:enforceWebDriverClassic': true,
     }),
     Firefox: (0, capabilities_1.mergeCapabilities)(capabilities_1.default.Firefox, {
-        // https://firefox-source-docs.mozilla.org/testing/geckodriver/Capabilities.html
         'moz:debuggerAddress': true,
+        // Workaround for failing internal tests
+        // Reference: https://webdriver.io/blog/2024/08/15/webdriverio-v9-release/#new-features
+        'wdio:enforceWebDriverClassic': true,
     }),
 };
 class LocalBrowserCreator extends browser_creator_1.default {

package/internal/manifest.json

@@ -1,3 +1,3 @@
 {
-  "commit": "28d57aa7afbb9bf4e2da341447c6fa4812fd62bf"
+  "commit": "b569393b252cab88cd1d801c72801362b694e6a5"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudscape-design/browser-test-tools",
-  "version": "3.0.76",
+  "version": "3.0.77",
   "repository": {
     "type": "git",
     "url": "https://github.com/cloudscape-design/browser-test-tools.git"
@@ -18,13 +18,15 @@
   "dependencies": {
     "@aws-sdk/client-device-farm": "^3.623.0",
     "@types/pngjs": "^6.0.4",
+    "@wdio/globals": "^9.7.0",
+    "@wdio/types": "^9.6.3",
     "get-stream": "^6.0.1",
     "lodash": "^4.17.21",
     "p-retry": "^4.6.2",
     "pixelmatch": "^5.3.0",
     "pngjs": "^6.0.0",
     "wait-on": "^7.2.0",
-    "webdriverio": "^7.25.2"
+    "webdriverio": "^9.7.0"
   },
   "exports": {
     "./chrome-launcher": "./chrome-launcher.js",

package/page-objects/base.d.ts

@@ -1,10 +1,10 @@
-/// <reference types="webdriverio/async" />
 import { ScrollPosition } from '../browser-scripts';
 import EventsSpy from './events-spy';
 import { ElementRect } from './types';
+import { Browser } from 'webdriverio';
 export default class BasePageObject {
-    protected browser: WebdriverIO.Browser;
-    constructor(browser: WebdriverIO.Browser);
+    protected browser: Browser;
+    constructor(browser: Browser);
     pause(milliseconds: number): Promise<void>;
     keys(keys: string | string[]): Promise<void>;
     setWindowSize({ width, height }: {
@@ -18,7 +18,7 @@ export default class BasePageObject {
     buttonUp(): Promise<void>;
     dragAndDrop(sourceSelector: string, xOffset?: number, yOffset?: number): Promise<void>;
     getValue(selector: string): Promise<string>;
-    setValue(selector: string, value: number | string | string[]): Promise<void>;
+    setValue(selector: string, value: number | string): Promise<void>;
     getViewportSize(): Promise<import("./types").ViewportSize>;
     getWindowScroll(): Promise<ScrollPosition>;
     windowScrollTo({ top, left }: Partial<ScrollPosition>): Promise<void>;
@@ -34,7 +34,7 @@ export default class BasePageObject {
     isDisplayedInViewport(selector: string): Promise<boolean>;
     isClickable(selector: string): Promise<boolean>;
     getElementAttribute(selector: string, attributeName: string): Promise<string>;
-    getElementProperty(selector: string, propertyName: string): Promise<any>;
+    getElementProperty(selector: string, propertyName: string): Promise<unknown>;
     getElementsCount(selector: string): Promise<number>;
     getFocusedElementText(): Promise<string>;
     getBoundingBox(selector: string): Promise<ElementRect>;

package/page-objects/base.js

@@ -61,56 +61,43 @@ class BasePageObject {
         await element.moveTo({ xOffset, yOffset });
     }
     async buttonDownOnElement(selector) {
-        // buttonDown exists only in JSON Wire protocol
-        if (this.browser.buttonDown) {
-            await this.hoverElement(selector);
-            await this.browser.buttonDown();
-        }
-        else {
-            // Clean up all previous actions before stating a new batch. Without this line Safari emits extra "mouseup" events
-            await this.browser.releaseActions();
-            const box = await this.getBoundingBox(selector);
-            const center = (0, utils_1.getElementCenter)(box);
-            // W3C alternative is `performActions`. All consecutive actions have to be a part of a single call
-            await this.browser.performActions([
-                {
-                    type: 'pointer',
-                    id: 'mouse',
-                    parameters: { pointerType: 'mouse' },
-                    actions: [
-                        { type: 'pointerMove', duration: 0, x: center.x, y: center.y },
-                        { type: 'pointerDown', button: 0 },
-                        // extra delay to let event listeners to be fired
-                        { type: 'pause', duration: 10 },
-                    ],
-                },
-            ]);
-        }
+        // Clean up all previous actions before stating a new batch. Without this line Safari emits extra "mouseup" events
+        await this.browser.releaseActions();
+        const box = await this.getBoundingBox(selector);
+        const center = (0, utils_1.getElementCenter)(box);
+        // W3C alternative is `performActions`. All consecutive actions have to be a part of a single call
+        await this.browser.performActions([
+            {
+                type: 'pointer',
+                id: 'mouse',
+                parameters: { pointerType: 'mouse' },
+                actions: [
+                    { type: 'pointerMove', duration: 0, x: center.x, y: center.y },
+                    { type: 'pointerDown', button: 0 },
+                    // extra delay to let event listeners to be fired
+                    { type: 'pause', duration: 10 },
+                ],
+            },
+        ]);
     }
     async buttonUp() {
-        // buttonUp exists only in JSON Wire protocol
-        if (this.browser.buttonUp) {
-            await this.browser.buttonUp();
-        }
-        else {
-            // W3C alternative is `performActions`
-            await this.browser.performActions([
-                {
-                    type: 'pointer',
-                    id: 'mouse',
-                    parameters: { pointerType: 'mouse' },
-                    actions: [
-                        { type: 'pointerUp', button: 0 },
-                        // extra delay for Safari to process the event before moving the cursor away
-                        { type: 'pause', duration: 10 },
-                        // return cursor back to the corner to avoid hover effects on screenshots
-                        { type: 'pointerMove', duration: 0, x: 0, y: 0 },
-                    ],
-                },
-            ]);
-            // make sure all controls are properly released to avoid conflicts with further actions
-            await this.browser.releaseActions();
-        }
+        // W3C alternative is `performActions`
+        await this.browser.performActions([
+            {
+                type: 'pointer',
+                id: 'mouse',
+                parameters: { pointerType: 'mouse' },
+                actions: [
+                    { type: 'pointerUp', button: 0 },
+                    // extra delay for Safari to process the event before moving the cursor away
+                    { type: 'pause', duration: 10 },
+                    // return cursor back to the corner to avoid hover effects on screenshots
+                    { type: 'pointerMove', duration: 0, x: 0, y: 0 },
+                ],
+            },
+        ]);
+        // make sure all controls are properly released to avoid conflicts with further actions
+        await this.browser.releaseActions();
     }
     async dragAndDrop(sourceSelector, xOffset = 0, yOffset = 0) {
         const element = await this.browser.$(sourceSelector);
@@ -168,7 +155,7 @@ class BasePageObject {
         return element.isSelected();
     }
     async isExisting(selector) {
-        const elements = await this.browser.$$(selector);
+        const elements = await this.browser.$$(selector).map(element => element);
         return elements.length > 0;
     }
     async isDisplayed(selector) {
@@ -177,7 +164,7 @@ class BasePageObject {
     }
     async isDisplayedInViewport(selector) {
         const element = await this.browser.$(selector);
-        return element.isDisplayedInViewport();
+        return element.isDisplayed({ withinViewport: true });
     }
     async isClickable(selector) {
         const element = await this.browser.$(selector);
@@ -208,7 +195,7 @@ class BasePageObject {
         return element.getText();
     }
     async getElementsText(selector) {
-        const elements = await this.browser.$$(selector);
+        const elements = await this.browser.$$(selector).map(element => element);
         return Promise.all(elements.map(async (element) => element.getText()));
     }
     /**
@@ -228,10 +215,10 @@ class BasePageObject {
             return callback();
         }
         const iframeEl = await this.browser.$(iframeSelector);
-        await this.browser.switchToFrame(iframeEl);
+        await this.browser.switchFrame(iframeEl);
         await callback();
         // go back to top
-        await this.browser.switchToFrame(null);
+        await this.browser.switchFrame(null);
     }
 }
 exports.default = BasePageObject;

package/page-objects/events-spy.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="webdriverio/async" />
 export default class EventsSpy {
     private browser;
     private selector;

package/page-objects/full-page-screenshot.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="webdriverio/async" />
 import type { Browser as PuppeteerBrowser } from 'puppeteer-core';
 export declare function scrollAndMergeStrategy(browser: WebdriverIO.Browser): Promise<string>;
 export default function fullPageScreenshot(browser: WebdriverIO.Browser, forceScrollAndMerge?: boolean): Promise<string>;

package/page-objects/full-page-screenshot.js

@@ -44,6 +44,10 @@ async function scrollAndMergeStrategy(browser) {
 }
 exports.scrollAndMergeStrategy = scrollAndMergeStrategy;
 async function fullPageScreenshot(browser, forceScrollAndMerge = false) {
+    var _a;
+    if ((_a = browser.capabilities.browserName) === null || _a === void 0 ? void 0 : _a.toLowerCase().includes('firefox')) {
+        return scrollAndMergeStrategy(browser);
+    }
     const puppeteer = await (0, utils_1.getPuppeteer)(browser);
     if (puppeteer && !forceScrollAndMerge) {
         // casting due to mismatch in NodeJS types of EventEmitter

package/page-objects/screenshot.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="webdriverio/async" />
 import BasePageObject from './base';
 import { ScreenshotCapturingOptions, ScreenshotWithOffset } from './types';
 export default class ScreenshotPageObject extends BasePageObject {

package/page-objects/utils.d.ts

@@ -1,8 +1,7 @@
-/// <reference types="webdriverio/async" />
 import { ViewportSize, ElementRect } from './types';
 export declare function getElementCenter(rect: ElementRect): {
     x: number;
     y: number;
 };
 export declare function calculateIosTopOffset(dimensions: Pick<ViewportSize, 'screenWidth' | 'screenHeight' | 'pixelRatio'>): number;
-export declare function getPuppeteer(browser: WebdriverIO.Browser): Promise<import("puppeteer-core/lib/cjs/puppeteer/common/Browser").Browser | null>;
+export declare function getPuppeteer(browser: WebdriverIO.Browser): Promise<import("puppeteer-core").Browser | null>;

package/use-browser.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="webdriverio/async" />
 import { WebDriverOptions } from './browsers/browser-creator';
+import { Browser } from 'webdriverio';
 type BrowserOptions = {
     browserName: string;
     seleniumType: string;
@@ -8,7 +8,7 @@ type BrowserOptions = {
     skipConsoleErrorsCheck: boolean;
 };
 interface TestFunction {
-    (browser: WebdriverIO.Browser): Promise<void> | void;
+    (browser: Browser): Promise<void> | void;
 }
 declare function useBrowser(optionsOverride: Partial<WebDriverOptions>, testFn: TestFunction): () => Promise<void>;
 declare function useBrowser(testFn: TestFunction): () => Promise<void>;