egg 3.29.0 → 4.0.0-beta.2

package/{app/extend/context.js → src/app/extend/context.ts}

@@ -1,9 +1,7 @@
-'use strict';
-
-const { performance } = require('perf_hooks');
-const delegate = require('delegates');
-const { assign } = require('utility');
-const eggUtils = require('egg-core').utils;
+import { performance } from 'node:perf_hooks';
+import delegate from 'delegates';
+import { assign } from 'utility';
+import { utils } from '@eggjs/core';
 
 const HELPER = Symbol('Context#helper');
 const LOCALS = Symbol('Context#locals');
@@ -13,8 +11,7 @@ const CONTEXT_LOGGERS = Symbol('Context#logger');
 const CONTEXT_HTTPCLIENT = Symbol('Context#httpclient');
 const CONTEXT_ROUTER = Symbol('Context#router');
 
-const proto = module.exports = {
-
+const Context = {
   /**
    * Get the current visitor's cookies.
    */
@@ -45,7 +42,7 @@ const proto = module.exports = {
    * @param {Object} [options] - options for request.
    * @return {Object} see {@link ContextHttpClient#curl}
    */
-  curl(url, options) {
+  curl(url: string, options?: object) {
     return this.httpclient.curl(url, options);
   },
 
@@ -88,13 +85,13 @@ const proto = module.exports = {
   },
 
   /**
-   * Wrap app.loggers with context infomation,
+   * Wrap app.loggers with context information,
    * if a custom logger is defined by naming aLogger, then you can `ctx.getLogger('aLogger')`
    *
    * @param {String} name - logger name
    * @return {Logger} logger
    */
-  getLogger(name) {
+  getLogger(name: string) {
     if (this.app.config.logger.enableFastContextLogger) {
       return this.app.getLogger(name);
     }
@@ -211,25 +208,22 @@ const proto = module.exports = {
    * });
    * ```
    */
-  runInBackground(scope) {
+  runInBackground(scope: (ctx: any) => Promise<void>) {
     // try to use custom function name first
     /* istanbul ignore next */
-    const taskName = scope._name || scope.name || eggUtils.getCalleeFromStack(true);
-    scope._name = taskName;
-    this._runInBackground(scope);
+    const taskName = Reflect.get(scope, '_name') || scope.name || utils.getCalleeFromStack(true);
+    this._runInBackground(scope, taskName);
   },
 
   // let plugins or frameworks to reuse _runInBackground in some cases.
   // e.g.: https://github.com/eggjs/egg-mock/pull/78
-  _runInBackground(scope) {
+  _runInBackground(scope: (ctx: any) => Promise<void>, taskName: string) {
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
     const ctx = this;
     const start = performance.now();
-    /* istanbul ignore next */
-    const taskName = scope._name || scope.name || eggUtils.getCalleeFromStack(true);
     // use setImmediate to ensure all sync logic will run async
     return new Promise(resolve => setImmediate(resolve))
-      // use app.toAsyncFunction to support both generator function and async function
-      .then(() => ctx.app.toAsyncFunction(scope)(ctx))
+      .then(() => scope(ctx))
       .then(() => {
         ctx.coreLogger.info('[egg:background] task:%s success (%dms)',
           taskName, Math.floor((performance.now() - start) * 1000) / 1000);
@@ -244,13 +238,13 @@ const proto = module.exports = {
         ctx.app.emit('error', err, ctx);
       });
   },
-};
+} as any;
 
 /**
  * Context delegation.
  */
 
-delegate(proto, 'request')
+delegate(Context, 'request')
   /**
    * @member {Boolean} Context#acceptJSON
    * @see Request#acceptJSON
@@ -276,10 +270,12 @@ delegate(proto, 'request')
    */
   .access('ip');
 
-delegate(proto, 'response')
+delegate(Context, 'response')
   /**
    * @member {Number} Context#realStatus
    * @see Response#realStatus
    * @since 1.0.0
    */
   .access('realStatus');
+
+export default Context;

package/src/app/middleware/body_parser.ts

@@ -0,0 +1,3 @@
+import bodyparser from 'koa-bodyparser';
+
+export default bodyparser;

package/{app/middleware/meta.js → src/app/middleware/meta.ts}

@@ -2,12 +2,20 @@
  * meta middleware, should be the first middleware
  */
 
-const { performance } = require('perf_hooks');
+import { performance } from 'node:perf_hooks';
+import type { EggCoreContext } from '@eggjs/core';
+import type { Next } from '../../lib/type.js';
 
-module.exports = options => {
-  return async function meta(ctx, next) {
+export interface MetaMiddlewareOptions {
+  enable: boolean;
+  logging: boolean;
+}
+
+export default (options: MetaMiddlewareOptions) => {
+  return async function meta(ctx: EggCoreContext, next: Next) {
     if (options.logging) {
-      ctx.coreLogger.info('[meta] request started, host: %s, user-agent: %s', ctx.host, ctx.header['user-agent']);
+      ctx.coreLogger.info('[meta] request started, host: %s, user-agent: %s',
+        ctx.host, ctx.header['user-agent']);
     }
     await next();
     // total response time header

package/{app/middleware/notfound.js → src/app/middleware/notfound.ts}

@@ -1,7 +1,13 @@
-'use strict';
+import type { EggCoreContext } from '@eggjs/core';
+import type { Next } from '../../lib/type.js';
 
-module.exports = options => {
-  return async function notfound(ctx, next) {
+export interface NotFoundMiddlewareOptions {
+  enable: boolean;
+  pageUrl: string;
+}
+
+export default (options: NotFoundMiddlewareOptions) => {
+  return async function notfound(ctx: EggCoreContext, next: Next) {
     await next();
 
     if (ctx.status !== 404 || ctx.body) {

package/src/app/middleware/override_method.ts

@@ -0,0 +1,3 @@
+import override from 'koa-override';
+
+export default override;

package/src/app/middleware/site_file.ts

@@ -0,0 +1,70 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { readFile } from 'node:fs/promises';
+import type { EggCoreContext } from '@eggjs/core';
+import type { Next } from '../../lib/type.js';
+
+export type SiteFileContentFun = (ctx: EggCoreContext) => Promise<Buffer | string>;
+
+export interface SiteFileMiddlewareOptions {
+  enable: boolean;
+  cacheControl: string;
+  [key: string]: string | Buffer | boolean | SiteFileContentFun | URL;
+}
+
+const BUFFER_CACHE = Symbol('siteFile URL buffer cache');
+
+module.exports = (options: SiteFileMiddlewareOptions) => {
+  return async function siteFile(ctx: EggCoreContext, next: Next) {
+    if (ctx.method !== 'HEAD' && ctx.method !== 'GET') {
+      return next();
+    }
+    /* istanbul ignore if */
+    if (ctx.path[0] !== '/') {
+      return next();
+    }
+
+    let content = options[ctx.path];
+    if (!content) {
+      return next();
+    }
+
+    // '/favicon.ico': 'https://eggjs.org/favicon.ico' or '/favicon.ico': async (ctx) => 'https://eggjs.org/favicon.ico'
+    // content is function
+    if (typeof content === 'function') {
+      content = await content(ctx);
+    }
+    // content is url
+    if (typeof content === 'string') {
+      return ctx.redirect(content);
+    }
+
+    // URL
+    if (content instanceof URL) {
+      if (content.protocol !== 'file:') {
+        return ctx.redirect(content.href);
+      }
+      // protocol = file:
+      let buffer = Reflect.get(content, BUFFER_CACHE) as Buffer;
+      if (!buffer) {
+        buffer = await readFile(fileURLToPath(content));
+        Reflect.set(content, BUFFER_CACHE, buffer);
+      }
+      ctx.set('cache-control', options.cacheControl);
+      ctx.body = content;
+      ctx.type = path.extname(ctx.path);
+      return;
+    }
+
+    // '/robots.txt': Buffer <xx..
+    // content is buffer
+    if (Buffer.isBuffer(content)) {
+      ctx.set('cache-control', options.cacheControl);
+      ctx.body = content;
+      ctx.type = path.extname(ctx.path);
+      return;
+    }
+
+    return next();
+  };
+};

package/{config/config.default.js → src/config/config.default.ts}

@@ -1,18 +1,15 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import type { EggAppInfo } from '@eggjs/core';
+import type { EggAppConfig } from '../lib/type.js';
 
 /**
  * The configuration of egg application, can be access by `app.config`
  * @class Config
  * @since 1.0.0
  */
-
-module.exports = appInfo => {
-
-  const config = {
-
+export default (appInfo: EggAppInfo) => {
+  const config: Partial<EggAppConfig> = {
     /**
      * The environment of egg
      * @member {String} Config#env
@@ -131,7 +128,7 @@ module.exports = appInfo => {
     HOME: appInfo.HOME,
 
     /**
-     * The directory of server running. You can find `application_config.json` under it that is dumpped from `app.config`.
+     * The directory of server running. You can find `application_config.json` under it that is dumped from `app.config`.
      * @member {String} Config#rundir
      * @default
      * @since 1.0.0
@@ -153,7 +150,7 @@ module.exports = appInfo => {
         /secret/i,
       ]),
       timing: {
-        // if boot action >= slowBootActionMinDuration, egg core will print it to warnning log
+        // if boot action >= slowBootActionMinDuration, egg core will print it to warning log
         slowBootActionMinDuration: 5000,
       },
     },
@@ -176,7 +173,7 @@ module.exports = appInfo => {
   };
 
   /**
-   * The option of `notfound` middleware
+   * The options of `notfound` middleware
    *
    * It will return page or json depend on negotiation when 404,
    * If pageUrl is set, it will redirect to the page.
@@ -185,13 +182,14 @@ module.exports = appInfo => {
    * @property {String} pageUrl - the 404 page url
    */
   config.notfound = {
+    enable: true,
     pageUrl: '',
   };
 
   /**
    * The option of `siteFile` middleware
    *
-   * You can map some files using this options, it will response immdiately when matching.
+   * You can map some files using this options, it will response immediately when matching.
    *
    * @member {Object} Config#siteFile - key is path, and value is url or buffer.
    * @property {String} cacheControl - files cache , default is public, max-age=2592000
@@ -202,13 +200,14 @@ module.exports = appInfo => {
    * };
    */
   config.siteFile = {
-    '/favicon.ico': fs.readFileSync(path.join(__dirname, 'favicon.png')),
+    enable: true,
+    '/favicon.ico': pathToFileURL(path.join(__dirname, 'favicon.png')),
     // default cache in 30 days
     cacheControl: 'public, max-age=2592000',
   };
 
   /**
-   * The option of `bodyParser` middleware
+   * The options of `bodyParser` middleware
    *
    * @member Config#bodyParser
    * @property {Boolean} enable - enable bodyParser or not, default is true
@@ -236,8 +235,9 @@ module.exports = appInfo => {
       depth: 5,
       parameterLimit: 1000,
     },
+    onProtoPoisoning: 'error',
     onerror(err, ctx) {
-      err.message += ', check bodyParser config';
+      err.message = `${err.message}, check bodyParser config`;
       if (ctx.status === 404) {
         // set default status to 400, meaning client bad request
         ctx.status = 400;
@@ -264,8 +264,7 @@ module.exports = appInfo => {
    * @property {String} agentLogName - file name of agent worker log
    * @property {Object} coreLogger - custom config of coreLogger
    * @property {Boolean} allowDebugAtProd - allow debug log at prod, defaults to false
-   * @property {Boolean} enablePerformanceTimer - using performance.now() timer instead of Date.now() for more more precise milliseconds, defaults to false. e.g.: logger will set 1.456ms instead of 1ms.
-   * @property {Boolean} enableFastContextLogger - using the app logger instead of EggContextLogger, defaults to false
+   * @property {Boolean} enableFastContextLogger - using the app logger instead of EggContextLogger, defaults to true
    */
   config.logger = {
     dir: path.join(appInfo.root, 'logs', appInfo.name),
@@ -282,8 +281,7 @@ module.exports = appInfo => {
     errorLogName: 'common-error.log',
     coreLogger: {},
     allowDebugAtProd: false,
-    enablePerformanceTimer: false,
-    enableFastContextLogger: false,
+    enableFastContextLogger: true,
   };
 
   /**
@@ -303,39 +301,20 @@ module.exports = appInfo => {
    * @property {Number} httpsAgent.freeSocketTimeout - httpss agent socket keepalive max free time, default is 4000 ms.
    * @property {Number} httpsAgent.maxSockets - https agent max socket number of one host, default is `Number.MAX_SAFE_INTEGER` @ses https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
    * @property {Number} httpsAgent.maxFreeSockets - https agent max free socket number of one host, default is 256.
-   * @property {Boolean} useHttpClientNext - use urllib@3 HttpClient, default is false
-   * @property {Boolean} allowH2 - use urllib@4 HttpClient and enable H2, default is false. Only works on Node.js >= 18
+   * @property {Boolean} useHttpClientNext - use urllib@3 HttpClient
    */
   config.httpclient = {
-    enableDNSCache: false,
-    dnsCacheLookupInterval: 10000,
-    dnsCacheMaxLength: 1000,
-
     request: {
       timeout: 5000,
     },
-    httpAgent: {
-      keepAlive: true,
-      freeSocketTimeout: 4000,
-      maxSockets: Number.MAX_SAFE_INTEGER,
-      maxFreeSockets: 256,
-    },
-    httpsAgent: {
-      keepAlive: true,
-      freeSocketTimeout: 4000,
-      maxSockets: Number.MAX_SAFE_INTEGER,
-      maxFreeSockets: 256,
-    },
-    useHttpClientNext: false,
-    // allowH2: false,
   };
 
   /**
-   * The option of `meta` middleware
+   * The options of `meta` middleware
    *
    * @member Config#meta
-   * @property {Boolean} enable - enable meta or not, default is true
-   * @property {Boolean} logging - enable logging start request, default is false
+   * @property {Boolean} enable - enable meta or not, default is `true`
+   * @property {Boolean} logging - enable logging start request, default is `false`
    */
   config.meta = {
     enable: true,
@@ -371,7 +350,7 @@ module.exports = appInfo => {
   config.serverTimeout = null;
 
   /**
-   *
+   * The options of cluster
    * @member {Object} Config#cluster
    * @property {Object} listen - listen options, see {@link https://nodejs.org/api/http.html#http_server_listen_port_hostname_backlog_callback}
    * @property {String} listen.path - set a unix sock path when server listen
@@ -418,7 +397,7 @@ module.exports = appInfo => {
    *   };
    * }
    */
-  config.onClientError = null;
+  config.onClientError = undefined;
 
   return config;
 };

package/src/config/config.local.ts

@@ -0,0 +1,11 @@
+import type { EggAppConfig } from '../lib/type.js';
+
+export default () => {
+  return {
+    logger: {
+      coreLogger: {
+        consoleLevel: 'WARN',
+      },
+    },
+  } satisfies Partial<EggAppConfig>;
+};

package/src/config/config.unittest.ts

@@ -0,0 +1,10 @@
+import type { EggAppConfig } from '../lib/type.js';
+
+export default () => {
+  return {
+    logger: {
+      consoleLevel: 'WARN',
+      buffer: false,
+    },
+  } satisfies Partial<EggAppConfig>;
+};

package/{config/plugin.js → src/config/plugin.ts}

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = {
+export default {
   // enable plugins
 
   /**

package/src/index.ts

@@ -0,0 +1,78 @@
+/**
+ * @namespace Egg
+ */
+
+import { BaseContextClass } from './lib/core/base_context_class.js';
+import { startEgg } from './lib/start.js';
+
+// export types
+export * from './lib/egg.js';
+export * from './lib/type.js';
+export * from './lib/start.js';
+
+/**
+ * Start egg application with cluster mode
+ * @since 1.0.0
+ */
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+export { startCluster } from 'egg-cluster';
+
+/**
+ * Start egg application with single process mode
+ * @since 1.0.0
+ */
+export const start = startEgg;
+
+/**
+ * @member {Application} Egg#Application
+ * @since 1.0.0
+ */
+export { Application } from './lib/application.js';
+
+/**
+ * @member {Agent} Egg#Agent
+ * @since 1.0.0
+ */
+export { Agent } from './lib/agent.js';
+
+/**
+ * @member {AppWorkerLoader} Egg#AppWorkerLoader
+ * @since 1.0.0
+ */
+
+/**
+ * @member {AgentWorkerLoader} Egg#AgentWorkerLoader
+ * @since 1.0.0
+ */
+
+export { AppWorkerLoader, AgentWorkerLoader } from './lib/loader/index.js';
+
+/**
+ * @member {Controller} Egg#Controller
+ * @since 1.1.0
+ */
+export const Controller = BaseContextClass;
+
+/**
+ * @member {Service} Egg#Service
+ * @since 1.1.0
+ */
+export const Service = BaseContextClass;
+
+/**
+ * @member {Subscription} Egg#Subscription
+ * @since 1.10.0
+ */
+export const Subscription = BaseContextClass;
+
+/**
+ * @member {BaseContextClass} Egg#BaseContextClass
+ * @since 1.2.0
+ */
+export { BaseContextClass } from './lib/core/base_context_class.js';
+
+/**
+ * @member {Boot} Egg#Boot
+ */
+export { BaseHookClass as Boot } from './lib/core/base_hook_class.js';

package/src/lib/agent.ts

@@ -0,0 +1,66 @@
+import { EggLogger } from 'egg-logger';
+import { EggApplicationCore, EggApplicationCoreOptions } from './egg.js';
+import { AgentWorkerLoader } from './loader/index.js';
+
+const EGG_LOADER = Symbol.for('egg#loader');
+
+/**
+ * Singleton instance in Agent Worker, extend {@link EggApplicationCore}
+ * @augments EggApplicationCore
+ */
+export class Agent extends EggApplicationCore {
+  readonly #agentAliveHandler: NodeJS.Timeout;
+
+  /**
+   * @class
+   * @param {Object} options - see {@link EggApplicationCore}
+   */
+  constructor(options?: Omit<EggApplicationCoreOptions, 'type'>) {
+    super({
+      ...options,
+      type: 'agent',
+    });
+
+    // keep agent alive even it doesn't have any io tasks
+    this.#agentAliveHandler = setInterval(() => {
+      this.coreLogger.info('[]');
+    }, 24 * 60 * 60 * 1000);
+  }
+
+  get [EGG_LOADER]() {
+    return AgentWorkerLoader;
+  }
+
+  _wrapMessenger() {
+    for (const methodName of [
+      'broadcast',
+      'sendTo',
+      'sendToApp',
+      'sendToAgent',
+      'sendRandom',
+    ]) {
+      wrapMethod(methodName, this.messenger, this.coreLogger);
+    }
+
+    function wrapMethod(methodName: string, messenger: any, logger: EggLogger) {
+      const originMethod = messenger[methodName];
+      messenger[methodName] = function(...args: any[]) {
+        const stack = new Error().stack!.split('\n').slice(1).join('\n');
+        logger.warn(
+          "agent can't call %s before server started\n%s",
+          methodName,
+          stack,
+        );
+        originMethod.apply(this, args);
+      };
+      messenger.prependOnceListener('egg-ready', () => {
+        messenger[methodName] = originMethod;
+      });
+    }
+  }
+
+  async close() {
+    clearInterval(this.#agentAliveHandler);
+    await super.close();
+  }
+}