Refactor about:sync's events framework

chrome/browser/resources/sync_internals/sync_log.js

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // require: cr.js
 // require: cr/event_target.js
 
 /**
  * @fileoverview This creates a log object which listens to and
  * records all sync events.
  */
 
 cr.define('chrome.sync', function() {
+  'use strict';
+
+  var eventsByCategory = {
+    notifier: [
+      'onNotificationStateChange',
+      'onIncomingNotification',
+    ],
+
+    manager: [
+      'onChangesApplied',
+      'onChangesComplete',
+      'onSyncCycleCompleted',
+      'onConnectionStatusChange',
+      'onPassphraseRequired',
+      'onPassphraseAccepted',
+      'onInitializationComplete',
+      'onStopSyncingPermanently',
+      'onClearServerDataSucceeded',
+      'onClearServerDataFailed',
+      'onEncryptedTypesChanged',
+      'onEncryptionComplete',
+      'onActionableError',

[Dan Beam, 2014/02/11 23:21:48]

sort

[rlarocque, 2014/02/12 00:39:55]

Done.

+    ],
+
+    transaction: [
+      'onTransactionWrite',
+    ]

[Dan Beam, 2014/02/11 23:21:48]

nit: ],

[rlarocque, 2014/02/12 00:39:55]

Done.

+  };
+
   /**
    * Creates a new log object which then immediately starts recording
    * sync events.  Recorded entries are available in the 'entries'
    * property and there is an 'append' event which can be listened to.
    * @constructor
    * @extends {cr.EventTarget}
    */
   var Log = function() {
     var self = this;
 
-    var makeListener = function(service, event) {
-      return function(details) {
-        self.log_(service, event, details);
-      };
-    };
-
-    for (var eventType in chrome.sync.events) {
-      var events = chrome.sync.events[eventType];
-      for (var i = 0; i < events.length; ++i) {
-        var eventName = events[i];
-        var event = chrome.sync[eventName];
-        event.addListener(makeListener(eventType, eventName));
+    /**
+     * Creates a callback function to be invoked when an event arrives.
+     */
+    var makeCallback = function(categoryName, eventName) {
+      return function(e) {
+        self.log_(categoryName, eventName, e.details);
       }

[Dan Beam, 2014/02/11 23:21:48]

};

[rlarocque, 2014/02/12 00:39:55]

Done.

     }
-  };
+
+    for (var categoryName in eventsByCategory) {
+      eventsByCategory[categoryName].forEach(function(eventName) {

[Dan Beam, 2014/02/11 23:21:48]

nit: because this doesn't need to make a new scope, it'd be better to use
vanilla for-loop. but it's bounded input... so i don't care that much.

[rlarocque, 2014/02/12 00:39:55]

Fixed.

+        chrome.sync.events.addEventListener(
+            eventName,
+            makeCallback(categoryName, eventName));
+      });
+    }
+  }
 
   Log.prototype = {
     __proto__: cr.EventTarget.prototype,
 
     /**
      * The recorded log entries.
      * @type {array}
      */
     entries: [],
 
@@ skipping 19 matching lines @@
       var e = cr.doc.createEvent('CustomEvent');
       e.initCustomEvent('append', false, false, entry);
       this.dispatchEvent(e);
     }
   };
 
   return {
     log: new Log()
   };
 });