[bidi][js] Deprecate NetworkInspector in favor of Network

Author: pujagani

javascript/node/selenium-webdriver/bidi/network.js

@@ -0,0 +1,92 @@
+// 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 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 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 getNetworkInstance(driver, browsingContextIds = null) {
+  let instance = new Network(driver, browsingContextIds)
+  await instance.init()
+  return instance
+}
+
+module.exports = getNetworkInstance

javascript/node/selenium-webdriver/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

javascript/node/selenium-webdriver/test/bidi/network_test.js

@@ -21,7 +21,7 @@ const assert = require('assert')
 const firefox = require('../../firefox')
 const { Browser, By, WebElement } = require('../../')
 const { Pages, suite } = require('../../lib/test')
-const NetworkInspector = require('../../bidi/networkInspector')
+const Network = require('../../bidi/network')
 const until = require('../../lib/until')
 
 suite(
@@ -39,11 +39,11 @@ suite(
       await driver.quit()
     })
 
-    describe('Network Inspector', function () {
+    describe('Network network', function () {
       it('can listen to event before request is sent', async function () {
         let beforeRequestEvent = null
-        const inspector = await NetworkInspector(driver)
-        await inspector.beforeRequestSent(function (event) {
+        const network = await Network(driver)
+        await network.beforeRequestSent(function (event) {
           beforeRequestEvent = event
         })
 
@@ -55,9 +55,9 @@ suite(
       })
 
       it('can request cookies', async function () {
-        const inspector = await NetworkInspector(driver)
+        const network = await Network(driver)
         let beforeRequestEvent = null
-        await inspector.beforeRequestSent(function (event) {
+        await network.beforeRequestSent(function (event) {
           beforeRequestEvent = event
         })
 
@@ -89,8 +89,8 @@ suite(
 
       it('can redirect http equiv', async function () {
         let beforeRequestEvent = []
-        const inspector = await NetworkInspector(driver)
-        await inspector.beforeRequestSent(function (event) {
+        const network = await Network(driver)
+        await network.beforeRequestSent(function (event) {
           beforeRequestEvent.push(event)
         })
 
@@ -109,8 +109,8 @@ suite(
 
       it('can subscribe to response started', async function () {
         let onResponseStarted = []
-        const inspector = await NetworkInspector(driver)
-        await inspector.responseStarted(function (event) {
+        const network = await Network(driver)
+        await network.responseStarted(function (event) {
           onResponseStarted.push(event)
         })
 
@@ -133,8 +133,8 @@ suite(
 
       it('test response started mime type', async function () {
         let onResponseStarted = []
-        const inspector = await NetworkInspector(driver)
-        await inspector.responseStarted(function (event) {
+        const network = await Network(driver)
+        await network.responseStarted(function (event) {
           onResponseStarted.push(event)
         })
 
@@ -163,8 +163,8 @@ suite(
 
       it('can subscribe to response completed', async function () {
         let onResponseCompleted = []
-        const inspector = await NetworkInspector(driver)
-        await inspector.responseCompleted(function (event) {
+        const network = await Network(driver)
+        await network.responseCompleted(function (event) {
           onResponseCompleted.push(event)
         })
 
@@ -188,8 +188,8 @@ suite(
 
       xit('can listen to auth required event', async function () {
         let authRequiredEvent = null
-        const inspector = await NetworkInspector(driver)
-        await inspector.authRequired(function (event) {
+        const network = await Network(driver)
+        await network.authRequired(function (event) {
           authRequiredEvent = event
         })
 
@@ -207,8 +207,8 @@ suite(
 
       it('test response completed mime type', async function () {
         let onResponseCompleted = []
-        const inspector = await NetworkInspector(driver)
-        await inspector.responseCompleted(function (event) {
+        const network = await Network(driver)
+        await network.responseCompleted(function (event) {
           onResponseCompleted.push(event)
         })