openwpm · englehardt · Jun 26, 2019 · Sep 28, 2018 · Sep 28, 2018 · Sep 28, 2018
diff --git a/Dockerfile b/Dockerfile
@@ -4,21 +4,16 @@
 FROM node:10 as extension
 WORKDIR /usr/src/app
 
-# Copy the package.json and package-lock.json first and install all the
-# packages. Should the source code of the extension be changed without
-# altering the list of required packages, this step can be cached by Docker.
-COPY automation/Extension/firefox/package*.json ./
-
 # The extension needs to run for example the TypeScript transpiler
 # to generate the JavaScript code of the extension. This must be done as root
 # as long as the directory of the extension is only writeable as root.
 RUN npm config set unsafe-perm true
 
-RUN npm install
 COPY automation/Extension/firefox/. ./
+COPY automation/Extension/webext-instrumentation/. ../webext-instrumentation
+RUN npm install
 RUN npm run build
 
-
 # Stage 2, build the main OpenWPM image
 FROM ubuntu:18.04
 

diff --git a/README.md b/README.md
@@ -379,9 +379,10 @@ dependencies, which can be installed with `install-dev.sh`.
 ### Editing instrumentation
 
 The instrumentation extension is included in `/automation/Extension/firefox/`.
-Any edits within this directory will require the extension to be re-built to produce a new `openwpm.xpi` with your updates. You can use `build_extension.sh` to do this.
-
-The actual instrumentation code is maintained in https://github.com/mozilla/openwpm-webext-instrumentation. To test changes to the instrumentation code, change the dependency in [package.json](https://github.com/mozilla/OpenWPM/blob/master/automation/Extension/firefox/package.json) to point to your local clone (e.g. `"openwpm-webext-instrumentation": "file:/path/to/openwpm-webext-instrumentation"`). Make sure to run `npm run build` in the `openwpm-webext-instrumentation` repo to pick up changes.
+The instrumentation itself (used by the above extension) is included in 
+`/automation/Extension/webext-instrumentation/`.
+Any edits within these directories will require the extension to be re-built to produce 
+a new `openwpm.xpi` with your updates. You can use `build_extension.sh` to do this.
 
 ### Debugging the platform
 

diff --git a/automation/Extension/firefox/package-lock.json b/automation/Extension/firefox/package-lock.json
diff --git a/automation/Extension/firefox/package.json b/automation/Extension/firefox/package.json
@@ -4,7 +4,7 @@
   "version": "1.0.0",
   "author": "Mozilla",
   "dependencies": {
-    "openwpm-webext-instrumentation": "github:mozilla/openwpm-webext-instrumentation#master"
+    "openwpm-webext-instrumentation": "../webext-instrumentation"
   },
   "devDependencies": {
     "eslint": "^5.16.0",
@@ -38,7 +38,8 @@
     "url": "https://github.com/mozilla/openwpm-firefox-webext"
   },
   "scripts": {
-    "prebuild": "webpack",
+    "prebuild": "cd ../webext-instrumentation && npm run build && cd - && webpack",
+    "postinstall": "cd ../webext-instrumentation && npm install",
     "build": "web-ext build",
     "eslint": "eslint . --ext jsm,js,json",
     "lint": "npm-run-all lint:*",

diff --git a/automation/Extension/firefox/web-ext-config.js b/automation/Extension/firefox/web-ext-config.js
@@ -10,7 +10,7 @@ const defaultConfig = {
     overwriteDest: true,
   },
   run: {
-    firefox: process.env.FIREFOX_BINARY || "firefox",
+    firefox: process.env.FIREFOX_BINARY || "firefoxdeveloperedition",
     browserConsole: true,
     startUrl: ["about:debugging"],
     pref: ["extensions.legacy.enabled=true"],

diff --git a/automation/Extension/webext-instrumentation/.editorconfig b/automation/Extension/webext-instrumentation/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
diff --git a/automation/Extension/webext-instrumentation/.gitignore b/automation/Extension/webext-instrumentation/.gitignore
@@ -0,0 +1,11 @@
+node_modules
+build
+test
+src/**.js
+.idea/*
+
+coverage
+.nyc_output
+*.log
+
+yarn.lock
diff --git a/automation/Extension/webext-instrumentation/.npmignore b/automation/Extension/webext-instrumentation/.npmignore
@@ -0,0 +1,14 @@
+src
+test
+tsconfig.json
+tsconfig.module.json
+tslint.json
+.travis.yml
+.github
+.prettierignore
+.vscode
+build/docs
+**/*.spec.*
+coverage
+.nyc_output
+*.log
diff --git a/automation/Extension/webext-instrumentation/.prettierignore b/automation/Extension/webext-instrumentation/.prettierignore
@@ -0,0 +1,2 @@
+# package.json is formatted by package managers, so we ignore it here
+package.json
diff --git a/automation/Extension/webext-instrumentation/README.md b/automation/Extension/webext-instrumentation/README.md
@@ -0,0 +1,26 @@
+# OpenWPM instrumentation library for WebExtensions
+
+Allows WebExtensions to track and monitor privacy-related browsing behavior
+
+## Installation
+
+This package is yet to be published to npm.
+
+## Instrumentation
+
+The instrumentation leverages the available [JavaScript APIs for WebExtensions](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API) and listens to navigation, web requests, cookie modifications and access to certain javascript API:s, as described in [the main OpenWPM project README](https://github.com/citp/OpenWPM/tree/develop#instrumentation-and-data-access) under the following bullet points:
+ - HTTP Request and Response Headers, redirects, and POST request bodies
+ - Javascript Calls
+ - Response body content
+ - Cookie Access (Experimental)
+
+More specifically, all packets sent by the instrumentation conform to [these interfaces](https://github.com/mozilla/openwpm-webext-instrumentation/blob/refactor-legacy-sdk-code-to-webext-equivalent/src/schema.ts).
+
+## Usage
+
+The instrumentation is designed to invoke a `dataReceiver` object whenever a packet or log entry is available.
+
+Pending proper documentation, the best way to see how this library is used is to check how the instrumentation is incorporated into the following extensions:
+
+ * https://github.com/mozilla/OpenWPM/tree/master/automation/Extension/firefox
+ * https://github.com/motin/jestr-pioneer-shield-study
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# package.json is formatted by package managers, so we ignore it here
		package.json