Micropilot

.gitignore

@@ -1,2 +1,3 @@
 *.swp
 *~
+packages/micropilot

README.md

@@ -1,7 +1,10 @@
 For users: https://github.com/mozilla/blushproof/wiki
 
 For developers:
+Requirements: nodejs, volo version 0.2.8 or higher
+
 To checkout:  
+    `npm install -g volo`
     `git clone https://github.com/mozilla/blushproof`  
     `cd .git`  
     `rm -rf hooks`  

lib/bpUI.js

@@ -14,6 +14,8 @@ const BROWSERURL = "chrome://browser/content/browser.xul"
 let bpContentPolicy = require("bpContentPolicy");
 let bpCategorizer = require("bpCategorizer");
 let bpUtil = require("bpUtil");
+let monitor = require("monitor").monitor;
+
 const { Cc, Ci, Cu } = require("chrome");
 // The second param avoids polluting the scope
 const { ForgetAboutSite } = Cu.import("resource://gre/modules/ForgetAboutSite.jsm", {});
@@ -22,6 +24,9 @@ let blushPanel = panel.Panel({
   contentURL: data.url("blushthis.html"),
   onMessage: function(aMessage) {
     console.log("received message", aMessage);
+    // Placeholder for metrics. We don't know the format, etc. yet.
+    monitor.record({ name: aMessage, ts: Date.now() });
+
     let host = utils.getMostRecentBrowserWindow().gBrowser.selectedBrowser
                  .contentWindow.location.host;
     // Unfortunately, [current browser].contentWindow.location is not an

lib/monitor.js

@@ -0,0 +1,31 @@
+// This module encapsulates all the micropilot logic. Other modules should only
+// ever have to use monitor.record.
+
+let micropilot = require("micropilot");
+
+const { storage } = require("simple-storage");
+
+let monitor = micropilot.Micropilot("blushproof").start();
+
+function daily_upload() {
+  // Placeholder for metadata about the upload. We probably want to keep track
+  // of the last upload.
+  monitor.record({ts: Date.now()});
+  // Placeholder for the upload url.
+  monitor.upload("fake.com", { simulate: true }).then(function(req) {
+    console.log(JSON.stringify(req.content));
+  });
+};
+
+micropilot.Fuse({
+  start: Date.now(),
+  // Run forever
+  duration: false,
+  // Upload every day in milliseconds
+  pulseinterval: 24 * 60 * 60 * 1000,
+  // (Upload more often for testing)
+  // pulseinterval: 10 * 1000,
+  pulsefn: daily_upload
+});
+
+exports.monitor = monitor;

package.json

@@ -5,5 +5,21 @@
   "description": "stop opening naughty sites accidentally",
   "author": "David Keeler <[email protected]>, Monica Chew <[email protected]>, Gregg Lind <[email protected]>",
   "license": "MPL 2.0",
-  "version": "0.1"
-}
+  "version": "0.1",
+  "dependencies": [
+    "micropilot"
+  ],
+  "preferences": [
+    {
+      "type": "bool",
+      "title": "micropilotlog",
+      "name": "micropilotlog",
+      "value": true
+    }
+  ],
+  "volo": {
+    "dependencies": {
+      "packages/micropilot": "github:gregglind/micropilot/v0.8"
+    }
+  }
+}