@eyeo/get-browser-binary 0.3.0 → 0.5.0

package/.dockerignore

@@ -0,0 +1,3 @@
+node_modules/
+browser-snapshots/
+docs/

package/.eslintrc.json

@@ -5,7 +5,8 @@
   "root": true,
   "env": {
     "es2022": true,
-    "node": true
+    "node": true,
+    "browser": true
   },
   "rules": {
     "brace-style": ["error", "stroustrup"],

package/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 default:
-  image: registry.gitlab.com/eyeo/docker/adblockplus-ci:node16-no-python
+  image: registry.gitlab.com/eyeo/docker/get-browser-binary:node16
   interruptible: true
 
 stages:
@@ -29,18 +29,15 @@ test:basic:
 
 test:browsers:linux:
   stage: test
+  image: docker:20.10.16
+  services:
+    - docker:20.10.16-dind
+  variables:
+    DOCKER_DRIVER: overlay2
   before_script:
-    - apt-get update && apt-get install -y procps
-    - npm install
-    # https://www.how2shout.com/linux/install-microsoft-edge-on-linux/
-    - wget https://packages.microsoft.com/keys/microsoft.asc
-    - cat microsoft.asc | gpg --dearmor > microsoft.gpg
-    - install -o root -g root -m 644 microsoft.gpg /etc/apt/trusted.gpg.d/
-    - echo "deb [arch=amd64] https://packages.microsoft.com/repos/edge stable main" > /etc/apt/sources.list.d/microsoft-edge-dev.list
-    - rm microsoft.*
-    - apt-get update && apt-get install -y microsoft-edge-stable
+    - docker build -f test/docker/Dockerfile -t browsers .
   script:
-    - xvfb-run -a npm test -- --grep "Browser"
+    - docker run --shm-size=256m browsers
 
 test:browsers:windows:
   stage: test
@@ -56,8 +53,16 @@ test:browsers:windows:
     - choco upgrade -y nodejs --version 16.10.0
     - npm install
   script:
-    - npm test -- --grep "chromium"
-    - npm test -- --grep "edge"
+    # Running only a subset of Firefox and Opera 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""""
+    - $full_tests = '(chromium|edge.*latest)'
+    - npm test -- --grep """"$full_tests""""
   tags:
     - shared-windows
     - windows

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+code-of-conduct@eyeo.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/README.md

@@ -1,11 +1,7 @@
 # get-browser-binary
 
-Download specific browser versions for Chromium, Firefox and Edge, and their
-matching [selenium webdriver](https://www.selenium.dev/selenium/docs/api/javascript/index.html).
-
-Note: Edge download is not implemented, and it is assumed to be already
-installed on the running system. In that case, the matching `msedgedriver`
-will be downloaded accordingly.
+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).
 
 ## Getting started
 
@@ -16,12 +12,10 @@ selenium webdriver:
 import {BROWSERS} from "@eyeo/get-browser-binary";
 
 (async function example() {
-  let {chromium} = BROWSERS;
-
-  let {binary} = await chromium.downloadBinary();
+  let {binary} = await BROWSERS.chromium.downloadBinary("latest");
   console.log(`Chromium binary downloaded to ${binary}`);
 
-  let driver = await chromium.getDriver();
+  let driver = await BROWSERS.chromium.getDriver("latest");
   await driver.navigate().to("https://example.com/");
   await driver.quit();
 })();
@@ -34,6 +28,18 @@ For more information, please refer to the [API documention](https://gitlab.com/e
 If you are already on the documentation page, you may find the API contents on
 the right side.
 
+### Supported browser versions
+
+- Chromium >= 75
+- Firefox >= 60
+- Edge >= 95
+- Opera >= 62
+
+Note: Edge download 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
@@ -69,11 +75,34 @@ npm test
 The `grep` option filters the tests to run with a regular expression. Example:
 
 ```shell
-npm test -- --grep "chromium latest"
+npm test -- --grep "chromium.*latest"
+```
+
+### Running tests on Docker
+
+Useful to reproduce the CI environment of the `test:browsers:linux` job:
+
+```shell
+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:
+
+```shell
+docker run --shm-size=256m -e TEST_ARGS="--grep chromium.*latest" -it browsers
+```
+
+Note: For a full automated run, `opera` tests should not use the interactive
+tty `-it` flag.
+
 ## Building the documentation
 
 ```shell
 npm run docs
 ```
+
+## Code of Conduct
+
+All contributors to this project are required to read and follow our
+[code of conduct](./CODE_OF_CONDUCT.md).

package/RELEASE_NOTES.md

@@ -1,3 +1,17 @@
+# 0.5.0
+
+- Enables Edge binary downloads on MacOS (!25)
+- Sets unsupported browser versions (#16)
+- Fixes the Edge repo url (!27)
+- Fixes an issue when downloading Opera (#21)
+- Fixes redundant Opera installations on Linux (!24)
+
+# 0.4.0
+
+- Adds Opera as a supported browser (#7)
+- Enables Edge binary downloads on Linux (!18)
+- Adds a code of conduct (#15)
+
 # 0.3.0
 
 - Adds incognito mode support to all browsers (#5)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eyeo/get-browser-binary",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Download browser binaries and matching webdrivers",
   "repository": {
     "type": "git",
@@ -21,7 +21,6 @@
     "fs-extra": "^10.0.0",
     "geckodriver": "^3.0.2",
     "got": "^11.8.2",
-    "msedgedriver": "^91.0.0",
     "selenium-webdriver": "^4.2.0"
   },
   "devDependencies": {