fix: conflict with orignal egg master branch

Author: AntiMoron

.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 }}

.gitignore

@@ -14,3 +14,4 @@ test/fixtures/*/timing.json
 lib/
 .tshy*
 dist
+.package-lock.json

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [6.1.0](https://github.com/eggjs/egg-core/compare/v6.0.3...v6.1.0) (2024-12-17)
+
+
+### Features
+
+* support `pkg.eggPlugin.exports` property ([#274](https://github.com/eggjs/egg-core/issues/274)) ([df9efed](https://github.com/eggjs/egg-core/commit/df9efedb22c630b13a4f1374f96450f6ba1107ab))
+
+## [6.0.3](https://github.com/eggjs/egg-core/compare/v6.0.2...v6.0.3) (2024-12-13)
+
+
+### Bug Fixes
+
+* dont import default value ([#273](https://github.com/eggjs/egg-core/issues/273)) ([16274e7](https://github.com/eggjs/egg-core/commit/16274e744007bcbeef9a99210fa00c8812d05718))
+
 ## [6.0.2](https://github.com/eggjs/egg-core/compare/v6.0.1...v6.0.2) (2024-06-30)
 
 

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eggjs/core",
-  "version": "6.0.2",
+  "version": "6.1.0",
   "publishConfig": {
     "access": "public"
   },
@@ -35,7 +35,7 @@
   },
   "homepage": "https://github.com/eggjs/egg-core#readme",
   "dependencies": {
-    "@eggjs/koa": "^2.18.2",
+    "@eggjs/koa": "^2.19.2",
     "@eggjs/router": "^3.0.5",
     "@eggjs/utils": "^4.0.2",
     "egg-logger": "^3.5.0",
@@ -66,7 +66,7 @@
     "mm": "3",
     "supertest": "7",
     "ts-node": "10",
-    "tshy": "1",
+    "tshy": "3",
     "tshy-after": "1",
     "typescript": "5",
     "urllib": "4"
@@ -86,17 +86,16 @@
     "./package.json": "./package.json",
     ".": {
       "import": {
-        "source": "./src/index.ts",
         "types": "./dist/esm/index.d.ts",
         "default": "./dist/esm/index.js"
       },
       "require": {
-        "source": "./src/index.ts",
         "types": "./dist/commonjs/index.d.ts",
         "default": "./dist/commonjs/index.js"
       }
     }
   },
   "main": "./dist/commonjs/index.js",
-  "types": "./dist/commonjs/index.d.ts"
+  "types": "./dist/commonjs/index.d.ts",
+  "module": "./dist/esm/index.js"
 }

src/egg.ts

@@ -1,8 +1,7 @@
 /* eslint-disable prefer-spread */
 import assert from 'node:assert';
 import { debuglog } from 'node:util';
-import is from 'is-type-of';
-import KoaApplication from '@eggjs/koa';
+import { Application as KoaApplication } from '@eggjs/koa';
 import type { ContextDelegation, MiddlewareFunc } from '@eggjs/koa';
 import { EggConsoleLogger } from 'egg-logger';
 import { RegisterOptions, ResourcesController, EggRouter as Router } from '@eggjs/router';
@@ -157,10 +156,8 @@ export class EggCore extends KoaApplication {
    * override koa's app.use, support generator function
    * @since 1.0.0
    */
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
   use(fn: MiddlewareFunc) {
-    assert(is.function(fn), 'app.use() requires a function');
+    assert(typeof fn === 'function', 'app.use() requires a function');
     debug('[use] add middleware: %o', fn._name || fn.name || '-');
     this.middleware.push(fn);
     return this;
@@ -226,7 +223,7 @@ export class EggCore extends KoaApplication {
    * Execute scope after loaded and before app start.
    *
    * Notice:
-   * This method is now NOT recommanded and reguarded as a deprecated one,
+   * This method is now NOT recommended and regarded as a deprecated one,
    * For plugin development, we should use `didLoad` instead.
    * For application development, we should use `willReady` instead.
    *
@@ -251,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

@@ -1,8 +1,8 @@
 import assert from 'node:assert';
 import { EventEmitter } from 'node:events';
 import { debuglog } from 'node:util';
-import is, { isClass } from 'is-type-of';
-import ReadyObject from 'get-ready';
+import { isClass } from 'is-type-of';
+import { Ready as ReadyObject } from 'get-ready';
 import type { ReadyFunctionArg } from 'get-ready';
 import { Ready } from 'ready-callback';
 import { EggConsoleLogger } from 'egg-logger';
@@ -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() {
@@ -184,7 +189,7 @@ export class Lifecycle extends EventEmitter {
   }
 
   registerBeforeClose(fn: Fun) {
-    assert(is.function(fn), 'argument should be function');
+    assert(typeof fn === 'function', 'argument should be function');
     assert(this.#isClosed === false, 'app has been closed');
     this.#closeFunctionSet.add(fn);
   }

src/loader/egg_loader.ts

@@ -2,10 +2,10 @@ import fs from 'node:fs';
 import path from 'node:path';
 import assert from 'node:assert';
 import { debuglog, inspect } from 'node:util';
-import is, { isAsyncFunction, isClass, isGeneratorFunction, isObject } from 'is-type-of';
 import homedir from 'node-homedir';
+import { isAsyncFunction, isClass, isGeneratorFunction, isObject, isPromise } from 'is-type-of';
 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 @@ export class EggLoader {
       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 @@ export class EggLoader {
       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 @@ export class EggLoader {
   //     "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 @@ export class EggLoader {
     }
 
     // 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 @@ export class EggLoader {
 
   #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/yadan@2.0.0/node_modules/yadan/node_modules',
       // 'node_modules/.pnpm/yadan@2.0.0/node_modules',  <- this is the sibling directory
       // 'node_modules/.pnpm/egg@2.33.1/node_modules/egg/node_modules',
       // 'node_modules/.pnpm/egg@2.33.1/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 @@ export class EggLoader {
     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')) {
@@ -1421,7 +1447,7 @@ export class EggLoader {
     let mod = await this.requireFile(fullpath);
     if (typeof mod === 'function' && !isClass(mod)) {
       mod = mod(...inject);
-      if (is.promise(mod)) {
+      if (isPromise(mod)) {
         mod = await mod;
       }
     }