Bug 609421 - Move tracker and store implementation into engines.js. r=rnewman

services/sync/modules/engines.js

@@ -20,6 +20,7 @@
  * Contributor(s):
  *  Dan Mills <thunder@mozilla.com>
  *  Myk Melez <myk@mozilla.org>
+ *  Anant Narayanan <anant@kix.in>
  *  Philipp von Weitershausen <philipp@weitershausen.de>
  *  Richard Newman <rnewman@mozilla.com>
  *
@@ -37,7 +38,8 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
-const EXPORTED_SYMBOLS = ['Engines', 'Engine', 'SyncEngine'];
+const EXPORTED_SYMBOLS = ['Engines', 'Engine', 'SyncEngine',
+                          'Tracker', 'Store'];
 
 const Cc = Components.classes;
 const Ci = Components.interfaces;
@@ -53,12 +55,191 @@ Cu.import("resource://services-sync/ext/Sync.js");
 Cu.import("resource://services-sync/identity.js");
 Cu.import("resource://services-sync/log4moz.js");
 Cu.import("resource://services-sync/resource.js");
-Cu.import("resource://services-sync/stores.js");
-Cu.import("resource://services-sync/trackers.js");
 Cu.import("resource://services-sync/util.js");
 
 Cu.import("resource://services-sync/main.js");    // So we can get to Service for callbacks.
 
+/*
+ * Trackers are associated with a single engine and deal with
+ * listening for changes to their particular data type.
+ *
+ * There are two things they keep track of:
+ * 1) A score, indicating how urgently the engine wants to sync
+ * 2) A list of IDs for all the changed items that need to be synced
+ * and updating their 'score', indicating how urgently they
+ * want to sync.
+ *
+ */
+function Tracker(name) {
+  name = name || "Unnamed";
+  this.name = this.file = name.toLowerCase();
+
+  this._log = Log4Moz.repository.getLogger("Tracker." + name);
+  let level = Svc.Prefs.get("log.logger.engine." + this.name, "Debug");
+  this._log.level = Log4Moz.Level[level];
+
+  this._score = 0;
+  this._ignored = [];
+  this.ignoreAll = false;
+  this.changedIDs = {};
+  this.loadChangedIDs();
+}
+Tracker.prototype = {
+  /*
+   * Score can be called as often as desired to decide which engines to sync
+   *
+   * Valid values for score:
+   * -1: Do not sync unless the user specifically requests it (almost disabled)
+   * 0: Nothing has changed
+   * 100: Please sync me ASAP!
+   *
+   * Setting it to other values should (but doesn't currently) throw an exception
+   */
+  get score() {
+    return this._score;
+  },
+
+  set score(value) {
+    this._score = value;
+    Observers.notify("weave:engine:score:updated", this.name);
+  },
+
+  // Should be called by service everytime a sync has been done for an engine
+  resetScore: function T_resetScore() {
+    this._score = 0;
+  },
+
+  saveChangedIDs: function T_saveChangedIDs() {
+    Utils.delay(function() {
+      Utils.jsonSave("changes/" + this.file, this, this.changedIDs);
+    }, 1000, this, "_lazySave");
+  },
+
+  loadChangedIDs: function T_loadChangedIDs() {
+    Utils.jsonLoad("changes/" + this.file, this, function(json) {
+      this.changedIDs = json;
+    });
+  },
+
+  // ignore/unignore specific IDs.  Useful for ignoring items that are
+  // being processed, or that shouldn't be synced.
+  // But note: not persisted to disk
+
+  ignoreID: function T_ignoreID(id) {
+    this.unignoreID(id);
+    this._ignored.push(id);
+  },
+
+  unignoreID: function T_unignoreID(id) {
+    let index = this._ignored.indexOf(id);
+    if (index != -1)
+      this._ignored.splice(index, 1);
+  },
+
+  addChangedID: function addChangedID(id, when) {
+    if (!id) {
+      this._log.warn("Attempted to add undefined ID to tracker");
+      return false;
+    }
+    if (this.ignoreAll || (id in this._ignored))
+      return false;
+
+    // Default to the current time in seconds if no time is provided
+    if (when == null)
+      when = Math.floor(Date.now() / 1000);
+
+    // Add/update the entry if we have a newer time
+    if ((this.changedIDs[id] || -Infinity) < when) {
+      this._log.trace("Adding changed ID: " + [id, when]);
+      this.changedIDs[id] = when;
+      this.saveChangedIDs();
+    }
+    return true;
+  },
+
+  removeChangedID: function T_removeChangedID(id) {
+    if (!id) {
+      this._log.warn("Attempted to remove undefined ID to tracker");
+      return false;
+    }
+    if (this.ignoreAll || (id in this._ignored))
+      return false;
+    if (this.changedIDs[id] != null) {
+      this._log.trace("Removing changed ID " + id);
+      delete this.changedIDs[id];
+      this.saveChangedIDs();
+    }
+    return true;
+  },
+
+  clearChangedIDs: function T_clearChangedIDs() {
+    this._log.trace("Clearing changed ID list");
+    this.changedIDs = {};
+    this.saveChangedIDs();
+  }
+};
+
+
+
+/*
+ * Data Stores
+ * These can wrap, serialize items and apply commands
+ */
+
+function Store(name) {
+  name = name || "Unnamed";
+  this.name = name.toLowerCase();
+
+  this._log = Log4Moz.repository.getLogger("Store." + name);
+  let level = Svc.Prefs.get("log.logger.engine." + this.name, "Debug");
+  this._log.level = Log4Moz.Level[level];
+}
+Store.prototype = {
+  applyIncoming: function Store_applyIncoming(record) {
+    if (record.deleted)
+      this.remove(record);
+    else if (!this.itemExists(record.id))
+      this.create(record);
+    else
+      this.update(record);
+  },
+
+  // override these in derived objects
+
+  create: function Store_create(record) {
+    throw "override create in a subclass";
+  },
+
+  remove: function Store_remove(record) {
+    throw "override remove in a subclass";
+  },
+
+  update: function Store_update(record) {
+    throw "override update in a subclass";
+  },
+
+  itemExists: function Store_itemExists(id) {
+    throw "override itemExists in a subclass";
+  },
+
+  createRecord: function Store_createRecord(id, collection) {
+    throw "override createRecord in a subclass";
+  },
+
+  changeItemID: function Store_changeItemID(oldID, newID) {
+    throw "override changeItemID in a subclass";
+  },
+
+  getAllIDs: function Store_getAllIDs() {
+    throw "override getAllIDs in a subclass";
+  },
+
+  wipe: function Store_wipe() {
+    throw "override wipe in a subclass";
+  }
+};
+
+
 // Singleton service, holds registered engines
 
 Utils.lazy(this, 'Engines', EngineManagerSvc);

services/sync/modules/engines/bookmarks.js

@@ -59,8 +59,6 @@ catch(ex) {
 }
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://services-sync/engines.js");
-Cu.import("resource://services-sync/stores.js");
-Cu.import("resource://services-sync/trackers.js");
 Cu.import("resource://services-sync/base_records/crypto.js");
 Cu.import("resource://services-sync/util.js");
 

services/sync/modules/engines/clients.js

@@ -44,7 +44,6 @@ const Cu = Components.utils;
 Cu.import("resource://services-sync/constants.js");
 Cu.import("resource://services-sync/engines.js");
 Cu.import("resource://services-sync/ext/StringBundle.js");
-Cu.import("resource://services-sync/stores.js");
 Cu.import("resource://services-sync/base_records/crypto.js");
 Cu.import("resource://services-sync/util.js");
 

services/sync/modules/engines/forms.js

@@ -42,8 +42,6 @@ const Cu = Components.utils;
 
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://services-sync/engines.js");
-Cu.import("resource://services-sync/stores.js");
-Cu.import("resource://services-sync/trackers.js");
 Cu.import("resource://services-sync/base_records/crypto.js");
 Cu.import("resource://services-sync/util.js");
 Cu.import("resource://services-sync/log4moz.js");

services/sync/modules/engines/history.js

@@ -50,8 +50,6 @@ const HISTORY_TTL = 5184000; // 60 days
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://services-sync/constants.js");
 Cu.import("resource://services-sync/engines.js");
-Cu.import("resource://services-sync/stores.js");
-Cu.import("resource://services-sync/trackers.js");
 Cu.import("resource://services-sync/base_records/crypto.js");
 Cu.import("resource://services-sync/util.js");
 Cu.import("resource://services-sync/log4moz.js");

services/sync/modules/engines/passwords.js

@@ -45,8 +45,6 @@ const Ci = Components.interfaces;
 Cu.import("resource://services-sync/base_records/collection.js");
 Cu.import("resource://services-sync/constants.js");
 Cu.import("resource://services-sync/engines.js");
-Cu.import("resource://services-sync/stores.js");
-Cu.import("resource://services-sync/trackers.js");
 Cu.import("resource://services-sync/base_records/crypto.js");
 Cu.import("resource://services-sync/util.js");
 

services/sync/modules/engines/prefs.js

@@ -44,8 +44,6 @@ const Cu = Components.utils;
 const WEAVE_SYNC_PREFS = "services.sync.prefs.sync.";
 
 Cu.import("resource://services-sync/engines.js");
-Cu.import("resource://services-sync/stores.js");
-Cu.import("resource://services-sync/trackers.js");
 Cu.import("resource://services-sync/base_records/crypto.js");
 Cu.import("resource://services-sync/util.js");
 Cu.import("resource://services-sync/ext/Preferences.js");

services/sync/modules/engines/tabs.js

@@ -47,8 +47,6 @@ const TABS_TTL = 604800; // 7 days
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://services-sync/engines.js");
 Cu.import("resource://services-sync/engines/clients.js");
-Cu.import("resource://services-sync/stores.js");
-Cu.import("resource://services-sync/trackers.js");
 Cu.import("resource://services-sync/base_records/crypto.js");
 Cu.import("resource://services-sync/util.js");
 Cu.import("resource://services-sync/ext/Preferences.js");

services/sync/modules/main.js

@@ -44,7 +44,7 @@ let lazies = {
                            'BasicAuthenticator', 'NoOpAuthenticator'],
   "base_records/crypto.js":
                           ["CollectionKeys", "BulkKeyBundle", "SyncKeyBundle"],
-  "engines.js":           ['Engines', 'Engine', 'SyncEngine'],
+  "engines.js":           ['Engines', 'Engine', 'SyncEngine', 'Store'],
   "engines/bookmarks.js": ['BookmarksEngine', 'BookmarksSharingManager'],
   "engines/clients.js":   ["Clients"],
   "engines/forms.js":     ["FormEngine"],
@@ -58,7 +58,6 @@ let lazies = {
   "resource.js":          ["Resource"],
   "service.js":           ["Service"],
   "status.js":            ["Status"],
-  "stores.js":            ["Store"],
   "util.js":              ['Utils', 'Svc', 'Str']
 };
 

services/sync/modules/stores.js

@@ -1,104 +0,0 @@
-/* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is Bookmarks Sync.
- *
- * The Initial Developer of the Original Code is Mozilla.
- * Portions created by the Initial Developer are Copyright (C) 2007
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- *  Dan Mills <thunder@mozilla.com>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 2 or later (the "GPL"), or
- * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
-const EXPORTED_SYMBOLS = ["Store"];
-
-const Cc = Components.classes;
-const Ci = Components.interfaces;
-const Cr = Components.results;
-const Cu = Components.utils;
-
-Cu.import("resource://services-sync/constants.js");
-Cu.import("resource://services-sync/log4moz.js");
-Cu.import("resource://services-sync/util.js");
-
-/*
- * Data Stores
- * These can wrap, serialize items and apply commands
- */
-
-function Store(name) {
-  name = name || "Unnamed";
-  this.name = name.toLowerCase();
-
-  this._log = Log4Moz.repository.getLogger("Store." + name);
-  let level = Svc.Prefs.get("log.logger.engine." + this.name, "Debug");
-  this._log.level = Log4Moz.Level[level];
-}
-Store.prototype = {
-  applyIncoming: function Store_applyIncoming(record) {
-    if (record.deleted)
-      this.remove(record);
-    else if (!this.itemExists(record.id))
-      this.create(record);
-    else
-      this.update(record);
-  },
-
-  // override these in derived objects
-
-  create: function Store_create(record) {
-    throw "override create in a subclass";
-  },
-
-  remove: function Store_remove(record) {
-    throw "override remove in a subclass";
-  },
-
-  update: function Store_update(record) {
-    throw "override update in a subclass";
-  },
-
-  itemExists: function Store_itemExists(id) {
-    throw "override itemExists in a subclass";
-  },
-
-  createRecord: function Store_createRecord(id, collection) {
-    throw "override createRecord in a subclass";
-  },
-
-  changeItemID: function Store_changeItemID(oldID, newID) {
-    throw "override changeItemID in a subclass";
-  },
-
-  getAllIDs: function Store_getAllIDs() {
-    throw "override getAllIDs in a subclass";
-  },
-
-  wipe: function Store_wipe() {
-    throw "override wipe in a subclass";
-  }
-};

services/sync/modules/trackers.js

@@ -1,167 +0,0 @@
-/* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is Bookmarks Sync.
- *
- * The Initial Developer of the Original Code is Mozilla.
- * Portions created by the Initial Developer are Copyright (C) 2008
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- *  Anant Narayanan <anant@kix.in>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 2 or later (the "GPL"), or
- * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
-const EXPORTED_SYMBOLS = ['Tracker'];
-
-const Cc = Components.classes;
-const Ci = Components.interfaces;
-const Cr = Components.results;
-const Cu = Components.utils;
-
-Cu.import("resource://services-sync/constants.js");
-Cu.import("resource://services-sync/ext/Observers.js");
-Cu.import("resource://services-sync/log4moz.js");
-Cu.import("resource://services-sync/util.js");
-
-/*
- * Trackers are associated with a single engine and deal with
- * listening for changes to their particular data type.
- *
- * There are two things they keep track of:
- * 1) A score, indicating how urgently the engine wants to sync
- * 2) A list of IDs for all the changed items that need to be synced
- * and updating their 'score', indicating how urgently they
- * want to sync.
- *
- */
-function Tracker(name) {
-  name = name || "Unnamed";
-  this.name = this.file = name.toLowerCase();
-
-  this._log = Log4Moz.repository.getLogger("Tracker." + name);
-  let level = Svc.Prefs.get("log.logger.engine." + this.name, "Debug");
-  this._log.level = Log4Moz.Level[level];
-
-  this._score = 0;
-  this._ignored = [];
-  this.ignoreAll = false;
-  this.changedIDs = {};
-  this.loadChangedIDs();
-}
-Tracker.prototype = {
-  /*
-   * Score can be called as often as desired to decide which engines to sync
-   *
-   * Valid values for score:
-   * -1: Do not sync unless the user specifically requests it (almost disabled)
-   * 0: Nothing has changed
-   * 100: Please sync me ASAP!
-   *
-   * Setting it to other values should (but doesn't currently) throw an exception
-   */
-  get score() {
-    return this._score;
-  },
-
-  set score(value) {
-    this._score = value;
-    Observers.notify("weave:engine:score:updated", this.name);
-  },
-
-  // Should be called by service everytime a sync has been done for an engine
-  resetScore: function T_resetScore() {
-    this._score = 0;
-  },
-
-  saveChangedIDs: function T_saveChangedIDs() {
-    Utils.delay(function() {
-      Utils.jsonSave("changes/" + this.file, this, this.changedIDs);
-    }, 1000, this, "_lazySave");
-  },
-
-  loadChangedIDs: function T_loadChangedIDs() {
-    Utils.jsonLoad("changes/" + this.file, this, function(json) {
-      this.changedIDs = json;
-    });
-  },
-
-  // ignore/unignore specific IDs.  Useful for ignoring items that are
-  // being processed, or that shouldn't be synced.
-  // But note: not persisted to disk
-
-  ignoreID: function T_ignoreID(id) {
-    this.unignoreID(id);
-    this._ignored.push(id);
-  },
-
-  unignoreID: function T_unignoreID(id) {
-    let index = this._ignored.indexOf(id);
-    if (index != -1)
-      this._ignored.splice(index, 1);
-  },
-
-  addChangedID: function addChangedID(id, when) {
-    if (!id) {
-      this._log.warn("Attempted to add undefined ID to tracker");
-      return false;
-    }
-    if (this.ignoreAll || (id in this._ignored))
-      return false;
-
-    // Default to the current time in seconds if no time is provided
-    if (when == null)
-      when = Math.floor(Date.now() / 1000);
-
-    // Add/update the entry if we have a newer time
-    if ((this.changedIDs[id] || -Infinity) < when) {
-      this._log.trace("Adding changed ID: " + [id, when]);
-      this.changedIDs[id] = when;
-      this.saveChangedIDs();
-    }
-    return true;
-  },
-
-  removeChangedID: function T_removeChangedID(id) {
-    if (!id) {
-      this._log.warn("Attempted to remove undefined ID to tracker");
-      return false;
-    }
-    if (this.ignoreAll || (id in this._ignored))
-      return false;
-    if (this.changedIDs[id] != null) {
-      this._log.trace("Removing changed ID " + id);
-      delete this.changedIDs[id];
-      this.saveChangedIDs();
-    }
-    return true;
-  },
-
-  clearChangedIDs: function T_clearChangedIDs() {
-    this._log.trace("Clearing changed ID list");
-    this.changedIDs = {};
-    this.saveChangedIDs();
-  }
-};

services/sync/tests/unit/test_engine.js

@@ -1,7 +1,5 @@
 Cu.import("resource://services-sync/engines.js");
 Cu.import("resource://services-sync/ext/Observers.js");
-Cu.import("resource://services-sync/stores.js");
-Cu.import("resource://services-sync/trackers.js");
 Cu.import("resource://services-sync/util.js");
 
 

services/sync/tests/unit/test_load_modules.js

@@ -20,8 +20,6 @@ const modules = [
                  "notifications.js",
                  "resource.js",
                  "service.js",
-                 "stores.js",
-                 "trackers.js",
                  "util.js",
 ];
 

services/sync/tests/unit/test_service_sync_updateEnabledEngines.js

@@ -1,4 +1,3 @@
-Cu.import("resource://services-sync/stores.js");
 Cu.import("resource://services-sync/engines.js");
 Cu.import("resource://services-sync/engines/clients.js");
 Cu.import("resource://services-sync/util.js");

services/sync/tests/unit/test_syncengine_sync.js

@@ -4,8 +4,6 @@ Cu.import("resource://services-sync/constants.js");
 Cu.import("resource://services-sync/engines.js");
 Cu.import("resource://services-sync/identity.js");
 Cu.import("resource://services-sync/resource.js");
-Cu.import("resource://services-sync/stores.js");
-Cu.import("resource://services-sync/trackers.js");
 Cu.import("resource://services-sync/util.js");
 
 /*

services/sync/tests/unit/test_tracker_addChanged.js

@@ -1,4 +1,4 @@
-Cu.import("resource://services-sync/trackers.js");
+Cu.import("resource://services-sync/engines.js");
 
 function run_test() {
   let tracker = new Tracker();