Bug 1039311 - [Collection] HomeIcons Singleton (refactor)

apps/collection/add_to_collection.html

@@ -10,6 +10,7 @@
     <script defer src="shared/js/everythingme/device.js"></script>
     <script defer src="shared/js/everythingme/api.js"></script>
 
+    <script defer src="shared/js/async_storage.js"></script>
     <script defer src="shared/js/bookmarks_database.js"></script>
     <script defer src="shared/js/collections_database.js"></script>
     <script defer src="shared/js/l10n.js"></script>

apps/collection/js/add_to_collection.js

@@ -5,6 +5,7 @@
 /* global CollectionsDatabase */
 /* global Common */
 /* global eme */
+/* global HomeIcons */
 /* global PinnedHomeIcon */
 
 (function(exports) {
@@ -33,7 +34,7 @@
         var collection = BaseCollection.create(fresh);
         var newPinned = new PinnedHomeIcon(event.data.identifier);
 
-        collection.homeIcons.init().then(() => {
+        HomeIcons.init().then(() => {
 
           // If a record is already pinned, delete it so it appears first.
           for (var i = 0, iLen = collection.pinned.length; i < iLen; i++) {

apps/collection/js/home_icons.js

@@ -15,15 +15,17 @@
   var initPromise;
 
   function HomeIcons() {
+    this.ready = false;
     this.gridItemsByIdentifier = {};
     this.recordsByManifestUrl = {};
     this.recordsByBookmarkUrl = {};
   }
 
   HomeIcons.prototype = {
     init: function init() {
-      initPromise = Promise.all([this.collectBookmarkURLs(),
-                                 this.collectManifestURLs()]);
+      initPromise =
+        Promise.all([this.collectBookmarkURLs(), this.collectManifestURLs()])
+               .then(() => this.ready = true);
 
       this.init = function noop() {
         return initPromise;
@@ -116,6 +118,6 @@
 
   };
 
-  exports.HomeIcons = HomeIcons;
+  exports.HomeIcons = new HomeIcons();
 
 }(window));

apps/collection/js/native_info.js

@@ -9,8 +9,6 @@
 
   const SETUP_KEY = 'NativeInfo-setup';
 
-  var homeIcons;
-
   function onerror(e) {
     eme.error('NativeInfo error', e.name || e.message || e);
   }
@@ -74,16 +72,13 @@
         // we are going to traverse all the collections on device
         for (var id in collections) {
           var collection = collections[id];
-          collection.homeIcons = homeIcons;
           collection = BaseCollection.create(collection);
 
           if (collection.cName) {
             var guids = guidsByCname[collection.cName] || [];
 
             if (guids.length) {
-              // identifiers is directly guids when we process an app
-              var identifiers = !homeIcons ? guids :
-               guids.map(homeIcons.getIdentifier.bind(homeIcons));
+              var identifiers = guids;
 
               eme.log('NativeInfo', identifiers.length, 'matches for',
                collection.cName, JSON.stringify(identifiers));
@@ -100,56 +95,53 @@
         return Promise.reject();
       }
 
-      function unpinFromCollection(collection) {
-        collection.homeIcons.init().then(function() {
-          collection.unpin(identifier);
-        });
-      }
-
       return CollectionsDatabase.getAll().then(function(collections) {
         // we are going to traverse all the collections on device
         for (var id in collections) {
-          unpinFromCollection(BaseCollection.create(collections[id]));
+          var collection = BaseCollection.create(collections[id]);
+          collection.unpin(identifier);
         }
       });
     },
 
     // on app install/uninstall
+    // id should be a guid (manifest or bookmark URL)
     processApp: function processApp(action, id) {
       if (action === 'install') {
-        // id should be a guid (manifest or bookmark URL)
-        homeIcons = new HomeIcons();
-        return homeIcons.init().then(this.getInfo.bind(this, [id]))
-               .then(this.addToCollections).catch(onerror);
+        return HomeIcons.init()
+               .then(() => this.getInfo([id]))
+               .then(this.addToCollections)
+               .catch(onerror);
+
       } else if (action === 'uninstall') {
-        return this.removeFromCollections(id).catch(onerror);
+        return HomeIcons.init()
+               .then(() => this.removeFromCollections(id))
+               .catch(onerror);
       }
     },
 
     // on collection install
     processCollection: function processCollection(collection) {
       return this.collectGuids()
-      .then(this.getInfo)
-      .then(function addToCollection(guidsByCname) {
-        // cName for suggested collections or query for custom collections
-        var key = collection.cName || collection.query;
-        var guids = guidsByCname[key] || [];
-
-        if (guids.length) {
-          var identifiers =
-            guids.map(homeIcons.getIdentifier.bind(homeIcons));
-          eme.log('NativeInfo', identifiers);
-          collection.pinHomeIcons(identifiers);
-        }
-      });
+        .then(this.getInfo)
+        .then(function addToCollection(guidsByCname) {
+          // cName for suggested collections or query for custom collections
+          var key = collection.cName || collection.query;
+          var guids = guidsByCname[key] || [];
+
+          if (guids.length) {
+            var identifiers = guids;
+            eme.log('NativeInfo', identifiers);
+            collection.pinHomeIcons(identifiers);
+          }
+        });
     },
 
     // returns a promise resolved with all guids for all apps and bookmarks
     collectGuids: function collectGuids() {
-      homeIcons = new HomeIcons();
-      return homeIcons.init().then(function success() {
-        var manifestURLs = homeIcons.manifestURLs;
-        var bookmarkURLs = homeIcons.bookmarkURLs;
+      return HomeIcons.init().then(function success() {
+        var manifestURLs = HomeIcons.manifestURLs;
+        var bookmarkURLs = HomeIcons.bookmarkURLs;
         eme.log('NativeInfo found', manifestURLs.length, 'apps');
         eme.log('NativeInfo found', bookmarkURLs.length, 'bookmarks');
 

apps/collection/js/objects.js

@@ -58,12 +58,6 @@
     if (window.SearchDedupe) {
       this.dedupe = new SearchDedupe();
     }
-
-    // for rendering pinned homescreen apps/bookmarks
-    if (window.HomeIcons) {
-      this.homeIcons = props.homeIcons || new HomeIcons();
-      this.homeIcons.init();
-    }
   }
 
   BaseCollection.create = function create(data) {
@@ -200,8 +194,8 @@
       var idx = this.pinnedIdentifiers.indexOf(identifier);
       if (idx !== -1) {
         this.pinned.splice(idx, 1);
-        eme.log('removed pinned item', identifier);
-        return this.save();
+        return this.save()
+               .then(() => eme.log('removed pinned item', identifier));
       }
     },
 
@@ -262,7 +256,11 @@
     toGridObject: function(item) {
       var icon;
       if (item.type === 'homeIcon') {
-        icon = this.homeIcons.get(item.identifier);
+        if (!HomeIcons.ready) {
+          eme.warn('HomeIcons not ready, pinned apps may not render properly');
+        }
+
+        icon = HomeIcons.get(item.identifier);
       } else if (item.type === 'webResult') {
         item.features = item.features || {};
         item.features.isEditable = false;

apps/collection/js/view_apps.js

@@ -1,8 +1,9 @@
 'use strict';
 /* global CollectionIcon */
+/* global CollectionsDatabase */
 /* global eme */
+/* global HomeIcons */
 /* global NativeInfo */
-/* global CollectionsDatabase */
 
 (function(exports) {
 
@@ -61,9 +62,8 @@
     // Update Collection from db
     // Render grid for the first time
     // Go get web results
-    NativeInfo.setup()
-    // Ensure homeIcons are initialized
-    .then(() => collection.homeIcons.init())
+    HomeIcons.init()
+    .then(() => NativeInfo.setup())
     .then(() => collection.refresh())
     .then(() => collection.render(grid))
     .then(() => {

apps/collection/synchronize.html

@@ -7,6 +7,7 @@
 
     <script defer src="shared/js/bookmarks_database.js"></script>
     <script defer src="shared/js/collections_database.js"></script>
+    <script defer src="shared/js/async_storage.js"></script>
 
     <script defer src="shared/js/l10n.js"></script>
     <script defer src="shared/js/url_helper.js"></script>
@@ -26,7 +27,7 @@
     <script defer src="js/objects.js"></script>
     <script defer src="js/home_icons.js"></script>
     <script defer src="js/native_info.js"></script>
-    
+
     <script defer src="js/synchronize.js"></script>
   </head>
   <body>

build/test/integration/distribution.test.js

@@ -262,7 +262,10 @@ suite('Distribution mechanism', function() {
     assert.equal(config.grid[0][1].entry_point, 'dialer');
     assert.equal(config.grid[0][2].name, 'Messages');
     assert.equal(config.grid[0][3].name, 'Marketplace');
-    assert.equal(config.grid[1][0].name, 'Gallery');
+    assert.equal(config.grid[1][0].name, 'Social');
+    assert.equal(config.grid[1][1].name, 'Games');
+    assert.equal(config.grid[1][2].name, 'Music');
+    assert.equal(config.grid[2][0].name, 'Gallery');
 
     assert.isTrue(fs.existsSync(path.join(process.cwd(), 'profile',
       'svoperapps', 'Twitter')),

customization/homescreens.json

@@ -5,6 +5,10 @@
       ["apps", "communications", "dialer"],
       ["apps", "sms"],
       ["external-apps", "marketplace.firefox.com"]
+    ], [
+      ["apps/collection/collections", "social"],
+      ["apps/collection/collections", "games"],
+      ["apps/collection/collections", "music"]
     ], [
       ["apps", "gallery"],
       ["apps", "fm"],