selenium-webdriver 4.16.0 → 4.18.0

package/bidi/protocolValue.js

@@ -15,17 +15,13 @@
 // specific language governing permissions and limitations
 // under the License.
 
-const {
-  PrimitiveType,
-  NonPrimitiveType,
-  RemoteType,
-} = require('./protocolType')
+const { PrimitiveType, NonPrimitiveType, RemoteType } = require('./protocolType')
 
 const TYPE_CONSTANT = 'type'
 const VALUE_CONSTANT = 'value'
 const RemoteReferenceType = {
   HANDLE: 'handle',
-  SHARED_ID: 'shareId',
+  SHARED_ID: 'sharedId',
 }
 
 class LocalValue {
@@ -98,16 +94,15 @@ class LocalValue {
     return new LocalValue(NonPrimitiveType.SET, value)
   }
 
+  static createChannelValue(value) {
+    return new LocalValue(NonPrimitiveType.CHANNEL, value)
+  }
+
   toJson() {
     let toReturn = {}
     toReturn[TYPE_CONSTANT] = this.type
 
-    if (
-      !(
-        this.type === PrimitiveType.NULL ||
-        this.type === PrimitiveType.UNDEFINED
-      )
-    ) {
+    if (!(this.type === PrimitiveType.NULL || this.type === PrimitiveType.UNDEFINED)) {
       toReturn[VALUE_CONSTANT] = this.value
     }
     return toReturn
@@ -165,12 +160,12 @@ class RemoteValue {
 }
 
 class ReferenceValue {
-  constructor(handle, shareId) {
+  constructor(handle, sharedId) {
     if (handle === RemoteReferenceType.HANDLE) {
-      this.handle = shareId
+      this.handle = sharedId
     } else {
       this.handle = handle
-      this.shareId = shareId
+      this.sharedId = sharedId
     }
   }
 
@@ -180,8 +175,8 @@ class ReferenceValue {
       toReturn[RemoteReferenceType.HANDLE] = this.handle
     }
 
-    if (this.shareId != null) {
-      toReturn[RemoteReferenceType.SHARED_ID] = this.shareId
+    if (this.sharedId != null) {
+      toReturn[RemoteReferenceType.SHARED_ID] = this.sharedId
     }
 
     return toReturn
@@ -195,10 +190,46 @@ class RegExpValue {
   }
 }
 
+class SerializationOptions {
+  constructor(maxDomDepth = 0, maxObjectDepth = null, includeShadowTree = 'none') {
+    this._maxDomDepth = maxDomDepth
+    this._maxObjectDepth = maxObjectDepth
+
+    if (['none', 'open', 'all'].includes(includeShadowTree)) {
+      throw Error(`Valid types are 'none', 'open', and 'all'. Received: ${includeShadowTree}`)
+    }
+    this._includeShadowTree = includeShadowTree
+  }
+}
+
+class ChannelValue {
+  constructor(channel, options = undefined, resultOwnership = undefined) {
+    this.channel = channel
+
+    if (options !== undefined) {
+      if (options instanceof SerializationOptions) {
+        this.options = options
+      } else {
+        throw Error(`Pass in SerializationOptions object. Received: ${options} `)
+      }
+    }
+
+    if (resultOwnership != undefined) {
+      if (['root', 'none'].includes(resultOwnership)) {
+        this.resultOwnership = resultOwnership
+      } else {
+        throw Error(`Valid types are 'root' and 'none. Received: ${resultOwnership}`)
+      }
+    }
+  }
+}
+
 module.exports = {
+  ChannelValue,
   LocalValue,
   RemoteValue,
   ReferenceValue,
   RemoteReferenceType,
   RegExpValue,
+  SerializationOptions,
 }

package/bidi/realmInfo.js

@@ -28,9 +28,7 @@ const RealmType = {
   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
     )
   },
@@ -72,13 +70,7 @@ class RealmInfo {
     }
 
     if (realmType === RealmType.WINDOW) {
-      return new WindowRealmInfo(
-        realmId,
-        origin,
-        realmType,
-        browsingContext,
-        sandbox
-      )
+      return new WindowRealmInfo(realmId, origin, realmType, browsingContext, sandbox)
     }
 
     return new RealmInfo(realmId, origin, realmType)
@@ -96,4 +88,5 @@ class WindowRealmInfo extends RealmInfo {
 module.exports = {
   RealmInfo,
   RealmType,
+  WindowRealmInfo,
 }

package/bidi/scriptManager.js

@@ -21,8 +21,10 @@ const {
   EvaluateResultException,
   ExceptionDetails,
 } = require('./evaluateResult')
-const { RealmInfo } = require('./realmInfo')
+const { Message } = require('./scriptTypes')
+const { RealmInfo, RealmType, WindowRealmInfo } = require('./realmInfo')
 const { RemoteValue } = require('./protocolValue')
+const { Source } = require('./scriptTypes')
 const { WebDriverError } = require('../lib/error')
 
 class ScriptManager {
@@ -53,11 +55,7 @@ class ScriptManager {
     await this.bidi.send(params)
   }
 
-  async disownBrowsingContextScript(
-    browsingContextId,
-    handles,
-    sandbox = null
-  ) {
+  async disownBrowsingContextScript(browsingContextId, handles, sandbox = null) {
     const params = {
       method: 'script.disown',
       params: {
@@ -81,7 +79,7 @@ class ScriptManager {
     awaitPromise,
     argumentValueList = null,
     thisParameter = null,
-    resultOwnership = null
+    resultOwnership = null,
   ) {
     const params = this.getCallFunctionParams(
       'realm',
@@ -91,7 +89,7 @@ class ScriptManager {
       awaitPromise,
       argumentValueList,
       thisParameter,
-      resultOwnership
+      resultOwnership,
     )
 
     const command = {
@@ -110,7 +108,7 @@ class ScriptManager {
     argumentValueList = null,
     thisParameter = null,
     resultOwnership = null,
-    sandbox = null
+    sandbox = null,
   ) {
     const params = this.getCallFunctionParams(
       'contextTarget',
@@ -120,7 +118,7 @@ class ScriptManager {
       awaitPromise,
       argumentValueList,
       thisParameter,
-      resultOwnership
+      resultOwnership,
     )
 
     const command = {
@@ -131,20 +129,8 @@ class ScriptManager {
     return this.createEvaluateResult(response)
   }
 
-  async evaluateFunctionInRealm(
-    realmId,
-    expression,
-    awaitPromise,
-    resultOwnership = null
-  ) {
-    const params = this.getEvaluateParams(
-      'realm',
-      realmId,
-      null,
-      expression,
-      awaitPromise,
-      resultOwnership
-    )
+  async evaluateFunctionInRealm(realmId, expression, awaitPromise, resultOwnership = null) {
+    const params = this.getEvaluateParams('realm', realmId, null, expression, awaitPromise, resultOwnership)
 
     const command = {
       method: 'script.evaluate',
@@ -160,7 +146,7 @@ class ScriptManager {
     expression,
     awaitPromise,
     resultOwnership = null,
-    sandbox = null
+    sandbox = null,
   ) {
     const params = this.getEvaluateParams(
       'contextTarget',
@@ -168,7 +154,7 @@ class ScriptManager {
       sandbox,
       expression,
       awaitPromise,
-      resultOwnership
+      resultOwnership,
     )
 
     const command = {
@@ -180,11 +166,7 @@ class ScriptManager {
     return this.createEvaluateResult(response)
   }
 
-  async addPreloadScript(
-    functionDeclaration,
-    argumentValueList = [],
-    sandbox = null
-  ) {
+  async addPreloadScript(functionDeclaration, argumentValueList = [], sandbox = null) {
     const params = {
       functionDeclaration: functionDeclaration,
       arguments: argumentValueList,
@@ -221,7 +203,7 @@ class ScriptManager {
     awaitPromise,
     argumentValueList = null,
     thisParameter = null,
-    resultOwnership = null
+    resultOwnership = null,
   ) {
     const params = {
       functionDeclaration: functionDeclaration,
@@ -256,14 +238,7 @@ class ScriptManager {
     return params
   }
 
-  getEvaluateParams(
-    targetType,
-    id,
-    sandbox,
-    expression,
-    awaitPromise,
-    resultOwnership = null
-  ) {
+  getEvaluateParams(targetType, id, sandbox, expression, awaitPromise, resultOwnership = null) {
     const params = {
       expression: expression,
       awaitPromise: awaitPromise,
@@ -291,16 +266,10 @@ class ScriptManager {
 
     if (type === EvaluateResultType.SUCCESS) {
       const result = response.result.result
-      evaluateResult = new EvaluateResultSuccess(
-        realmId,
-        new RemoteValue(result)
-      )
+      evaluateResult = new EvaluateResultSuccess(realmId, new RemoteValue(result))
     } else {
       const exceptionDetails = response.result.exceptionDetails
-      evaluateResult = new EvaluateResultException(
-        realmId,
-        new ExceptionDetails(exceptionDetails)
-      )
+      evaluateResult = new EvaluateResultException(realmId, new ExceptionDetails(exceptionDetails))
     }
     return evaluateResult
   }
@@ -348,6 +317,49 @@ class ScriptManager {
     let response = await this.bidi.send(command)
     return this.realmInfoMapper(response.result.realms)
   }
+
+  async onMessage(callback) {
+    await this.subscribeAndHandleEvent('script.message', callback)
+  }
+
+  async onRealmCreated(callback) {
+    await this.subscribeAndHandleEvent('script.realmCreated', callback)
+  }
+
+  async onRealmDestroyed(callback) {
+    await this.subscribeAndHandleEvent('script.realmDestroyed', 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 ('channel' in params) {
+          response = new Message(params.channel, new RemoteValue(params.data), new Source(params.source))
+        } else if ('realm' in params) {
+          if (params.type === RealmType.WINDOW) {
+            response = new WindowRealmInfo(params.realm, params.origin, params.type, params.context, params.sandbox)
+          } else if (params.realm !== null && params.type !== null) {
+            response = new RealmInfo(params.realm, params.origin, params.type)
+          } else if (params.realm !== null) {
+            response = params.realm
+          }
+        }
+        callback(response)
+      }
+    })
+  }
 }
 
 async function getScriptManagerInstance(browsingContextId, driver) {

package/bidi/scriptTypes.js

@@ -0,0 +1,58 @@
+// 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.
+
+class Message {
+  constructor(channel, data, source) {
+    this._channel = channel
+    this._data = data
+    this._source = source
+  }
+
+  get channel() {
+    return this._channel
+  }
+
+  get data() {
+    return this._data
+  }
+
+  get source() {
+    return this._source
+  }
+}
+
+class Source {
+  constructor(source) {
+    this._browsingContextId = null
+    this._realmId = source.realm
+
+    // Browsing context is returned as an optional parameter
+    if ('context' in source) {
+      this._browsingContextId = source.context
+    }
+  }
+
+  get browsingContextId() {
+    return this._browsingContextId
+  }
+
+  get realmId() {
+    return this._realmId
+  }
+}
+
+module.exports = { Message, Source }

package/bidi/urlPattern.js

@@ -0,0 +1,58 @@
+// 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 {LocalValue} = require('./protocolValue')
+
+class UrlPattern {
+  #map = new Map()
+
+  protocol(protocol) {
+    this.#map.set('protocol', protocol)
+    return this
+  }
+
+  hostname(hostname) {
+    this.#map.set('hostname', hostname)
+    return this
+  }
+
+  port(port) {
+    if (typeof port === 'number') {
+      this.#map.set('port', port.toString())
+    } else {
+      throw new Error(`Port must be a number. Received:'${port}'`)
+    }
+    return this
+  }
+
+  pathname(pathname) {
+    this.#map.set('pathname', pathname)
+    return this
+  }
+
+  search(search) {
+    this.#map.set('search', search)
+    return this
+  }
+
+  asMap() {
+    this.#map.set('type', 'pattern')
+    return this.#map
+  }
+}
+
+module.exports = {UrlPattern}

package/chrome.js

@@ -36,17 +36,12 @@
  *     a unique browser session with a clean user profile (unless otherwise
  *     configured through the {@link Options} class).
  *
- * __Headless Chrome__ <a id="headless"></a>
- *
- * To start Chrome in headless mode, simply call
- * {@linkplain Options#headless Options.headless()}.
- *
  *     let chrome = require('selenium-webdriver/chrome');
  *     let {Builder} = require('selenium-webdriver');
  *
  *     let driver = new Builder()
  *         .forBrowser('chrome')
- *         .setChromeOptions(new chrome.Options().headless())
+ *         .setChromeOptions(new chrome.Options())
  *         .build();
  *
  * __Customizing the ChromeDriver Server__ <a id="custom-server"></a>
@@ -219,14 +214,7 @@ class Driver extends chromium.Driver {
    */
   static createSession(opt_config, opt_serviceExecutor) {
     let caps = opt_config || new Options()
-    return /** @type {!Driver} */ (
-      super.createSession(
-        caps,
-        opt_serviceExecutor,
-        'goog',
-        CHROME_CAPABILITY_KEY
-      )
-    )
+    return /** @type {!Driver} */ (super.createSession(caps, opt_serviceExecutor, 'goog', CHROME_CAPABILITY_KEY))
   }
 
   /**