selenium-webdriver 4.9.2 → 4.11.0

package/CHANGES.md

@@ -1,3 +1,42 @@
+## v4.11.0
+
+#### :nail_care: Polish
+
+* [BiDi] fix addPreloadScript failing tests (#12182)
+* Print debug message once for each browser when selenium manager used
+* Add forgotten RelativeBy in check options (#12289)
+* SM supports all browsers in Selenium since a while ago
+* Using SM to check drivers on the PATH
+* Display info about SM activity
+* Removing logic to find drivers, delegating to Selenium Manager
+* Removing service parameter from getPath
+* add support for Chrome 115 and remove support for Chrome 112
+* Update webdriver-bootstrap.js (#12276)
+
+#### :rocket: New Feature
+
+* [BiDi] add Network module events (#12197)
+* Adding ignore process match for IE Mode across bindings (#12279)
+* Add browser output from Selenium Manager to options (#12411)
+
+#### :bug: Bug Fix
+
+* fix SeleniumServer.start() crashes on MacOS with nodejs selenium-webdriver (#12158)
+* Update by.js: Add forgotten RelativeBy in check options (#12289)
+
+## v4.10.0
+
+#### :nail_care: Polish
+
+* Adding CDP v114 and removing v111
+
+#### :rocket: New Feature
+
+* [Edge] Support webview2 (#11978)
+* [BiDi] Add Script module commands to add/remove preloaded scripts (#11847)
+* [BiDi] Add printPage command (#12124)
+* Add support for proxies with Selenium Manager
+
 ## v4.9.2
 
 #### :nail_care: Polish
@@ -1294,3 +1333,12 @@ major version release (i.e. 1.0.0).
 * Initial release for npm:
 
         npm install selenium-webdriver
+
+
+
+
+
+    
+
+
+    

package/bidi/browsingContext.js

@@ -26,13 +26,13 @@ class BrowsingContext {
       throw Error('WebDriver instance must support BiDi protocol')
     }
 
-    if (type != undefined && !['window', 'tab'].includes(type)) {
+    if (type !== undefined && !['window', 'tab'].includes(type)) {
       throw Error(`Valid types are 'window' & 'tab'. Received: ${type}`)
     }
 
     this.bidi = await this._driver.getBidi()
     this._id =
-      browsingContextId == undefined
+      browsingContextId === undefined
         ? (await this.create(type, referenceContext))['result']['context']
         : browsingContextId
   }
@@ -65,7 +65,7 @@ class BrowsingContext {
    */
   async navigate(url, readinessState = undefined) {
     if (
-      readinessState != undefined &&
+      readinessState !== undefined &&
       !['none', 'interactive', 'complete'].includes(readinessState)
     ) {
       throw Error(
@@ -117,7 +117,7 @@ class BrowsingContext {
   }
 
   /**
-   * Closes the browing context
+   * Closes the browsing context
    * @returns {Promise<void>}
    */
   async close() {
@@ -129,6 +129,42 @@ class BrowsingContext {
     }
     await this.bidi.send(params)
   }
+
+  /**
+   * Prints PDF of the webpage
+   * @param options print options given by the user
+   * @returns PrintResult object
+   */
+  async printPage(options = {}) {
+    let params = {
+      method: 'browsingContext.print',
+      // Setting default values for parameters
+      params: {
+        context: this._id,
+        background: false,
+        margin: {
+          bottom: 1.0,
+          left: 1.0,
+          right: 1.0,
+          top: 1.0,
+        },
+        orientation: 'portrait',
+        page: {
+          height: 27.94,
+          width: 21.59,
+        },
+        pageRanges: [],
+        scale: 1.0,
+        shrinkToFit: true,
+      },
+    }
+
+    // Updating parameter values based on the options passed
+    params.params = this._driver.validatePrintPageParams(options, params.params)
+
+    const response = await this.bidi.send(params)
+    return new PrintResult(response.result.data)
+  }
 }
 
 class NavigateResult {
@@ -146,6 +182,16 @@ class NavigateResult {
   }
 }
 
+class PrintResult {
+  constructor(data) {
+    this._data = data
+  }
+
+  get data() {
+    return this._data
+  }
+}
+
 /**
  * initiate browsing context instance and return
  * @param driver

package/bidi/browsingContextInspector.js

@@ -54,7 +54,7 @@ class BrowsingContextInspector {
     } else {
       await this.bidi.subscribe(eventType)
     }
-    this._on(callback)
+    await this._on(callback)
   }
 
   async _on(callback) {

package/bidi/logInspector.js

@@ -54,10 +54,11 @@ class LogInspector {
   /**
    * Listen to Console logs
    * @param callback
+   * @param filterBy
    * @returns {Promise<void>}
    */
   async onConsoleEntry(callback, filterBy = undefined) {
-    if (filterBy != undefined && !(filterBy instanceof FilterBy)) {
+    if (filterBy !== undefined && !(filterBy instanceof FilterBy)) {
       throw Error(`Pass valid FilterBy object. Received: ${filterBy}`)
     }
 
@@ -78,7 +79,7 @@ class LogInspector {
           params.stackTrace
         )
 
-        if (filterBy != undefined) {
+        if (filterBy !== undefined) {
           if (params?.level === filterBy.getLevel()) {
             callback(consoleEntry)
           }
@@ -93,10 +94,11 @@ class LogInspector {
   /**
    * Listen to JS logs
    * @param callback
+   * @param filterBy
    * @returns {Promise<void>}
    */
   async onJavascriptLog(callback, filterBy = undefined) {
-    if (filterBy != undefined && !(filterBy instanceof FilterBy)) {
+    if (filterBy !== undefined && !(filterBy instanceof FilterBy)) {
       throw Error(`Pass valid FilterBy object. Received: ${filterBy}`)
     }
 
@@ -114,7 +116,7 @@ class LogInspector {
           params.stackTrace
         )
 
-        if (filterBy != undefined) {
+        if (filterBy !== undefined) {
           if (params?.level === filterBy.getLevel()) {
             callback(jsEntry)
           }
@@ -163,10 +165,11 @@ class LogInspector {
   /**
    * Listen to any logs
    * @param callback
+   * @param filterBy
    * @returns {Promise<void>}
    */
   async onLog(callback, filterBy = undefined) {
-    if (filterBy != undefined && !(filterBy instanceof FilterBy)) {
+    if (filterBy !== undefined && !(filterBy instanceof FilterBy)) {
       throw Error(`Pass valid FilterBy object. Received: ${filterBy}`)
     }
 
@@ -183,7 +186,7 @@ class LogInspector {
           params.stackTrace
         )
 
-        if (filterBy != undefined) {
+        if (filterBy !== undefined) {
           if (params?.level === filterBy.getLevel()) {
             callback(jsEntry)
           }
@@ -193,7 +196,7 @@ class LogInspector {
         callback(jsEntry)
         return
       }
-  
+
       if (params?.type === 'console') {
         let consoleEntry = new ConsoleLogEntry(
           params.level,
@@ -205,8 +208,8 @@ class LogInspector {
           params.args,
           params.stackTrace
         )
-        
-        if (filterBy != undefined) {
+
+        if (filterBy !== undefined) {
           if (params?.level === filterBy.getLevel()) {
             callback(consoleEntry)
           }
@@ -218,7 +221,7 @@ class LogInspector {
       }
 
       if (
-        params != undefined &&
+        params !== undefined &&
         !['console', 'javascript'].includes(params?.type)
       ) {
         let genericEntry = new GenericLogEntry(
@@ -229,7 +232,7 @@ class LogInspector {
           params.stackTrace
         )
 
-        if (filterBy != undefined) {
+        if (filterBy !== undefined) {
           if (params?.level === filterBy.getLevel()) {
             callback(genericEntry)
           }

package/bidi/networkInspector.js

@@ -0,0 +1,88 @@
+// 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 } = require('./networkTypes')
+
+class NetworkInspector {
+  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 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
+          )
+        }
+        callback(response)
+      }
+    })
+  }
+}
+
+async function getNetworkInspectorInstance(driver, browsingContextIds = null) {
+  let instance = new NetworkInspector(driver, browsingContextIds)
+  await instance.init()
+  return instance
+}
+
+module.exports = getNetworkInspectorInstance