Adds caching to interesting/search api calls

app/subapps/browser/browser.js

 /*
 This file is part of the Juju GUI, which lets users view and manage Juju
 environments within a graphical interface (https://launchpad.net/juju-gui).
 Copyright (C) 2012-2013 Canonical Ltd.
 
 This program is free software: you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License version 3, as published by
 the Free Software Foundation.
 
 This program is distributed in the hope that it will be useful, but WITHOUT
@@ skipping 172 matching lines @@
            (this._hasStateChanged('charmID') && !this._viewState.charmID)
           )
       ) {
         return true;
       } else {
         return false;
       }
     },
 
     /**
-     * Strip the viewmode from the charmid when processing to check for proper
-     * routing.
-     *
-     * @method _stripViewMode
-     * @param {String} id the req.param.id found.
-     *
+       Determine if search changed, so we know how to handle the cache.
+
+       @method _searchChanged
+       @return {Boolean} true If search changed.
+     */
+    _searchChanged: function() {
+      if (this._viewState.search && (
+          this._hasStateChanged('search') ||
+          this._hasStateChanged('querystring'))) {
+        return true;
+      } else {
+        return false;
+      }
+    },
+
+    /**
+       Strip the viewmode from the charmid when processing to check for proper
+       routing.
+
+       @method _stripViewMode
+       @param {String} id the req.param.id found.
      */
     _stripViewMode: function(id) {
       // Clear out any parts of /sidebar/search, /sidebar, or /search from the
       // id. See if we still really have an id.
       var match =
           /^(sidebar|fullscreen|minimized|search|test\/index\.html)\/?(search)?/;
 
       if (id && id.match(match)) {
         // Strip it out.
         id = id.replace(match, '');
 
         // if the id is now empty, set it to null.
         if (id === '') {
           id = null;
         }
       }
-
       return id;
     },
 
     /**
        Verify that a particular part of the state has changed.
 
        @method _hasStateChanged
        @param {String} field the part of the state to check.
      */
     _hasStateChanged: function(field) {
@@ skipping 70 matching lines @@
         preserve: false
       }
     },
 
     /**
        Cleanup after ourselves on destroy.
 
        @method destructor
      */
     destructor: function() {
-      this._cacheCharms.destroy();
+      this._cache.charms.destroy();

[rharding, 2013/05/29 14:29:36]

should this check for interesting/search to either set to undefined, or unset as
well?

[j.c.sackett, 2013/05/29 15:04:01]

Yup, done.

       delete this._viewState;
     },
 
     /**
        General app initializer
 
        @method initializer
        @param {Object} cfg general init config object.
      */
     initializer: function(cfg) {
       // Hold onto charm data so we can pass model instances to other views when
       // charms are selected.
-      this._cacheCharms = new models.BrowserCharmList();
+      this._cache = {
+        charms: new models.BrowserCharmList(),
+        interesting: null,
+        search: null
+      };
       this._initState();
       this._filter = new models.browser.Filter();
 
       // Listen for navigate events from any views we're rendering.
       this.on('*:viewNavigate', function(ev) {
         var url;
         if (ev.url) {
           url = ev.url;
         } else if (ev.change) {
           url = this._getStateUrl(ev.change);
         }
         this.navigate(url);
       });
+
     },
 
     /**
        Render the charm details view
 
        @method renderCharmDetails
        @param {Request} req current request object.
        @param {Response} res current response object.
        @param {function} next callable for the next route in the chain.
      */
     renderCharmDetails: function(req, res, next) {
       var charmID = this._viewState.charmID;
       var extraCfg = {
         charmID: charmID,
         container: Y.Node.create('<div class="charmview"/>'),
         deploy: this.get('deploy')
       };
 
       // The details view needs to know if we're using a fullscreen template
       // or the sidebar version.
       if (this._viewState.viewmode === 'fullscreen') {
         extraCfg.isFullscreen = true;
       }
 
       // Gotten from the sidebar creating the cache.
-      var model = this._cacheCharms.getById(charmID);
+      var model = this._cache.charms.getById(charmID);
 
       if (model) {
         extraCfg.charm = model;
       }
 
       this._details = new Y.juju.browser.views.BrowserCharmView(
           this._getViewCfg(extraCfg));
       this._details.render();
       this._details.addTarget(this);
     },
@@ skipping 28 matching lines @@
         // view-data (such as a charm details) side by side.
         extraCfg.renderTo = container.one('.bws-content');
       }
 
       // If there's a selected charm we need to pass that info onto the View
       // to render it selected.
       if (this._viewState.charmID) {
         extraCfg.activeID = this._viewState.charmID;
       }
 
+
       this._editorial = new Y.juju.browser.views.EditorialView(
           this._getViewCfg(extraCfg));
 
-      this._editorial.render();
+      this._editorial.on(this._editorial.EV_CACHE_UPDATED, function(ev) {
+        // Add any sidebar charms to the running cache.
+        this._cache = Y.merge(this._cache, ev.cache);
+      }, this);
+
+      if (this._cache.interesting) {

[rharding, 2013/05/29 14:29:36]

You've init'd _cache.interesting to null. can you just pass it in and it'll fail
any check for if(cache) later on. Then this if can go away and just call
.render(this._cache.interesting)

[j.c.sackett, 2013/05/29 15:04:01]

Good call. Done.

+        this._editorial.render(this._cache.interesting);
+      } else {
+        this._editorial.render();
+      }
       this._editorial.addTarget(this);
-
-      // Add any sidebar charms to the running cache.
-      this._cacheCharms.add(this._editorial._cacheCharms);
     },
 
     /**
        Render search results
 
        @method renderSearchResults
        @param {Request} req current request object.
        @param {Response} res current response object.
        @param {function} next callable for the next route in the chain.
      */
@@ skipping 10 matching lines @@
 
       // If there's a selected charm we need to pass that info onto the View
       // to render it selected.
       if (this._viewState.charmID) {
         extraCfg.activeID = this._viewState.charmID;
       }
 
       this._search = new Y.juju.browser.views.BrowserSearchView(
           this._getViewCfg(extraCfg));
 
-      this._search.render();
+      // Prepare to handle cache
+      this._search.on(this._search.EV_CACHE_UPDATED, function(ev) {
+        this._cache = Y.merge(this._cache, ev.cache);
+      }, this);
+
+      if (this._cache.search && !this._searchChanged()) {

[rharding, 2013/05/29 14:29:36]

same if condition can go away here .

[j.c.sackett, 2013/05/29 15:04:01]

Yes, though the !this._searchChanged must remain so we don't pass in a non-null,
but stale cache.

+        this._search.render(this._cache.search);
+      } else {
+        this._search.render();
+      }
       this._search.addTarget(this);
     },
 
     /**
        Render the fullscreen view to the client.
 
        @method fullscreen
        @param {Request} req current request object.
        @param {Response} res current response object.
        @param {function} next callable for the next route in the chain.
@@ skipping 302 matching lines @@
     'querystring',
     'sub-app',
     'subapp-browser-charmview',
     'subapp-browser-editorial',
     'subapp-browser-fullscreen',
     'subapp-browser-minimized',
     'subapp-browser-searchview',
     'subapp-browser-sidebar'
   ]
 });