refactor($browser): remove private polling mechanism

shahata · petebacondarwin · commit 9b35dfb65841 · 2015-03-02T22:21:11.000Z
The only feature of Angular using this mechanism was `$cookies`, which no longer mirrors the browser cookie values and so does not need to poll. Closes #11222
diff --git a/src/ng/browser.js b/src/ng/browser.js
@@ -73,56 +73,13 @@ function Browser(window, document, $log, $sniffer) {
    * @param {function()} callback Function that will be called when no outstanding request
    */
   self.notifyWhenNoOutstandingRequests = function(callback) {
-    // force browser to execute all pollFns - this is needed so that cookies and other pollers fire
-    // at some deterministic time in respect to the test runner's actions. Leaving things up to the
-    // regular poller would result in flaky tests.
-    forEach(pollFns, function(pollFn) { pollFn(); });
-
     if (outstandingRequestCount === 0) {
       callback();
     } else {
       outstandingRequestCallbacks.push(callback);
     }
   };
 
-  //////////////////////////////////////////////////////////////
-  // Poll Watcher API
-  //////////////////////////////////////////////////////////////
-  var pollFns = [],
-      pollTimeout;
-
-  /**
-   * @name $browser#addPollFn
-   *
-   * @param {function()} fn Poll function to add
-   *
-   * @description
-   * Adds a function to the list of functions that poller periodically executes,
-   * and starts polling if not started yet.
-   *
-   * @returns {function()} the added function
-   */
-  self.addPollFn = function(fn) {
-    if (isUndefined(pollTimeout)) startPoller(100, setTimeout);
-    pollFns.push(fn);
-    return fn;
-  };
-
-  /**
-   * @param {number} interval How often should browser call poll functions (ms)
-   * @param {function()} setTimeout Reference to a real or fake `setTimeout` function.
-   *
-   * @description
-   * Configures the poller to run in the specified intervals, using the specified
-   * setTimeout fn and kicks it off.
-   */
-  function startPoller(interval, setTimeout) {
-    (function check() {
-      forEach(pollFns, function(pollFn) { pollFn(); });
-      pollTimeout = setTimeout(check, interval);
-    })();
-  }
-
   //////////////////////////////////////////////////////////////
   // URL API
   //////////////////////////////////////////////////////////////
diff --git a/src/ngMock/angular-mocks.js b/src/ngMock/angular-mocks.js
@@ -138,11 +138,6 @@ angular.mock.$Browser.prototype = {
     });
   },
 
-  addPollFn: function(pollFn) {
-    this.pollFns.push(pollFn);
-    return pollFn;
-  },
-
   url: function(url, replace, state) {
     if (angular.isUndefined(state)) {
       state = null;
@@ -2148,7 +2143,6 @@ if (window.jasmine || window.mocha) {
 
     if (injector) {
       injector.get('$rootElement').off();
-      injector.get('$browser').pollFns.length = 0;
     }
 
     // clean up jquery's fragment cache
diff --git a/test/ng/browserSpecs.js b/test/ng/browserSpecs.js
@@ -249,37 +249,6 @@ describe('browser', function() {
   });
 
 
-  describe('poller', function() {
-
-    it('should call functions in pollFns in regular intervals', function() {
-      var log = '';
-      browser.addPollFn(function() {log+='a';});
-      browser.addPollFn(function() {log+='b';});
-      expect(log).toEqual('');
-      fakeWindow.setTimeout.flush();
-      expect(log).toEqual('ab');
-      fakeWindow.setTimeout.flush();
-      expect(log).toEqual('abab');
-    });
-
-    it('should startPoller', function() {
-      expect(fakeWindow.timeouts.length).toEqual(0);
-
-      browser.addPollFn(function() {});
-      expect(fakeWindow.timeouts.length).toEqual(1);
-
-      //should remain 1 as it is the check fn
-      browser.addPollFn(function() {});
-      expect(fakeWindow.timeouts.length).toEqual(1);
-    });
-
-    it('should return fn that was passed into addPollFn', function() {
-      var fn = function() { return 1; };
-      var returnedFn = browser.addPollFn(fn);
-      expect(returnedFn).toBe(fn);
-    });
-  });
-
   describe('url', function() {
     var pushState, replaceState, locationReplace;
 
@@ -723,7 +692,6 @@ describe('browser', function() {
           fakeWindow.location.href = newUrl;
         });
         $provide.value('$browser', browser);
-        browser.pollFns = [];
 
         sniffer.history = options.history;
         $provide.value('$sniffer', sniffer);
@@ -846,7 +814,6 @@ describe('browser', function() {
 
     beforeEach(module(function($provide, $locationProvider) {
       $provide.value('$browser', browser);
-      browser.pollFns = [];
     }));
 
     it('should not interfere with legacy browser url replace behavior', function() {
diff --git a/test/ng/locationSpec.js b/test/ng/locationSpec.js
@@ -99,7 +99,6 @@ describe('$location', function() {
 
         /* global Browser: false */
         var b = new Browser($window, $document, fakeLog, sniffer);
-        b.pollFns = [];
         return b;
       };
     });
