Settings Router Refactor: Support dynamic parameters

chrome/browser/resources/settings/route.js

 // Copyright 2016 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.
 
 cr.define('settings', function() {
   /**
    * Class for navigable routes. May only be instantiated within this file.
    * @constructor
    * @param {string} path
    * @private
@@ skipping 274 matching lines @@
   var getRouteForPath = function(path) {
     // TODO(tommycli): Use Object.values once Closure compilation supports it.
     var matchingKey = Object.keys(Route).find(function(key) {
       return Route[key].path == path;
     });
 
     return Route[matchingKey] || null;
   };
 
   /**
-   * The current active route. This may only be updated via the global
-   * function settings.navigateTo.
+   * The current active route. This updated only by settings.navigateTo.
    * @private {!settings.Route}
    */
-  var currentRoute_ = (function() {
+  var currentRoute_ = Route.BASIC;
+
+  /**
+   * The current query parameters. This updated only by settings.navigateTo.
+   * @private {!URLSearchParams}
+   */
+  var currentQueryParameters_ = new URLSearchParams();
+
+  // Initialize the route and query params from the URL.
+  (function() {
     var route = getRouteForPath(window.location.pathname);
-    if (route)
-      return route;
-
-    // Reset the URL path to '/' if the user navigates to a nonexistent URL.
-    window.history.replaceState(undefined, '', Route.BASIC.path);
-    return Route.BASIC;
+    if (route) {
+      currentRoute_ = route;
+      currentQueryParameters_ = new URLSearchParams(window.location.search);
+    } else {
+      window.history.pushState(undefined, '', Route.BASIC.path);
+    }
   })();
 
   /**
    * Helper function to set the current route and notify all observers.
    * @param {!settings.Route} route
+   * @param {!URLSearchParams} queryParameters
    */
-  var setCurrentRoute = function(route) {
+  var setCurrentRoute = function(route, queryParameters) {
     currentRoute_ = route;
+    currentQueryParameters_ = queryParameters;
     for (var observer of routeObservers_)
       observer.currentRouteChanged();
   };
 
   /** @return {!settings.Route} */
   var getCurrentRoute = function() { return currentRoute_; };
 
+  /** @return {!URLSearchParams} */
+  var getQueryParameters = function() { return currentQueryParameters_; };

[Dan Beam, 2016/08/03 17:18:00]

can we return a copy?

[tommycli, 2016/08/03 17:24:39]

Done.

+
   /**
    * Navigates to a canonical route and pushes a new history entry.
    * @param {!settings.Route} route
+   * @param {URLSearchParams=} opt_dynamicParameters
    * @private
    */
-  var navigateTo = function(route) {
-    if (assert(route) == currentRoute_)
+  var navigateTo = function(route, opt_dynamicParameters) {
+    var params = opt_dynamicParameters || new URLSearchParams();
+    if (assert(route) == currentRoute_ &&
+        params.toString() == currentQueryParameters_.toString()) {

[Dan Beam, 2016/08/03 17:04:28]

this breaks when append() is used in a different order

[Dan Beam, 2016/08/03 17:18:00]

eh, it's fine

[tommycli, 2016/08/03 17:24:39]

Acknowledged.

       return;
+    }
 
-    window.history.pushState(undefined, '', route.path);
-    setCurrentRoute(route);
+    var url = route.path;
+    if (opt_dynamicParameters) {
+      var queryString = opt_dynamicParameters.toString();
+      if (queryString)
+        url += '?' + queryString;
+    }
+
+    setCurrentRoute(route, params);
+    window.history.pushState(undefined, '', url);
   };
 
   window.addEventListener('popstate', function(event) {
     // On pop state, do not push the state onto the window.history again.
-    setCurrentRoute(getRouteForPath(window.location.pathname) || Route.BASIC);
+    setCurrentRoute(getRouteForPath(window.location.pathname) || Route.BASIC,
+                    new URLSearchParams(window.location.search));
   });
 
   return {
     Route: Route,
     RouteObserverBehavior: RouteObserverBehavior,
     getRouteForPath: getRouteForPath,
     getCurrentRoute: getCurrentRoute,
+    getQueryParameters: getQueryParameters,
     navigateTo: navigateTo,
   };
 });