[Javascript] Ensure correct serialization of extensions in chromium.Options (#9495)

Fixes #6676

Co-authored-by: David Burns <david.burns@theautomatedtester.co.uk>

Author: nickgaya

javascript/node/selenium-webdriver/chromium.js

@@ -358,8 +358,11 @@ class Options extends Capabilities {
    * @return {!Options} A self reference.
    */
   addExtensions(...args) {
-    let current = this.options_.extensions || []
-    this.options_.extensions = current.concat(...args)
+    let extensions = this.options_.extensions || new Extensions()
+    extensions.add(...args)
+    if (extensions.length) {
+      this.options_.extensions = extensions
+    }
     return this
   }
 
@@ -584,28 +587,47 @@ class Options extends Capabilities {
     }
     return this
   }
+}
+
+/**
+ * A list of extensions to install when launching the browser.
+ */
+class Extensions {
+  constructor() {
+    this.extensions = []
+  }
+
+  /**
+   * @return {number} The length of the extensions list.
+   */
+  get length() {
+    return this.extensions.length
+  }
 
   /**
-   * Converts this instance to its JSON wire protocol representation. Note this
-   * function is an implementation not intended for general use.
+   * Add additional extensions to install when launching the browser. Each
+   * extension should be specified as the path to the packed CRX file, or a
+   * Buffer for an extension.
    *
-   * @return {!Object} The JSON wire protocol representation of this instance.
-   * @suppress {checkTypes} Suppress [] access on a struct.
+   * @param {...(string|!Buffer|!Array<(string|!Buffer)>)} args The
+   *     extensions to add.
+   */
+  add(...args) {
+    this.extensions = this.extensions.concat(...args)
+  }
+
+  /**
+   * @return {!Object} A serialized representation of this Extensions object.
    */
   [Symbols.serialize]() {
-    if (this.options_.extensions && this.options_.extensions.length) {
-      this.options_.extensions = this.options_.extensions.map(function (
-        extension
-      ) {
-        if (Buffer.isBuffer(extension)) {
-          return extension.toString('base64')
-        }
-        return io
-          .read(/** @type {string} */ (extension))
-          .then((buffer) => buffer.toString('base64'))
-      })
-    }
-    return super[Symbols.serialize]()
+    return this.extensions.map(function (extension) {
+      if (Buffer.isBuffer(extension)) {
+        return extension.toString('base64')
+      }
+      return io
+        .read(/** @type {string} */ (extension))
+        .then((buffer) => buffer.toString('base64'))
+    })
   }
 }
 

javascript/node/selenium-webdriver/lib/test/data/chrome/webextension.crx

@@ -19,11 +19,17 @@
 
 const assert = require('assert')
 const fs = require('fs')
+const path = require('path')
 
 const chrome = require('../../chrome')
 const symbols = require('../../lib/symbols')
 const test = require('../../lib/test')
 
+const WEBEXTENSION_CRX = path.join(
+  __dirname,
+  '../../lib/test/data/chrome/webextension.crx'
+)
+
 describe('chrome.Options', function () {
   describe('addArguments', function () {
     it('takes var_args', function () {
@@ -65,15 +71,16 @@ describe('chrome.Options', function () {
       assert.strictEqual(options.options_.extensions, undefined)
 
       options.addExtensions('a', 'b')
-      assert.deepStrictEqual(options.options_.extensions, ['a', 'b'])
+      assert.deepStrictEqual(options.options_.extensions.extensions,
+                             ['a', 'b'])
     })
 
     it('flattens input arrays', function () {
       let options = new chrome.Options()
       assert.strictEqual(options.options_.extensions, undefined)
 
       options.addExtensions(['a', 'b'], 'c', [1, 2], 3)
-      assert.deepStrictEqual(options.options_.extensions, [
+      assert.deepStrictEqual(options.options_.extensions.extensions, [
         'a',
         'b',
         'c',
@@ -86,16 +93,15 @@ describe('chrome.Options', function () {
 
   describe('serialize', function () {
     it('base64 encodes extensions', async function () {
-      let expected = fs.readFileSync(__filename, 'base64')
+      let expected = fs.readFileSync(WEBEXTENSION_CRX, 'base64')
       let wire = new chrome.Options()
-        .addExtensions(__filename)
+        .addExtensions(WEBEXTENSION_CRX)
         [symbols.serialize]()
 
-      assert.strictEqual(wire['goog:chromeOptions'].extensions.length, 1)
-      assert.strictEqual(
-        await wire['goog:chromeOptions'].extensions[0],
-        expected
-      )
+      let extensions = wire['goog:chromeOptions'].extensions
+        [symbols.serialize]()
+      assert.strictEqual(extensions.length, 1)
+      assert.strictEqual(await extensions[0], expected)
     })
   })
 
@@ -129,8 +135,12 @@ test.suite(
   function (env) {
     var driver
 
+    beforeEach(function () {
+      driver = null
+    })
+
     afterEach(function () {
-      return driver.quit()
+      return driver && driver.quit()
     })
 
     describe('Chrome options', function () {
@@ -146,6 +156,38 @@ test.suite(
         )
         assert.strictEqual(userAgent, 'foo;bar')
       })
+
+      it('can install an extension from path', async function () {
+        let options = new chrome.Options().addExtensions(WEBEXTENSION_CRX)
+
+        driver = await env.builder().forBrowser('chrome')
+          .setChromeOptions(options).build()
+
+        await driver.get(test.Pages.echoPage)
+        await verifyWebExtensionWasInstalled()
+      })
+
+      it('can install an extension from Buffer', async function () {
+        let options = new chrome.Options()
+          .addExtensions(fs.readFileSync(WEBEXTENSION_CRX))
+
+        driver = await env.builder().forBrowser('chrome')
+          .setChromeOptions(options).build()
+
+        await driver.get(test.Pages.echoPage)
+        await verifyWebExtensionWasInstalled()
+      })
+
+      async function verifyWebExtensionWasInstalled() {
+        let footer = await driver.findElement({
+          id: 'webextensions-selenium-example',
+        })
+        let text = await footer.getText()
+        assert.strictEqual(
+          text,
+          'Content injected by webextensions-selenium-example'
+        )
+      }
     })
   },
   { browsers: ['chrome'] }