fix(mocks): $timeout#flush should not update time when empty

IgorMinar · IgorMinar · commit 42af8eada280 · 2013-08-25T14:46:55.000-07:00
When $timeout#flush is called with a delay and no task can be flushed within that
delay, the current time should not be updated as that gets the mock into an inconsistent
state.

BREAKING CHANGE: if a tests was written around the buggy behavior the delays might be off now

This would typically not be a problem, but because of the previous breaking change in
$timeout.flush, the combination of two might be confusing and that's why we are documenting
it.

Old behavior:

```
doSomething(); //schedules task to execute in 500ms from now
doOtherStuff(); //schedules task to execute in 600ms from now

try {
  $timeout.flush(300); // throws "no task to be flushed" exception
} catch(e) {};
$time.flush(200); //flushes only doSomething() task
```

New behavior:

```
doSomething(); //schedules task to execute in 500ms from now
doOtherStuff(); //schedules task to execute in 600ms from now

try {
  $timeout.flush(300); // throws "no task to be flushed" exception
} catch(e) {};
$time.flush(200); // throws "no task to be flushed" exception again
                  // because previous exception didn't move the time forward
```

Fixed test:

```
doSomething(); //schedules task to execute in 500ms from now
doOtherStuff(); //schedules task to execute in 600ms from now

try {
  $timeout.flush(300); // throws "no task to be flushed" exception
} catch(e) {};
$time.flush(500); // flushes only doSomething() task
```
diff --git a/src/ngMock/angular-mocks.js b/src/ngMock/angular-mocks.js
@@ -105,16 +105,17 @@ angular.mock.$Browser = function() {
    */
   self.defer.flush = function(delay) {
     var flushedSomething = false;
+        now = self.defer.now;
 
     if (angular.isDefined(delay)) {
-      self.defer.now += delay;
+      now += delay;
     } else {
       if (self.deferredFns.length) {
-        self.defer.now = self.deferredFns[self.deferredFns.length-1].time;
+        now = self.deferredFns[self.deferredFns.length-1].time;
       }
     }
 
-    while (self.deferredFns.length && self.deferredFns[0].time <= self.defer.now) {
+    while (self.deferredFns.length && self.deferredFns[0].time <= now) {
       flushedSomething = true;
       self.deferredFns.shift().fn();
     }
@@ -126,6 +127,8 @@ angular.mock.$Browser = function() {
         throw Error('No deferred tasks with delay up to ' + delay + 'ms to be flushed!')
       }
     }
+
+    self.defer.now = now;
   };
 
   /**
diff --git a/test/ngMock/angular-mocksSpec.js b/test/ngMock/angular-mocksSpec.js
@@ -404,7 +404,7 @@ describe('ngMock', function() {
       expect(function() {$timeout.flush(100);}).toThrow();
       expect(log).toEqual(['t1']);
 
-      $timeout.flush(900);
+      $timeout.flush(1000);
       expect(log).toEqual(['t1', 't2']);
       expect(function() {$timeout.flush();}).toThrow();
     });
@@ -425,6 +425,21 @@ describe('ngMock', function() {
     });
 
 
+    it('should not update the current time if an exception is thrown during a flush', function() {
+      $timeout(log.fn('t1'), 100);
+      $timeout(log.fn('t2'), 101);
+
+      expect(function() { $timeout.flush(90); }).toThrow();
+      expect(function() { $timeout.flush(90); }).toThrow();
+
+      $timeout.flush(100);
+      expect(log).toEqual(['t1']);
+
+      $timeout.flush(1);
+      expect(log).toEqual(['t1', 't2']);
+    });
+
+
     describe('verifyNoPendingTasks', function() {
 
       it('should throw an exception when not flushed', function() {

Original file line number	Diff line number	Diff line change
`@@ -105,16 +105,17 @@ angular.mock.$Browser = function() {`
`105`	`105`	`*/`
`106`	`106`	`self.defer.flush = function(delay) {`
`107`	`107`	`var flushedSomething = false;`
	`108`	`+ now = self.defer.now;`
`108`	`109`
`109`	`110`	`if (angular.isDefined(delay)) {`
`110`		`- self.defer.now += delay;`
	`111`	`+ now += delay;`
`111`	`112`	`} else {`
`112`	`113`	`if (self.deferredFns.length) {`
`113`		`- self.defer.now = self.deferredFns[self.deferredFns.length-1].time;`
	`114`	`+ now = self.deferredFns[self.deferredFns.length-1].time;`
`114`	`115`	`}`
`115`	`116`	`}`
`116`	`117`
`117`		`- while (self.deferredFns.length && self.deferredFns[0].time <= self.defer.now) {`
	`118`	`+ while (self.deferredFns.length && self.deferredFns[0].time <= now) {`
`118`	`119`	`flushedSomething = true;`
`119`	`120`	`self.deferredFns.shift().fn();`
`120`	`121`	`}`
`@@ -126,6 +127,8 @@ angular.mock.$Browser = function() {`
`126`	`127`	`throw Error('No deferred tasks with delay up to ' + delay + 'ms to be flushed!')`
`127`	`128`	`}`
`128`	`129`	`}`
	`130`	`+`
	`131`	`+ self.defer.now = now;`
`129`	`132`	`};`
`130`	`133`
`131`	`134`	`/**`