Merge pull request #961 from openwpm/release-prep

feat: update Firefox version and all OpenWPM dependencies

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
     hooks:
     -   id: isort
   - repo: https://github.com/psf/black
-    rev: 21.6b0
+    rev: 21.11b1
     hooks:
       - id: black
         language_version: python3
@@ -15,5 +15,10 @@ repos:
         additional_dependencies: [pytest, types-tabulate, types-PyYAML, types-redis]
         # We may need to add more and more dependencies here, as pre-commit
         # runs in an environment without our dependencies
+  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+    rev: v6.0.0
+    hooks:
+      - id: commitlint
+        stages: [commit-msg]
 
 

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.18.0 - 2021-12-07
+
+Updates OpenWPM to Firefox 95
+
 ## v0.17.0 - 2021-07-23
 
 Updates OpenWPM to Firefox 90.0.2

CONTRIBUTING.md

@@ -1,6 +1,5 @@
 # Contributing <!-- omit in toc -->
 
-
 - [Setting up a dev enviroment](#setting-up-a-dev-enviroment)
 - [General Hints and Guidelines](#general-hints-and-guidelines)
   - [Avoid failing tests for PRs caused by formatting/linting issues](#avoid-failing-tests-for-prs-caused-by-formattinglinting-issues)
@@ -12,6 +11,7 @@
   - [Updating schema docs](#updating-schema-docs)
 
 ## Setting up a dev enviroment
+
 Dev dependencies are installed by using the main `environment.yaml` (which
 is used by `./install.sh` script).
 
@@ -52,13 +52,15 @@ continuing the crawl). We recommend using
 This utility allows manual debugging of the extension instrumentation with or
 without Selenium enabled, as well as makes it easy to launch a Selenium
 instance (without any instrumentation)
-* `./scripts/build-extension.sh`
+
-* `python -m test.manual_test` builds the current extension directory
+- `./scripts/build-extension.sh`
+- `python -m test.manual_test` builds the current extension directory
   and launches a Firefox instance with it.
-* `python -m test.manual_test --selenium` launches a Firefox Selenium instance
+- `python -m test.manual_test --selenium` launches a Firefox Selenium instance
   after automatically rebuilding `openwpm.xpi`. The script then
   drops into an `ipython` shell where the webdriver instance is available
   through variable `driver`.
+
 * `python -m test.manual_test --selenium --no_extension` launches a Firefox Selenium
   instance with no instrumentation. The script then
   drops into an `ipython` shell where the webdriver instance is available
@@ -73,8 +75,10 @@ This means that `environment.yaml` should not be edited directly.
 Instead, place new requirements in `scripts/environment-unpinned.yaml` or `scripts/environment-unpinned-dev.yaml`
 and then run repin:
 
-    $ cd scripts
+```bash
-    $ ./repin.sh
+    cd scripts
+    ./repin.sh
+```
 
 To update the version of firefox, the TAG variable must be updated in the `./scripts/install-firefox.sh`
 script. This script contains further information about finding the right TAG.
@@ -84,13 +88,14 @@ script. This script contains further information about finding the right TAG.
 OpenWPM's tests are build on [pytest](https://docs.pytest.org/en/latest/). Execute `py.test -vv`
 in the test directory to run all tests:
 
-    $ conda activate openwpm
+```bash
-    $ py.test -vv
+    conda activate openwpm
+    py.test -vv
+```
 
 See the [pytest docs](https://docs.pytest.org/en/latest/) for more information on selecting
 specific tests and various pytest options.
 
-
 ### Updating schema docs
 
 In the rare instance that you need to create schema docs

Extension/firefox/package.json

@@ -7,27 +7,27 @@
   },
   "devDependencies": {
     "@types/download": "^8.0.1",
-    "@typescript-eslint/parser": "^4.28.4",
+    "@typescript-eslint/parser": "^4.33.0",
     "body-parser": "^1.19.0",
     "download": "^8.0.0",
-    "eslint": "^7.31.0",
+    "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-fetch-options": "0.0.5",
-    "eslint-plugin-html": "^6.1.2",
+    "eslint-plugin-html": "^6.2.0",
-    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-json": "^3.0.0",
+    "eslint-plugin-json": "^3.1.0",
-    "eslint-plugin-mozilla": "^2.10.0",
+    "eslint-plugin-mozilla": "^2.11.1",
-    "eslint-plugin-no-unsanitized": "^3.1.5",
+    "eslint-plugin-no-unsanitized": "^3.2.0",
-    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-prettier": "^3.4.1",
     "express": "^4.17.1",
     "npm-run-all": "^4.1.5",
     "prettier": "^1.19.1",
     "safe-compare": "^1.1.4",
-    "ts-loader": "^9.2.3",
+    "ts-loader": "^9.2.6",
-    "typescript": "^4.3.5",
+    "typescript": "^4.5.2",
-    "web-ext": "^6.2.0",
+    "web-ext": "^6.6.0",
-    "webpack": "^5.46.0",
+    "webpack": "^5.65.0",
-    "webpack-cli": "^4.7.2"
+    "webpack-cli": "^4.9.1"
   },
   "engines": {
     "node": ">=7.0.0"

Extension/webext-instrumentation/package.json

@@ -60,14 +60,14 @@
   "devDependencies": {
     "@types/download": "^8.0.0",
     "@types/firefox-webext-browser": "^82.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.28.4",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.28.4",
+    "@typescript-eslint/parser": "^4.33.0",
     "codecov": "^3.8.3",
     "commitizen": "^4.2.4",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^7.31.0",
+    "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.0.0",
-    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-jsdoc": "^35.5.1",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "eslint-plugin-unicorn": "^33.0.1",
@@ -75,12 +75,12 @@
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "open-cli": "^6.0.1",
-    "prettier": "^2.3.2",
+    "prettier": "^2.5.1",
     "publish-please": "^5.5.2",
     "standard-version": "github:conventional-changelog/standard-version#master",
     "trash-cli": "^4.0.0",
-    "typedoc": "^0.21.4",
+    "typedoc": "^0.21.9",
-    "typescript": "^4.3.5"
+    "typescript": "^4.5.2"
   },
   "ava": {
     "failFast": true,

VERSION

@@ -1 +1 @@
-0.17.0
+0.18.0

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']};

environment.yaml

@@ -2,45 +2,46 @@ channels:
 - conda-forge
 - main
 dependencies:
-- beautifulsoup4=4.9.3
+- beautifulsoup4=4.10.0
-- black=21.7b0
+- black=21.11b1
-- click=8.0.1
+- click=8.0.3
 - codecov=2.1.11
 - dill=0.3.4
-- gcsfs=2021.7.0
+- gcsfs=2021.11.1
-- geckodriver=0.29.0
+- geckodriver=0.30.0
-- ipython=7.25.0
+- ipython=7.30.1
+- isort=5.10.1
 - leveldb=1.23
 - multiprocess=0.70.12.2
 - mypy=0.910
-- nodejs=14.17.1
+- nodejs=14.17.4
-- pandas=1.3.0
+- pandas=1.3.4
-- pillow=8.3.1
+- pillow=8.4.0
-- pip=21.1.3
+- pip=21.3.1
-- pre-commit=2.13.0
+- pre-commit=2.16.0
 - psutil=5.8.0
-- pyarrow=4.0.1
+- pyarrow=6.0.1
-- pytest-asyncio=0.15.1
+- pytest-asyncio=0.16.0
-- pytest-cov=2.12.1
+- pytest-cov=3.0.0
-- pytest=6.2.4
+- pytest=6.2.5
-- python=3.9.6
+- python=3.9.7
 - pyvirtualdisplay=2.2
 - recommonmark=0.7.1
-- redis-py=3.5.3
+- redis-py=4.0.2
-- s3fs=2021.7.0
+- s3fs=2021.11.1
 - selenium=3.141.0
-- sentry-sdk=1.3.0
+- sentry-sdk=1.5.0
 - sphinx-markdown-tables=0.0.15
-- sphinx=4.1.1
+- sphinx=4.3.1
 - tabulate=0.8.9
 - tblib=1.7.0
 - wget=1.20.3
 - pip:
-  - dataclasses-json==0.5.4
+  - dataclasses-json==0.5.6
   - domain-utils==0.7.1
-  - jsonschema==3.2.0
+  - jsonschema==4.2.1
   - plyvel==1.3.0
-  - types-pyyaml==5.4.3
+  - types-pyyaml==6.0.1
-  - types-redis==3.5.4
+  - types-redis==4.0.3
-  - types-tabulate==0.1.1
+  - types-tabulate==0.8.3
 name: openwpm

package.json

@@ -24,8 +24,11 @@
   },
   "homepage": "",
   "devDependencies": {
-    "@adobe/jsonschema2md": "^6.1.0",
+    "@adobe/jsonschema2md": "^6.1.4",
-    "markdown-link-check": "^3.8.7",
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
+    "commitlint": "^15.0.0",
+    "markdown-link-check": "^3.9.0",
     "markdownlint-cli": "^0.27.1",
     "npm-scripts-info": "^0.3.9"
   }

scripts/environment-unpinned-dev.yaml

@@ -5,6 +5,7 @@ dependencies:
     - codecov
     - pytest-cov
     - ipython
+    - isort
     - pip
     - pre-commit
     - pytest

scripts/install-firefox.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-
+set -e
 # Use the Unbranded build that corresponds to a specific Firefox version
 # To upgrade:
 #    1. Go to: https://hg.mozilla.org/releases/mozilla-release/tags.
@@ -9,7 +9,7 @@
 # Note this script is **destructive** and will
 # remove the existing Firefox in the OpenWPM directory
 
-TAG='cda19fb46018c9cb8dc5e6127ebb2cfd04aa9be4' # FIREFOX_90_0_2_RELEASE
+TAG='5a1a2f3b06c23a27532ba48f9999c59c643f3f36' # FIREFOX_95_0_RELEASE
 
 case "$(uname -s)" in
    Darwin)