[js][bidi] Added printPage command (#12124)

TamsilAmani · harsha509 · web-flow · commit b1cd355fb019 · 2023-06-01T19:52:29.000+05:30
* [js][bidi] Added printPage command with tests

* [js][bidi] Corrected default value for height

---------

Co-authored-by: Sri Harsha &lt;12621691+harsha509@users.noreply.github.com&gt;
diff --git a/javascript/node/selenium-webdriver/bidi/browsingContext.js b/javascript/node/selenium-webdriver/bidi/browsingContext.js
@@ -129,6 +129,42 @@ class BrowsingContext {
     }
     await this.bidi.send(params)
   }
+
+  /**
+   * Prints PDF of the webpage
+   * @param options print options given by the user
+   * @returns PrintResult object
+   */
+  async printPage(options = {}) {
+    let params = {
+      method: 'browsingContext.print',
+      // Setting default values for parameters
+      params: {
+        context: this._id,
+        background: false,
+        margin: {
+          bottom: 1.0,
+          left: 1.0,
+          right: 1.0,
+          top: 1.0,
+        },
+        orientation: 'portrait',
+        page: {
+          height: 27.94,
+          width: 21.59,
+        },
+        pageRanges: [],
+        scale: 1.0,
+        shrinkToFit: true,
+      },
+    }
+
+    // Updating parameter values based on the options passed
+    params.params = this._driver.validatePrintPageParams(options, params.params)
+
+    const response = await this.bidi.send(params)
+    return new PrintResult(response.result.data)
+  }
 }
 
 class NavigateResult {
@@ -146,6 +182,16 @@ class NavigateResult {
   }
 }
 
+class PrintResult {
+  constructor(data) {
+    this._data = data
+  }
+
+  get data() {
+    return this._data
+  }
+}
+
 /**
  * initiate browsing context instance and return
  * @param driver
diff --git a/javascript/node/selenium-webdriver/test/bidi/bidi_test.js b/javascript/node/selenium-webdriver/test/bidi/bidi_test.js
@@ -297,6 +297,10 @@ suite(
     })
 
     describe('Browsing Context', function () {
+      let startIndex = 0
+      let endIndex = 5
+      let pdfMagicNumber = 'JVBER'
+
       it('can create a browsing context for given id', async function () {
         const id = await driver.getWindowHandle()
         const browsingContext = await BrowsingContext(driver, {
@@ -398,6 +402,44 @@ suite(
         })
         await assert.rejects(window2.getTree(), { message: 'no such frame' })
       })
+
+      it('can print PDF with total pages', async function () {
+        const id = await driver.getWindowHandle()
+        const browsingContext = await BrowsingContext(driver, {
+          browsingContextId: id,
+        })
+
+        await driver.get(Pages.printPage)
+        const result = await browsingContext.printPage()
+
+        let base64Code = result.data.slice(startIndex, endIndex)
+        assert.strictEqual(base64Code, pdfMagicNumber)
+      })
+
+      it('can print PDF with all valid parameters', async function () {
+        const id = await driver.getWindowHandle()
+        const browsingContext = await BrowsingContext(driver, {
+          browsingContextId: id,
+        })
+
+        await driver.get(Pages.printPage)
+        const result = await browsingContext.printPage({
+          orientation: 'landscape',
+          scale: 1,
+          background: true,
+          width: 30,
+          height: 30,
+          top: 1,
+          bottom: 1,
+          left: 1,
+          right: 1,
+          shrinkToFit: true,
+          pageRanges: ['1-2'],
+        })
+
+        let base64Code = result.data.slice(startIndex, endIndex)
+        assert.strictEqual(base64Code, pdfMagicNumber)
+      })
     })
 
     describe('Browsing Context Inspector', function () {
