[bidi] [js] Add browsing context commands and events (#13078)

Author: pujagani

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

@@ -294,6 +294,21 @@ class BrowsingContext {
       navigateResult['navigation']
     )
   }
+
+  async setViewport(width, height, devicePixelRatio = undefined) {
+    const params = {
+      method: 'browsingContext.setViewport',
+      params: {
+        context: this._id,
+        viewport: { width: width, height: height },
+        devicePixelRatio: devicePixelRatio,
+      },
+    }
+    let result = await this.bidi.send(params)
+    if ('error' in result) {
+      throw Error(result['error'])
+    }
+  }
 }
 
 class NavigateResult {

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

@@ -37,6 +37,34 @@ class BrowsingContextInspector {
     )
   }
 
+  async onNavigationStarted(callback) {
+    await this.subscribeAndHandleEvent(
+      'browsingContext.navigationStarted',
+      callback
+    )
+  }
+
+  async onFragmentNavigated(callback) {
+    await this.subscribeAndHandleEvent(
+      'browsingContext.fragmentNavigated',
+      callback
+    )
+  }
+
+  async onUserPromptClosed(callback) {
+    await this.subscribeAndHandleEvent(
+      'browsingContext.userPromptClosed',
+      callback
+    )
+  }
+
+  async onUserPromptOpened(callback) {
+    await this.subscribeAndHandleEvent(
+      'browsingContext.userPromptOpened',
+      callback
+    )
+  }
+
   async onDomContentLoaded(callback) {
     await this.subscribeAndHandleEvent(
       'browsingContext.domContentLoaded',

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

@@ -677,6 +677,45 @@ suite(
         assert.notEqual(result.navigationId, null)
         assert(result.url.includes('/bidi/logEntryAdded.html'))
       })
+
+      it('can set viewport', async function () {
+        const id = await driver.getWindowHandle()
+        const browsingContext = await BrowsingContext(driver, {
+          browsingContextId: id,
+        })
+
+        await driver.get(Pages.blankPage)
+
+        await browsingContext.setViewport(250, 300)
+
+        const result = await driver.executeScript(
+          'return [window.innerWidth, window.innerHeight];'
+        )
+        assert.equal(result[0], 250)
+        assert.equal(result[1], 300)
+      })
+
+      xit('can set viewport with device pixel ratio', async function () {
+        const id = await driver.getWindowHandle()
+        const browsingContext = await BrowsingContext(driver, {
+          browsingContextId: id,
+        })
+
+        await driver.get(Pages.blankPage)
+
+        await browsingContext.setViewport(250, 300, 5)
+
+        const result = await driver.executeScript(
+          'return [window.innerWidth, window.innerHeight];'
+        )
+        assert.equal(result[0], 250)
+        assert.equal(result[1], 300)
+
+        const devicePixelRatio = await driver.executeScript(
+          'return window.devicePixelRatio;'
+        )
+        assert.equal(devicePixelRatio, 5)
+      })
     })
 
     describe('Browsing Context Inspector', function () {
@@ -742,6 +781,93 @@ suite(
         assert.equal(navigationInfo.browsingContextId, browsingContext.id)
         assert(navigationInfo.url.includes('/bidi/logEntryAdded.html'))
       })
+
+      xit('can listen to navigation started event', async function () {
+        let navigationInfo = null
+        const browsingConextInspector = await BrowsingContextInspector(driver)
+
+        await browsingConextInspector.onNavigationStarted((entry) => {
+          navigationInfo = entry
+        })
+
+        const browsingContext = await BrowsingContext(driver, {
+          browsingContextId: await driver.getWindowHandle(),
+        })
+
+        await browsingContext.navigate(Pages.logEntryAdded, 'complete')
+
+        assert.equal(navigationInfo.browsingContextId, browsingContext.id)
+        assert(navigationInfo.url.includes('/bidi/logEntryAdded.html'))
+      })
+
+      it('can listen to fragment navigated event', async function () {
+        let navigationInfo = null
+        const browsingConextInspector = await BrowsingContextInspector(driver)
+
+        const browsingContext = await BrowsingContext(driver, {
+          browsingContextId: await driver.getWindowHandle(),
+        })
+        await browsingContext.navigate(Pages.linkedImage, 'complete')
+
+        await browsingConextInspector.onFragmentNavigated((entry) => {
+          navigationInfo = entry
+        })
+
+        await browsingContext.navigate(
+          Pages.linkedImage + '#linkToAnchorOnThisPage',
+          'complete'
+        )
+
+        assert.equal(navigationInfo.browsingContextId, browsingContext.id)
+        assert(navigationInfo.url.includes('linkToAnchorOnThisPage'))
+      })
+
+      xit('can listen to user prompt opened event', async function () {
+        let userpromptOpened = null
+        const browsingConextInspector = await BrowsingContextInspector(driver)
+
+        const browsingContext = await BrowsingContext(driver, {
+          browsingContextId: await driver.getWindowHandle(),
+        })
+
+        await driver.get(Pages.alertsPage)
+
+        await driver.findElement(By.id('alert')).click()
+
+        await driver.wait(until.alertIsPresent())
+
+        await browsingConextInspector.onUserPromptOpened((entry) => {
+          userpromptOpened = entry
+        })
+
+        assert.equal(userpromptOpened.browsingContextId, browsingContext.id)
+        assert.equal(userpromptOpened.type, 'alert')
+      })
+
+      xit('can listen to user prompt closed event', async function () {
+        let userpromptClosed = null
+        const browsingConextInspector = await BrowsingContextInspector(driver)
+
+        const browsingContext = await BrowsingContext(driver, {
+          browsingContextId: await driver.getWindowHandle(),
+        })
+
+        await driver.get(Pages.alertsPage)
+
+        await driver.findElement(By.id('prompt')).click()
+
+        await driver.wait(until.alertIsPresent())
+
+        await browsingConextInspector.onUserPromptClosed((entry) => {
+          userpromptClosed = entry
+        })
+
+        await browsingContext.handleUserPrompt(true, 'selenium')
+
+        assert.equal(userpromptClosed.browsingContextId, browsingContext.id)
+        assert.equal(userpromptClosed.accepted, true)
+        assert.equal(userpromptClosed.userText, 'selenium')
+      })
     })
 
     describe('Local Value', function () {
@@ -2038,7 +2164,10 @@ suite(
 
         assert.equal(beforeRequestEvent.request.method, 'GET')
         assert.equal(beforeRequestEvent.request.cookies[0].name, 'north')
-        assert.equal(beforeRequestEvent.request.cookies[0].value.value, 'biryani')
+        assert.equal(
+          beforeRequestEvent.request.cookies[0].value.value,
+          'biryani'
+        )
         const url = beforeRequestEvent.request.url
         assert.equal(url, await driver.getCurrentUrl())