feat: support pkg.eggPlugin.exports property

.github/workflows/nodejs.yml

@@ -11,6 +11,6 @@ jobs:
     name: Node.js
     uses: node-modules/github-actions/.github/workflows/node-test.yml@master
     with:
-      version: '18.19.0, 18, 20, 22'
+      version: '18.19.0, 18, 20, 22, 23'
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -5,6 +5,7 @@
 [![Test coverage][codecov-image]][codecov-url]
 [![Known Vulnerabilities][snyk-image]][snyk-url]
 [![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/core.svg?style=flat)](https://nodejs.org/en/download/)
 
 [npm-image]: https://img.shields.io/npm/v/@eggjs/core.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/@eggjs/core

src/egg.ts

@@ -248,7 +248,12 @@ export class EggCore extends KoaApplication {
    *   console.log('done');
    * });
    */
+  ready(): Promise<void>;
+  ready(flagOrFunction: ReadyFunctionArg): void;
   ready(flagOrFunction?: ReadyFunctionArg) {
+    if (flagOrFunction === undefined) {
+      return this.lifecycle.ready();
+    }
     return this.lifecycle.ready(flagOrFunction);
   }
 

src/lifecycle.ts

@@ -109,8 +109,13 @@ export class Lifecycle extends EventEmitter {
     });
   }
 
-  ready(arg?: ReadyFunctionArg) {
-    return this.#readyObject.ready(arg);
+  ready(): Promise<void>;
+  ready(flagOrFunction: ReadyFunctionArg): void;
+  ready(flagOrFunction?: ReadyFunctionArg) {
+    if (flagOrFunction === undefined) {
+      return this.#readyObject.ready();
+    }
+    return this.#readyObject.ready(flagOrFunction);
   }
 
   get app() {

src/loader/egg_loader.ts

@@ -5,7 +5,7 @@
 import { isAsyncFunction, isClass, isGeneratorFunction, isObject } from 'is-type-of';
 import { homedir } from 'node-homedir';
 import type { Logger } from 'egg-logger';
-import { getParamNames, readJSONSync } from 'utility';
+import { getParamNames, readJSONSync, readJSON } from 'utility';
 import { extend } from 'extend2';
 import { Request, Response, Context, Application } from '@eggjs/koa';
 import { pathMatching, type PathMatchingOptions } from 'egg-path-matching';
@@ -462,7 +462,7 @@
       plugin.path = this.getPluginPath(plugin);
 
       // read plugin information from ${plugin.path}/package.json
-      this.#mergePluginConfig(plugin);
+      await this.#mergePluginConfig(plugin);
 
       // disable the plugin that not match the serverEnv
       if (env && plugin.env.length > 0 && !plugin.env.includes(env)) {
@@ -538,7 +538,7 @@
       for (const name in customPlugins) {
         this.#normalizePluginConfig(customPlugins, name, configPath);
       }
-      debug('Loaded custom plugins: %j', Object.keys(customPlugins));
+      debug('Loaded custom plugins: %o', customPlugins);
     }
     return customPlugins;
   }
@@ -623,16 +623,18 @@
   //     "strict": true, whether check plugin name, default to true.
   //   }
   // }
-  #mergePluginConfig(plugin: EggPluginInfo) {
+  async #mergePluginConfig(plugin: EggPluginInfo) {
     let pkg;
     let config;
     const pluginPackage = path.join(plugin.path!, 'package.json');
-    if (fs.existsSync(pluginPackage)) {
-      pkg = readJSONSync(pluginPackage);
+    if (await utils.existsPath(pluginPackage)) {
+      pkg = await readJSON(pluginPackage);
       config = pkg.eggPlugin;
       if (pkg.version) {
         plugin.version = pkg.version;
       }
+      // support commonjs and esm dist files
+      plugin.path = this.#formatPluginPathFromPackageJSON(plugin.path!, pkg);
     }
 
     const logger = this.options.logger;
@@ -712,9 +714,9 @@
     }
 
     // Following plugins will be enabled implicitly.
-    //   - configclient required by [hsfclient]
-    //   - eagleeye required by [hsfclient]
-    //   - diamond required by [hsfclient]
+    //   - configclient required by [rpcClient]
+    //   - monitor required by [rpcClient]
+    //   - diamond required by [rpcClient]
     if (implicitEnabledPlugins.length) {
       let message = implicitEnabledPlugins
         .map(name => `  - ${name} required by [${requireMap[name]}]`)
@@ -769,20 +771,43 @@
 
   #resolvePluginPath(plugin: EggPluginInfo) {
     const name = plugin.package || plugin.name;
-
     try {
       // should find the plugin directory
       // pnpm will lift the node_modules to the sibling directory
       // 'node_modules/.pnpm/[email protected]/node_modules/yadan/node_modules',
       // 'node_modules/.pnpm/[email protected]/node_modules',  <- this is the sibling directory
       // 'node_modules/.pnpm/[email protected]/node_modules/egg/node_modules',
       // 'node_modules/.pnpm/[email protected]/node_modules', <- this is the sibling directory
-      const filePath = utils.resolvePath(`${name}/package.json`, { paths: [ ...this.lookupDirs ] });
-      return path.dirname(filePath);
-    } catch (err: any) {
+      const pluginPkgFile = utils.resolvePath(`${name}/package.json`, { paths: [ ...this.lookupDirs ] });
+      return path.dirname(pluginPkgFile);
+    } catch (err) {
       debug('[resolvePluginPath] error: %o', err);
-      throw new Error(`Can not find plugin ${name} in "${[ ...this.lookupDirs ].join(', ')}"`);
+      throw new Error(`Can not find plugin ${name} in "${[ ...this.lookupDirs ].join(', ')}"`, {
+        cause: err,
+      });
+    }
+  }
+
+  #formatPluginPathFromPackageJSON(pluginPath: string, pluginPkg: {
+    eggPlugin?: {
+      exports?: {
+        import?: string;
+        require?: string;
+      };
+    };
+  }) {
+    if (pluginPkg.eggPlugin?.exports) {
+      if (typeof require === 'function') {
+        if (pluginPkg.eggPlugin.exports.require) {
+          pluginPath = path.join(pluginPath, pluginPkg.eggPlugin.exports.require);
+        }
+      } else {
+        if (pluginPkg.eggPlugin.exports.import) {
+          pluginPath = path.join(pluginPath, pluginPkg.eggPlugin.exports.import);
+        }
+      }
     }
+    return pluginPath;
   }
 
   #extendPlugins(targets: Record<string, EggPluginInfo>, plugins: Record<string, EggPluginInfo>) {
@@ -1036,9 +1061,10 @@
     debug('loadExtend %s, filepaths: %j', name, filepaths);
 
     const mergeRecord = new Map();
-    for (let filepath of filepaths) {
-      filepath = this.resolveModule(filepath)!;
+    for (const rawFilepath of filepaths) {
+      const filepath = this.resolveModule(rawFilepath)!;
       if (!filepath) {
+        debug('loadExtend %o not found', rawFilepath);
         continue;
       }
       if (filepath.endsWith('/index.js')) {

src/utils/index.ts

@@ -1,6 +1,7 @@
 import { debuglog } from 'node:util';
 import path from 'node:path';
 import fs from 'node:fs';
+import { stat } from 'node:fs/promises';
 import BuiltinModule from 'node:module';
 import { importResolve, importModule } from '@eggjs/utils';
 
@@ -18,14 +19,61 @@
 const extensionNames = Object.keys(extensions).concat([ '.cjs', '.mjs' ]);
 debug('Module extensions: %j', extensionNames);
 
+function getCalleeFromStack(withLine?: boolean, stackIndex?: number) {
+  stackIndex = stackIndex === undefined ? 2 : stackIndex;
+  const limit = Error.stackTraceLimit;
+  const prep = Error.prepareStackTrace;
+
+  Error.prepareStackTrace = prepareObjectStackTrace;
+  Error.stackTraceLimit = 5;
+
+  // capture the stack
+  const obj: any = {};
+  Error.captureStackTrace(obj);
+  let callSite = obj.stack[stackIndex];
+  let fileName = '';
+  if (callSite) {
+    // egg-mock will create a proxy
+    // https://github.com/eggjs/egg-mock/blob/master/lib/app.js#L174
+    fileName = callSite.getFileName();
+    /* istanbul ignore if */
+    if (fileName && fileName.endsWith('egg-mock/lib/app.js')) {
+      // TODO: add test
+      callSite = obj.stack[stackIndex + 1];
+      fileName = callSite.getFileName();
+    }
+  }
+
+  Error.prepareStackTrace = prep;
+  Error.stackTraceLimit = limit;
+
+  if (!callSite || !fileName) return '<anonymous>';
+  if (!withLine) return fileName;
+  return `${fileName}:${callSite.getLineNumber()}:${callSite.getColumnNumber()}`;
+}
+
 export default {
   deprecated(message: string) {
-    console.warn('[@eggjs/core:deprecated] %s', message);
+    if (debug.enabled) {
+      console.trace('[@eggjs/core:deprecated] %s', message);
+    } else {
+      console.warn('[@eggjs/core:deprecated] %s', message);
+      console.warn('[@eggjs/core:deprecated] set NODE_DEBUG=@eggjs/core:utils can show call stack');
+    }
   },
 
   extensions,
   extensionNames,
 
+  async existsPath(filepath: string) {
+    try {
+      await stat(filepath);
+      return true;
+    } catch {
+      return false;
+    }
+  },
+
   async loadFile(filepath: string) {
     try {
       // if not js module, just return content buffer
@@ -55,38 +103,7 @@
     return ctx ? fn.call(ctx, ...args) : fn(...args);
   },
 
-  getCalleeFromStack(withLine?: boolean, stackIndex?: number) {
-    stackIndex = stackIndex === undefined ? 2 : stackIndex;
-    const limit = Error.stackTraceLimit;
-    const prep = Error.prepareStackTrace;
-
-    Error.prepareStackTrace = prepareObjectStackTrace;
-    Error.stackTraceLimit = 5;
-
-    // capture the stack
-    const obj: any = {};
-    Error.captureStackTrace(obj);
-    let callSite = obj.stack[stackIndex];
-    let fileName = '';
-    if (callSite) {
-      // egg-mock will create a proxy
-      // https://github.com/eggjs/egg-mock/blob/master/lib/app.js#L174
-      fileName = callSite.getFileName();
-      /* istanbul ignore if */
-      if (fileName && fileName.endsWith('egg-mock/lib/app.js')) {
-        // TODO: add test
-        callSite = obj.stack[stackIndex + 1];
-        fileName = callSite.getFileName();
-      }
-    }
-
-    Error.prepareStackTrace = prep;
-    Error.stackTraceLimit = limit;
-
-    if (!callSite || !fileName) return '<anonymous>';
-    if (!withLine) return fileName;
-    return `${fileName}:${callSite.getLineNumber()}:${callSite.getColumnNumber()}`;
-  },
+  getCalleeFromStack,
 
   getResolvedFilename(filepath: string, baseDir: string) {
     const reg = /[/\\]/g;

test/fixtures/plugin-egg-plugin/config/plugin.js

@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   a: {
     enable: true,

test/fixtures/plugin-pkg-exports/config/plugin.js

@@ -0,0 +1,5 @@
+module.exports = {
+  a: {
+    enable: true,
+  },
+};

test/fixtures/plugin-pkg-exports/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "plugin-pkg-exports"
+}

test/loader/mixin/load_plugin.test.ts

@@ -14,14 +14,25 @@ describe('test/loader/mixin/load_plugin.test.ts', () => {
     app = undefined;
   });
 
-  it('should exports allPlugins, appPlugins, customPlugins, eggPlugins', () => {
+  it('should exports allPlugins, appPlugins, customPlugins, eggPlugins', async () => {
     app = createApp('plugin');
     const loader = app.loader;
-    loader.loadPlugin();
+    await loader.loadPlugin();
+    assert('allPlugins' in loader);
+    assert('appPlugins' in loader);
+    assert('customPlugins' in loader);
+    assert('eggPlugins' in loader);
+  });
+
+  it('should load plugin by pkg.eggPlugin.exports', async () => {
+    app = createApp('plugin-pkg-exports');
+    const loader = app.loader;
+    await loader.loadPlugin();
     assert('allPlugins' in loader);
     assert('appPlugins' in loader);
     assert('customPlugins' in loader);
     assert('eggPlugins' in loader);
+    assert(loader.plugins.a.enable);
   });
 
   it('should loadConfig all plugins', async () => {