V0.24.0 release prep (#1047)

* chore(update): move to FF 117 * chore(pre-commit): update pre-commit * chore(changelog): create changelog for v0.24.0 * fix(Extension): fix Extension dependency spec * fix(extension): use ESModules and remove Services import * refactor(Extension): remove unneeded imports
2023-09-05 23:01:20 +02:00 · 2023-09-05 23:01:20 +02:00 · f0a800ae29
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@ -4,12 +4,12 @@ repos:
    hooks:
      - id: isort
  - repo: https://github.com/psf/black
-    rev: 23.3.0
+    rev: 23.7.0
    hooks:
      - id: black
        language_version: python3
  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.3.0
+    rev: v1.5.1
    hooks:
      - id: mypy
        additional_dependencies:
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,5 +1,10 @@
 # Changelog

+## v0.24.0 - 2023-09-05
+
+Bump to Firefox 117
+Upgrade to Selenium 4.11 (Fixing the logs)
+
 ## v0.23.0 - 2023-08-03

 Bump to Firefox 115.0.3
--- a/Extension/.eslintrc.js
+++ b/Extension/.eslintrc.js
@ -48,8 +48,8 @@ module.exports = {
    "jsdoc/check-alignment": "error",
    "jsdoc/check-indentation": "error",
    "jsdoc/tag-lines": [
-      'error',
-      'any',
+      "error",
+      "any",
      {
        startLines: 1,
      },
@ -115,15 +115,31 @@ module.exports = {
        "mozilla/browser-window": true,
        "mozilla/privileged": true,
      },
-      globals: {
-        Cu: "readonly",
-        Ci: "readonly",
-        Cc: "readonly",
-        Cr: "readonly",
-        ExtensionAPI: "readonly",
-        Services: "readonly",
-        OS: "readonly",
-      },
+      /** See https://firefox-source-docs.mozilla.org/toolkit/components/extensions/webextensions/basics.html#globals-available-in-the-api-scripts-global */
+      globals: [
+        "AppConstants",
+        "console",
+        "Cu",
+        "Ci",
+        "Cc",
+        "Cr",
+        "ChromeWorker",
+        "extensions",
+        "ExtensionAPI",
+        "ExtensionCommon",
+        "ExtensionUtils",
+        "ExtensionUtils",
+        "MatchGlob",
+        "MatchPattern",
+        "MatchPatternSet",
+        "Services",
+        "StructuredCloneHolder",
+        "OS",
+        "XPCOMUtils",
+      ].reduce((acc, e) => {
+        acc[e] = "readonly";
+        return acc;
+      }, {}),
    },
    {
      files: ["*.ts"],
--- a/Extension/.prettierignore
+++ b/Extension/.prettierignore
@ -15,3 +15,4 @@ dist
 openwpm.xpi
 bundled/content.js
 bundled/feature.js
+bundled/privileged/sockets/bufferpack.js
--- a/Extension/bundled/manifest.json
+++ b/Extension/bundled/manifest.json
@ -4,9 +4,7 @@
  "version": "1.0",
  "description": "OpenWPM Client Extension",
  "background": {
-    "scripts": [
-      "feature.js"
-    ]
+    "scripts": ["feature.js"]
  },
  "content_scripts": [],
  "applications": {
@ -34,44 +32,26 @@
    "sockets": {
      "schema": "./privileged/sockets/schema.json",
      "parent": {
-        "scopes": [
-          "addon_parent"
-        ],
+        "scopes": ["addon_parent"],
        "script": "./privileged/sockets/api.js",
-        "paths": [
-          [
-            "sockets"
-          ]
-        ]
+        "paths": [["sockets"]]
      }
    },
    "profileDirIO": {
      "schema": "./privileged/profileDirIO/schema.json",
      "parent": {
-        "scopes": [
-          "addon_parent"
-        ],
+        "scopes": ["addon_parent"],
        "script": "./privileged/profileDirIO/api.js",
-        "paths": [
-          [
-            "profileDirIO"
-          ]
-        ]
+        "paths": [["profileDirIO"]]
      }
    },
    "stackDump": {
      "schema": "./privileged/stackDump/schema.json",
      "parent": {
-        "scopes": [
-          "addon_parent"
-        ],
+        "scopes": ["addon_parent"],
        "script": "./privileged/stackDump/api.js",
-        "paths": [
-          [
-            "stackDump"
-          ]
-        ]
+        "paths": [["stackDump"]]
      }
    }
  }
-}
+}
--- a/Extension/bundled/privileged/profileDirIO/api.js
+++ b/Extension/bundled/privileged/profileDirIO/api.js
@ -1,8 +1,3 @@
-ChromeUtils.defineModuleGetter(
-  this,
-  "ExtensionCommon",
-  "resource://gre/modules/ExtensionCommon.jsm",
-);
 Cu.importGlobalProperties(["TextEncoder", "TextDecoder"]);

 this.profileDirIO = class extends ExtensionAPI {
--- a/Extension/bundled/privileged/sockets/api.js
+++ b/Extension/bundled/privileged/sockets/api.js
@ -1,15 +1,3 @@
-/* globals ExtensionCommon */
-ChromeUtils.defineModuleGetter(
-  this,
-  "ExtensionCommon",
-  "resource://gre/modules/ExtensionCommon.jsm",
-);
-ChromeUtils.defineModuleGetter(
-  this,
-  "Services",
-  "resource://gre/modules/Services.jsm",
-);
-
 const tm = Cc["@mozilla.org/thread-manager;1"].getService();
 const socketService = Cc[
  "@mozilla.org/network/socket-transport-service;1"
--- a/Extension/bundled/privileged/stackDump/OpenWPMStackDumpChild.jsm
+++ b/Extension/bundled/privileged/stackDump/OpenWPMStackDumpChild.jsm
@ -2,7 +2,6 @@
 "use strict";
 // eslint-disable-next-line no-unused-vars
 const EXPORTED_SYMBOLS = ["OpenWPMStackDumpChild"];
-const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");

 class Controller {
  constructor(actor) {
@ -25,7 +24,7 @@ class Controller {
      channel.loadInfo &&
      channel.loadInfo.loadingDocument === null &&
      channel.loadInfo.loadingPrincipal ===
-      Services.scriptSecurityManager.getSystemPrincipal()
+        Services.scriptSecurityManager.getSystemPrincipal()
    ) {
      return false;
    }
@ -134,14 +133,14 @@ class Controller {
            // Format described here https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/Stack
            stacktrace.push(
              frame.name +
-              "@" +
-              frame.filename +
-              ":" +
-              frame.lineNumber +
-              ":" +
-              frame.columnNumber +
-              ";" +
-              frame.asyncCause,
+                "@" +
+                frame.filename +
+                ":" +
+                frame.lineNumber +
+                ":" +
+                frame.columnNumber +
+                ";" +
+                frame.asyncCause,
            );
            frame = frame.caller || frame.asyncCaller;
          }
--- a/Extension/bundled/privileged/stackDump/api.js
+++ b/Extension/bundled/privileged/stackDump/api.js
@ -1,18 +1,4 @@
-/* globals resProto ExtensionCommon */
-ChromeUtils.defineModuleGetter(
-  this,
-  "ExtensionCommon",
-  "resource://gre/modules/ExtensionCommon.jsm",
-);
-ChromeUtils.defineModuleGetter(
-  this,
-  "Services",
-  "resource://gre/modules/Services.jsm",
-);
-const { XPCOMUtils } = ChromeUtils.import(
-  "resource://gre/modules/XPCOMUtils.jsm",
-);
-
+/* globals resProto*/
 XPCOMUtils.defineLazyServiceGetter(
  this,
  "resProto",
--- a/Extension/package-lock.json
+++ b/Extension/package-lock.json
--- a/Extension/package.json
+++ b/Extension/package.json
@ -9,33 +9,33 @@
    "start": "Start is required for the manual_test.py to run"
  },
  "devDependencies": {
-    "@babel/cli": "^7.22.9",
-    "@babel/core": "^7.22.9",
-    "@babel/eslint-parser": "^7.22.9",
-    "@babel/preset-env": "^7.22.9",
+    "@babel/cli": "^7.22.15",
+    "@babel/core": "^7.22.15",
+    "@babel/eslint-parser": "^7.22.15",
+    "@babel/preset-env": "^7.22.15",
    "@types/download": "^8.0.2",
    "@types/firefox-webext-browser": "^111.0.1",
-    "@typescript-eslint/eslint-plugin": "^6.2.0",
-    "@typescript-eslint/parser": "^6.2.0",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
    "ajv": "^8.12.0",
    "body-parser": "^1.20.2",
    "download": "^8.0.0",
-    "eslint": "^8.46.0",
-    "eslint-config-prettier": "^8.9.0",
+    "eslint": "^8.48.0",
+    "eslint-config-prettier": "^8.0.0",
    "eslint-plugin-html": "^7.1.0",
-    "eslint-plugin-import": "^2.28.0",
-    "eslint-plugin-jsdoc": "^46.4.5",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jsdoc": "^46.5.1",
    "eslint-plugin-json": "^3.1.0",
    "eslint-plugin-mozilla": "^3.1.0",
    "eslint-plugin-no-unsanitized": "^4.0.2",
    "eslint-plugin-prettier": "^5.0.0",
    "eslint-plugin-unicorn": "^48.0.1",
    "express": "^4.18.2",
-    "prettier": "^3.0.0",
+    "prettier": "^3.0.3",
    "safe-compare": "^1.1.4",
    "ts-loader": "^9.4.4",
-    "typedoc": "^0.24.8",
-    "typescript": "^5.1.6",
+    "typedoc": "^0.25.1",
+    "typescript": "^5.2.2",
    "web-ext": "^7.6.2",
    "webpack": "^5.88.2",
    "webpack-cli": "^5.1.4"
@ -58,7 +58,7 @@
    "lint": "npm run lint:eslint && npm run lint:prettier && npm run lint:web-ext-lint",
    "lint:eslint": "eslint .",
    "lint:web-ext-lint": "web-ext lint --privileged",
-    "lint:prettier": "prettier 'src/**/*.ts' --list-different",
+    "lint:prettier": "prettier --list-different .",
    "info": "npm-scripts-info",
    "build": "npm run clean && npm run build:main && npm run build:module && npm run build:webpack && npm run build:webext",
    "build:main": "tsc -p tsconfig.json",
@ -66,7 +66,7 @@
    "build:webpack": "webpack",
    "build:webext": "web-ext build",
    "fix": "npm run fix:prettier && npm run fix:eslint",
-    "fix:prettier": "prettier 'src/**/*.ts' --write",
+    "fix:prettier": "prettier --write .",
    "fix:eslint": "eslint --fix .",
    "test": "npm run build && npm run test:lint",
    "test:lint": "eslint . && npm run lint:prettier || exit 0",
--- a/2
+++ b/2
@ -1 +1 @@
-0.23.0
+0.24.0
--- a/environment.yaml
+++ b/environment.yaml
@ -4,46 +4,46 @@ channels:
 dependencies:
 - beautifulsoup4=4.12.2
 - black=23.7.0
- click=8.1.6
+- click=8.1.7
 - codecov=2.1.13
 - dill=0.3.7
 - easyprocess=1.1
- gcsfs=2023.6.0
+- gcsfs=2023.9.0
 - geckodriver=0.33.0
- ipython=8.14.0
+- ipython=8.15.0
 - isort=5.12.0
 - leveldb=1.23
 - multiprocess=0.70.15
- mypy=1.4.1
- nodejs=18.16.1
- pandas=2.0.3
+- mypy=1.5.1
+- nodejs=20.6.0
+- pandas=2.1.0
 - pillow=10.0.0
 - pip=23.2.1
- pre-commit=3.3.3
+- pre-commit=3.4.0
 - psutil=5.9.5
- pyarrow=12.0.1
+- pyarrow=13.0.0
 - pytest-asyncio=0.21.1
 - pytest-cov=4.1.0
- pytest=7.4.0
- python=3.11.4
+- pytest=7.4.1
+- python=3.11.5
 - pyvirtualdisplay=3.0
 - recommonmark=0.7.1
- redis-py=4.6.0
- s3fs=2023.6.0
- selenium=4.11.2
- sentry-sdk=1.29.2
+- redis-py=5.0.0
+- s3fs=2023.9.0
+- selenium=4.12.0
+- sentry-sdk=1.30.0
 - sphinx-markdown-tables=0.0.17
- sphinx=7.1.2
+- sphinx=7.2.5
 - tabulate=0.9.0
 - tblib=1.7.0
 - wget=1.20.3
 - pip:
-  - dataclasses-json==0.5.14
+  - dataclasses-json==0.6.0
  - domain-utils==0.7.1
-  - jsonschema==4.18.6
+  - jsonschema==4.19.0
  - plyvel==1.5.0
  - tranco==0.6
  - types-pyyaml==6.0.12.11
-  - types-redis==4.6.0.3
+  - types-redis==4.6.0.5
  - types-tabulate==0.9.0.3
 name: openwpm
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -24,11 +24,11 @@
  "homepage": "",
  "devDependencies": {
    "@adobe/jsonschema2md": "^7.1.5",
-    "@commitlint/cli": "^17.6.7",
-    "@commitlint/config-conventional": "^17.6.7",
-    "commitlint": "^17.6.7",
+    "@commitlint/cli": "^17.7.0",
+    "@commitlint/config-conventional": "^17.7.0",
+    "commitlint": "^17.7.0",
    "markdown-link-check": "^3.11.2",
-    "markdownlint-cli": "^0.35.0"
+    "markdownlint-cli": "^0.36.0"
  },
  "resolutions": {
    "glob-parent": "^6.0.2",
--- a/scripts/install-firefox.sh
+++ b/scripts/install-firefox.sh
@ -9,7 +9,7 @@ set -e
 # Note this script is **destructive** and will
 # remove the existing Firefox in the OpenWPM directory

-TAG='326212e7271a9c9f0776153095cf48d7153260aa' # FIREFOX_115_0_3_RELEASE
+TAG='27de51e74c19186044da535125895c96fc3a0f23' # FIREFOX_117_0_RELEASE

 case "$(uname -s)" in
 Darwin)
 @ -1 +1 @@
 .23.0
 .24.0