fix: always run jasmine's done callbacks for async tests in jasmine's zone

IgorMinar · vicb · commit b7f3d040e8e9 · 2015-05-08T12:25:19.000+02:00
If we don't, we are leaking zones because Jasmine executes async tests from within the done callback, which means we never unwind the zone stack. This causes various specs to fail if other specs run before them and build up a zone stack. Closes #91
diff --git a/karma-microtasks.conf.js b/karma-microtasks.conf.js
@@ -7,6 +7,7 @@ module.exports = function (config) {
       'test/util.js',
       'dist/zone-microtask.js',
       'dist/*-zone.js',
+      'test/jasmine-patch.js',
       //'test/lib/brick.js',
       'test/microtasks.spec.js',
       {pattern: 'test/assets/**/*.html', watched: true, served: true, included: false}
diff --git a/karma.conf.js b/karma.conf.js
@@ -7,6 +7,7 @@ module.exports = function (config) {
       'test/util.js',
       'dist/zone.js',
       'dist/*-zone.js',
+      'test/jasmine-patch.js',
       //'test/lib/brick.js',
       'test/**/*.spec.js',
       {pattern: 'test/assets/**/*.html', watched: true, served: true, included: false}
diff --git a/test/commonjs.spec.js b/test/commonjs.spec.js
@@ -1,5 +1,10 @@
 'use strict';
 
+// WARNING: Browserify tests currently don't patch Jasmine's `it` and `fit` functions.
+//          Writing any async tests in this file will result in zone leakage.
+//          See `jasmine-patch.js` for a hint of what needs to be done here.
+
+
 describe('Zone in CommonJS environment', function () {
   var commonJSExports;
 
diff --git a/test/jasmine-patch.js b/test/jasmine-patch.js
@@ -0,0 +1,40 @@
+'use strict';
+
+(function() {
+  // patch jasmine's it and fit functions so that the `done` callback always resets the zone
+  // to the jasmine zone, which should be the root zone. (angular/zone.js#91)
+
+  var jasmineZone = window.zone;
+  var originalIt = window.it;
+  var originalFit = window.fit;
+
+  window.it = function zoneResettingIt(description, specFn) {
+    if (specFn.length) {
+      originalIt(description, function zoneResettingSpecFn(originalDone) {
+        specFn(function zoneResettingDone() {
+          jasmineZone.run(originalDone);
+        });
+      });
+    } else {
+      originalIt(description, specFn);  
+    }
+  };
+
+  window.fit = function zoneResettingFit(description, specFn) {
+    if (specFn.length) {
+      originalFit(description, function zoneResettingSpecFn(originalDone) {
+        specFn(function zoneResettingDone() {
+          jasmineZone.run(originalDone);
+        });
+      });
+    } else {
+      originalFit(description, specFn);  
+    }
+  };
+
+}(window));
+
+// global beforeEach to check if we always start from the root zone
+beforeEach(function() {
+  expect(window.zone.isRootZone()).toBe(true);
+});
