[js] download files from remote server (#13102)

* error if downloads are not enabled

* unzip and download file to provided directory

* getDownloadableFiles returns the names directly

* fix unzipping files into target location (#13388)

---------

Co-authored-by: harsha509 <[email protected]>
Co-authored-by: Sri Harsha <[email protected]>

Author: titusfortner

javascript/node/selenium-webdriver/index.js

@@ -41,7 +41,7 @@ const webdriver = require('./lib/webdriver')
 const select = require('./lib/select')
 const LogInspector = require('./bidi/logInspector')
 const BrowsingContext = require('./bidi/browsingContext')
-const BrowsingConextInspector = require('./bidi/browsingContextInspector')
+const BrowsingContextInspector = require('./bidi/browsingContextInspector')
 const ScriptManager = require('./bidi/scriptManager')
 const NetworkInspector = require('./bidi/networkInspector')
 
@@ -720,7 +720,7 @@ class Builder {
 /**
  * In the 3.x releases, the various browser option classes
  * (e.g. firefox.Options) had to be manually set as an option using the
- * Capabilties class:
+ * Capabilities class:
  *
  *     let ffo = new firefox.Options();
  *     // Configure firefox options...
@@ -802,6 +802,6 @@ exports.until = until
 exports.Select = select.Select
 exports.LogInspector = LogInspector
 exports.BrowsingContext = BrowsingContext
-exports.BrowsingConextInspector = BrowsingConextInspector
+exports.BrowsingContextInspector = BrowsingContextInspector
 exports.ScriptManager = ScriptManager
 exports.NetworkInspector = NetworkInspector

javascript/node/selenium-webdriver/lib/capabilities.js

@@ -209,6 +209,9 @@ const Capability = {
    * Used to upload a file when strict file interactability is on
    */
   STRICT_FILE_INTERACTABILITY: 'strictFileInteractability',
+
+
+  ENABLE_DOWNLOADS: "se:downloadsEnabled",
 }
 
 /**
@@ -519,6 +522,10 @@ class Capabilities {
       strictFileInteractability
     )
   }
+
+  enableDownloads() {
+    return this.set(Capability.ENABLE_DOWNLOADS, true)
+  }
 }
 
 /**

javascript/node/selenium-webdriver/lib/command.js

@@ -181,6 +181,10 @@ const Name = {
 
   ACTIONS: 'actions',
   CLEAR_ACTIONS: 'clearActions',
+
+  GET_DOWNLOADABLE_FILES: "getDownloadableFiles",
+  DOWNLOAD_FILE: "downloadFile",
+  DELETE_DOWNLOADABLE_FILES: "deleteDownloadableFiles",
 }
 
 /**

javascript/node/selenium-webdriver/lib/http.js

@@ -400,6 +400,10 @@ const W3C_COMMAND_MAP = new Map([
     cmd.Name.SET_USER_VERIFIED,
     post('/session/:sessionId/webauthn/authenticator/:authenticatorId/uv'),
   ],
+
+  [cmd.Name.GET_DOWNLOADABLE_FILES, get('/session/:sessionId/se/files')],
+  [cmd.Name.DOWNLOAD_FILE, post(`/session/:sessionId/se/files`)],
+  [cmd.Name.DELETE_DOWNLOADABLE_FILES, del(`/session/:sessionId/se/files`)]
 ])
 
 /**

javascript/node/selenium-webdriver/lib/webdriver.js

@@ -42,6 +42,7 @@ const webElement = require('./webelement')
 const { isObject } = require('./util')
 const BIDI = require('../bidi')
 const { PinnedScript } = require('./pinnedScript')
+const JSZip = require('jszip');
 
 // Capability names that are defined in the W3C spec.
 const W3C_CAPABILITY_NAMES = new Set([
@@ -1726,6 +1727,61 @@ class WebDriver {
         .setParameter('isUserVerified', verified)
     )
   }
+
+  async getDownloadableFiles() {
+      const caps = await this.getCapabilities()
+      if (!caps['map_'].get('se:downloadsEnabled')) {
+        throw new error.WebDriverError('Downloads must be enabled in options')
+      }
+
+      return (await this.execute(new command.Command(command.Name.GET_DOWNLOADABLE_FILES))).names
+  }
+
+  async downloadFile(fileName, targetDirectory) {
+    const caps = await this.getCapabilities();
+    if (!caps['map_'].get('se:downloadsEnabled')) {
+      throw new Error('Downloads must be enabled in options');
+    }
+
+    const response = await this.execute(
+      new command.Command(command.Name.DOWNLOAD_FILE).setParameter('name', fileName)
+    );
+
+    const base64Content = response.contents;
+
+    if (!targetDirectory.endsWith('/')) {
+      targetDirectory += '/';
+    }
+
+    fs.mkdirSync(targetDirectory, { recursive: true });
+    const zipFilePath = path.join(targetDirectory, `${fileName}.zip`);
+    fs.writeFileSync(zipFilePath, Buffer.from(base64Content, 'base64'));
+
+    const zipData = fs.readFileSync(zipFilePath);
+    await JSZip.loadAsync(zipData)
+      .then(zip => {
+        // Iterate through each file in the zip archive
+        Object.keys(zip.files).forEach(async (fileName) => {
+          const fileData = await zip.files[fileName].async('nodebuffer');
+          fs.writeFileSync(`${targetDirectory}/${fileName}`, fileData);
+          console.log(`File extracted: ${fileName}`);
+        });
+      })
+      .catch(error => {
+        console.error("Error unzipping file:", error);
+      });
+  }
+
+  async deleteDownloadableFiles() {
+    const caps = await this.getCapabilities()
+    if (!caps['map_'].get('se:downloadsEnabled')) {
+      throw new error.WebDriverError('Downloads must be enabled in options')
+    }
+
+    return await this.execute(
+      new command.Command(command.Name.DELETE_DOWNLOADABLE_FILES)
+    )
+  }
 }
 
 /**