@eyeo/get-browser-binary 0.5.0 → 0.7.0

package/.gitlab-ci.yml

@@ -53,14 +53,13 @@ test:browsers:windows:
     - choco upgrade -y nodejs --version 16.10.0
     - npm install
   script:
-    # Running only a subset of Firefox and Opera tests to avoid low OS resources error
+    # Running only a subset of Firefox tests to avoid low OS resources error
     # https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/2
-    # Regarding grep, running npm v8 on powershell has issues when the grep
-    # value contains the pipe (|) literal. Storing that string as a verbatim
-    # string (single quotes) and then sorrounding it with four double quotes
-    # does the trick.
-    - $subset_tests = '(firefox|opera).*latest.*downloads'
-    - npm test -- --grep """"$subset_tests""""
+    - npm test -- --grep "firefox.*installs"
+    # Running npm v8 on powershell has issues when the grep value contains the
+    # pipe (|) literal. Storing that string as a verbatim string (single quotes)
+    # and then sorrounding it with four double quotes does the trick.
+    # https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/29
     - $full_tests = '(chromium|edge.*latest)'
     - npm test -- --grep """"$full_tests""""
   tags:

package/.mocharc.json

@@ -0,0 +1,3 @@
+{
+  "timeout": 50000
+}

package/README.md

@@ -1,19 +1,19 @@
 # get-browser-binary
 
-Download specific browser versions for Chromium, Firefox, Edge and Opera, and
-their matching [selenium webdriver](https://www.selenium.dev/selenium/docs/api/javascript/index.html).
+Install specific browser versions for Chromium, Firefox and Edge, and their
+matching [selenium webdriver](https://www.selenium.dev/selenium/docs/api/javascript/index.html).
 
 ## Getting started
 
-The sample below shows how to download the latest Chromium and run it using
+The sample below shows how to install the latest Chromium and run it using
 selenium webdriver:
 
 ```javascript
 import {BROWSERS} from "@eyeo/get-browser-binary";
 
 (async function example() {
-  let {binary} = await BROWSERS.chromium.downloadBinary("latest");
-  console.log(`Chromium binary downloaded to ${binary}`);
+  let {binary} = await BROWSERS.chromium.installBrowser("latest");
+  console.log(`Chromium executable location: ${binary}`);
 
   let driver = await BROWSERS.chromium.getDriver("latest");
   await driver.navigate().to("https://example.com/");
@@ -33,13 +33,10 @@ the right side.
 - Chromium >= 75
 - Firefox >= 60
 - Edge >= 95
-- Opera >= 62
 
-Note: Edge download is not supported on Windows. It is assumed to be installed
+Note: Installing Edge is not supported on Windows. It is assumed to be installed
 because it is the default browser on that platform.
 
-Note: Using the `operadriver` on Windows is not supported.
-
 ## Development
 
 ### Prerequisites
@@ -55,7 +52,7 @@ npm install
 
 ### Folders to ignore / cache
 
-All browser and webdriver files will be downloaded to the `./browser-snapshots`
+All browser and webdriver files will be extracted to the `./browser-snapshots`
 folder, which probably makes sense to be ignored (for instance, by adding it to
 `.gitignore`).
 
@@ -78,6 +75,13 @@ The `grep` option filters the tests to run with a regular expression. Example:
 npm test -- --grep "chromium.*latest"
 ```
 
+The `timeout` option overrides the timeout defined by `.mocharc.json`.
+Increasing the timeout may be useful on slow connection environments:
+
+```shell
+npm test -- --timeout <ms>
+```
+
 ### Running tests on Docker
 
 Useful to reproduce the CI environment of the `test:browsers:linux` job:
@@ -87,14 +91,20 @@ docker build -f test/docker/Dockerfile -t browsers .
 docker run --shm-size=256m -it browsers
 ```
 
-The `grep` option can also be used on Docker via the `TEST_ARGS` parameter:
+The `grep` and `timeout` options can also be used on Docker via the `TEST_ARGS`
+parameter:
 
 ```shell
-docker run --shm-size=256m -e TEST_ARGS="--grep chromium.*latest" -it browsers
+docker run --shm-size=256m -e TEST_ARGS="--grep chromium.*latest --timeout 100000" -it browsers
 ```
 
-Note: For a full automated run, `opera` tests should not use the interactive
-tty `-it` flag.
+By default, tests delete the `./browser-snapshots` before each `Browser` suite
+runs. To change that behavior you may set the `TEST_KEEP_SNAPSHOTS` environment
+variable to `true`. Example:
+
+```shell
+TEST_KEEP_SNAPSHOTS=true npm test
+```
 
 ## Building the documentation
 

package/RELEASE_NOTES.md

@@ -1,3 +1,29 @@
+# 0.7.0
+
+- Implement takeFullPageScreenshot (#32)
+- Unify error messages (#22)
+- Document when a browser binary is downloaded or installed (#30)
+- Use cached driver binary if it already exists (#20)
+- Remove chromedriver dependency (#33)
+- Fallback mechanism on minor browser versions (Edge) (#27)
+
+### Testing
+
+- Use a manifest V3 extension on latest chromium-based browsers tests (#31)
+- Allow test run to not delete browser snapshots (#28)
+- Add a timeout option to run the tests (#24)
+
+### Notes for integrators
+
+- The `downloadBinary` function has been renamed to `installBrowser` (!38).
+
+# 0.6.0
+
+- Removes Opera support (#26)
+- Improves error handling when the downloaded browser version doesn't match
+known channels (#25)
+- Fixes an Edge running issue on Windows (32-bit) (#23)
+
 # 0.5.0
 
 - Enables Edge binary downloads on MacOS (!25)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eyeo/get-browser-binary",
-  "version": "0.5.0",
-  "description": "Download browser binaries and matching webdrivers",
+  "version": "0.7.0",
+  "description": "Install browser binaries and matching webdrivers",
   "repository": {
     "type": "git",
     "url": "https://gitlab.com/eyeo/developer-experience/get-browser-binary"
@@ -15,13 +15,12 @@
   "type": "module",
   "main": "index.js",
   "dependencies": {
-    "chromedriver": "^90.0.1",
     "dmg": "^0.1.0",
     "extract-zip": "^2.0.1",
-    "fs-extra": "^10.0.0",
     "geckodriver": "^3.0.2",
     "got": "^11.8.2",
-    "selenium-webdriver": "^4.2.0"
+    "jimp": "^0.16.2",
+    "selenium-webdriver": "^4.7.1"
   },
   "devDependencies": {
     "eslint": "^8.17.0",