add toAsyncFunction on app instance

Author: fengmk2

package.json

@@ -46,7 +46,7 @@
     "is-type-of": "^2.1.0",
     "koa-bodyparser": "^4.4.1",
     "koa-override": "^4.0.0",
-    "onelogger": "^1.0.0",
+    "onelogger": "^1.0.1",
     "performance-ms": "^1.1.0",
     "sendmessage": "^3.0.1",
     "urllib": "^4.6.11",

src/lib/application.ts

@@ -5,6 +5,7 @@ import { Socket } from 'node:net';
 import { graceful } from 'graceful';
 import { assign } from 'utility';
 import { utils as eggUtils } from '@eggjs/core';
+import { isGeneratorFunction } from 'is-type-of';
 import {
   EggApplicationCore,
   type EggApplicationCoreOptions,
@@ -267,6 +268,16 @@ export class Application extends EggApplicationCore {
     return this._keys;
   }
 
+  /**
+   * @deprecated keep compatible with egg 3.x
+   */
+  toAsyncFunction(fn: (...args: any[]) => any) {
+    if (isGeneratorFunction(fn)) {
+      throw new Error('Generator function is not supported');
+    }
+    return fn;
+  }
+
   /**
    * bind app's events
    *

src/lib/core/utils.ts

@@ -4,7 +4,7 @@ import {
   isClass, isFunction, isGeneratorFunction, isAsyncFunction,
 } from 'is-type-of';
 
-export function convertObject(obj: any, ignore: string | RegExp | (string | RegExp)[]) {
+export function convertObject(obj: any, ignore: string | RegExp | (string | RegExp)[] = []) {
   if (!Array.isArray(ignore)) {
     ignore = [ ignore ];
   }

test/fixtures/apps/multiple-view-engine/app.js

@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = app => {
   app.view.use('ejs', require('./ejs'));
   app.view.use('nunjucks', require('./nunjucks'));

test/fixtures/apps/multiple-view-engine/ejs.js

@@ -1,8 +1,8 @@
-const { sleep } = require('../../../utils');
+const { scheduler } = require('node:timers/promises');
 
 class EjsView {
   async render(filename, locals, options) {
-    await sleep(10);
+    await scheduler.wait(10);
     return {
       filename,
       locals,
@@ -12,7 +12,7 @@ class EjsView {
   }
 
   async renderString(tpl, locals, options) {
-    await sleep(10);
+    await scheduler.wait(10);
     return {
       tpl,
       locals,

test/fixtures/apps/multiple-view-engine/nunjucks.js

@@ -1,8 +1,8 @@
-const { sleep } = require('../../../utils');
+const { scheduler } = require('node:timers/promises');
 
 class NunjucksView {
   async render(filename, locals, options) {
-    await sleep(10);
+    await scheduler.wait(10);
     return {
       filename,
       locals,

test/lib/core/logger.test.ts

@@ -1,4 +1,4 @@
-import assert from 'node:assert';
+import { strict as assert } from 'node:assert';
 import path from 'node:path';
 import fs from 'node:fs';
 import { scheduler } from 'node:timers/promises';

test/lib/core/router.test.js test/lib/core/router.test.ts

@@ -1,13 +1,11 @@
-'use strict';
+import { strict as assert } from 'node:assert';
+import { mm } from '@eggjs/mock';
+import { MockApplication, createApp } from '../../utils.js';
 
-const assert = require('assert');
-const mm = require('egg-mock');
-const utils = require('../../utils');
-
-describe('test/lib/core/router.test.js', () => {
-  let app;
+describe('test/lib/core/router.test.ts', () => {
+  let app: MockApplication;
   before(() => {
-    app = utils.app({
+    app = createApp({
       baseDir: 'apps/router-app',
     });
     return app.ready();
@@ -128,25 +126,25 @@ describe('test/lib/core/router.test.js', () => {
       assert(app.router.url('edit_post', { id: 1 }) === '/posts/1/edit');
     });
 
-    it('should work with unknow params', () => {
+    it('should work with unknown params', () => {
       assert(
-        app.router.url('posts', { name: 'foo', page: 2 }) === '/posts?name=foo&page=2'
+        app.router.url('posts', { name: 'foo', page: 2 }) === '/posts?name=foo&page=2',
       );
       assert(
-        app.router.url('posts', { name: 'foo&?', page: 2 }) === '/posts?name=foo%26%3F&page=2'
+        app.router.url('posts', { name: 'foo&?', page: 2 }) === '/posts?name=foo%26%3F&page=2',
       );
       assert(
-        app.router.url('edit_post', { id: 10, page: 2 }) === '/posts/10/edit?page=2'
+        app.router.url('edit_post', { id: 10, page: 2 }) === '/posts/10/edit?page=2',
       );
       assert(app.router.url('edit_post', { i: 2, id: 10 }) === '/posts/10/edit?i=2');
       assert(
-        app.router.url('edit_post', { id: 10, page: 2, tags: [ 'chair', 'develop' ] }) === '/posts/10/edit?page=2&tags=chair&tags=develop'
+        app.router.url('edit_post', { id: 10, page: 2, tags: [ 'chair', 'develop' ] }) === '/posts/10/edit?page=2&tags=chair&tags=develop',
       );
       assert(
-        app.router.url('edit_post', { id: [ 10 ], page: [ 2 ], tags: [ 'chair', 'develop' ] }) === '/posts/10/edit?page=2&tags=chair&tags=develop'
+        app.router.url('edit_post', { id: [ 10 ], page: [ 2 ], tags: [ 'chair', 'develop' ] }) === '/posts/10/edit?page=2&tags=chair&tags=develop',
       );
       assert(
-        app.router.url('edit_post', { id: [ 10, 11 ], page: [ 2 ], tags: [ 'chair', 'develop' ] }) === '/posts/10/edit?page=2&tags=chair&tags=develop'
+        app.router.url('edit_post', { id: [ 10, 11 ], page: [ 2 ], tags: [ 'chair', 'develop' ] }) === '/posts/10/edit?page=2&tags=chair&tags=develop',
       );
     });
   });

test/lib/core/singleton.test.js test/lib/core/singleton.test.ts

@@ -1,8 +1,10 @@
-const assert = require('assert');
-const Singleton = require('../../../lib/core/singleton');
-const { sleep } = require('../../utils');
+import { strict as assert } from 'node:assert';
+import { scheduler } from 'node:timers/promises';
+import { Singleton } from '../../../src/lib/core/singleton.js';
+
 class DataService {
-  constructor(config) {
+  config: any;
+  constructor(config: any) {
     this.config = config;
   }
 
@@ -11,41 +13,39 @@ class DataService {
   }
 }
 
-function create(config) {
+function create(config: any) {
   return new DataService(config);
 }
 
-async function asyncCreate(config) {
-  await sleep(10);
+async function asyncCreate(config: any) {
+  await scheduler.wait(10);
   return new DataService(config);
 }
 
-describe('test/lib/core/singleton.test.js', () => {
-
+describe('test/lib/core/singleton.test.ts', () => {
   afterEach(() => {
-    delete DataService.prototype.createInstance;
-    delete DataService.prototype.createInstanceAsync;
+    delete (DataService as any).prototype.createInstance;
+    delete (DataService as any).prototype.createInstanceAsync;
   });
 
   describe('sync singleton creation tests', () => {
-
     it('should init with client', async () => {
       const name = 'dataService';
 
       const clients = [
         { foo: 'bar' },
       ];
       for (const client of clients) {
-        const app = { config: { dataService: { client } } };
+        const app: any = { config: { dataService: { client } } };
         const singleton = new Singleton({
           name,
           app,
           create,
         });
         singleton.init();
         assert(app.dataService instanceof DataService);
-        assert(app.dataService.config.foo === 'bar');
-        assert(typeof app.dataService.createInstance === 'function');
+        assert.equal(app.dataService.config.foo, 'bar');
+        assert.equal(typeof app.dataService.createInstance, 'function');
       }
     });
 
@@ -57,21 +57,21 @@ describe('test/lib/core/singleton.test.js', () => {
         second: { foo: 'bar2' },
       };
 
-      const app = { config: { dataService: { clients } } };
+      const app: any = { config: { dataService: { clients } } };
       const singleton = new Singleton({
         name,
         app,
         create,
       });
       singleton.init();
       assert(app.dataService instanceof Singleton);
-      assert(app.dataService.get('first').config.foo === 'bar1');
-      assert(app.dataService.get('second').config.foo === 'bar2');
-      assert(typeof app.dataService.createInstance === 'function');
+      assert.equal(app.dataService.get('first').config.foo, 'bar1');
+      assert.equal(app.dataService.get('second').config.foo, 'bar2');
+      assert.equal(typeof app.dataService.createInstance, 'function');
     });
 
     it('should client support default', async () => {
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             client: { foo: 'bar' },
@@ -88,13 +88,13 @@ describe('test/lib/core/singleton.test.js', () => {
       });
       singleton.init();
       assert(app.dataService instanceof DataService);
-      assert(app.dataService.config.foo === 'bar');
-      assert(app.dataService.config.foo1 === 'bar1');
-      assert(typeof app.dataService.createInstance === 'function');
+      assert.equal(app.dataService.config.foo, 'bar');
+      assert.equal(app.dataService.config.foo1, 'bar1');
+      assert.equal(typeof app.dataService.createInstance, 'function');
     });
 
     it('should clients support default', async () => {
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             clients: {
@@ -124,7 +124,7 @@ describe('test/lib/core/singleton.test.js', () => {
     });
 
     it('should createInstance without client/clients support default', async () => {
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             default: { foo: 'bar' },
@@ -148,12 +148,12 @@ describe('test/lib/core/singleton.test.js', () => {
     });
 
     it('should work with unextensible', async () => {
-      function create(config) {
+      function create(config: any) {
         const d = new DataService(config);
         Object.preventExtensions(d);
         return d;
       }
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             client: { foo: 'bar' },
@@ -176,12 +176,12 @@ describe('test/lib/core/singleton.test.js', () => {
     });
 
     it('should work with frozen', async () => {
-      function create(config) {
+      function create(config: any) {
         const d = new DataService(config);
         Object.freeze(d);
         return d;
       }
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             client: { foo: 'bar' },
@@ -211,17 +211,19 @@ describe('test/lib/core/singleton.test.js', () => {
         Object.freeze(d);
         return d;
       }
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             client: { foo: 'bar' },
             default: { foo: 'bar' },
           },
         },
-        logger: {
-          warn(msg, name) {
-            assert(name === 'dataService');
-            warn = true;
+        coreLogger: {
+          warn(_msg: string, name?: string) {
+            if (name) {
+              assert.equal(name, 'dataService');
+              warn = true;
+            }
           },
         },
       };
@@ -243,12 +245,12 @@ describe('test/lib/core/singleton.test.js', () => {
       let success = true;
       const name = 'dataService';
       const clientName = 'customClient';
-      function create(config, app, client) {
+      function create(_config: any, _app: any, client: string) {
         if (client !== clientName) {
           success = false;
         }
       }
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             clients: {
@@ -276,7 +278,7 @@ describe('test/lib/core/singleton.test.js', () => {
         { foo: 'bar' },
       ];
       for (const client of clients) {
-        const app = { config: { dataService: { client } } };
+        const app: any = { config: { dataService: { client } } };
         const singleton = new Singleton({
           name,
           app,
@@ -298,7 +300,7 @@ describe('test/lib/core/singleton.test.js', () => {
         second: { foo: 'bar2' },
       };
 
-      const app = { config: { dataService: { clients } } };
+      const app: any = { config: { dataService: { clients } } };
       const singleton = new Singleton({
         name,
         app,
@@ -312,7 +314,7 @@ describe('test/lib/core/singleton.test.js', () => {
     });
 
     it('should createInstanceAsync without client/clients support default', async () => {
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             default: { foo: 'bar' },
@@ -336,7 +338,7 @@ describe('test/lib/core/singleton.test.js', () => {
     });
 
     it('should createInstanceAsync throw error', async () => {
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             default: { foo: 'bar' },
@@ -356,8 +358,9 @@ describe('test/lib/core/singleton.test.js', () => {
       try {
         app.dataService = await app.dataService.createInstance({ foo1: 'bar1' });
         throw new Error('should not execute');
-      } catch (err) {
-        assert(err.message === 'egg:singleton dataService only support create asynchronous, please use createInstanceAsync');
+      } catch (err: any) {
+        assert.equal(err.message,
+          'egg:singleton dataService only support create asynchronous, please use createInstanceAsync');
       }
     });
 
@@ -366,12 +369,12 @@ describe('test/lib/core/singleton.test.js', () => {
       const name = 'dataService';
       const clientName = 'customClient';
 
-      async function _create(config, app, client) {
+      async function _create(_config: any, _app: any, client: string) {
         if (client !== clientName) {
           success = false;
         }
       }
-      const app = {
+      const app: any = {
         config: {
           dataService: {
             clients: {