fix: dump async function as AsyncFunction (eggjs#1687)

Luluda · Nov 20, 2017 · 757f275 · 757f275
1 parent 12edd64
commit 757f275
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/app/extend/context.js b/app/extend/context.js
@@ -182,12 +182,12 @@ const proto = module.exports = {
   },
 
   /**
-   * Run generator function in the background
-   * @param {Generator} scope - generator function, the first args is ctx
+   * Run async function in the background
+   * @param {Function} scope - the first args is ctx
    * ```js
    * this.body = 'hi';
    *
-   * this.runInBackground(function* saveUserInfo(ctx) {
+   * this.runInBackground(async ctx => {
    *   yield ctx.mysql.query(sql);
    *   yield ctx.curl(url);
    * });

diff --git a/lib/application.js b/lib/application.js
@@ -156,9 +156,9 @@ class Application extends EggApplication {
   }
 
   /**
-   * Run generator function in the background
+   * Run async function in the background
    * @see Context#runInBackground
-   * @param {Generator} scope - generator function, the first args is an anonymous ctx
+   * @param {Function} scope - the first args is an anonymous ctx
    */
   runInBackground(scope) {
     const ctx = this.createAnonymousContext();

diff --git a/lib/core/utils.js b/lib/core/utils.js
@@ -46,7 +46,9 @@ function convertValue(key, value, ignore) {
 
   // support generator function
   if (is.function(value)) {
-    return is.generatorFunction(value) ? `<GeneratorFunction ${name}>` : `<Function ${name}>`;
+    if (is.generatorFunction(value)) return `<GeneratorFunction ${name}>`;
+    if (is.asyncFunction(value)) return `<AsyncFunction ${name}>`;
+    return `<Function ${name}>`;
   }
 
   const typeName = value.constructor.name;

diff --git a/test/lib/core/utils.test.js b/test/lib/core/utils.test.js
@@ -46,12 +46,14 @@ describe('test/lib/core/utils.test.js', () => {
       /* eslint object-shorthand: 0 */
       anonymousFunction$: function(a) { console.log(a); },
       generatorFunction$: function* a(a) { console.log(a); },
+      asyncFunction$: async function a(a) { console.log(a); },
     };
     utils.convertObject(obj);
     assert(obj.function$ === '<Function a>');
     assert(obj.arrowFunction$ === '<Function arrowFunction$>');
     assert(obj.anonymousFunction$ === '<Function anonymousFunction$>');
     assert(obj.generatorFunction$ === '<GeneratorFunction a>');
+    assert(obj.asyncFunction$ === '<AsyncFunction a>');
   });
 
   it('should convert error', () => {