The Tor Browser: services/sync/tests/unit/test_bookmark_engine.js@b8a032363ba2 (annotated)

services/sync/tests/unit/test_bookmark_engine.js@b8a032363ba2 (annotated)

services/sync/tests/unit/test_bookmark_engine.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

 /* Any copyright is dedicated to the Public Domain.
    http://creativecommons.org/publicdomain/zero/1.0/ */
 Cu.import("resource://gre/modules/PlacesUtils.jsm");
 Cu.import("resource://gre/modules/BookmarkJSONUtils.jsm");
 Cu.import("resource://services-common/async.js");
 Cu.import("resource://gre/modules/Log.jsm");
 Cu.import("resource://services-sync/engines.js");
 Cu.import("resource://services-sync/engines/bookmarks.js");
 Cu.import("resource://services-sync/service.js");
 Cu.import("resource://services-sync/util.js");
 Cu.import("resource://testing-common/services/sync/utils.js");
 Cu.import("resource://gre/modules/Promise.jsm");
 Service.engineManager.register(BookmarksEngine);
 add_test(function bad_record_allIDs() {
   let server = new SyncServer();
   server.start();
   let syncTesting = new SyncTestingInfrastructure(server.server);
   _("Ensure that bad Places queries don't cause an error in getAllIDs.");
   let engine = new BookmarksEngine(Service);
   let store = engine._store;
   let badRecordID = PlacesUtils.bookmarks.insertBookmark(
       PlacesUtils.bookmarks.toolbarFolder,
       Utils.makeURI("place:folder=1138"),
       PlacesUtils.bookmarks.DEFAULT_INDEX,
       null);
   do_check_true(badRecordID > 0);
   _("Record is " + badRecordID);
   _("Type: " + PlacesUtils.bookmarks.getItemType(badRecordID));
   _("Fetching children.");
   store._getChildren("toolbar", {});
   _("Fetching all IDs.");
   let all = store.getAllIDs();
   _("All IDs: " + JSON.stringify(all));
   do_check_true("menu" in all);
   do_check_true("toolbar" in all);
   _("Clean up.");
   PlacesUtils.bookmarks.removeItem(badRecordID);
   server.stop(run_next_test);
 });
 add_test(function test_ID_caching() {
   let server = new SyncServer();
   server.start();
   let syncTesting = new SyncTestingInfrastructure(server.server);
   _("Ensure that Places IDs are not cached.");
   let engine = new BookmarksEngine(Service);
   let store = engine._store;
   _("All IDs: " + JSON.stringify(store.getAllIDs()));
   let mobileID = store.idForGUID("mobile");
   _("Change the GUID for that item, and drop the mobile anno.");
   store._setGUID(mobileID, "abcdefghijkl");
   PlacesUtils.annotations.removeItemAnnotation(mobileID, "mobile/bookmarksRoot");
   let err;
   let newMobileID;
   // With noCreate, we don't find an entry.
   try {
     newMobileID = store.idForGUID("mobile", true);
     _("New mobile ID: " + newMobileID);
   } catch (ex) {
     err = ex;
     _("Error: " + Utils.exceptionStr(err));
   }
   do_check_true(!err);
   // With !noCreate, lookup works, and it's different.
   newMobileID = store.idForGUID("mobile", false);
   _("New mobile ID: " + newMobileID);
   do_check_true(!!newMobileID);
   do_check_neq(newMobileID, mobileID);
   // And it's repeatable, even with creation enabled.
   do_check_eq(newMobileID, store.idForGUID("mobile", false));
   do_check_eq(store.GUIDForId(mobileID), "abcdefghijkl");
   server.stop(run_next_test);
 });
 function serverForFoo(engine) {
   return serverForUsers({"foo": "password"}, {
     meta: {global: {engines: {bookmarks: {version: engine.version,
                                           syncID: engine.syncID}}}},
     bookmarks: {}
   });
 }
 add_test(function test_processIncoming_error_orderChildren() {
   _("Ensure that _orderChildren() is called even when _processIncoming() throws an error.");
   let engine = new BookmarksEngine(Service);
   let store  = engine._store;
   let server = serverForFoo(engine);
   new SyncTestingInfrastructure(server.server);
   let collection = server.user("foo").collection("bookmarks");
   try {
     let folder1_id = PlacesUtils.bookmarks.createFolder(
       PlacesUtils.bookmarks.toolbarFolder, "Folder 1", 0);
     let folder1_guid = store.GUIDForId(folder1_id);
     let fxuri = Utils.makeURI("http://getfirefox.com/");
     let tburi = Utils.makeURI("http://getthunderbird.com/");
     let bmk1_id = PlacesUtils.bookmarks.insertBookmark(
       folder1_id, fxuri, PlacesUtils.bookmarks.DEFAULT_INDEX, "Get Firefox!");
     let bmk1_guid = store.GUIDForId(bmk1_id);
     let bmk2_id = PlacesUtils.bookmarks.insertBookmark(
       folder1_id, tburi, PlacesUtils.bookmarks.DEFAULT_INDEX, "Get Thunderbird!");
     let bmk2_guid = store.GUIDForId(bmk2_id);
     // Create a server record for folder1 where we flip the order of
     // the children.
     let folder1_payload = store.createRecord(folder1_guid).cleartext;
     folder1_payload.children.reverse();
     collection.insert(folder1_guid, encryptPayload(folder1_payload));
     // Create a bogus record that when synced down will provoke a
     // network error which in turn provokes an exception in _processIncoming.
     const BOGUS_GUID = "zzzzzzzzzzzz";
     let bogus_record = collection.insert(BOGUS_GUID, "I'm a bogus record!");
     bogus_record.get = function get() {
       throw "Sync this!";
     };
     // Make the 10 minutes old so it will only be synced in the toFetch phase.
     bogus_record.modified = Date.now() / 1000 - 60 * 10;
     engine.lastSync = Date.now() / 1000 - 60;
     engine.toFetch = [BOGUS_GUID];
     let error;
     try {
       engine.sync();
     } catch(ex) {
       error = ex;
     }
     do_check_true(!!error);
     // Verify that the bookmark order has been applied.
     let new_children = store.createRecord(folder1_guid).children;
     do_check_eq(new_children.length, 2);
     do_check_eq(new_children[0], folder1_payload.children[0]);
     do_check_eq(new_children[1], folder1_payload.children[1]);
     do_check_eq(PlacesUtils.bookmarks.getItemIndex(bmk1_id), 1);
     do_check_eq(PlacesUtils.bookmarks.getItemIndex(bmk2_id), 0);
   } finally {
     store.wipe();
     Svc.Prefs.resetBranch("");
     Service.recordManager.clearCache();
     server.stop(run_next_test);
   }
 });
 add_task(function test_restorePromptsReupload() {
   _("Ensure that restoring from a backup will reupload all records.");
   let engine = new BookmarksEngine(Service);
   let store  = engine._store;
   let server = serverForFoo(engine);
   new SyncTestingInfrastructure(server.server);
   let collection = server.user("foo").collection("bookmarks");
   Svc.Obs.notify("weave:engine:start-tracking");   // We skip usual startup...
   try {
     let folder1_id = PlacesUtils.bookmarks.createFolder(
       PlacesUtils.bookmarks.toolbarFolder, "Folder 1", 0);
     let folder1_guid = store.GUIDForId(folder1_id);
     _("Folder 1: " + folder1_id + ", " + folder1_guid);
     let fxuri = Utils.makeURI("http://getfirefox.com/");
     let tburi = Utils.makeURI("http://getthunderbird.com/");
     _("Create a single record.");
     let bmk1_id = PlacesUtils.bookmarks.insertBookmark(
       folder1_id, fxuri, PlacesUtils.bookmarks.DEFAULT_INDEX, "Get Firefox!");
     let bmk1_guid = store.GUIDForId(bmk1_id);
     _("Get Firefox!: " + bmk1_id + ", " + bmk1_guid);
     let dirSvc = Cc["@mozilla.org/file/directory_service;1"]
       .getService(Ci.nsIProperties);
     let backupFile = dirSvc.get("TmpD", Ci.nsILocalFile);
     _("Make a backup.");
     backupFile.append("t_b_e_" + Date.now() + ".json");
     _("Backing up to file " + backupFile.path);
     backupFile.create(Ci.nsILocalFile.NORMAL_FILE_TYPE, 0600);
     yield BookmarkJSONUtils.exportToFile(backupFile);
     _("Create a different record and sync.");
     let bmk2_id = PlacesUtils.bookmarks.insertBookmark(
       folder1_id, tburi, PlacesUtils.bookmarks.DEFAULT_INDEX, "Get Thunderbird!");
     let bmk2_guid = store.GUIDForId(bmk2_id);
     _("Get Thunderbird!: " + bmk2_id + ", " + bmk2_guid);
     PlacesUtils.bookmarks.removeItem(bmk1_id);
     let error;
     try {
       engine.sync();
     } catch(ex) {
       error = ex;
       _("Got error: " + Utils.exceptionStr(ex));
     }
     do_check_true(!error);
     _("Verify that there's only one bookmark on the server, and it's Thunderbird.");
     // Of course, there's also the Bookmarks Toolbar and Bookmarks Menu...
     let wbos = collection.keys(function (id) {
       return ["menu", "toolbar", "mobile", folder1_guid].indexOf(id) == -1;
     });
     do_check_eq(wbos.length, 1);
     do_check_eq(wbos[0], bmk2_guid);
     _("Now restore from a backup.");
     yield BookmarkJSONUtils.importFromFile(backupFile, true);
     _("Ensure we have the bookmarks we expect locally.");
     let guids = store.getAllIDs();
     _("GUIDs: " + JSON.stringify(guids));
     let found = false;
     let count = 0;
     let newFX;
     for (let guid in guids) {
       count++;
       let id = store.idForGUID(guid, true);
       // Only one bookmark, so _all_ should be Firefox!
       if (PlacesUtils.bookmarks.getItemType(id) == PlacesUtils.bookmarks.TYPE_BOOKMARK) {
         let uri = PlacesUtils.bookmarks.getBookmarkURI(id);
         _("Found URI " + uri.spec + " for GUID " + guid);
         do_check_eq(uri.spec, fxuri.spec);
         newFX = guid;   // Save the new GUID after restore.
         found = true;   // Only runs if the above check passes.
       }
     }
     _("We found it: " + found);
     do_check_true(found);
     _("Have the correct number of IDs locally, too.");
     do_check_eq(count, ["menu", "toolbar", folder1_id, bmk1_id].length);
     _("Sync again. This'll wipe bookmarks from the server.");
     try {
       engine.sync();
     } catch(ex) {
       error = ex;
       _("Got error: " + Utils.exceptionStr(ex));
     }
     do_check_true(!error);
     _("Verify that there's only one bookmark on the server, and it's Firefox.");
     // Of course, there's also the Bookmarks Toolbar and Bookmarks Menu...
     let payloads     = server.user("foo").collection("bookmarks").payloads();
     let bookmarkWBOs = payloads.filter(function (wbo) {
                          return wbo.type == "bookmark";
                        });
     let folderWBOs   = payloads.filter(function (wbo) {
                          return ((wbo.type == "folder") &&
                                  (wbo.id   != "menu") &&
                                  (wbo.id   != "toolbar"));
                        });
     do_check_eq(bookmarkWBOs.length, 1);
     do_check_eq(bookmarkWBOs[0].id, newFX);
     do_check_eq(bookmarkWBOs[0].bmkUri, fxuri.spec);
     do_check_eq(bookmarkWBOs[0].title, "Get Firefox!");
     _("Our old friend Folder 1 is still in play.");
     do_check_eq(folderWBOs.length, 1);
     do_check_eq(folderWBOs[0].title, "Folder 1");
   } finally {
     store.wipe();
     Svc.Prefs.resetBranch("");
     Service.recordManager.clearCache();
     let deferred = Promise.defer();
     server.stop(deferred.resolve);
     yield deferred.promise;
   }
 });
 function FakeRecord(constructor, r) {
   constructor.call(this, "bookmarks", r.id);
   for (let x in r) {
     this[x] = r[x];
   }
 }
 // Bug 632287.
 add_test(function test_mismatched_types() {
   _("Ensure that handling a record that changes type causes deletion " +
     "then re-adding.");
   let oldRecord = {
     "id": "l1nZZXfB8nC7",
     "type":"folder",
     "parentName":"Bookmarks Toolbar",
     "title":"Innerst i Sneglehode",
     "description":null,
     "parentid": "toolbar"
   };
   let newRecord = {
     "id": "l1nZZXfB8nC7",
     "type":"livemark",
     "siteUri":"http://sneglehode.wordpress.com/",
     "feedUri":"http://sneglehode.wordpress.com/feed/",
     "parentName":"Bookmarks Toolbar",
     "title":"Innerst i Sneglehode",
     "description":null,
     "children":
       ["HCRq40Rnxhrd", "YeyWCV1RVsYw", "GCceVZMhvMbP", "sYi2hevdArlF",
        "vjbZlPlSyGY8", "UtjUhVyrpeG6", "rVq8WMG2wfZI", "Lx0tcy43ZKhZ",
        "oT74WwV8_j4P", "IztsItWVSo3-"],
     "parentid": "toolbar"
   };
   let engine = new BookmarksEngine(Service);
   let store  = engine._store;
   let server = serverForFoo(engine);
   new SyncTestingInfrastructure(server.server);
   _("GUID: " + store.GUIDForId(6, true));
   try {
     let bms = PlacesUtils.bookmarks;
     let oldR = new FakeRecord(BookmarkFolder, oldRecord);
     let newR = new FakeRecord(Livemark, newRecord);
     oldR._parent = PlacesUtils.bookmarks.toolbarFolder;
     newR._parent = PlacesUtils.bookmarks.toolbarFolder;
     store.applyIncoming(oldR);
     _("Applied old. It's a folder.");
     let oldID = store.idForGUID(oldR.id);
     _("Old ID: " + oldID);
     do_check_eq(bms.getItemType(oldID), bms.TYPE_FOLDER);
     do_check_false(PlacesUtils.annotations
                               .itemHasAnnotation(oldID, PlacesUtils.LMANNO_FEEDURI));
     store.applyIncoming(newR);
     let newID = store.idForGUID(newR.id);
     _("New ID: " + newID);
     _("Applied new. It's a livemark.");
     do_check_eq(bms.getItemType(newID), bms.TYPE_FOLDER);
     do_check_true(PlacesUtils.annotations
                              .itemHasAnnotation(newID, PlacesUtils.LMANNO_FEEDURI));
   } finally {
     store.wipe();
     Svc.Prefs.resetBranch("");
     Service.recordManager.clearCache();
     server.stop(run_next_test);
   }
 });
 add_test(function test_bookmark_guidMap_fail() {
   _("Ensure that failures building the GUID map cause early death.");
   let engine = new BookmarksEngine(Service);
   let store = engine._store;
   let store  = engine._store;
   let server = serverForFoo(engine);
   let coll   = server.user("foo").collection("bookmarks");
   new SyncTestingInfrastructure(server.server);
   // Add one item to the server.
   let itemID = PlacesUtils.bookmarks.createFolder(
     PlacesUtils.bookmarks.toolbarFolder, "Folder 1", 0);
   let itemGUID    = store.GUIDForId(itemID);
   let itemPayload = store.createRecord(itemGUID).cleartext;
   coll.insert(itemGUID, encryptPayload(itemPayload));
   engine.lastSync = 1;   // So we don't back up.
   // Make building the GUID map fail.
   store.getAllIDs = function () { throw "Nooo"; };
   // Ensure that we throw when accessing _guidMap.
   engine._syncStartup();
   _("No error.");
   do_check_false(engine._guidMapFailed);
   _("We get an error if building _guidMap fails in use.");
   let err;
   try {
     _(engine._guidMap);
   } catch (ex) {
     err = ex;
   }
   do_check_eq(err.code, Engine.prototype.eEngineAbortApplyIncoming);
   do_check_eq(err.cause, "Nooo");
   _("We get an error and abort during processIncoming.");
   err = undefined;
   try {
     engine._processIncoming();
   } catch (ex) {
     err = ex;
   }
   do_check_eq(err, "Nooo");
   server.stop(run_next_test);
 });
 add_test(function test_bookmark_is_taggable() {
   let engine = new BookmarksEngine(Service);
   let store = engine._store;
   do_check_true(store.isTaggable("bookmark"));
   do_check_true(store.isTaggable("microsummary"));
   do_check_true(store.isTaggable("query"));
   do_check_false(store.isTaggable("folder"));
   do_check_false(store.isTaggable("livemark"));
   do_check_false(store.isTaggable(null));
   do_check_false(store.isTaggable(undefined));
   do_check_false(store.isTaggable(""));
   run_next_test();
 });
 add_test(function test_bookmark_tag_but_no_uri() {
   _("Ensure that a bookmark record with tags, but no URI, doesn't throw an exception.");
   let engine = new BookmarksEngine(Service);
   let store = engine._store;
   // We're simply checking that no exception is thrown, so
   // no actual checks in this test.
   store._tagURI(null, ["foo"]);
   store._tagURI(null, null);
   store._tagURI(Utils.makeURI("about:fake"), null);
   let record = {
     _parent:     PlacesUtils.bookmarks.toolbarFolder,
     id:          Utils.makeGUID(),
     description: "",
     tags:        ["foo"],
     title:       "Taggy tag",
     type:        "folder"
   };
   // Because update() walks the cleartext.
   record.cleartext = record;
   store.create(record);
   record.tags = ["bar"];
   store.update(record);
   run_next_test();
 });
 add_test(function test_misreconciled_root() {
   _("Ensure that we don't reconcile an arbitrary record with a root.");
   let engine = new BookmarksEngine(Service);
   let store = engine._store;
   let server = serverForFoo(engine);
   // Log real hard for this test.
   store._log.trace = store._log.debug;
   engine._log.trace = engine._log.debug;
   engine._syncStartup();
   // Let's find out where the toolbar is right now.
   let toolbarBefore = store.createRecord("toolbar", "bookmarks");
   let toolbarIDBefore = store.idForGUID("toolbar");
   do_check_neq(-1, toolbarIDBefore);
   let parentGUIDBefore = toolbarBefore.parentid;
   let parentIDBefore = store.idForGUID(parentGUIDBefore);
   do_check_neq(-1, parentIDBefore);
   do_check_eq("string", typeof(parentGUIDBefore));
   _("Current parent: " + parentGUIDBefore + " (" + parentIDBefore + ").");
   let to_apply = {
     id: "zzzzzzzzzzzz",
     type: "folder",
     title: "Bookmarks Toolbar",
     description: "Now you're for it.",
     parentName: "",
     parentid: "mobile",   // Why not?
     children: [],
   };
   let rec = new FakeRecord(BookmarkFolder, to_apply);
   let encrypted = encryptPayload(rec.cleartext);
   encrypted.decrypt = function () {
     for (let x in rec) {
       encrypted[x] = rec[x];
     }
   };
   _("Applying record.");
   engine._processIncoming({
     get: function () {
       this.recordHandler(encrypted);
       return {success: true}
     },
   });
   // Ensure that afterwards, toolbar is still there.
   // As of 2012-12-05, this only passes because Places doesn't use "toolbar" as
   // the real GUID, instead using a generated one. Sync does the translation.
   let toolbarAfter = store.createRecord("toolbar", "bookmarks");
   let parentGUIDAfter = toolbarAfter.parentid;
   let parentIDAfter = store.idForGUID(parentGUIDAfter);
   do_check_eq(store.GUIDForId(toolbarIDBefore), "toolbar");
   do_check_eq(parentGUIDBefore, parentGUIDAfter);
   do_check_eq(parentIDBefore, parentIDAfter);
   server.stop(run_next_test);
 });
 function run_test() {
   initTestLogging("Trace");
   generateNewKeys(Service.collectionKeys);
   run_next_test();
 }