[js][bidi] Add support for installing and uninstalling extension

Author: pujagani

javascript/selenium-webdriver/BUILD.bazel

@@ -39,6 +39,7 @@ js_library(
         "common/*.js",
         "bidi/*.js",
         "bidi/external/*.js",
+        "bidi/extension/*.js",
     ]),
     deps = [
         ":node_modules/@bazel/runfiles",

javascript/selenium-webdriver/bidi/extension/extension.js

@@ -0,0 +1,68 @@
+// 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 ExtensionData = require("./extensionData")
+
+class Extension {
+  constructor(driver) {
+    this._driver = driver
+  }
+
+  async init() {
+    if (!(await this._driver.getCapabilities()).get('webSocketUrl')) {
+      throw Error('WebDriver instance must support BiDi protocol')
+    }
+
+    this.bidi = await this._driver.getBidi()
+  }
+
+  async install(extensionData) {
+
+    if (!(extensionData instanceof ExtensionData)) {
+      throw new Error("install() requires an ExtensionData instance")
+    }
+
+    const command = {
+      method: 'webExtension.install',
+      params: {
+        extensionData: extensionData.asMap()
+      },
+    }
+
+    let response = await this.bidi.send(command)
+    return response.result.extension
+  }
+
+  async uninstall(id) {
+    const command = {
+      method: 'webExtension.uninstall',
+      params: {
+        extension: id
+      },
+    }
+
+   await this.bidi.send(command)
+  }
+}
+
+  async function getExtensionInstance(driver) {
+    let instance = new Extension(driver)
+    await instance.init()
+    return instance
+  }
+
+module.exports = getExtensionInstance

javascript/selenium-webdriver/bidi/extension/extensionData.js

@@ -0,0 +1,54 @@
+// 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 ExtensionData {
+
+  #type
+  #path
+
+  constructor(type, path) {
+    this.#type = type
+    this.#path = path
+  }
+
+  static setPath(path) {
+    return new ExtensionData("path", path)
+  }
+
+  static setArchivePath(path) {
+    return new ExtensionData("archivePath", path)
+  }
+
+  static setBase64Encoded(value) {
+    return new ExtensionData("base64", value)
+  }
+
+  asMap() {
+    let toReturn = {}
+    toReturn["type"] = this.#type
+
+    if (this.#type === "base64") {
+      toReturn["value"] = this.#path
+    } else {
+      toReturn["path"] = this.#path
+    }
+
+    return toReturn
+  }
+}
+
+module.exports = ExtensionData

javascript/selenium-webdriver/test/bidi/extension_test.js

@@ -0,0 +1,62 @@
+'use strict'
+
+const assert = require('node:assert')
+const { suite } = require('../../lib/test')
+const Extension = require('selenium-webdriver/bidi/extension/extension')
+const ExtensionData = require('selenium-webdriver/bidi/extension/extensionData')
+const {locate} = require("../../lib/test/resources")
+const {Browser} = require('selenium-webdriver')
+const fs = require('fs')
+
+suite(
+  function (env) {
+    let driver
+
+    beforeEach(async function () {
+      driver = await env.builder().build()
+    })
+
+    afterEach(async function () {
+      await driver.quit()
+    })
+
+    const WEBEXTENSION_CRX = locate('common/extensions/webextensions-selenium-example.crx')
+
+    const  ARCHIVE_PATH= locate('common/extensions/webextensions-selenium-example.xpi')
+
+    describe('BiDi Module Extension', function () {
+      it('can install extension from a given path', async function () {
+        const extension = await Extension(driver)
+        const id = await extension.install(ExtensionData.setPath(WEBEXTENSION_CRX))
+
+        assert.strictEqual(id, "[email protected]")
+      })
+
+      it('can install extension from an archive path', async function () {
+          const extension = await Extension(driver)
+          const id = await extension.install(ExtensionData.setArchivePath(ARCHIVE_PATH))
+
+          assert.strictEqual(id, "[email protected]")
+        })
+
+      it('can install extension from a base64 encoded path', async function () {
+        const extension = await Extension(driver)
+
+        const base64Path = fs.readFileSync(ARCHIVE_PATH, { encoding: 'base64' })
+        const id = await extension.install(ExtensionData.setBase64Encoded(base64Path))
+
+        assert.strictEqual(id, "[email protected]")
+      })
+
+      it('can uninstall an extension', async function () {
+        const extension = await Extension(driver)
+        const id = await extension.install(ExtensionData.setPath(WEBEXTENSION_CRX))
+
+        assert.strictEqual(id, "[email protected]")
+
+        await extension.uninstall(id)
+      })
+    })
+  },
+  { browsers: [Browser.FIREFOX] },
+)