egg 3.29.0 → 4.0.0-beta.10

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

@@ -1,17 +1,21 @@
-'use strict';
+import querystring from 'node:querystring';
+import { Request as EggCoreRequest } from '@eggjs/core';
+import type { Application } from '../../lib/application.js';
+import type { ContextDelegation } from './context.js';
+import Response from './response.js';
 
-const querystring = require('querystring');
-const accepts = require('accepts');
-
-const _querycache = Symbol('_querycache');
-const _queriesCache = Symbol('_queriesCache');
-const PROTOCOL = Symbol('PROTOCOL');
-const HOST = Symbol('HOST');
-const ACCEPTS = Symbol('ACCEPTS');
-const IPS = Symbol('IPS');
+const QUERY_CACHE = Symbol('request query cache');
+const QUERIES_CACHE = Symbol('request queries cache');
+const PROTOCOL = Symbol('request protocol');
+const HOST = Symbol('request host');
+const IPS = Symbol('request ips');
 const RE_ARRAY_KEY = /[^\[\]]+\[\]$/;
 
-module.exports = {
+export default class Request extends EggCoreRequest {
+  declare app: Application;
+  declare ctx: ContextDelegation;
+  declare response: Response;
+
   /**
    * Parse the "Host" header field host
    * and support X-Forwarded-Host when a
@@ -29,17 +33,19 @@ module.exports = {
    * => 'demo.eggjs.org'
    * ```
    */
-  get host() {
-    if (this[HOST]) return this[HOST];
+  get host(): string {
+    let host = this[HOST] as string | undefined;
+    if (host) {
+      return host;
+    }
 
-    let host;
     if (this.app.config.proxy) {
       host = getFromHeaders(this, this.app.config.hostHeaders);
     }
     host = host || this.get('host') || '';
-    this[HOST] = host.split(/\s*,\s*/)[0];
-    return this[HOST];
-  },
+    this[HOST] = host = host.split(',')[0].trim();
+    return host;
+  }
 
   /**
    * @member {String} Request#protocol
@@ -49,25 +55,28 @@ module.exports = {
    * => 'https'
    * ```
    */
-  get protocol() {
-    if (this[PROTOCOL]) return this[PROTOCOL];
+  get protocol(): string {
+    let protocol = this[PROTOCOL] as string;
+    if (protocol) {
+      return protocol;
+    }
     // detect encrypted socket
-    if (this.socket && this.socket.encrypted) {
-      this[PROTOCOL] = 'https';
-      return this[PROTOCOL];
+    if (this.socket?.encrypted) {
+      this[PROTOCOL] = protocol = 'https';
+      return protocol;
     }
     // get from headers specified in `app.config.protocolHeaders`
     if (this.app.config.proxy) {
       const proto = getFromHeaders(this, this.app.config.protocolHeaders);
       if (proto) {
-        this[PROTOCOL] = proto.split(/\s*,\s*/)[0];
-        return this[PROTOCOL];
+        this[PROTOCOL] = protocol = proto.split(/\s*,\s*/)[0];
+        return protocol;
       }
     }
-    // use protocol specified in `app.conig.protocol`
-    this[PROTOCOL] = this.app.config.protocol || 'http';
-    return this[PROTOCOL];
-  },
+    // use protocol specified in `app.config.protocol`
+    this[PROTOCOL] = protocol = this.app.config.protocol || 'http';
+    return protocol;
+  }
 
   /**
    * Get all pass through ip addresses from the request.
@@ -80,29 +89,34 @@ module.exports = {
    * => ['100.23.1.2', '201.10.10.2']
    * ```
    */
-  get ips() {
-    if (this[IPS]) return this[IPS];
+  get ips(): string[] {
+    let ips = this[IPS] as string[] | undefined;
+    if (ips) {
+      return ips;
+    }
 
     // return empty array when proxy=false
     if (!this.app.config.proxy) {
-      this[IPS] = [];
-      return this[IPS];
+      this[IPS] = ips = [];
+      return ips;
     }
 
-    const val = getFromHeaders(this, this.app.config.ipHeaders) || '';
-    this[IPS] = val ? val.split(/\s*,\s*/) : [];
+    const val = getFromHeaders(this, this.app.config.ipHeaders);
+    this[IPS] = ips = val ? val.split(/\s*,\s*/) : [];
 
     let maxIpsCount = this.app.config.maxIpsCount;
     // Compatible with maxProxyCount logic (previous logic is wrong, only for compatibility with legacy logic)
-    if (!maxIpsCount && this.app.config.maxProxyCount) maxIpsCount = this.app.config.maxProxyCount + 1;
+    if (!maxIpsCount && this.app.config.maxProxyCount) {
+      maxIpsCount = this.app.config.maxProxyCount + 1;
+    }
 
     if (maxIpsCount > 0) {
       // if maxIpsCount present, only keep `maxIpsCount` ips
       // [ illegalIp, clientRealIp, proxyIp1, proxyIp2 ...]
-      this[IPS] = this[IPS].slice(-maxIpsCount);
+      this[IPS] = ips = ips.slice(-maxIpsCount);
     }
-    return this[IPS];
-  },
+    return ips;
+  }
 
   /**
    * Get the request remote IPv4 address
@@ -115,16 +129,16 @@ module.exports = {
    * => '111.10.2.1'
    * ```
    */
-  get ip() {
+  get ip(): string {
     if (this._ip) {
       return this._ip;
     }
-    const ip = this.ips[0] || this.socket.remoteAddress;
+    const ip = this.ips[0] ?? this.socket.remoteAddress;
     // will be '::ffff:x.x.x.x', should convert to standard IPv4 format
     // https://zh.wikipedia.org/wiki/IPv6
-    this._ip = ip && ip.indexOf('::ffff:') > -1 ? ip.substring(7) : ip;
+    this._ip = ip && ip.startsWith('::ffff:') ? ip.substring(7) : ip;
     return this._ip;
-  },
+  }
 
   /**
    * Set the request remote IPv4 address
@@ -137,9 +151,9 @@ module.exports = {
    * => '111.10.2.1'
    * ```
    */
-  set ip(ip) {
+  set ip(ip: string) {
     this._ip = ip;
-  },
+  }
 
   /**
    * detect if response should be json
@@ -150,25 +164,25 @@ module.exports = {
    * @member {Boolean} Request#acceptJSON
    * @since 1.0.0
    */
-  get acceptJSON() {
+  get acceptJSON(): boolean {
     if (this.path.endsWith('.json')) return true;
     if (this.response.type && this.response.type.indexOf('json') >= 0) return true;
     if (this.accepts('html', 'text', 'json') === 'json') return true;
     return false;
-  },
+  }
 
   // How to read query safely
   // https://github.com/koajs/qs/issues/5
-  _customQuery(cacheName, filter) {
+  _customQuery(cacheName: symbol, filter: (value: string | string[]) => string | string[]) {
     const str = this.querystring || '';
-    let c = this[cacheName];
+    let c = this[cacheName] as Record<string, Record<string, string | string[]>>;
     if (!c) {
       c = this[cacheName] = {};
     }
     let cacheQuery = c[str];
     if (!cacheQuery) {
       cacheQuery = c[str] = {};
-      const isQueries = cacheName === _queriesCache;
+      const isQueries = cacheName === QUERIES_CACHE;
       // `querystring.parse` CANNOT parse something like `a[foo]=1&a[bar]=2`
       const query = str ? querystring.parse(str) : {};
       for (const key in query) {
@@ -176,20 +190,19 @@ module.exports = {
           // key is '', like `a=b&`
           continue;
         }
-        const value = filter(query[key]);
+        const value = filter(query[key]!);
         cacheQuery[key] = value;
         if (isQueries && RE_ARRAY_KEY.test(key)) {
           // `this.queries['key'] => this.queries['key[]']` is compatibly supported
-          const subkey = key.substring(0, key.length - 2);
-
-          if (!cacheQuery[subkey]) {
-            cacheQuery[subkey] = value;
+          const subKey = key.substring(0, key.length - 2);
+          if (!cacheQuery[subKey]) {
+            cacheQuery[subKey] = value;
           }
         }
       }
     }
     return cacheQuery;
-  },
+  }
 
   /**
    * get params pass by querystring, all values are of string type.
@@ -212,8 +225,8 @@ module.exports = {
    * ```
    */
   get query() {
-    return this._customQuery(_querycache, firstValue);
-  },
+    return this._customQuery(QUERY_CACHE, firstValue) as Record<string, string>;
+  }
 
   /**
    * get params pass by querystring, all value are Array type. {@link Request#query}
@@ -232,50 +245,39 @@ module.exports = {
    * ```
    */
   get queries() {
-    return this._customQuery(_queriesCache, arrayValue);
-  },
-
-  get accept() {
-    let accept = this[ACCEPTS];
-    if (accept) {
-      return accept;
-    }
-    accept = this[ACCEPTS] = accepts(this.req);
-    return accept;
-  },
+    return this._customQuery(QUERIES_CACHE, arrayValue) as Record<string, string[]>;
+  }
 
   /**
    * Set query-string as an object.
    *
    * @function Request#query
    * @param {Object} obj set querystring and query object for request.
-   * @return {void}
    */
-  set query(obj) {
+  set query(obj: Record<string, string>) {
     this.querystring = querystring.stringify(obj);
-  },
-};
-
+  }
+}
 
-function firstValue(value) {
+function firstValue(value: string | string[]) {
   if (Array.isArray(value)) {
     value = value[0];
   }
   return value;
 }
 
-function arrayValue(value) {
+function arrayValue(value: string | string[]) {
   if (!Array.isArray(value)) {
     value = [ value ];
   }
   return value;
 }
 
-function getFromHeaders(ctx, names) {
+function getFromHeaders(request: Request, names: string) {
   if (!names) return '';
-  names = names.split(/\s*,\s*/);
-  for (const name of names) {
-    const value = ctx.get(name);
+  const fields = names.split(/\s*,\s*/);
+  for (const name of fields) {
+    const value = request.get<string>(name);
     if (value) return value;
   }
   return '';

package/src/app/extend/response.ts

@@ -0,0 +1,36 @@
+import { Response as KoaResponse } from '@eggjs/core';
+
+const REAL_STATUS = Symbol('response realStatus');
+
+export default class Response extends KoaResponse {
+  /**
+   * Get or set a real status code.
+   *
+   * e.g.: Using 302 status redirect to the global error page
+   * instead of show current 500 status page.
+   * And access log should save 500 not 302,
+   * then the `realStatus` can help us find out the real status code.
+   * @member {Number} Response#realStatus
+   * @return {Number} The status code to be set.
+   */
+  get realStatus(): number {
+    if (this[REAL_STATUS]) {
+      return this[REAL_STATUS] as number;
+    }
+    return this.status;
+  }
+
+  /**
+   * Set a real status code.
+   *
+   * e.g.: Using 302 status redirect to the global error page
+   * instead of show current 500 status page.
+   * And access log should save 500 not 302,
+   * then the `realStatus` can help us find out the real status code.
+   * @member {Number} Response#realStatus
+   * @param {Number} status The status code to be set.
+   */
+  set realStatus(status: number) {
+    this[REAL_STATUS] = status;
+  }
+}

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,19 @@
  * meta middleware, should be the first middleware
  */
 
-const { performance } = require('perf_hooks');
+import { performance } from 'node:perf_hooks';
+import type { ContextDelegation, Next } from '../../lib/egg.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: ContextDelegation, 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,12 @@
-'use strict';
+import type { Next, ContextDelegation } from '../../lib/egg.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: ContextDelegation, 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,68 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { readFile } from 'node:fs/promises';
+import type { Next, ContextDelegation } from '../../lib/egg.js';
+
+export type SiteFileContentFun = (ctx: ContextDelegation) => 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');
+
+export default (options: SiteFileMiddlewareOptions) => {
+  return async function siteFile(ctx: ContextDelegation, next: Next) {
+    if (ctx.method !== 'HEAD' && ctx.method !== 'GET') {
+      return next();
+    }
+    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,16 @@
-'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';
+import { getSourceFile } from '../lib/utils.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 +129,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 +151,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 +174,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 +183,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 +201,14 @@ module.exports = appInfo => {
    * };
    */
   config.siteFile = {
-    '/favicon.ico': fs.readFileSync(path.join(__dirname, 'favicon.png')),
+    enable: true,
+    '/favicon.ico': pathToFileURL(getSourceFile('config/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 +236,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 +265,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 +282,7 @@ module.exports = appInfo => {
     errorLogName: 'common-error.log',
     coreLogger: {},
     allowDebugAtProd: false,
-    enablePerformanceTimer: false,
-    enableFastContextLogger: false,
+    enableFastContextLogger: true,
   };
 
   /**
@@ -303,39 +302,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 +351,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 +398,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>;
+};