fixup! feat($route): add support for the reloadOnUrl configuration option

Author: gkalpak

src/ngRoute/route.js

@@ -196,7 +196,9 @@ function $RouteProvider() {
    *      If the option is set to `false` and the URL in the browser changes, then a `$routeUpdate`
    *      event is broadcasted on the root scope (without reloading the route).
    *
-   *      **Note:** This option has no effect if `reloadOnUrl` is set to false.
+   *      <div class="alert alert-warning">
+   *        **Note:** This option has no effect if `reloadOnUrl` is set to `false`.
+   *      </div>
    *
    *    - `[caseInsensitiveMatch=false]` - `{boolean=}` - match routes without being case sensitive
    *
@@ -556,9 +558,9 @@ function $RouteProvider() {
      * @name $route#$routeUpdate
      * @eventType broadcast on root scope
      * @description
-     * Any of the `reloadOnSearch` and `reloadOnUrl` properties has been set to false and we are
-     * reusing the same instance of the route (including template, controller instance, resolved
-     * dependencies etc).
+     * Broadcasted if the same instance of a route (including template, controller instance,
+     * resolved dependencies, etc.) is being reused. This can happen if either `reloadOnSearch` or
+     * `reloadOnUrl` has been set to `false`.
      *
      * @param {Object} angularEvent Synthetic event object
      * @param {Route} current Current/previous route information.
@@ -666,21 +668,7 @@ function $RouteProvider() {
       var lastRoute = $route.current;
 
       preparedRoute = parseRoute();
-      preparedRouteIsUpdateOnly =
-          // IF this is not a forced reload
-          !forceReload
-          // AND both `lastRoute`/`preparedRoute` are defined
-          && preparedRoute && lastRoute
-          // AND they map to the same Route Definition Object
-          && (preparedRoute.$$route === lastRoute.$$route)
-          // AND `reloadOnUrl` is disabled
-          && (!preparedRoute.reloadOnUrl
-              // OR `reloadOnSearch` is disabled
-              || (!preparedRoute.reloadOnSearch
-                  // AND both routes have the same path params
-                  && angular.equals(preparedRoute.pathParams, lastRoute.pathParams)
-              )
-          );
+      preparedRouteIsUpdateOnly = isNavigationUpdateOnly(preparedRoute, lastRoute);
 
       if (!preparedRouteIsUpdateOnly && (lastRoute || preparedRoute)) {
         if ($rootScope.$broadcast('$routeChangeStart', preparedRoute, lastRoute).defaultPrevented) {
@@ -860,6 +848,29 @@ function $RouteProvider() {
       return match || routes[null] && inherit(routes[null], {params: {}, pathParams:{}});
     }
 
+    /**
+     * @param {Object} newRoute - The new route configuration (as returned by `parseRoute()`).
+     * @param {Object} oldRoute - The previous route configuration (as returned by `parseRoute()`).
+     * @returns {boolean} Whether this is an "update-only" navigation, i.e. the URL maps to the same
+     *                    route and it can be reused (based on the config and the type of change).
+     */
+    function isNavigationUpdateOnly(newRoute, oldRoute) {
+      // IF this is not a forced reload
+      return !forceReload
+          // AND both `newRoute`/`oldRoute` are defined
+          && newRoute && oldRoute
+          // AND they map to the same Route Definition Object
+          && (newRoute.$$route === oldRoute.$$route)
+          // AND `reloadOnUrl` is disabled
+          && (!newRoute.reloadOnUrl
+              // OR `reloadOnSearch` is disabled
+              || (!newRoute.reloadOnSearch
+                  // AND both routes have the same path params
+                  && angular.equals(newRoute.pathParams, oldRoute.pathParams)
+              )
+          );
+    }
+
     /**
      * @returns {string} interpolation of the redirect path with the parameters
      */

test/ngRoute/routeSpec.js

@@ -1679,7 +1679,7 @@ describe('$route', function() {
 
 
   describe('reloadOnUrl', function() {
-    it('should reload a route when `reloadOnUrl` is enabled and `.url()` changes', function() {
+    it('should reload when `reloadOnUrl` is true and `.url()` changes', function() {
       var routeChange = jasmine.createSpy('routeChange');
 
       module(function($routeProvider) {
@@ -1722,7 +1722,7 @@ describe('$route', function() {
     });
 
 
-    it('should reload a route when `reloadOnUrl` is disabled and URL maps to different route',
+    it('should reload when `reloadOnUrl` is false and URL maps to different route',
       function() {
         var routeChange = jasmine.createSpy('routeChange');
         var routeUpdate = jasmine.createSpy('routeUpdate');
@@ -1760,7 +1760,7 @@ describe('$route', function() {
     );
 
 
-    it('should not reload a route when `reloadOnUrl` is disabled and URL maps to the same route',
+    it('should not reload when `reloadOnUrl` is false and URL maps to the same route',
       function() {
         var routeChange = jasmine.createSpy('routeChange');
         var routeUpdate = jasmine.createSpy('routeUpdate');
@@ -1826,7 +1826,7 @@ describe('$route', function() {
     });
 
 
-    describe('reload', function() {
+    describe('with `$route.reload()`', function() {
       var $location;
       var $log;
       var $rootScope;
@@ -1940,7 +1940,7 @@ describe('$route', function() {
   });
 
   describe('reloadOnSearch', function() {
-    it('should not have no effect if `reloadOnUrl` is set to `false`', function() {
+    it('should not have any effect if `reloadOnUrl` is false', function() {
       var reloaded = jasmine.createSpy('route reload');
 
       module(function($routeProvider) {
@@ -1975,7 +1975,7 @@ describe('$route', function() {
     });
 
 
-    it('should reload a route when reloadOnSearch is enabled and .search() or .hash() changes',
+    it('should reload when `reloadOnSearch` is true and `.search()`/`.hash()` changes',
       function() {
         var reloaded = jasmine.createSpy('route reload');
 
@@ -2011,7 +2011,7 @@ describe('$route', function() {
     );
 
 
-    it('should not reload a route when reloadOnSearch is disabled and .search() or .hash() changes',
+    it('should not reload when `reloadOnSearch` is false and `.search()`/`.hash()` changes',
       function() {
         var routeChange = jasmine.createSpy('route change'),
             routeUpdate = jasmine.createSpy('route update');
@@ -2052,39 +2052,39 @@ describe('$route', function() {
     );
 
 
-    it('should reload reloadOnSearch route when url differs only in route path param', function() {
-      var routeChange = jasmine.createSpy('route change');
+    it('should reload when `reloadOnSearch` is true and url differs only in route path param',
+      function() {
+        var routeChange = jasmine.createSpy('route change');
 
-      module(function($routeProvider) {
-        $routeProvider.when('/foo/:fooId', {controller: angular.noop, reloadOnSearch: false});
-      });
+        module(function($routeProvider) {
+          $routeProvider.when('/foo/:fooId', {controller: angular.noop, reloadOnSearch: false});
+        });
 
-      inject(function($route, $location, $rootScope) {
-        $rootScope.$on('$routeChangeStart', routeChange);
-        $rootScope.$on('$routeChangeSuccess', routeChange);
+        inject(function($route, $location, $rootScope) {
+          $rootScope.$on('$routeChangeStart', routeChange);
+          $rootScope.$on('$routeChangeSuccess', routeChange);
 
-        expect(routeChange).not.toHaveBeenCalled();
+          expect(routeChange).not.toHaveBeenCalled();
 
-        $location.path('/foo/aaa');
-        $rootScope.$digest();
-        expect(routeChange).toHaveBeenCalled();
-        expect(routeChange).toHaveBeenCalledTimes(2);
-        routeChange.calls.reset();
+          $location.path('/foo/aaa');
+          $rootScope.$digest();
+          expect(routeChange).toHaveBeenCalledTimes(2);
+          routeChange.calls.reset();
 
-        $location.path('/foo/bbb');
-        $rootScope.$digest();
-        expect(routeChange).toHaveBeenCalled();
-        expect(routeChange).toHaveBeenCalledTimes(2);
-        routeChange.calls.reset();
+          $location.path('/foo/bbb');
+          $rootScope.$digest();
+          expect(routeChange).toHaveBeenCalledTimes(2);
+          routeChange.calls.reset();
 
-        $location.search({foo: 'bar'}).hash('baz');
-        $rootScope.$digest();
-        expect(routeChange).not.toHaveBeenCalled();
-      });
-    });
+          $location.search({foo: 'bar'}).hash('baz');
+          $rootScope.$digest();
+          expect(routeChange).not.toHaveBeenCalled();
+        });
+      }
+    );
 
 
-    it('should update params when reloadOnSearch is disabled and .search() changes', function() {
+    it('should update params when `reloadOnSearch` is false and `.search()` changes', function() {
       var routeParamsWatcher = jasmine.createSpy('routeParamsWatcher');
 
       module(function($routeProvider) {
@@ -2172,7 +2172,7 @@ describe('$route', function() {
     });
 
 
-    describe('reload', function() {
+    describe('with `$route.reload()`', function() {
       var $location;
       var $log;
       var $rootScope;