Merge 522f03e into 5ef20b5

emmaguo · Feb 27, 2015 · 66a4ee7 · 66a4ee7
2 parents 5ef20b5 + 522f03e
commit 66a4ee7
Show file tree

Hide file tree

Showing 4 changed files with 112 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -316,6 +316,23 @@ myModule.config(function (pollerConfig) {
 });
 ```
 
+### Automatically switch to longer delay when page visibility changes
+You can also use `pollerConfig` to automatically switch interval delay for all pollers that you set `idleDelay` property.
+```javascript
+var myModule = angular.module('myApp', ['emguo.poller']);
+
+myModule.config(function (pollerConfig) {
+    pollerConfig.delayOnVisibilityChange = true;
+});
+
+myModule.controller('controller', function (poller) {
+    var myPoller = poller.get('/progress', {
+        delay: 5000,
+        idleDelay: 60000
+    });
+});
+```
+
 ## Supported Angular versions
 
 Angular Poller supports Angular 1.2.0 - 1.3.x.
@@ -341,4 +358,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/angular-poller.js b/angular-poller.js
@@ -41,10 +41,11 @@
             stopOnStateChange: false,
             resetOnRouteChange: false,
             resetOnStateChange: false,
+            delayOnVisibilityChange: false,
             neverOverwrite: false
         })
 
-        .run(function ($rootScope, poller, pollerConfig) {
+        .run(function ($rootScope, $document, poller, pollerConfig) {
 
             /**
              * Automatically stop or reset all pollers before route change ($routeProvider) or state change ($stateProvider).
@@ -72,6 +73,28 @@
                     poller.reset();
                 });
             }
+
+            if (pollerConfig.delayOnVisibilityChange) {
+                var handleVisibility = function(isHidden) {
+                    if (isHidden || document.hidden || document.webkitHidden || document.mozHidden || document.msHidden) {
+                        poller.delayAll();
+                    }
+                    else {
+                        poller.resetDelay();
+                    }
+                };
+
+                $document.on('visibilitychange', function() {
+                    $rootScope.$broadcast('$visibilityChange');
+                });
+
+                $rootScope.$on('$visibilityChange', function(event, isHidden) {
+                    handleVisibility(isHidden);
+                });
+
+                handleVisibility();
+            }
+
         })
 
         .factory('poller', function ($interval, $q, $http, pollerConfig) {
@@ -82,6 +105,7 @@
                     action: 'get',
                     argumentsArray: [],
                     delay: 5000,
+                    idleDelay: 0,
                     smart: false,
                     catchError: false
                 },
@@ -140,10 +164,11 @@
                  * @param options
                  */
                 set: function (options) {
-
-                    angular.forEach(['action', 'argumentsArray', 'delay', 'smart', 'catchError'], function (prop) {
+                    angular.forEach(['action', 'argumentsArray', 'delay', 'normalDelay', 'idleDelay', 'smart', 'catchError'], function (prop) {
                         if (options && options[prop]) {
                             this[prop] = options[prop];
+                        } else if (prop === 'normalDelay') {
+                            this[prop] = this.delay;
                         } else if (!this[prop]) {
                             this[prop] = defaults[prop];
                         }
@@ -165,6 +190,10 @@
                         current,
                         timestamp;
 
+                    if (!delay) {
+                        return;
+                    }
+
                     this.deferred = this.deferred || $q.defer();
 
                     /**
@@ -308,8 +337,33 @@
                 reset: function () {
                     this.stopAll();
                     pollers = [];
+                },
+
+                /**
+                 * Switch all poller services delay to idleDelay
+                 */
+                delayAll: function() {
+                    angular.forEach(pollers, function (p) {
+                        if (p.idleDelay !== false && angular.isDefined(p.idleDelay)) {
+                            p.delay = p.idleDelay;
+                            p.restart();
+                        }
+                    });
+                },
+
+                /**
+                 * Switch all poller services delay back to normalDelay
+                 */
+                resetDelay: function() {
+                    angular.forEach(pollers, function(p) {
+                        if (p.idleDelay !== false && angular.isDefined(p.idleDelay)) {
+                            p.delay = p.normalDelay;
+                            p.restart();
+                        }
+                    });
                 }
+
             };
         }
     );
-})(window, window.angular);
+})(window, window.angular);
diff --git a/angular-poller.min.js b/angular-poller.min.js
diff --git a/test/angular-poller-spec.js b/test/angular-poller-spec.js
@@ -444,6 +444,16 @@ describe('emguo.poller', function () {
                 expect(anotherPoller.delay).to.equal(1000);
             });
 
+            it('should always set (and overwrite) normalDelay same as delay.', function() {
+                anotherPoller = poller.get(target, {delay: 1000});
+                expect(anotherPoller.normalDelay).to.exist();
+                expect(anotherPoller.normalDelay).to.equal(anotherPoller.delay);
+
+                poller.get(target, {delay: 3000});
+                expect(anotherPoller.normalDelay).to.exist();
+                expect(anotherPoller.normalDelay).to.equal(anotherPoller.delay);
+            });
+
             it('should not modify delay property if it is not re-defined.', function () {
                 anotherPoller = poller.get(target);
                 expect(anotherPoller.delay).to.equal(8000);
@@ -639,4 +649,27 @@ describe('emguo.poller PollerConfig', function () {
         expect(anotherPoller.argumentsArray.length).to.equal(0);
         expect(anotherPoller.delay).to.equal(5000);
     });
-});
+
+    it('should switch delay of all pollers that have idleDelay on visibilitychange.', function () {
+        module(function ($provide) {
+            $provide.constant('pollerConfig', {
+                delayOnVisibilityChange: true
+            });
+        });
+
+        inject(function (_$rootScope_, _$resource_, _poller_) {
+            $rootScope = _$rootScope_;
+            $resource = _$resource_;
+            poller = _poller_;
+
+            var delaySpy = sinon.spy(poller, 'delayAll');
+            $rootScope.$broadcast('$visibilityChange', true);
+
+            var hasteSpy = sinon.spy(poller, 'resetDelay');
+            $rootScope.$broadcast('$visibilityChange', false);
+
+            expect(delaySpy).to.have.callCount(1);
+            expect(hasteSpy).to.have.callCount(1);
+        });
+    });
+});