Rewrite webdriverio element commands (#6139)

Co-authored-by: Mykola Grybyk <25589559+mgrybyk@users.noreply.github.com>

Author: christian-bromann

packages/webdriverio/src/commands/browser.js renamed to packages/webdriverio/src/commands/browser.ts

@@ -43,8 +43,11 @@
 import { findElements, enhanceElementsArray } from '../../utils'
 import { getElements } from '../../utils/getElementObject'
 
-export default async function $$ (this: WebdriverIO.BrowserObject, selector: string) {
+export default async function $$ (
+    this: WebdriverIO.BrowserObject,
+    selector: string
+) {
     const res = await findElements.call(this, selector)
     const elements = await getElements.call(this, selector, res)
-    return enhanceElementsArray(elements, this, selector)
+    return enhanceElementsArray(elements, this, selector) as WebdriverIO.Element[]
 }

packages/webdriverio/src/commands/browser/$$.ts

@@ -52,13 +52,18 @@ import { getElement } from '../../utils/getElementObject'
 import { ELEMENT_KEY } from '../../constants'
 import type { ElementReference } from '../../types'
 
-export default async function $ (this: WebdriverIO.BrowserObject, selector: string | ElementReference) {
+export default async function $ (
+    this: WebdriverIO.BrowserObject,
+    selector: string | ElementReference
+) {
+    const elemReference = selector as ElementReference
+
     /**
      * convert protocol result into WebdriverIO element
      * e.g. when element was fetched with `getActiveElement`
      */
-    if (typeof selector !== 'string' && typeof (selector as ElementReference)[ELEMENT_KEY] === 'string') {
-        return getElement.call(this, undefined, selector as ElementReference)
+    if (typeof selector !== 'string' && typeof elemReference[ELEMENT_KEY] === 'string') {
+        return getElement.call(this, undefined, elemReference)
     }
 
     const res = await findElement.call(this, selector)

packages/webdriverio/src/commands/browser/$.ts

@@ -26,14 +26,21 @@ import { getElements } from '../../utils/getElementObject'
 import { ELEMENT_KEY } from '../../constants'
 import type { ElementReference } from '../../types'
 
-async function custom$$ (this: WebdriverIO.BrowserObject, strategyName: string, ...strategyArguments: any[]) {
+export default async function custom$$ (
+    this: WebdriverIO.BrowserObject,
+    strategyName: string,
+    ...strategyArguments: any[]
+) {
     const strategy = this.strategies.get(strategyName)
 
     if (!strategy) {
         throw Error('No strategy found for ' + strategyName)
     }
 
-    let res: ElementReference | ElementReference[] = await this.execute(strategy, ...strategyArguments)
+    let res: ElementReference | ElementReference[] = await this.execute(
+        strategy,
+        ...strategyArguments
+    )
 
     /**
      * if the user's script return just one element
@@ -49,5 +56,3 @@ async function custom$$ (this: WebdriverIO.BrowserObject, strategyName: string,
     const elements = res.length ? await getElements.call(this, strategy.toString(), res) : []
     return enhanceElementsArray(elements, this, strategyName, 'custom$$', [strategyArguments])
 }
-
-export default custom$$

packages/webdriverio/src/commands/browser/custom$$.ts

@@ -25,14 +25,21 @@ import { getElement } from '../../utils/getElementObject'
 import { ELEMENT_KEY } from '../../constants'
 import type { ElementReference } from '../../types'
 
-async function custom$ (this: WebdriverIO.BrowserObject, strategyName: string, ...strategyArguments: any[]) {
+export default async function custom$ (
+    this: WebdriverIO.BrowserObject,
+    strategyName: string,
+    ...strategyArguments: any[]
+) {
     const strategy = this.strategies.get(strategyName)
 
     if (!strategy) {
         throw Error('No strategy found for ' + strategyName)
     }
 
-    let res: ElementReference | ElementReference[] = await this.execute(strategy, ...strategyArguments)
+    let res: ElementReference | ElementReference[] = await this.execute(
+        strategy,
+        ...strategyArguments
+    )
 
     /**
      * if the user's script returns multiple elements
@@ -49,5 +56,3 @@ async function custom$ (this: WebdriverIO.BrowserObject, strategyName: string, .
 
     throw Error('Your locator strategy script must return an element')
 }
-
-export default custom$

packages/webdriverio/src/commands/browser/custom$.ts

@@ -32,7 +32,10 @@
 import { serializeError } from 'serialize-error'
 import WDIORepl from '@wdio/repl'
 
-export default function debug(this: WebdriverIO.BrowserObject, commandTimeout = 5000) {
+export default function debug(
+    this: WebdriverIO.BrowserObject,
+    commandTimeout = 5000
+) {
     const repl = new WDIORepl()
     const { introMessage } = WDIORepl
 

packages/webdriverio/src/commands/browser/debug.ts

@@ -42,7 +42,10 @@
  *
  */
 
-export default function deleteCookies(this: WebdriverIO.BrowserObject, names?: string | string[]) {
+export default function deleteCookies(
+    this: WebdriverIO.BrowserObject,
+    names?: string | string[]
+) {
     if (names === undefined) {
         return this.deleteAllCookies()
     }

packages/webdriverio/src/commands/browser/deleteCookies.ts

@@ -35,15 +35,19 @@ import { verifyArgsAndStripIfElement } from '../../utils'
  *
  */
 
-export default function execute (this: WebdriverIO.BrowserObject, script: string | Function, ...args: any[]) {
-    /*!
+export default function execute (
+    this: WebdriverIO.BrowserObject,
+    script: string | Function,
+    ...args: any[]
+) {
+    /**
      * parameter check
      */
     if ((typeof script !== 'string' && typeof script !== 'function')) {
         throw new Error('number or type of arguments don\'t agree with execute protocol command')
     }
 
-    /*!
+    /**
      * instances started as multibrowserinstance can't getting called with
      * a function parameter, therefor we need to check if it starts with "function () {"
      */

packages/webdriverio/src/commands/browser/execute.ts

@@ -43,15 +43,19 @@ import { verifyArgsAndStripIfElement } from '../../utils'
  *
  */
 
-export default function executeAsync (this: WebdriverIO.BrowserObject, script: string | Function, ...args: any[]) {
-    /*!
+export default function executeAsync (
+    this: WebdriverIO.BrowserObject,
+    script: string | Function,
+    ...args: any[]
+) {
+    /**
      * parameter check
      */
     if ((typeof script !== 'string' && typeof script !== 'function')) {
         throw new Error('number or type of arguments don\'t agree with execute protocol command')
     }
 
-    /*!
+    /**
      * instances started as multibrowserinstance can't getting called with
      * a function parameter, therefor we need to check if it starts with "function () {"
      */

packages/webdriverio/src/commands/browser/executeAsync.ts

@@ -30,9 +30,12 @@
  * @uses webdriver/getAllCookies
  *
  */
-export default async function getCookies(this: WebdriverIO.BrowserObject, names?: string | string[]) {
+export default async function getCookies(
+    this: WebdriverIO.BrowserObject,
+    names?: string | string[]
+) {
     if (names === undefined) {
-        return this.getAllCookies()
+        return this.getAllCookies() as Promise<WebDriver.Cookie[]>
     }
 
     const namesList = Array.isArray(names) ? names : [names]

packages/webdriverio/src/commands/browser/getCookies.ts

@@ -16,7 +16,7 @@ export default async function getPuppeteer (this: WebdriverIO.BrowserObject) {
      * that instance
      */
     if (this.puppeteer) {
-        return this.puppeteer
+        return this.puppeteer as puppeteer.Browser
     }
 
     /**
@@ -28,7 +28,7 @@ export default async function getPuppeteer (this: WebdriverIO.BrowserObject) {
             browserURL: `http://${chromiumOptions.debuggerAddress}`,
             defaultViewport: null
         })
-        return this.puppeteer
+        return this.puppeteer as puppeteer.Browser
     }
 
     /**
@@ -56,7 +56,7 @@ export default async function getPuppeteer (this: WebdriverIO.BrowserObject) {
                 browserURL: `http://localhost:${rdPort}`,
                 defaultViewport: null
             })
-            return this.puppeteer
+            return this.puppeteer as puppeteer.Browser
         }
     }
 

packages/webdriverio/src/commands/browser/getPuppeteer.ts

@@ -1,15 +1,13 @@
 /**
  *
- * Returns browser window size (and position for drivers with W3C support).
+ * Returns browser window size.
  *
  * <example>
  * :getWindowSize.js
     it('should return browser window size', function () {
-        const windowSize = browser.getWindowSize(500, 600);
+        const windowSize = browser.getWindowSize();
         console.log(windowSize);
-        // outputs
-        // Firefox: { x: 4, y: 23, width: 1280, height: 767 }
-        // Chrome: { width: 1280, height: 767 }
+        // outputs `{ width: 1280, height: 767 }`
     });
  * </example>
  *
@@ -21,11 +19,18 @@
 
 import { getBrowserObject } from '../../utils'
 
-export default function getWindowSize(this: WebdriverIO.BrowserObject) {
+interface BrowserSize {
+    width: number
+    height: number
+}
+
+export default async function getWindowSize(this: WebdriverIO.BrowserObject) {
     const browser = getBrowserObject(this)
 
     if (!browser.isW3C) {
-        return browser._getWindowSize()
+        return browser._getWindowSize() as BrowserSize
     }
-    return browser.getWindowRect()
+
+    const { width, height } = await browser.getWindowRect() as BrowserSize
+    return { width, height } as BrowserSize
 }

packages/webdriverio/src/commands/browser/getWindowSize.ts

@@ -27,7 +27,10 @@
 
 import { checkUnicode } from '../../utils'
 
-export default function keys (this: WebdriverIO.BrowserObject, value: string | string[]) {
+export default function keys (
+    this: WebdriverIO.BrowserObject,
+    value: string | string[]
+) {
     let keySequence: string[] = []
 
     /**

packages/webdriverio/src/commands/browser/keys.ts

@@ -102,7 +102,11 @@ import { getBrowserObject } from '../../utils'
 
 const SESSION_MOCKS: Record<string, Set<Interception>> = {}
 
-export default async function mock (this: WebdriverIO.BrowserObject, url: string, filterOptions: WebdriverIO.MockFilterOptions) {
+export default async function mock (
+    this: WebdriverIO.BrowserObject,
+    url: string,
+    filterOptions?: WebdriverIO.MockFilterOptions
+): Promise<Interception> {
     const NetworkInterception = this.isSauce ? WebDriverNetworkInterception : DevtoolsNetworkInterception
 
     if (!this.isSauce) {
@@ -121,7 +125,9 @@ export default async function mock (this: WebdriverIO.BrowserObject, url: string
     if (SESSION_MOCKS[handle].size === 0 && !this.isSauce) {
         const pages = await this.puppeteer.pages()
 
-        // get active page
+        /**
+         * get active page
+         */
         let page
         for (let i = 0; i < pages.length && !page; i++) {
             const isHidden = await pages[i].evaluate(() => document.hidden)
@@ -130,7 +136,9 @@ export default async function mock (this: WebdriverIO.BrowserObject, url: string
             }
         }
 
-        // fallback to the first page
+        /**
+         * fallback to the first page
+         */
         if (!page) {
             page = pages[0]
         }

packages/webdriverio/src/commands/browser/mock.ts

@@ -36,15 +36,19 @@
 
 import newWindowHelper from '../../scripts/newWindow'
 
-export default async function newWindow (this: WebdriverIO.BrowserObject, url: string, { windowName = 'New Window', windowFeatures = '' }: WebdriverIO.NewWindowOptions = {}) {
-    /*!
+export default async function newWindow (
+    this: WebdriverIO.BrowserObject,
+    url: string,
+    { windowName = 'New Window', windowFeatures = '' }: WebdriverIO.NewWindowOptions = {}
+) {
+    /**
      * parameter check
      */
     if (typeof url !== 'string') {
         throw new Error('number or type of arguments don\'t agree with newWindow command')
     }
 
-    /*!
+    /**
      * mobile check
      */
     if (this.isMobile) {

packages/webdriverio/src/commands/browser/newWindow.ts

@@ -20,6 +20,9 @@
  *
  */
 
-export default function pause (this: WebdriverIO.BrowserObject, milliseconds = 1000) {
+export default function pause (
+    this: WebdriverIO.BrowserObject,
+    milliseconds = 1000
+) {
     return new Promise((resolve) => setTimeout(resolve, milliseconds))
 }

packages/webdriverio/src/commands/browser/pause.ts

@@ -31,7 +31,11 @@
 import fs from 'fs'
 import { getAbsoluteFilepath, assertDirectoryExists } from '../../utils'
 
-export default async function savePDF (this: WebdriverIO.BrowserObject, filepath: string, options?: WebdriverIO.PDFPrintOptions) {
+export default async function savePDF (
+    this: WebdriverIO.BrowserObject,
+    filepath: string,
+    options?: WebdriverIO.PDFPrintOptions
+) {
     /**
      * type check
      */

packages/webdriverio/src/commands/browser/savePDF.ts

@@ -22,7 +22,10 @@
 import fs from 'fs'
 import { getAbsoluteFilepath, assertDirectoryExists } from '../../utils'
 
-export default async function saveRecordingScreen (this: WebdriverIO.BrowserObject, filepath: string) {
+export default async function saveRecordingScreen (
+    this: WebdriverIO.BrowserObject,
+    filepath: string
+) {
     /**
      * type check
      */

packages/webdriverio/src/commands/browser/saveRecordingScreen.ts

@@ -21,7 +21,10 @@
 import fs from 'fs'
 import { getAbsoluteFilepath, assertDirectoryExists } from '../../utils'
 
-export default async function saveScreenshot (this: WebdriverIO.BrowserObject, filepath: string) {
+export default async function saveScreenshot (
+    this: WebdriverIO.BrowserObject,
+    filepath: string
+) {
     /**
      * type check
      */

packages/webdriverio/src/commands/browser/saveScreenshot.ts

@@ -62,6 +62,7 @@ export default async function setCookies(
         throw new Error('Invalid input (see https://webdriver.io/docs/api/browser/setCookies.html for documentation.')
     }
 
-    return Promise.all(cookieObjsList
+    await Promise.all(cookieObjsList
         .map(cookieObj => this.addCookie(cookieObj)))
+    return
 }