fix(ngRoute): make route.resolve count as a pending request

Protractor users were having a problem where if they had asynchonous code in a route.resolve
variable, Protractor was not waiting for that code to complete before continuing. See
angular/protractor#789 (comment) for details

Also enhanced ngMock to wait for pending requests before calling callbacks from
`$browser.notifyWhenNoOutstandingRequests`

Potentially breaking change if someone was relying on route.resolve not blocking
`$browser.notifyWhenNoOutstandingRequests`

Author: sjelin

src/ngMock/angular-mocks.js

@@ -37,10 +37,26 @@ angular.mock.$Browser = function() {
   self.$$lastUrl = self.$$url; // used by url polling fn
   self.pollFns = [];
 
-  // TODO(vojta): remove this temporary api
-  self.$$completeOutstandingRequest = angular.noop;
-  self.$$incOutstandingRequestCount = angular.noop;
-
+  // Testability API
+
+  var outstandingRequestCount = 0;
+  var outstandingRequestCallbacks = [];
+  self.$$incOutstandingRequestCount = function() { outstandingRequestCount++; };
+  self.$$completeOutstandingRequest = function() {
+    outstandingRequestCount--;
+    if (!outstandingRequestCount) {
+      while (outstandingRequestCallbacks.length) {
+        outstandingRequestCallbacks.pop()();
+      }
+    }
+  };
+  self.notifyWhenNoOutstandingRequests = function(callback) {
+    if (outstandingRequestCount) {
+      outstandingRequestCallbacks.push(callback);
+    } else {
+      callback();
+    }
+  };
 
   // register url polling fn
 
@@ -166,10 +182,6 @@ angular.mock.$Browser.prototype = {
 
   state: function() {
     return this.$$state;
-  },
-
-  notifyWhenNoOutstandingRequests: function(fn) {
-    fn();
   }
 };
 

src/ngRoute/route.js

@@ -350,7 +350,8 @@ function $RouteProvider() {
                '$injector',
                '$templateRequest',
                '$sce',
-      function($rootScope, $location, $routeParams, $q, $injector, $templateRequest, $sce) {
+               '$browser',
+      function($rootScope, $location, $routeParams, $q, $injector, $templateRequest, $sce, $browser) {
 
     /**
      * @ngdoc service
@@ -776,6 +777,7 @@ function $RouteProvider() {
 
     function resolveLocals(route) {
       if (route) {
+        $browser.$$incOutstandingRequestCount();
         var locals = angular.extend({}, route.resolve);
         angular.forEach(locals, function(value, key) {
           locals[key] = angular.isString(value) ?
@@ -786,7 +788,10 @@ function $RouteProvider() {
         if (angular.isDefined(template)) {
           locals['$template'] = template;
         }
-        return $q.all(locals);
+        return $q.all(locals).then(function(locals) {
+          $browser.$$completeOutstandingRequest(function() {});
+          return locals;
+        });
       }
     }
 

test/ng/testabilitySpec.js

@@ -194,5 +194,33 @@ describe('$$testability', function() {
         $$testability.whenStable(callback);
         expect(callback).toHaveBeenCalled();
       }));
+
+    it('should wait for route promises before calling callbacks', function() {
+      var deferred;
+
+      module('ngRoute');
+
+      module(function($provide, $routeProvider) {
+        $routeProvider.when('/path', { template: '', resolve: {
+          a: function($q) {
+            deferred = $q.defer();
+            return deferred.promise;
+          }
+        } });
+      });
+
+      inject(function($location, $route, $rootScope, $httpBackend, $$testability) {
+        $location.path('/path');
+        $rootScope.$digest();
+
+        var callback = jasmine.createSpy('callback');
+        $$testability.whenStable(callback);
+        expect(callback).not.toHaveBeenCalled();
+
+        deferred.resolve();
+        $rootScope.$digest();
+        expect(callback).toHaveBeenCalled();
+      });
+    });
   });
 });