The Tor Browser: b2g/chrome/content/devtools.js@b8a032363ba2 (annotated)

b2g/chrome/content/devtools.js@b8a032363ba2 (annotated)

b2g/chrome/content/devtools.js

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 'use strict';
 const DEVELOPER_HUD_LOG_PREFIX = 'DeveloperHUD';
 XPCOMUtils.defineLazyGetter(this, 'devtools', function() {
   const {devtools} = Cu.import('resource://gre/modules/devtools/Loader.jsm', {});
   return devtools;
 });
 XPCOMUtils.defineLazyGetter(this, 'DebuggerClient', function() {
   return Cu.import('resource://gre/modules/devtools/dbg-client.jsm', {}).DebuggerClient;
 });
 XPCOMUtils.defineLazyGetter(this, 'WebConsoleUtils', function() {
   return devtools.require('devtools/toolkit/webconsole/utils').Utils;
 });
 XPCOMUtils.defineLazyGetter(this, 'EventLoopLagFront', function() {
   return devtools.require('devtools/server/actors/eventlooplag').EventLoopLagFront;
 });
 XPCOMUtils.defineLazyGetter(this, 'MemoryFront', function() {
   return devtools.require('devtools/server/actors/memory').MemoryFront;
 });
 /**
  * The Developer HUD is an on-device developer tool that displays widgets,
  * showing visual debug information about apps. Each widget corresponds to a
  * metric as tracked by a metric watcher (e.g. consoleWatcher).
  */
 let developerHUD = {
   _targets: new Map(),
   _frames: new Map(),
   _client: null,
   _conn: null,
   _watchers: [],
   _logging: true,
   /**
    * This method registers a metric watcher that will watch one or more metrics
    * on app frames that are being tracked. A watcher must implement the
    * `trackTarget(target)` and `untrackTarget(target)` methods, register
    * observed metrics with `target.register(metric)`, and keep them up-to-date
    * with `target.update(metric, message)` when necessary.
    */
   registerWatcher: function dwp_registerWatcher(watcher) {
     this._watchers.unshift(watcher);
   },
   init: function dwp_init() {
     if (this._client)
       return;
     if (!DebuggerServer.initialized) {
       RemoteDebugger.start();
     }
     // We instantiate a local debugger connection so that watchers can use our
     // DebuggerClient to send requests to tab actors (e.g. the consoleActor).
     // Note the special usage of the private _serverConnection, which we need
     // to call connectToChild and set up child process actors on a frame we
     // intend to track. These actors will use the connection to communicate with
     // our DebuggerServer in the parent process.
     let transport = DebuggerServer.connectPipe();
     this._conn = transport._serverConnection;
     this._client = new DebuggerClient(transport);
     for (let w of this._watchers) {
       if (w.init) {
         w.init(this._client);
       }
     }
     Services.obs.addObserver(this, 'remote-browser-shown', false);
     Services.obs.addObserver(this, 'inprocess-browser-shown', false);
     Services.obs.addObserver(this, 'message-manager-disconnect', false);
     let systemapp = document.querySelector('#systemapp');
     this.trackFrame(systemapp);
     let frames = systemapp.contentWindow.document.querySelectorAll('iframe[mozapp]');
     for (let frame of frames) {
       this.trackFrame(frame);
     }
     SettingsListener.observe('hud.logging', this._logging, enabled => {
       this._logging = enabled;
     });
   },
   uninit: function dwp_uninit() {
     if (!this._client)
       return;
     for (let frame of this._targets.keys()) {
       this.untrackFrame(frame);
     }
     Services.obs.removeObserver(this, 'remote-browser-shown');
     Services.obs.removeObserver(this, 'inprocess-browser-shown');
     Services.obs.removeObserver(this, 'message-manager-disconnect');
     this._client.close();
     delete this._client;
   },
   /**
    * This method will ask all registered watchers to track and update metrics
    * on an app frame.
    */
   trackFrame: function dwp_trackFrame(frame) {
     if (this._targets.has(frame))
       return;
     DebuggerServer.connectToChild(this._conn, frame).then(actor => {
       let target = new Target(frame, actor);
       this._targets.set(frame, target);
       for (let w of this._watchers) {
         w.trackTarget(target);
       }
     });
   },
   untrackFrame: function dwp_untrackFrame(frame) {
     let target = this._targets.get(frame);
     if (target) {
       for (let w of this._watchers) {
         w.untrackTarget(target);
       }
       target.destroy();
       this._targets.delete(frame);
     }
   },
   observe: function dwp_observe(subject, topic, data) {
     if (!this._client)
       return;
     let frame;
     switch(topic) {
       // listen for frame creation in OOP (device) as well as in parent process (b2g desktop)
       case 'remote-browser-shown':
       case 'inprocess-browser-shown':
         let frameLoader = subject;
         // get a ref to the app <iframe>
         frameLoader.QueryInterface(Ci.nsIFrameLoader);
         // Ignore notifications that aren't from a BrowserOrApp
         if (!frameLoader.ownerIsBrowserOrAppFrame) {
           return;
         }
         frame = frameLoader.ownerElement;
         if (!frame.appManifestURL) // Ignore all frames but app frames
           return;
         this.trackFrame(frame);
         this._frames.set(frameLoader.messageManager, frame);
         break;
       // Every time an iframe is destroyed, its message manager also is
       case 'message-manager-disconnect':
         let mm = subject;
         frame = this._frames.get(mm);
         if (!frame)
           return;
         this.untrackFrame(frame);
         this._frames.delete(mm);
         break;
     }
   },
   log: function dwp_log(message) {
     if (this._logging) {
       dump(DEVELOPER_HUD_LOG_PREFIX + ': ' + message + '\n');
     }
   }
 };
 /**
  * A Target object represents all there is to know about a Firefox OS app frame
  * that is being tracked, e.g. a pointer to the frame, current values of watched
  * metrics, and how to notify the front-end when metrics have changed.
  */
 function Target(frame, actor) {
   this.frame = frame;
   this.actor = actor;
   this.metrics = new Map();
 }
 Target.prototype = {
   /**
    * Register a metric that can later be updated. Does not update the front-end.
    */
   register: function target_register(metric) {
     this.metrics.set(metric, 0);
   },
   /**
    * Modify one of a target's metrics, and send out an event to notify relevant
    * parties (e.g. the developer HUD, automated tests, etc).
    */
   update: function target_update(metric, message) {
     if (!metric.name) {
       throw new Error('Missing metric.name');
     }
     if (!metric.value) {
       metric.value = 0;
     }
     let metrics = this.metrics;
     if (metrics) {
       metrics.set(metric.name, metric.value);
     }
     let data = {
       metrics: [], // FIXME(Bug 982066) Remove this field.
       manifest: this.frame.appManifestURL,
       metric: metric,
       message: message
     };
     // FIXME(Bug 982066) Remove this loop.
     if (metrics && metrics.size > 0) {
       for (let name of metrics.keys()) {
         data.metrics.push({name: name, value: metrics.get(name)});
       }
     }
     if (message) {
       developerHUD.log('[' + data.manifest + '] ' + data.message);
     }
     this._send(data);
   },
   /**
    * Nicer way to call update() when the metric value is a number that needs
    * to be incremented.
    */
   bump: function target_bump(metric, message) {
     metric.value = (this.metrics.get(metric.name) || 0) + 1;
     this.update(metric, message);
   },
   /**
    * Void a metric value and make sure it isn't displayed on the front-end
    * anymore.
    */
   clear: function target_clear(metric) {
     metric.value = 0;
     this.update(metric);
   },
   /**
    * Tear everything down, including the front-end by sending a message without
    * widgets.
    */
   destroy: function target_destroy() {
     delete this.metrics;
     this._send({});
   },
   _send: function target_send(data) {
     shell.sendEvent(this.frame, 'developer-hud-update', Cu.cloneInto(data, this.frame));
   }
 };
 /**
  * The Console Watcher tracks the following metrics in apps: reflows, warnings,
  * and errors, with security errors reported separately.
  */
 let consoleWatcher = {
   _client: null,
   _targets: new Map(),
   _watching: {
     reflows: false,
     warnings: false,
     errors: false,
     security: false
   },
   _security: [
     'Mixed Content Blocker',
     'Mixed Content Message',
     'CSP',
     'Invalid HSTS Headers',
     'Insecure Password Field',
     'SSL',
     'CORS'
   ],
   init: function cw_init(client) {
     this._client = client;
     this.consoleListener = this.consoleListener.bind(this);
     let watching = this._watching;
     for (let key in watching) {
       let metric = key;
       SettingsListener.observe('hud.' + metric, watching[metric], watch => {
         // Watch or unwatch the metric.
         if (watching[metric] = watch) {
           return;
         }
         // If unwatched, remove any existing widgets for that metric.
         for (let target of this._targets.values()) {
           target.clear({name: metric});
         }
       });
     }
     client.addListener('logMessage', this.consoleListener);
     client.addListener('pageError', this.consoleListener);
     client.addListener('consoleAPICall', this.consoleListener);
     client.addListener('reflowActivity', this.consoleListener);
   },
   trackTarget: function cw_trackTarget(target) {
     target.register('reflows');
     target.register('warnings');
     target.register('errors');
     target.register('security');
     this._client.request({
       to: target.actor.consoleActor,
       type: 'startListeners',
       listeners: ['LogMessage', 'PageError', 'ConsoleAPI', 'ReflowActivity']
     }, (res) => {
       this._targets.set(target.actor.consoleActor, target);
     });
   },
   untrackTarget: function cw_untrackTarget(target) {
     this._client.request({
       to: target.actor.consoleActor,
       type: 'stopListeners',
       listeners: ['LogMessage', 'PageError', 'ConsoleAPI', 'ReflowActivity']
     }, (res) => { });
     this._targets.delete(target.actor.consoleActor);
   },
   consoleListener: function cw_consoleListener(type, packet) {
     let target = this._targets.get(packet.from);
     let metric = {};
     let output = '';
     switch (packet.type) {
       case 'pageError':
         let pageError = packet.pageError;
         if (pageError.warning || pageError.strict) {
           metric.name = 'warnings';
           output += 'warning (';
         } else {
           metric.name = 'errors';
           output += 'error (';
         }
         if (this._security.indexOf(pageError.category) > -1) {
           metric.name = 'security';
         }
         let {errorMessage, sourceName, category, lineNumber, columnNumber} = pageError;
         output += category + '): "' + (errorMessage.initial || errorMessage) +
           '" in ' + sourceName + ':' + lineNumber + ':' + columnNumber;
         break;
       case 'consoleAPICall':
         switch (packet.message.level) {
           case 'error':
             metric.name = 'errors';
             output += 'error (console)';
             break;
           case 'warn':
             metric.name = 'warnings';
             output += 'warning (console)';
             break;
           default:
             return;
         }
         break;
       case 'reflowActivity':
         metric.name = 'reflows';
         let {start, end, sourceURL, interruptible} = packet;
         metric.interruptible = interruptible;
         let duration = Math.round((end - start) * 100) / 100;
         output += 'reflow: ' + duration + 'ms';
         if (sourceURL) {
           output += ' ' + this.formatSourceURL(packet);
         }
         break;
       default:
         return;
     }
     if (!this._watching[metric.name]) {
       return;
     }
     target.bump(metric, output);
   },
   formatSourceURL: function cw_formatSourceURL(packet) {
     // Abbreviate source URL
     let source = WebConsoleUtils.abbreviateSourceURL(packet.sourceURL);
     // Add function name and line number
     let {functionName, sourceLine} = packet;
     source = 'in ' + (functionName || '<anonymousFunction>') +
       ', ' + source + ':' + sourceLine;
     return source;
   }
 };
 developerHUD.registerWatcher(consoleWatcher);
 let eventLoopLagWatcher = {
   _client: null,
   _fronts: new Map(),
   _active: false,
   init: function(client) {
     this._client = client;
     SettingsListener.observe('hud.jank', false, this.settingsListener.bind(this));
   },
   settingsListener: function(value) {
     if (this._active == value) {
       return;
     }
     this._active = value;
     // Toggle the state of existing fronts.
     let fronts = this._fronts;
     for (let target of fronts.keys()) {
       if (value) {
         fronts.get(target).start();
       } else {
         fronts.get(target).stop();
         target.clear({name: 'jank'});
       }
     }
   },
   trackTarget: function(target) {
     target.register('jank');
     let front = new EventLoopLagFront(this._client, target.actor);
     this._fronts.set(target, front);
     front.on('event-loop-lag', time => {
       target.update({name: 'jank', value: time}, 'jank: ' + time + 'ms');
     });
     if (this._active) {
       front.start();
     }
   },
   untrackTarget: function(target) {
     let fronts = this._fronts;
     if (fronts.has(target)) {
       fronts.get(target).destroy();
       fronts.delete(target);
     }
   }
 };
 developerHUD.registerWatcher(eventLoopLagWatcher);
 /**
  * The Memory Watcher uses devtools actors to track memory usage.
  */
 let memoryWatcher = {
   _client: null,
   _fronts: new Map(),
   _timers: new Map(),
   _watching: {
     jsobjects: false,
     jsstrings: false,
     jsother: false,
     dom: false,
     style: false,
     other: false
   },
   _active: false,
   init: function mw_init(client) {
     this._client = client;
     let watching = this._watching;
     for (let key in watching) {
       let category = key;
       SettingsListener.observe('hud.' + category, false, watch => {
         watching[category] = watch;
       });
     }
     SettingsListener.observe('hud.appmemory', false, enabled => {
       if (this._active = enabled) {
         for (let target of this._fronts.keys()) {
           this.measure(target);
         }
       } else {
         for (let target of this._fronts.keys()) {
           clearTimeout(this._timers.get(target));
           target.clear({name: 'memory'});
         }
       }
     });
   },
   measure: function mw_measure(target) {
     // TODO Also track USS (bug #976024).
     let watch = this._watching;
     let front = this._fronts.get(target);
     front.measure().then((data) => {
       let total = 0;
       if (watch.jsobjects) {
         total += parseInt(data.jsObjectsSize);
       }
       if (watch.jsstrings) {
         total += parseInt(data.jsStringsSize);
       }
       if (watch.jsother) {
         total += parseInt(data.jsOtherSize);
       }
       if (watch.dom) {
         total += parseInt(data.domSize);
       }
       if (watch.style) {
         total += parseInt(data.styleSize);
       }
       if (watch.other) {
         total += parseInt(data.otherSize);
       }
       // TODO Also count images size (bug #976007).
       target.update({name: 'memory', value: total});
       let duration = parseInt(data.jsMilliseconds) + parseInt(data.nonJSMilliseconds);
       let timer = setTimeout(() => this.measure(target), 100 * duration);
       this._timers.set(target, timer);
     }, (err) => {
       console.error(err);
     });
   },
   trackTarget: function mw_trackTarget(target) {
     target.register('uss');
     target.register('memory');
     this._fronts.set(target, MemoryFront(this._client, target.actor));
     if (this._active) {
       this.measure(target);
     }
   },
   untrackTarget: function mw_untrackTarget(target) {
     let front = this._fronts.get(target);
     if (front) {
       front.destroy();
       clearTimeout(this._timers.get(target));
       this._fronts.delete(target);
       this._timers.delete(target);
     }
   }
 };
 developerHUD.registerWatcher(memoryWatcher);