fix: Allow calling clearTimeout from within the setTimeout callback

mhevery · mhevery · commit a8ea55dd9778 · 2016-03-28T11:10:50.000-07:00
Closes #302
diff --git a/lib/browser/browser.ts b/lib/browser/browser.ts
@@ -86,7 +86,7 @@ function patchTimer(
   var clearNative = patchMethod(window, cancelName, (delegate: Function) => function(self: any, args: any[]) {
     var task: Task = args[0];
     if (task && typeof task.type == 'string') {
-      if (task.cancelFn) {
+      if (task.cancelFn && task.data.isPeriodic || task.runCount == 0) {
         // Do not cancel already canceled functions
         task.zone.cancelTask(task);
       }
diff --git a/lib/zone.ts b/lib/zone.ts
@@ -462,6 +462,11 @@ interface Task {
    * at the time of Task creation.
    */
   zone: Zone;
+
+  /**
+   * Number of times the task has been executed, or -1 if canceled.
+   */
+  runCount: number;
 }
 
 interface MicroTask extends Task {
@@ -565,6 +570,7 @@ var Zone: ZoneType = (function(global) {
 
 
     runTask(task: Task, applyThis?: any, applyArgs?: any) {
+      task.runCount++;
       if (task.zone != this)
         throw new Error('A task can only be run in the zone which created it! (Creation: ' +
             task.zone.name + '; Execution: ' + this.name + ')');
@@ -612,6 +618,7 @@ var Zone: ZoneType = (function(global) {
 
     cancelTask(task: Task): any {
       var value = this._zoneDelegate.cancelTask(this, task);
+      task.runCount = -1;
       task.cancelFn = null;
       return value;
     }
@@ -791,6 +798,7 @@ var Zone: ZoneType = (function(global) {
     public scheduleFn: (task: Task) => void;
     public cancelFn: (task: Task) => void;
     public zone: Zone;
+    public runCount: number = 0;
 
     constructor(type: TaskType, zone: Zone, source: string, callback: Function, options: TaskData,
                 scheduleFn: (task: Task) => void, cancelFn:(task: Task) => void)
diff --git a/test/browser/setTimeout.spec.ts b/test/browser/setTimeout.spec.ts
@@ -52,6 +52,13 @@ describe('setTimeout', function () {
     });
   });
 
+  it('should allow cancelation of fns while the task is being executed', function (done) {var spy = jasmine.createSpy('spy');
+    var cancelId = setTimeout(() => {
+      clearTimeout(cancelId);
+      done();
+    }, 0);
+  });
+
   it('should pass invalid values through', function () {
     clearTimeout(null);
     clearTimeout(<any>{});

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ function patchTimer(`
`86`	`86`	`var clearNative = patchMethod(window, cancelName, (delegate: Function) => function(self: any, args: any[]) {`
`87`	`87`	`var task: Task = args[0];`
`88`	`88`	`if (task && typeof task.type == 'string') {`
`89`		`- if (task.cancelFn) {`
	`89`	`+ if (task.cancelFn && task.data.isPeriodic \|\| task.runCount == 0) {`
`90`	`90`	`// Do not cancel already canceled functions`
`91`	`91`	`task.zone.cancelTask(task);`
`92`	`92`	`}`