appium-geckodriver 1.3.9 → 1.4.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.4.0](https://github.com/appium/appium-geckodriver/compare/v1.3.10...v1.4.0) (2024-09-18)
+
+### Features
+
+* Add geckodriver download script ([#122](https://github.com/appium/appium-geckodriver/issues/122)) ([9f3fa7d](https://github.com/appium/appium-geckodriver/commit/9f3fa7dd6722357c4e2e6a1df2920c086b89a22e))
+
+## [1.3.10](https://github.com/appium/appium-geckodriver/compare/v1.3.9...v1.3.10) (2024-08-21)
+
+### Miscellaneous Chores
+
+* **deps-dev:** bump webdriverio from 8.40.3 to 9.0.5 ([#121](https://github.com/appium/appium-geckodriver/issues/121)) ([853e924](https://github.com/appium/appium-geckodriver/commit/853e924257706d72f977f83faac7a87235fd9840))
+
 ## [1.3.9](https://github.com/appium/appium-geckodriver/compare/v1.3.8...v1.3.9) (2024-07-29)
 
 ### Miscellaneous Chores

package/README.md

@@ -19,6 +19,9 @@ Under the hood this driver is a wrapper/proxy over `geckodriver` binary. Check t
 
 It is mandatory to have both Firefox browser installed and the geckodriver binary downloaded on the platform where automated tests are going to be executed. Firefox could be downloaded from the [official download site](https://www.mozilla.org/en-GB/firefox/all/) and the driver binary could be retrieved from the GitHub [releases page](https://github.com/mozilla/geckodriver/releases). The binary must be put into one of the folders included to PATH environment variable. On macOS it also might be necessary to run `xattr -cr "<binary_path>"` to avoid [notarization](https://firefox-source-docs.mozilla.org/testing/geckodriver/Notarization.html) issues.
 
+Since driver version 1.4.0 the geckodriver binary deployment could be automated via the
+[install-geckodriver](#install-geckodriver) driver script.
+
 Then you need to decide where the automated test is going to be executed. Gecko driver supports the following target platforms:
  - macOS
  - Windows
@@ -56,6 +59,21 @@ setWindowRect | See https://www.w3.org/TR/webdriver/#capabilities
 timeouts | See https://www.w3.org/TR/webdriver/#capabilities
 unhandledPromptBehavior | See https://www.w3.org/TR/webdriver/#capabilities
 
+## Scripts
+
+### install-geckodriver
+
+This script is used to install the given or latest stable version of Geckodriver server from
+the [GitHub releases](https://github.com/mozilla/geckodriver/release) page.
+Run `appium driver run gecko install-geckodriver <optional_version>`, where `optional_version`
+must be either valid Geckodriver version number or should not be present (the latest stable version is used then).
+By default, the script will download and unpack the binary into `/usr/local/bin/geckodriver`
+on macOS and Linux or into `%LOCALAPPDATA%\Mozilla\geckodriver.exe` on Windows.
+You must also make sure the `%LOCALAPPDATA%\Mozilla` (Windows) or `/usr/local/bin/` (Linux & macOS)
+folder is present in the PATH environment variable before
+starting an actual automation session. The deployment script should also show a warning message if
+it is unable to find the parent folder in the PATH folders list.
+
 ## Example
 
 ```python

package/build/lib/logger.d.ts

@@ -1,3 +1,3 @@
+export const log: import("@appium/types").AppiumLogger;
 export default log;
-declare const log: import("@appium/types").AppiumLogger;
 //# sourceMappingURL=logger.d.ts.map

package/build/lib/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../lib/logger.js"],"names":[],"mappings":";AAEA,wDAA4C"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../lib/logger.js"],"names":[],"mappings":"AAEA,uDAAmD"}

package/build/lib/logger.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.log = void 0;
 const support_1 = require("appium/support");
-const log = support_1.logger.getLogger('GeckoDriver');
-exports.default = log;
+exports.log = support_1.logger.getLogger('GeckoDriver');
+exports.default = exports.log;
 //# sourceMappingURL=logger.js.map

package/build/lib/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../lib/logger.js"],"names":[],"mappings":";;AAAA,4CAAwC;AAExC,MAAM,GAAG,GAAG,gBAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AAE5C,kBAAe,GAAG,CAAC"}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../lib/logger.js"],"names":[],"mappings":";;;AAAA,4CAAwC;AAE3B,QAAA,GAAG,GAAG,gBAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AAEnD,kBAAe,WAAG,CAAC"}

package/build/lib/utils.d.ts

@@ -2,4 +2,33 @@ export function formatCapsForServer(caps: any): {
     browserName: string;
     platformName: any;
 };
+/**
+ *
+ * @param {string} srcUrl
+ * @param {string} dstPath
+ * @returns {Promise<void>}
+ */
+export function downloadToFile(srcUrl: string, dstPath: string): Promise<void>;
+/**
+ *
+ * @param {string} p
+ * @returns {Promise<void>}
+ */
+export function mkdirp(p: string): Promise<void>;
+/**
+ *
+ * @param {string} srcAcrhive
+ * @param {string} fileToExtract
+ * @param {string} dstPath
+ * @returns {Promise<void>}
+ */
+export function extractFileFromTarGz(srcAcrhive: string, fileToExtract: string, dstPath: string): Promise<void>;
+/**
+ *
+ * @param {string} srcAcrhive
+ * @param {string} fileToExtract
+ * @param {string} dstPath
+ * @returns {Promise<void>}
+ */
+export function extractFileFromZip(srcAcrhive: string, fileToExtract: string, dstPath: string): Promise<void>;
 //# sourceMappingURL=utils.d.ts.map

package/build/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":"AAeA;;;EAeC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":"AAoBA;;;EAeC;AAED;;;;;GAKG;AACH,uCAJW,MAAM,WACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;;GAIG;AACH,0BAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;;;;GAMG;AACH,iDALW,MAAM,iBACN,MAAM,WACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAuCzB;AAED;;;;;;GAMG;AACH,+CALW,MAAM,iBACN,MAAM,WACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAqBzB"}

package/build/lib/utils.js

@@ -4,7 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatCapsForServer = formatCapsForServer;
+exports.downloadToFile = downloadToFile;
+exports.mkdirp = mkdirp;
+exports.extractFileFromTarGz = extractFileFromTarGz;
+exports.extractFileFromZip = extractFileFromZip;
 const lodash_1 = __importDefault(require("lodash"));
+const support_1 = require("appium/support");
+const tar_stream_1 = __importDefault(require("tar-stream"));
+const node_zlib_1 = __importDefault(require("node:zlib"));
+const bluebird_1 = __importDefault(require("bluebird"));
+const node_path_1 = __importDefault(require("node:path"));
 const GECKO_CAP_PREFIXES = ['moz:'];
 // https://www.w3.org/TR/webdriver/#capabilities
 const STANDARD_CAPS = [
@@ -33,4 +42,91 @@ function formatCapsForServer(caps) {
     }
     return result;
 }
+/**
+ *
+ * @param {string} srcUrl
+ * @param {string} dstPath
+ * @returns {Promise<void>}
+ */
+async function downloadToFile(srcUrl, dstPath) {
+    await support_1.net.downloadFile(srcUrl, dstPath);
+}
+/**
+ *
+ * @param {string} p
+ * @returns {Promise<void>}
+ */
+async function mkdirp(p) {
+    await support_1.fs.mkdirp(p);
+}
+/**
+ *
+ * @param {string} srcAcrhive
+ * @param {string} fileToExtract
+ * @param {string} dstPath
+ * @returns {Promise<void>}
+ */
+async function extractFileFromTarGz(srcAcrhive, fileToExtract, dstPath) {
+    const chunks = [];
+    const extract = tar_stream_1.default.extract();
+    const extractPromise = new bluebird_1.default((resolve, reject) => {
+        extract.on('entry', (header, stream, next) => {
+            if (header.name === fileToExtract) {
+                stream.on('data', (chunk) => {
+                    chunks.push(chunk);
+                });
+            }
+            stream.on('end', function () {
+                next();
+            });
+            stream.resume();
+        });
+        extract.once('error', reject);
+        extract.once('finish', async () => {
+            if (chunks.length) {
+                try {
+                    await support_1.fs.writeFile(dstPath, Buffer.concat(chunks));
+                }
+                catch (e) {
+                    return reject(e);
+                }
+            }
+            else {
+                return reject(new Error(`The file '${fileToExtract}' could not be found in the '${srcAcrhive}' archive`));
+            }
+            resolve();
+        });
+    });
+    support_1.fs.createReadStream(srcAcrhive)
+        .pipe(node_zlib_1.default.createGunzip())
+        .pipe(extract);
+    await extractPromise;
+}
+/**
+ *
+ * @param {string} srcAcrhive
+ * @param {string} fileToExtract
+ * @param {string} dstPath
+ * @returns {Promise<void>}
+ */
+async function extractFileFromZip(srcAcrhive, fileToExtract, dstPath) {
+    let didFindEntry = false;
+    await support_1.zip.readEntries(srcAcrhive, async ({ entry, extractEntryTo }) => {
+        if (didFindEntry || entry.fileName !== fileToExtract) {
+            return;
+        }
+        didFindEntry = true;
+        const tmpRoot = await support_1.tempDir.openDir();
+        try {
+            await extractEntryTo(tmpRoot);
+            await support_1.fs.mv(node_path_1.default.resolve(tmpRoot, entry.fileName), dstPath);
+        }
+        finally {
+            await support_1.fs.rimraf(tmpRoot);
+        }
+    });
+    if (!didFindEntry) {
+        throw new Error(`The file '${fileToExtract}' could not be found in the '${srcAcrhive}' archive`);
+    }
+}
 //# sourceMappingURL=utils.js.map

package/build/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":";;;;;AAgCS,kDAAmB;AAhC5B,oDAAuB;AAEvB,MAAM,kBAAkB,GAAG,CAAC,MAAM,CAAC,CAAC;AACpC,gDAAgD;AAChD,MAAM,aAAa,GAAG;IACpB,gBAAgB;IAChB,cAAc;IACd,qBAAqB;IACrB,kBAAkB;IAClB,OAAO;IACP,eAAe;IACf,UAAU;IACV,yBAAyB;CAC1B,CAAC;AAEF,SAAS,mBAAmB,CAAE,IAAI;IAChC,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC;IACjC,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACjG,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QACxB,qDAAqD;QACrD,MAAM,CAAC,YAAY,GAAG,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":";;;;;AAoBA,kDAeC;AAQD,wCAEC;AAOD,wBAEC;AASD,oDAqCC;AASD,gDAmBC;AAhID,oDAAuB;AACvB,4CAAuD;AACvD,4DAA6B;AAC7B,0DAA6B;AAC7B,wDAAyB;AACzB,0DAA6B;AAE7B,MAAM,kBAAkB,GAAG,CAAC,MAAM,CAAC,CAAC;AACpC,gDAAgD;AAChD,MAAM,aAAa,GAAG;IACpB,gBAAgB;IAChB,cAAc;IACd,qBAAqB;IACrB,kBAAkB;IAClB,OAAO;IACP,eAAe;IACf,UAAU;IACV,yBAAyB;CAC1B,CAAC;AAEF,SAAgB,mBAAmB,CAAE,IAAI;IACvC,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC;IACjC,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACjG,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QACxB,qDAAqD;QACrD,MAAM,CAAC,YAAY,GAAG,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,cAAc,CAAC,MAAM,EAAE,OAAO;IAClD,MAAM,aAAG,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC1C,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,MAAM,CAAC,CAAC;IAC5B,MAAM,YAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACrB,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CAAC,UAAU,EAAE,aAAa,EAAE,OAAO;IAC3E,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,OAAO,GAAG,oBAAG,CAAC,OAAO,EAAE,CAAC;IAC9B,MAAM,cAAc,GAAG,IAAI,kBAAC,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC/C,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YAC3C,IAAI,MAAM,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;gBAClC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC1B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACrB,CAAC,CAAC,CAAC;YACL,CAAC;YACD,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE;gBACf,IAAI,EAAE,CAAC;YACT,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9B,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;YAChC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,IAAI,CAAC;oBACH,MAAM,YAAE,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBACrD,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,MAAM,CACX,IAAI,KAAK,CAAC,aAAa,aAAa,gCAAgC,UAAU,WAAW,CAAC,CAC3F,CAAC;YACJ,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,YAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC;SAC5B,IAAI,CAAC,mBAAI,CAAC,YAAY,EAAE,CAAC;SACzB,IAAI,CAAC,OAAO,CAAC,CAAC;IAEjB,MAAM,cAAc,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,kBAAkB,CAAC,UAAU,EAAE,aAAa,EAAE,OAAO;IACzE,IAAI,YAAY,GAAG,KAAK,CAAC;IACzB,MAAM,aAAG,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,EAAE,EAAC,KAAK,EAAE,cAAc,EAAC,EAAE,EAAE;QAClE,IAAI,YAAY,IAAI,KAAK,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;YACrD,OAAO;QACT,CAAC;QACD,YAAY,GAAG,IAAI,CAAC;QAEpB,MAAM,OAAO,GAAG,MAAM,iBAAO,CAAC,OAAO,EAAE,CAAC;QACxC,IAAI,CAAC;YACH,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;YAC9B,MAAM,YAAE,CAAC,EAAE,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC;gBAAS,CAAC;YACT,MAAM,YAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,aAAa,aAAa,gCAAgC,UAAU,WAAW,CAAC,CAAC;IACnG,CAAC;AACH,CAAC"}