[js][bidi] Add methods to listen to js logs and any type of logs

Author: pujagani

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

@@ -15,11 +15,13 @@
 // specific language governing permissions and limitations
 // under the License.
 
-const { ConsoleLogEntry, JavascriptLogEntry } = require('./logEntries')
+const { ConsoleLogEntry, JavascriptLogEntry, GenericLogEntry } = require('./logEntries')
 
 const LOG = {
   TYPE_CONSOLE : 'console',
-  TYPE_JS_EXCEPTION: 'jsException'
+  TYPE_JS_LOGS : 'jsLogs',
+  TYPE_JS_EXCEPTION: 'jsException',
+  TYPE_LOG : 'log'
 }
 
 class LogInspector {
@@ -80,7 +82,36 @@ class LogInspector {
   }
 
   /**
-   * List to JS Exceptions
+   * Listen to JS logs
+   * @param callback
+   * @returns {Promise<void>}
+   */
+  async onJavascriptLog (callback) {
+    this.ws = await this.bidi.socket
+    let enabled = (LOG.TYPE_JS_LOGS in this.listener) || this.logListener(
+      LOG.TYPE_JS_LOGS)
+    this.listener[LOG.TYPE_JS_LOGS].push(callback)
+
+    if (enabled) {
+      return
+    }
+
+    this.ws.on('message', event => {
+      const { params } = JSON.parse(Buffer.from(event.toString()))
+      if ((params?.type === 'javascript')) {
+
+        let jsEntry = new JavascriptLogEntry(params.level, params.text,
+          params.timestamp, params.type, params.stackTrace)
+
+        this.listener[LOG.TYPE_JS_LOGS].forEach(listener => {
+          listener(jsEntry)
+        })
+      }
+    })
+  }
+
+  /**
+   * Listen to JS Exceptions
    * @param callback
    * @returns {Promise<void>}
    */
@@ -108,6 +139,58 @@ class LogInspector {
     })
   }
 
+  /**
+   * Listen to any logs
+   * @param callback
+   * @returns {Promise<void>}
+   */
+  async onLog (callback) {
+    this.ws = await this.bidi.socket
+    let enabled = (LOG.TYPE_LOG in this.listener) || this.logListener(
+      LOG.TYPE_LOG)
+    this.listener[LOG.TYPE_LOG].push(callback)
+
+    if (enabled) {
+      return
+    }
+
+    this.ws.on('message', event => {
+      const { params } = JSON.parse(Buffer.from(event.toString()))
+      if ((params?.type === 'javascript')) {
+
+        let jsEntry = new JavascriptLogEntry(params.level, params.text,
+          params.timestamp, params.type, params.stackTrace)
+
+        this.listener[LOG.TYPE_LOG].forEach(listener => {
+          listener(jsEntry)
+        })
+        return
+      }
+      
+      if ((params?.type === 'console')) {
+
+        let consoleEntry = new ConsoleLogEntry(params.level, params.text,
+          params.timestamp, params.type, params.method, params.realm,
+          params.args, params.stackTrace)
+
+        this.listener[LOG.TYPE_LOG].forEach(listener => {
+          listener(consoleEntry)
+        })
+        return
+      } 
+
+      if (params != undefined && !['console', 'javascript'].includes(params?.type)) {
+        let genericEntry = new GenericLogEntry(params.level, params.text,
+          params.timestamp, params.type, params.stackTrace)
+
+        this.listener[LOG.TYPE_LOG].forEach(listener => {
+          listener(genericEntry)
+        })
+      }
+    })
+  }
+
+
   /**
    * Unsubscribe to log event
    * @returns {Promise<void>}

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

@@ -72,6 +72,23 @@ suite(
         await inspector.close()
       })
 
+      it('can listen to javascript log', async function () {
+        let logEntry = null
+        const inspector = await logInspector(driver)
+        await inspector.onJavascriptLog(function (log) {
+          logEntry = log
+        })
+
+        await driver.get(Pages.logEntryAdded)
+        await driver.findElement({ id: 'jsException' }).click()
+
+        assert.equal(logEntry.text, 'Error: Not working')
+        assert.equal(logEntry.type, 'javascript')
+        assert.equal(logEntry.level, 'error')
+
+        await inspector.close()
+      })
+
       it('can listen to javascript error log', async function () {
         let logEntry = null
         const inspector = await logInspector(driver)
@@ -105,6 +122,27 @@ suite(
 
         await inspector.close()
       })
+
+      it('can listen to any log', async function () {
+        let logEntry = null
+        const inspector = await logInspector(driver)
+        await inspector.onLog(function (log) {
+          logEntry = log
+        })
+
+        await driver.get(Pages.logEntryAdded)
+        await driver.findElement({ id: 'consoleLog' }).click()
+
+        assert.equal(logEntry.text, 'Hello, world!')
+        assert.equal(logEntry.realm, null)
+        assert.equal(logEntry.type, 'console')
+        assert.equal(logEntry.level, 'info')
+        assert.equal(logEntry.method, 'log')
+        assert.equal(logEntry.stackTrace, null)
+        assert.equal(logEntry.args.length, 1)
+
+        await inspector.close()
+      })
     })
 
     describe('Browsing Context', function () {