feat(bluebird): patch bluebird promise and treat it as microtask (#655)

Author: JiaLiPassion

NON-STANDARD-APIS.md

@@ -13,6 +13,48 @@ But there are still a lot of non standard APIs are not patched by default, such
 
 ## Currently supported non standard node APIs
 
+## Currently supported non standard common APIs
+
+* bluebird promise
+
+Browser Usage: 
+
+```
+  <script src="zone.js"></script>
+  <script src="bluebird.js"></script>
+  <script src="zone-bluebird.js"></script>
+  <script>
+  Zone[Zone['__symbol__']('bluebird')](Promise);
+  </script>
+```
+
+After those steps, window.Promise will become a ZoneAware Bluebird Promise.
+
+Node Usage:
+
+```
+require('zone-node.js');
+const Bluebird = require('bluebird');
+require('zone-bluebird.js');
+Zone[Zone['__symbol__']('bluebird')](Bluebird);
+```
+
+In NodeJS environment, you can choose to use Bluebird Promise as global.Promise
+or use ZoneAwarePromise as global.Promise.
+
+To run the jasmine test cases of bluebird
+
+```
+  npm install bluebird
+```
+
+then modify test/node_tests.ts
+remove the comment of the following line
+
+```
+//import './extra/bluebird.spec';
+```
+
 ## Usage
 
 By default, those APIs' support will not be loaded in zone.js or zone-node.js,

dist/zone-bluebird.js

@@ -0,0 +1,35 @@
+/**
+* @license
+* Copyright Google Inc. All Rights Reserved.
+*
+* Use of this source code is governed by an MIT-style license that can be
+* found in the LICENSE file at https://angular.io/license
+*/
+(function (global, factory) {
+	typeof exports === 'object' && typeof module !== 'undefined' ? factory() :
+	typeof define === 'function' && define.amd ? define(factory) :
+	(factory());
+}(this, (function () { 'use strict';
+
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+(function (_global) {
+    var __symbol__ = Zone['__symbol__'];
+    // TODO: @JiaLiPassion, we can automatically patch bluebird
+    // if global.Promise = Bluebird, but sometimes in nodejs,
+    // global.Promise is not Bluebird, and Bluebird is just be
+    // used by other libraries such as sequelize, so I think it is
+    // safe to just expose a method to patch Bluebird explicitly
+    Zone[__symbol__('bluebird')] = function patchBluebird(Bluebird) {
+        Bluebird.setScheduler(function (fn) {
+            Zone.current.scheduleMicroTask('bluebird', fn);
+        });
+    };
+})(typeof window === 'object' && window || typeof self === 'object' && self || global);
+
+})));

dist/zone-bluebird.min.js

@@ -99,6 +99,14 @@ gulp.task('build/webapis-notification.js', ['compile-esm'], function(cb) {
     return generateScript('./lib/browser/webapis-notification.ts', 'webapis-notification.js', true, cb);
 });
 
+gulp.task('build/bluebird.js', ['compile-esm'], function(cb) {
+    return generateScript('./lib/extra/bluebird.ts', 'zone-bluebird.js', false, cb);
+});
+
+gulp.task('build/bluebird.min.js', ['compile-esm'], function(cb) {
+    return generateScript('./lib/extra/bluebird.ts', 'zone-bluebird.min.js', true, cb);
+});
+
 gulp.task('build/jasmine-patch.js', ['compile-esm'], function(cb) {
   return generateScript('./lib/jasmine/jasmine.ts', 'jasmine-patch.js', false, cb);
 });
@@ -167,6 +175,8 @@ gulp.task('build', [
   'build/webapis-media-query.js',
   'build/webapis-notification.js',
   'build/zone-mix.js',
+  'build/bluebird.js',
+  'build/bluebird.min.js',
   'build/jasmine-patch.js',
   'build/jasmine-patch.min.js',
   'build/mocha-patch.js',

gulpfile.js

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+((_global: any) => {
+  const __symbol__ = Zone['__symbol__'];
+  // TODO: @JiaLiPassion, we can automatically patch bluebird
+  // if global.Promise = Bluebird, but sometimes in nodejs,
+  // global.Promise is not Bluebird, and Bluebird is just be
+  // used by other libraries such as sequelize, so I think it is
+  // safe to just expose a method to patch Bluebird explicitly
+  Zone[__symbol__('bluebird')] = function patchBluebird(Bluebird) {
+    Bluebird.setScheduler((fn) => {
+      Zone.current.scheduleMicroTask('bluebird', fn);
+    });
+  };
+})(typeof window === 'object' && window || typeof self === 'object' && self || global);

lib/extra/bluebird.ts

@@ -18,15 +18,18 @@ describe('ZoneAwareError', () => {
   });
 
   it('should support prepareStackTrace', () => {
+    const originalPrepareStackTrace = (<any>Error).prepareStackTrace;
     (<any>Error).prepareStackTrace = function(error, stack) {
       return stack;
     };
     let obj: any = new Object();
     Error.captureStackTrace(obj);
     expect(obj.stack[0].getFileName()).not.toBeUndefined();
+    (<any>Error).prepareStackTrace = originalPrepareStackTrace;
   });
 
   it('should not add additional stacktrace from Zone when use prepareStackTrace', () => {
+    const originalPrepareStackTrace = (<any>Error).prepareStackTrace;
     (<any>Error).prepareStackTrace = function(error, stack) {
       return stack;
     };
@@ -36,5 +39,6 @@ describe('ZoneAwareError', () => {
     obj.stack.forEach(function(st) {
       expect(st.getFunctionName()).not.toEqual('zoneCaptureStackTrace');
     });
+    (<any>Error).prepareStackTrace = originalPrepareStackTrace;
   });
 });

test/extra/bluebird.spec.ts

@@ -12,3 +12,7 @@ import './node/process.spec';
 import './node/Error.spec';
 import './node/crypto.spec';
 import './node/http.spec';
+
+// before test bluebird, must run npm install bluebird first.
+// then remove the comment below
+// import './extra/bluebird.spec';