selenium-webdriver 4.16.0 → 4.18.0

package/bidi/input.js

@@ -0,0 +1,97 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// type: module added to package.json
+// import { WebElement } from '../lib/webdriver'
+const { WebElement } = require('../lib/webdriver')
+
+class Input {
+  constructor(driver) {
+    this._driver = driver
+  }
+
+  async init() {
+    if (!(await this._driver.getCapabilities()).get('webSocketUrl')) {
+      throw Error('WebDriver instance must support BiDi protocol')
+    }
+
+    this.bidi = await this._driver.getBidi()
+  }
+
+  async perform(browsingContextId, actions) {
+    const _actions = await updateActions(actions)
+
+    const command = {
+      method: 'input.performActions',
+      params: {
+        context: browsingContextId,
+        actions: _actions,
+      },
+    }
+
+    let response = await this.bidi.send(command)
+
+    return response
+  }
+
+  async release(browsingContextId) {
+    const command = {
+      method: 'input.releaseActions',
+      params: {
+        context: browsingContextId,
+      },
+    }
+    return await this.bidi.send(command)
+  }
+}
+
+async function updateActions(actions) {
+  const _actions = []
+  for (const action of actions) {
+    const sequenceList = action.actions
+    let updatedSequenceList = []
+
+    if (action.type === 'pointer' || action.type === 'wheel') {
+      for (const sequence of sequenceList) {
+        if ((sequence.type === 'pointerMove' || sequence.type === 'scroll') && sequence.origin instanceof WebElement) {
+          const element = sequence.origin
+          const elementId = await element.getId()
+          sequence.origin = {
+            type: 'element',
+            element: { sharedId: elementId },
+          }
+        }
+        updatedSequenceList.push(sequence)
+      }
+
+      const updatedAction = { ...action, actions: updatedSequenceList }
+      _actions.push(updatedAction)
+    } else {
+      _actions.push(action)
+    }
+  }
+
+  return _actions
+}
+
+async function getInputInstance(driver) {
+  let instance = new Input(driver)
+  await instance.init()
+  return instance
+}
+
+module.exports = getInputInstance

package/bidi/interceptPhase.js

@@ -0,0 +1,24 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const InterceptPhase = {
+  BEFORE_REQUEST_SENT: 'beforeRequestSent',
+  RESPONSE_STARTED: 'responseStarted',
+  AUTH_REQUIRED: 'authRequired',
+}
+
+module.exports = {InterceptPhase}

package/bidi/logInspector.js

@@ -19,15 +19,15 @@ const { FilterBy } = require('./filterBy')
 const { ConsoleLogEntry, JavascriptLogEntry, GenericLogEntry } = require('./logEntries')
 
 const LOG = {
-  TYPE_CONSOLE : 'console',
-  TYPE_JS_LOGS : 'javascript',
+  TYPE_CONSOLE: 'console',
+  TYPE_JS_LOGS: 'javascript',
 }
 
 class LogInspector {
   bidi
   ws
 
-  constructor (driver, browsingContextIds) {
+  constructor(driver, browsingContextIds) {
     this._driver = driver
     this._browsingContextIds = browsingContextIds
     this.listener = {}
@@ -37,7 +37,7 @@ class LogInspector {
    * Subscribe to log event
    * @returns {Promise<void>}
    */
-  async init () {
+  async init() {
     this.bidi = await this._driver.getBidi()
     await this.bidi.subscribe('log.entryAdded', this._browsingContextIds)
   }
@@ -45,7 +45,7 @@ class LogInspector {
   /**
    * @param kind
    */
-  logListener (kind) {
+  logListener(kind) {
     if (!(kind in this.listener)) {
       this.listener[kind] = []
     }
@@ -76,7 +76,7 @@ class LogInspector {
           params.method,
           params.realm,
           params.args,
-          params.stackTrace
+          params.stackTrace,
         )
 
         if (filterBy !== undefined) {
@@ -113,7 +113,7 @@ class LogInspector {
           params.text,
           params.timestamp,
           params.type,
-          params.stackTrace
+          params.stackTrace,
         )
 
         if (filterBy !== undefined) {
@@ -135,9 +135,7 @@ class LogInspector {
    */
   async onJavascriptException(callback) {
     this.ws = await this.bidi.socket
-    let enabled =
-      LOG.TYPE_JS_EXCEPTION in this.listener ||
-      this.logListener(LOG.TYPE_JS_EXCEPTION)
+    let enabled = LOG.TYPE_JS_EXCEPTION in this.listener || this.logListener(LOG.TYPE_JS_EXCEPTION)
     this.listener[LOG.TYPE_JS_EXCEPTION].push(callback)
 
     if (enabled) {
@@ -152,7 +150,7 @@ class LogInspector {
           params.text,
           params.timestamp,
           params.type,
-          params.stackTrace
+          params.stackTrace,
         )
 
         this.listener[LOG.TYPE_JS_EXCEPTION].forEach((listener) => {
@@ -183,7 +181,7 @@ class LogInspector {
           params.text,
           params.timestamp,
           params.type,
-          params.stackTrace
+          params.stackTrace,
         )
 
         if (filterBy !== undefined) {
@@ -206,7 +204,7 @@ class LogInspector {
           params.method,
           params.realm,
           params.args,
-          params.stackTrace
+          params.stackTrace,
         )
 
         if (filterBy !== undefined) {
@@ -220,16 +218,13 @@ class LogInspector {
         return
       }
 
-      if (
-        params !== undefined &&
-        !['console', 'javascript'].includes(params?.type)
-      ) {
+      if (params !== undefined && !['console', 'javascript'].includes(params?.type)) {
         let genericEntry = new GenericLogEntry(
           params.level,
           params.text,
           params.timestamp,
           params.type,
-          params.stackTrace
+          params.stackTrace,
         )
 
         if (filterBy !== undefined) {
@@ -248,7 +243,7 @@ class LogInspector {
    * Unsubscribe to log event
    * @returns {Promise<void>}
    */
-  async close () {
+  async close() {
     await this.bidi.unsubscribe('log.entryAdded', this._browsingContextIds)
   }
 }
@@ -259,7 +254,7 @@ class LogInspector {
  * @param browsingContextIds
  * @returns {Promise<LogInspector>}
  */
-async function getLogInspectorInstance (driver, browsingContextIds) {
+async function getLogInspectorInstance(driver, browsingContextIds) {
   let instance = new LogInspector(driver, browsingContextIds)
   await instance.init()
   return instance

package/bidi/network.js

@@ -0,0 +1,178 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+const { BeforeRequestSent, ResponseStarted, FetchError} = require('./networkTypes')
+const {AddInterceptParameters} = require("./addInterceptParameters");
+
+class Network {
+  constructor(driver, browsingContextIds) {
+    this._driver = driver
+    this._browsingContextIds = browsingContextIds
+  }
+
+  async init() {
+    this.bidi = await this._driver.getBidi()
+  }
+
+  async beforeRequestSent(callback) {
+    await this.subscribeAndHandleEvent('network.beforeRequestSent', callback)
+  }
+
+  async responseStarted(callback) {
+    await this.subscribeAndHandleEvent('network.responseStarted', callback)
+  }
+
+  async responseCompleted(callback) {
+    await this.subscribeAndHandleEvent('network.responseCompleted', callback)
+  }
+
+  async authRequired(callback) {
+    await this.subscribeAndHandleEvent('network.authRequired', callback)
+  }
+
+  async fetchError(callback) {
+    await this.subscribeAndHandleEvent('network.fetchError', callback)
+  }
+
+  async subscribeAndHandleEvent(eventType, callback) {
+    if (this._browsingContextIds != null) {
+      await this.bidi.subscribe(eventType, this._browsingContextIds)
+    } else {
+      await this.bidi.subscribe(eventType)
+    }
+    await this._on(callback)
+  }
+
+  async _on(callback) {
+    this.ws = await this.bidi.socket
+    this.ws.on('message', (event) => {
+      const { params } = JSON.parse(Buffer.from(event.toString()))
+      if (params) {
+        let response = null
+        if ('initiator' in params) {
+          response = new BeforeRequestSent(
+            params.context,
+            params.navigation,
+            params.redirectCount,
+            params.request,
+            params.timestamp,
+            params.initiator,
+          )
+        } else if ('response' in params) {
+          response = new ResponseStarted(
+            params.context,
+            params.navigation,
+            params.redirectCount,
+            params.request,
+            params.timestamp,
+            params.response,
+          )
+        } else if ('errorText' in params) {
+          response = new FetchError(
+            params.context,
+            params.navigation,
+            params.redirectCount,
+            params.request,
+            params.timestamp,
+            params.errorText,
+          )
+        }
+        callback(response)
+        }
+    })
+  }
+
+  async addIntercept(params) {
+
+    if (!params instanceof AddInterceptParameters) {
+      throw new Error(`Params must be an instance of AddInterceptParamenters. Received:'${params}'`)
+    }
+
+    const command = {
+      method: 'network.addIntercept',
+      params: Object.fromEntries(params.asMap())
+    }
+
+    let response = await this.bidi.send(command)
+
+    return response.result.intercept
+  }
+
+  async removeIntercept(interceptId) {
+    const command = {
+      method: 'network.removeIntercept',
+      params: {intercept: interceptId},
+    }
+
+    await this.bidi.send(command)
+  }
+
+  async continueWithAuth(requestId, username, password) {
+    const command = {
+            method: 'network.continueWithAuth',
+            params: {
+              request: requestId.toString(),
+              action: 'provideCredentials',
+              credentials: {
+                type: 'password',
+                username: username,
+                password: password
+              },
+            },
+          }
+    await this.bidi.send(command)
+  }
+
+  async continueWithAuthNoCredentials(requestId) {
+    const command = {
+      method: 'network.continueWithAuth',
+      params: {
+        request: requestId.toString(),
+        action: 'default'
+      },
+    }
+    await this.bidi.send(command)
+  }
+
+  async cancelAuth(requestId) {
+    const command = {
+      method: 'network.continueWithAuth',
+      params: {
+        request: requestId.toString(),
+        action: 'cancel'
+      },
+    }
+    await this.bidi.send(command)
+  }
+
+  async close() {
+    await this.bidi.unsubscribe(
+      'network.beforeRequestSent',
+      'network.responseStarted',
+      'network.responseCompleted',
+      'network.authRequired')
+  }
+
+}
+
+async function getNetworkInstance(driver, browsingContextIds = null) {
+  let instance = new Network(driver, browsingContextIds)
+  await instance.init()
+  return instance
+}
+
+module.exports = getNetworkInstance

package/bidi/networkInspector.js

@@ -17,6 +17,12 @@
 
 const { BeforeRequestSent, ResponseStarted } = require('./networkTypes')
 
+/**
+ * @deprecated
+ * in favor of using the `Network` class from `bidi/network.js`
+ *  Inspector is specific to listening to events.
+ *  Goal is to club commands and events under one class called Network.
+ */
 class NetworkInspector {
   constructor(driver, browsingContextIds) {
     this._driver = driver
@@ -39,6 +45,10 @@ class NetworkInspector {
     await this.subscribeAndHandleEvent('network.responseCompleted', callback)
   }
 
+  async authRequired(callback) {
+    await this.subscribeAndHandleEvent('network.authRequired', callback)
+  }
+
   async subscribeAndHandleEvent(eventType, callback) {
     if (this._browsingContextIds != null) {
       await this.bidi.subscribe(eventType, this._browsingContextIds)
@@ -61,7 +71,7 @@ class NetworkInspector {
             params.redirectCount,
             params.request,
             params.timestamp,
-            params.initiator
+            params.initiator,
           )
         } else if ('response' in params) {
           response = new ResponseStarted(
@@ -70,7 +80,7 @@ class NetworkInspector {
             params.redirectCount,
             params.request,
             params.timestamp,
-            params.response
+            params.response,
           )
         }
         callback(response)

package/bidi/networkTypes.js

@@ -38,18 +38,7 @@ class Header {
 }
 
 class Cookie {
-  constructor(
-    name,
-    value,
-    binaryValue,
-    domain,
-    path,
-    expires,
-    size,
-    httpOnly,
-    secure,
-    sameSite
-  ) {
+  constructor(name, value, binaryValue, domain, path, expires, size, httpOnly, secure, sameSite) {
     this._name = name
     this._value = value
     this._binaryValue = binaryValue
@@ -118,7 +107,7 @@ class FetchTimingInfo {
     tlsStart,
     requestStart,
     responseStart,
-    responseEnd
+    responseEnd,
   ) {
     this._originTime = originTime
     this._requestTime = requestTime
@@ -189,16 +178,7 @@ class FetchTimingInfo {
 }
 
 class RequestData {
-  constructor(
-    request,
-    url,
-    method,
-    headers,
-    cookies,
-    headersSize,
-    bodySize,
-    timings
-  ) {
+  constructor(request, url, method, headers, cookies, headersSize, bodySize, timings) {
     this._request = request
     this._url = url
     this._method = method
@@ -224,20 +204,7 @@ class RequestData {
       let binaryValue = 'binaryValue' in cookie ? cookie.binaryValue : null
       let expires = 'expires' in cookie ? cookie.expires : null
 
-      this._cookies.push(
-        new Cookie(
-          name,
-          value,
-          binaryValue,
-          domain,
-          path,
-          expires,
-          size,
-          httpOnly,
-          secure,
-          sameSite
-        )
-      )
+      this._cookies.push(new Cookie(name, value, binaryValue, domain, path, expires, size, httpOnly, secure, sameSite))
     })
     this._headersSize = headersSize
     this._bodySize = bodySize
@@ -254,7 +221,7 @@ class RequestData {
       timings.tlsStart,
       timings.requestStart,
       timings.responseStart,
-      timings.responseEnd
+      timings.responseEnd,
     )
   }
 
@@ -296,12 +263,7 @@ class BaseParameters {
     this._id = id
     this._navigation =
       navigation != null
-        ? new NavigationInfo(
-            navigation.context,
-            navigation.navigation,
-            navigation.timestamp,
-            navigation.url
-          )
+        ? new NavigationInfo(navigation.context, navigation.navigation, navigation.timestamp, navigation.url)
         : null
     this._redirectCount = redirectCount
     this._request = new RequestData(
@@ -312,7 +274,7 @@ class BaseParameters {
       request.cookies,
       request.headersSize,
       request.bodySize,
-      request.timings
+      request.timings,
     )
     this._timestamp = timestamp
   }
@@ -376,7 +338,7 @@ class BeforeRequestSent extends BaseParameters {
       initiator.columnNumber,
       initiator.lineNumber,
       initiator.stackTrace,
-      initiator.request
+      initiator.request,
     )
   }
 
@@ -385,6 +347,17 @@ class BeforeRequestSent extends BaseParameters {
   }
 }
 
+class FetchError extends BaseParameters {
+  constructor(id, navigation, redirectCount, request, timestamp, errorText) {
+    super(id, navigation, redirectCount, request, timestamp)
+    this._errorText = errorText
+  }
+
+  get errorText() {
+    return this._errorText
+  }
+}
+
 class ResponseData {
   constructor(
     url,
@@ -397,7 +370,7 @@ class ResponseData {
     bytesReceived,
     headersSize,
     bodySize,
-    content
+    content,
   ) {
     this._url = url
     this._protocol = protocol
@@ -471,7 +444,7 @@ class ResponseStarted extends BaseParameters {
       response.bytesReceived,
       response.headerSize,
       response.bodySize,
-      response.content
+      response.content,
     )
   }
 
@@ -480,4 +453,4 @@ class ResponseStarted extends BaseParameters {
   }
 }
 
-module.exports = { BeforeRequestSent, ResponseStarted }
+module.exports = { BeforeRequestSent, ResponseStarted, FetchError }

package/bidi/protocolType.js

@@ -27,9 +27,7 @@ const PrimitiveType = {
   findByName(name) {
     return (
       Object.values(this).find((type) => {
-        return (
-          typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
-        )
+        return typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
       }) || null
     )
   },
@@ -42,13 +40,12 @@ const NonPrimitiveType = {
   OBJECT: 'object',
   REGULAR_EXPRESSION: 'regexp',
   SET: 'set',
+  CHANNEL: 'channel',
 
   findByName(name) {
     return (
       Object.values(this).find((type) => {
-        return (
-          typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
-        )
+        return typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
       }) || null
     )
   },
@@ -74,9 +71,7 @@ const RemoteType = {
   findByName(name) {
     return (
       Object.values(this).find((type) => {
-        return (
-          typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
-        )
+        return typeof type === 'string' && name.toLowerCase() === type.toLowerCase()
       }) || null
     )
   },