egg 4.0.0-beta.0 → 4.0.0-beta.10

package/src/app/extend/context.types.ts

@@ -0,0 +1,24 @@
+import type {
+  Router,
+} from '@eggjs/core';
+import type {
+  HttpClientRequestURL, HttpClientRequestOptions, HttpClient,
+} from '../../lib/core/httpclient.js';
+import type {
+  ContextHttpClient,
+} from '../../lib/core/context_httpclient.js';
+import type Helper from './helper.js';
+import type { EggLogger } from 'egg-logger';
+
+declare module '@eggjs/core' {
+  // add Context overrides types
+  interface Context {
+    curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
+    get router(): Router;
+    set router(val: Router);
+    get helper(): Helper;
+    get httpclient(): ContextHttpClient;
+    get httpClient(): ContextHttpClient;
+    getLogger(name: string): EggLogger;
+  }
+}

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

@@ -1,10 +1,12 @@
-'use strict';
-
-const url = require('url');
-
-
-module.exports = {
+import url from 'node:url';
+import { BaseContextClass } from '../../lib/core/base_context_class.js';
 
+/**
+ * The Helper class which can be used as utility function.
+ * We support developers to extend Helper through ${baseDir}/app/extend/helper.js ,
+ * then you can use all method on `ctx.helper` that is a instance of Helper.
+ */
+export default class Helper extends BaseContextClass {
   /**
    * Generate URL path(without host) for route. Takes the route name and a map of named params.
    * @function Helper#pathFor
@@ -19,9 +21,9 @@ module.exports = {
    * ```
    * @return {String} url path(without host)
    */
-  pathFor(name, params) {
+  pathFor(name: string, params: Record<string, any>): string {
     return this.app.router.url(name, params);
-  },
+  }
 
   /**
    * Generate full URL(with host) for route. Takes the route name and a map of named params.
@@ -36,8 +38,7 @@ module.exports = {
    * ```
    * @return {String} full url(with host)
    */
-  urlFor(name, params) {
-    return this.ctx.protocol + '://' + this.ctx.host + url.resolve('/', this.app.router.url(name, params));
-  },
-
-};
+  urlFor(name: string, params: Record<string, any>): string {
+    return this.ctx.protocol + '://' + this.ctx.host + url.resolve('/', this.pathFor(name, params));
+  }
+}

package/src/app/extend/{request.js → 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/meta.ts

@@ -3,8 +3,7 @@
  */
 
 import { performance } from 'node:perf_hooks';
-import type { EggCoreContext } from '@eggjs/core';
-import type { Next } from '../../lib/type.js';
+import type { ContextDelegation, Next } from '../../lib/egg.js';
 
 export interface MetaMiddlewareOptions {
   enable: boolean;
@@ -12,7 +11,7 @@ export interface MetaMiddlewareOptions {
 }
 
 export default (options: MetaMiddlewareOptions) => {
-  return async function meta(ctx: EggCoreContext, next: Next) {
+  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']);

package/src/app/middleware/notfound.ts

@@ -1,5 +1,4 @@
-import type { EggCoreContext } from '@eggjs/core';
-import type { Next } from '../../lib/type.js';
+import type { Next, ContextDelegation } from '../../lib/egg.js';
 
 export interface NotFoundMiddlewareOptions {
   enable: boolean;
@@ -7,7 +6,7 @@ export interface NotFoundMiddlewareOptions {
 }
 
 export default (options: NotFoundMiddlewareOptions) => {
-  return async function notfound(ctx: EggCoreContext, next: Next) {
+  return async function notfound(ctx: ContextDelegation, next: Next) {
     await next();
 
     if (ctx.status !== 404 || ctx.body) {

package/src/app/middleware/site_file.ts

@@ -1,21 +1,23 @@
 import path from 'node:path';
-import type { EggCoreContext } from '@eggjs/core';
-import type { Next } from '../../lib/type.js';
+import { fileURLToPath } from 'node:url';
+import { readFile } from 'node:fs/promises';
+import type { Next, ContextDelegation } from '../../lib/egg.js';
 
-export type SiteFileContentFun = (ctx: EggCoreContext) => Promise<Buffer | string>;
+export type SiteFileContentFun = (ctx: ContextDelegation) => Promise<Buffer | string>;
 
 export interface SiteFileMiddlewareOptions {
   enable: boolean;
   cacheControl: string;
-  [key: string]: string | Buffer | boolean | SiteFileContentFun;
+  [key: string]: string | Buffer | boolean | SiteFileContentFun | URL;
 }
 
-module.exports = (options: SiteFileMiddlewareOptions) => {
-  return async function siteFile(ctx: EggCoreContext, next: Next) {
+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();
     }
-    /* istanbul ignore if */
     if (ctx.path[0] !== '/') {
       return next();
     }
@@ -35,6 +37,23 @@ module.exports = (options: SiteFileMiddlewareOptions) => {
       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)) {

package/src/config/config.default.ts

@@ -1,7 +1,8 @@
-import fs from 'node:fs';
 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`
@@ -189,7 +190,7 @@ export default (appInfo: EggAppInfo) => {
   /**
    * 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
@@ -201,7 +202,7 @@ export default (appInfo: EggAppInfo) => {
    */
   config.siteFile = {
     enable: true,
-    '/favicon.ico': fs.readFileSync(path.join(__dirname, 'favicon.png')),
+    '/favicon.ico': pathToFileURL(getSourceFile('config/favicon.png')),
     // default cache in 30 days
     cacheControl: 'public, max-age=2592000',
   };

package/src/config/plugin.ts

@@ -41,7 +41,7 @@ export default {
    */
   watcher: {
     enable: true,
-    package: 'egg-watcher',
+    package: '@eggjs/watcher',
   },
 
   /**
@@ -96,7 +96,7 @@ export default {
    */
   schedule: {
     enable: true,
-    package: 'egg-schedule',
+    package: '@eggjs/schedule',
   },
 
   /**

package/src/index.ts

@@ -4,6 +4,10 @@
 
 import { BaseContextClass } from './lib/core/base_context_class.js';
 import { startEgg } from './lib/start.js';
+import Helper from './app/extend/helper.js';
+
+// export extends
+export { Helper };
 
 // export types
 export * from './lib/egg.js';
@@ -14,9 +18,7 @@ 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';
+export * from '@eggjs/cluster';
 
 /**
  * Start egg application with single process mode

package/src/lib/application.ts

@@ -2,14 +2,16 @@ import path from 'node:path';
 import fs from 'node:fs';
 import http from 'node:http';
 import { Socket } from 'node:net';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import graceful from 'graceful';
+import { graceful } from 'graceful';
 import { assign } from 'utility';
 import { utils as eggUtils } from '@eggjs/core';
-import { EggApplicationCore, EggContext, EggApplicationCoreOptions } from './egg.js';
+import {
+  EggApplicationCore,
+  type EggApplicationCoreOptions,
+  type ContextDelegation,
+} from './egg.js';
 import { AppWorkerLoader } from './loader/index.js';
-import { BaseContextClass } from './core/base_context_class.js';
+import Helper from '../app/extend/helper.js';
 
 const EGG_LOADER = Symbol.for('egg#loader');
 
@@ -34,13 +36,6 @@ function escapeHeaderValue(value: string) {
   return /[\r\n]/.test(value) ? value.replace(/[\r\n]+[ \t]*/g, '') : value;
 }
 
-/**
- * The Helper class which can be used as utility function.
- * We support developers to extend Helper through ${baseDir}/app/extend/helper.js ,
- * then you can use all method on `ctx.helper` that is a instance of Helper.
- */
-class HelperClass extends BaseContextClass {}
-
 /**
  * Singleton instance in App Worker, extend {@link EggApplicationCore}
  * @augments EggApplicationCore
@@ -53,7 +48,7 @@ export class Application extends EggApplicationCore {
    * reference to {@link Helper}
    * @member {Helper} Application#Helper
    */
-  Helper = HelperClass;
+  Helper = Helper;
 
   /**
    * @class
@@ -77,8 +72,7 @@ export class Application extends EggApplicationCore {
   }
 
   #responseRaw(socket: Socket, raw?: any) {
-    /* istanbul ignore next */
-    if (!socket.writable) return;
+    if (!socket?.writable) return;
     if (!raw) {
       return socket.end(DEFAULT_BAD_REQUEST_RESPONSE);
     }
@@ -152,7 +146,6 @@ export class Application extends EggApplicationCore {
     // set ignore code
     const serverGracefulIgnoreCode = this.config.serverGracefulIgnoreCode || [];
 
-    /* istanbul ignore next */
     graceful({
       server: [ server ],
       error: (err: Error, throwErrorCount: number) => {
@@ -228,13 +221,13 @@ export class Application extends EggApplicationCore {
    * @see Context#runInBackground
    * @param {Function} scope - the first args is an anonymous ctx
    */
-  runInBackground(scope: (ctx: EggContext) => void) {
-    const ctx = this.createAnonymousContext();
+  runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, req?: unknown) {
+    const ctx = this.createAnonymousContext(req);
     if (!scope.name) {
       Reflect.set(scope, '_name', eggUtils.getCalleeFromStack(true));
     }
     this.ctxStorage.run(ctx, () => {
-      ctx.runInBackground(scope);
+      return ctx.runInBackground(scope);
     });
   }
 
@@ -244,13 +237,13 @@ export class Application extends EggApplicationCore {
    * @param {Function} scope - the first args is an anonymous ctx, scope should be async function
    * @param {Request} [req] - if you want to mock request like querystring, you can pass an object to this function.
    */
-  async runInAnonymousContextScope(scope: (ctx: EggContext) => Promise<void>, req?: unknown) {
+  async runInAnonymousContextScope(scope: (ctx: ContextDelegation) => Promise<void>, req?: unknown) {
     const ctx = this.createAnonymousContext(req);
     if (!scope.name) {
       Reflect.set(scope, '_name', eggUtils.getCalleeFromStack(true));
     }
     return await this.ctxStorage.run(ctx, async () => {
-      return await scope(ctx as EggContext);
+      return await scope(ctx);
     });
   }