v0.0.1

Author: Harald Kirschner

.eslintignore

@@ -0,0 +1,23 @@
+{
+    "globals": {
+        "browser": true,
+        "chrome": true,
+    },
+    "rules": {
+        "no-set-state": "off",
+        "no-console": "off",
+        "no-unused-vars": "off",
+        "no-case-declarations": "off"
+    },
+    "env": {
+        "browser": true,
+        "es6": true,
+        "node": true
+    },
+    "parserOptions": {
+        "ecmaVersion": 2017
+    },
+    "extends": [
+      "eslint:recommended"
+    ]
+}

.eslintrc

@@ -0,0 +1,5 @@
+*.xpi
+.profile
+node_modules
+**/*-bundle.js
+.env

.gitignore

@@ -0,0 +1,9 @@
+# Personal Performance Beacon: Addon
+
+Crowd-sourced Firefox profiling.
+
+See [Server](https://github.com/digitarald/ppb-server).
+
+## Attribution
+
+[Stopwatch](https://www.iconfinder.com/icons/353443/clock_stopwatch_timer_watch_icon) is part of the [Glypho Icon Pack](http://glypho.eu/) by [Cristian Bogdan Rosu](http://www.bogdanrosu.com/)

LICENSE

@@ -0,0 +1,30 @@
+const profiler = require('./profiler');
+
+module.exports = (port) => {
+  port.onMessage.addListener(async function(msg) {
+    switch (msg.name) {
+      case 'start':
+        profiler.start(msg.settings);
+        port.postMessage({ name: 'start' });
+        break;
+      case 'stop':
+        profiler.stop();
+        port.postMessage({ name: 'stop' });
+        break;
+      case 'getData':
+        const data = await profiler.getData();
+        console.log(`getData yielded ${JSON.stringify(data).length} bytes`);
+        port.postMessage({
+          name: 'getData',
+          data: data
+        });
+        break;
+      case 'getStatus':
+        port.postMessage({
+          name: 'getStatus',
+          data: profiler.isActive() || false
+        });
+        break;
+    }
+  });
+};

README.md

@@ -0,0 +1,25 @@
+const { Cc, Ci } = require("chrome");
+
+class Profiler {
+  constructor() {
+    this.service = Cc["@mozilla.org/tools/profiler;1"].getService(Ci.nsIProfiler);
+  }
+
+  start({entries = 10000000, interval = 1, features = ['stackwalk'], threads = []}) {
+    this.service.StartProfiler(entries, interval, features, features.length, threads, threads.length);
+  }
+
+  stop() {
+    this.service.StopProfiler();
+  }
+
+  getData() {
+    return this.service.getProfileDataAsync();
+  }
+
+  isActive() {
+    return this.service.IsActive();
+  }
+}
+
+module.exports = new Profiler();

addon/lib/profiler-port.js

@@ -0,0 +1,6 @@
+const webext = require("sdk/webextension");
+const connectProfiler = require("./lib/profiler-port");
+
+webext.startup().then(({browser}) => {
+  browser.runtime.onConnect.addListener(connectProfiler);
+});

addon/lib/profiler.js

@@ -0,0 +1,25 @@
+{
+  "title": "Personal Performance Beacon",
+  "name": "personal-performance-beacon",
+  "description": "Crowd-sourced Firefox Profiling.",
+  "author": "Quantum Flow <quantum-flow@mozilla.org>",
+  "version": "0.0.2",
+  "main": "./main.js",
+  "engines": {
+    "firefox": ">=53.0"
+  },
+  "permissions": {
+    "multiprocess": true
+  },
+  "hasEmbeddedWebExtension": true,
+  "license": "MPL",
+  "preferences": [
+    {
+      "name": "reportUrl",
+      "title": "Reporter URL",
+      "description": "Collected profiles get posted to this URL",
+      "type": "string",
+      "value": "https://profile-analyzer.firebaseapp.com/"
+    }
+  ]
+}

addon/main.js

@@ -0,0 +1,20 @@
+{
+  "name": "SDK Transition Addon",
+  "version": "0.0.1",
+  "manifest_version": 2,
+  "permissions": [
+    "webNavigation",
+    "storage",
+    "https://quantum-ppb.herokuapp.com/",
+    "https://quantum-flow.s3.amazonaws.com/",
+    "https://www.google-analytics.com/"
+  ],
+  "background": {
+    "scripts": ["background.js"]
+  },
+  "browser_action": {
+    "default_icon": "icons/icon-default.svg",
+    "default_title": "Personal Performance Beacon",
+    "browser_style": false
+  }
+}

addon/package.json

@@ -0,0 +1,25 @@
+{
+  "title": "Personal Performance Beacon Addon",
+  "name": "ppb-addon",
+  "description": "Crowd-sourced Firefox Profiling.",
+  "author": "Quantum Flow <quantum-flow@mozilla.org>",
+  "version": "0.0.1",
+  "scripts": {
+    "test:lint": "eslint **/*.js",
+    "bundle:dev": "webpack",
+    "bundle:prod": "NODE_ENV=production webpack",
+    "start": "npm run bundle:dev && npm run start:browser",
+    "sign": "jpm sign --addon-dir addon --api-key $JWT_ISSUER --api-secret $JWT_SECRET",
+    "start:browser": "jpm run --addon-dir addon --binary /Applications/FirefoxNightly.app --profile ./.profile --no-copy",
+    "start:post": "npm run bundle:dev && jpm post --addon-dir addon --post-url http://127.0.0.1:8888",
+    "build": "npm run bundle:prod && npm run sign"
+  },
+  "devDependencies": {
+    "eslint": "^3.18.0",
+    "jpm": "^1.3.0",
+    "webpack": "^2.2.1"
+  },
+  "dependencies": {
+    "pako": "^1.0.4"
+  }
+}

addon/webextension/icons/icon-default.svg

@@ -0,0 +1,58 @@
+const stringifyQuery = (params) => {
+  var esc = encodeURIComponent;
+  return Object.keys(params)
+    .map(k => encodeURIComponent(k) + '=' + encodeURIComponent(params[k]))
+    .join('&');
+}
+
+module.exports = class Analytics {
+
+  constructor(tid) {
+    this.tid = tid;
+    this.cid = '0';
+  }
+
+  setClient(cid) {
+    this.cid = cid;
+  }
+
+  track(type, params) {
+    Object.assign(params, {
+      v: 1,
+      tid: this.tid,
+      cid: this.cid,
+      aip: 1,
+      ds: 'addon',
+      t: type
+    });
+    // console.log(`analytics track: ${type}`, params);
+    fetch('https://www.google-analytics.com/collect', {
+      method: 'post',
+      body: stringifyQuery(params)
+    });
+  }
+
+  trackEvent(category, action, label = '', value = '') {
+    this.track('event', {
+      ec: category,
+      ea: action,
+      el: label,
+      ev: value
+    });
+  }
+
+  trackException(description, fatal = false) {
+    this.track('exception', {
+      exd: description,
+      exf: fatal ? 1 : 0
+    });
+  }
+
+  trackUserTiming(category, variable, time = 0) {
+    this.track('timing', {
+      utc: category,
+      utv: variable,
+      utt: time
+    });
+  }
+}