Fixing extension logging (#912)

* Combined log_directory and log_file to log_path

* Updated documentation

* Fixed tests

* Implemented test, need to change CSP

* Extension logging restored and tested

* Renamed extra to custom_params

* Reverting stackdump changes

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
       - id: black
         language_version: python3
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.790
+    rev: v0.812
     hooks:
       - id: mypy
         additional_dependencies: [pytest]

openwpm/Extension/firefox/feature.js/index.js

@@ -53,6 +53,9 @@ async function main() {
                        config['logger_address'],
                        config['browser_id']);
 
+  if (config["custom_params"]["pre_instrumentation_code"]) {
+    eval(config["custom_params"]["pre_instrumentation_code"])
+  }
   if (config["navigation_instrument"]) {
     loggingDB.logDebug("Navigation instrumentation enabled");
     let navigationInstrument = new NavigationInstrument(loggingDB);

openwpm/Extension/firefox/src/manifest.json

@@ -13,7 +13,7 @@
       "strict_min_version": "60.0"
     }
   },
-
+  "content_security_policy":"script-src 'self' 'unsafe-eval'; object-src 'self';",
   "permissions": [
     "<all_urls>",
     "webRequest",

openwpm/Extension/firefox/src/privileged/sockets/api.js

@@ -111,7 +111,7 @@ this.sockets = class extends ExtensionAPI {
 
           try {
             let socket = gManager.sendingSocketMap.get(id);
-            var transport = socketService.createTransport([], host, port, null);
+            var transport = socketService.createTransport([], host, port, null, null);
             socket.stream = transport.openOutputStream(1, 4096, 1048575);
             socket.bOutputStream.setOutputStream(socket.stream);
             return true;

openwpm/config.py

@@ -103,6 +103,7 @@ class BrowserParams(DataClassJsonMixin):
     recovery_tar: Optional[Path] = None
     donottrack: bool = False
     tracking_protection: bool = False
+    custom_params: Dict[Any, Any] = field(default_factory=lambda: {})
 
 
 @dataclass

test/extension/test_logging.py

@@ -0,0 +1,22 @@
+def test_extension_logging(task_manager_creator, default_params, tmp_path):
+    test_msg = "This is a test message from the extension"
+    log_path = tmp_path / "openwpm.log"
+    manager_params, browser_params = default_params
+    manager_params.log_path = log_path
+    for browser_param in browser_params:
+        browser_param.custom_params[
+            "pre_instrumentation_code"
+        ] = f"""
+            // Weird name needed due to webpack name mangling
+            _loggingdb_js__WEBPACK_IMPORTED_MODULE_1__.logWarn("{test_msg}"); 
+        """
+
+    task_manager, _ = task_manager_creator((manager_params, browser_params))
+    task_manager.close()
+    log_list = []
+    with open(log_path, "r") as log_file:
+        for log_line in log_file:
+            if test_msg in log_line:
+                log_list.append(log_line)
+    # We expect to see it once when printing the config and once when printing the log message
+    assert len(log_line) == 2 * manager_params.num_browsers