egg 4.0.10 → 4.1.0-beta.3

package/src/app/extend/context.ts

@@ -1,332 +0,0 @@
-import { assign } from 'utility';
-import { now, diff } from 'performance-ms';
-import {
-  utils, Context as EggCoreContext, Router,
-} from '@eggjs/core';
-import type { Cookies as ContextCookies } from '@eggjs/cookies';
-import type { EggLogger } from 'egg-logger';
-import type { Application } from '../../lib/application.js';
-import type {
-  HttpClientRequestURL, HttpClientRequestOptions, HttpClient,
-} from '../../lib/core/httpclient.js';
-import type { BaseContextClass } from '../../lib//core/base_context_class.js';
-import type Request from './request.js';
-import type Response from './response.js';
-import type Helper from './helper.js';
-
-const HELPER = Symbol('ctx helper');
-const LOCALS = Symbol('ctx locals');
-const LOCALS_LIST = Symbol('ctx localsList');
-const COOKIES = Symbol('ctx cookies');
-const CONTEXT_HTTPCLIENT = Symbol('ctx httpclient');
-const CONTEXT_ROUTER = Symbol('ctx router');
-
-interface Cookies extends ContextCookies {
-  request: any;
-  response: any;
-}
-
-export default class Context extends EggCoreContext {
-  declare app: Application;
-  declare request: Request;
-  declare response: Response;
-  declare service: BaseContextClass;
-  declare proxy: any;
-
-  /**
-   * Request start time
-   * @member {Number} Context#starttime
-   */
-  starttime: number;
-  /**
-   * Request start timer using `performance.now()`
-   * @member {Number} Context#performanceStarttime
-   */
-  performanceStarttime: number;
-
-  /**
-   * Get the current visitor's cookies.
-   */
-  get cookies() {
-    let cookies = this[COOKIES];
-    if (!cookies) {
-      this[COOKIES] = cookies = new this.app.ContextCookies(this, this.app.keys, this.app.config.cookies);
-    }
-    return cookies as Cookies;
-  }
-
-  /**
-   * Get a wrapper httpclient instance contain ctx in the hold request process
-   *
-   * @return {HttpClient} the wrapper httpclient instance
-   */
-  get httpclient(): HttpClient {
-    if (!this[CONTEXT_HTTPCLIENT]) {
-      this[CONTEXT_HTTPCLIENT] = new this.app.ContextHttpClient(this as any);
-    }
-    return this[CONTEXT_HTTPCLIENT] as HttpClient;
-  }
-
-  /**
-   * Alias to {@link Context#httpclient}
-   */
-  get httpClient(): HttpClient {
-    return this.httpclient;
-  }
-
-  /**
-   * Shortcut for httpclient.curl
-   *
-   * @function Context#curl
-   * @param {String|Object} url - request url address.
-   * @param {Object} [options] - options for request.
-   * @return {Object} see {@link ContextHttpClient#curl}
-   */
-  async curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']> {
-    return await this.httpclient.curl(url, options);
-  }
-
-  /**
-   * Alias to {@link Application#router}
-   *
-   * @member {Router} Context#router
-   * @since 1.0.0
-   * @example
-   * ```js
-   * this.router.pathFor('post', { id: 12 });
-   * ```
-   */
-  get router(): Router {
-    if (this[CONTEXT_ROUTER]) {
-      return this[CONTEXT_ROUTER] as Router;
-    }
-    return this.app.router;
-  }
-
-  /**
-   * Set router to Context, only use on EggRouter
-   * @param {Router} val router instance
-   */
-  set router(val: Router) {
-    this[CONTEXT_ROUTER] = val;
-  }
-
-  /**
-   * Get helper instance from {@link Application#Helper}
-   *
-   * @member {Helper} Context#helper
-   * @since 1.0.0
-   */
-  get helper(): Helper {
-    if (!this[HELPER]) {
-      this[HELPER] = new this.app.Helper(this as any);
-    }
-    return this[HELPER] as Helper;
-  }
-
-  /**
-   * 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
-   */
-  getLogger(name: string): EggLogger {
-    return this.app.getLogger(name);
-  }
-
-  /**
-   * Logger for Application
-   *
-   * @member {Logger} Context#logger
-   * @since 1.0.0
-   * @example
-   * ```js
-   * this.logger.info('some request data: %j', this.request.body);
-   * this.logger.warn('WARNING!!!!');
-   * ```
-   */
-  get logger(): EggLogger {
-    return this.getLogger('logger');
-  }
-
-  /**
-   * Logger for frameworks and plugins
-   *
-   * @member {Logger} Context#coreLogger
-   * @since 1.0.0
-   */
-  get coreLogger(): EggLogger {
-    return this.getLogger('coreLogger');
-  }
-
-  /**
-   * locals is an object for view, you can use `app.locals` and `ctx.locals` to set variables,
-   * which will be used as data when view is rendering.
-   * The difference between `app.locals` and `ctx.locals` is the context level, `app.locals` is global level, and `ctx.locals` is request level. when you get `ctx.locals`, it will merge `app.locals`.
-   *
-   * when you set locals, only object is available
-   *
-   * ```js
-   * this.locals = {
-   *   a: 1
-   * };
-   * this.locals = {
-   *   b: 1
-   * };
-   * this.locals.c = 1;
-   * console.log(this.locals);
-   * {
-   *   a: 1,
-   *   b: 1,
-   *   c: 1,
-   * };
-   * ```
-   *
-   * `ctx.locals` has cache, it only merges `app.locals` once in one request.
-   *
-   * @member {Object} Context#locals
-   */
-  get locals() {
-    if (!this[LOCALS]) {
-      this[LOCALS] = assign({}, this.app.locals);
-    }
-    if (Array.isArray(this[LOCALS_LIST]) && this[LOCALS_LIST].length > 0) {
-      assign(this[LOCALS], this[LOCALS_LIST]);
-      this[LOCALS_LIST] = null;
-    }
-    return this[LOCALS] as Record<string, any>;
-  }
-
-  set locals(val) {
-    const localsList = this[LOCALS_LIST] as Record<string, any>[] ?? [];
-    localsList.push(val);
-    this[LOCALS_LIST] = localsList;
-  }
-
-  /**
-   * alias to {@link Context#locals}, compatible with koa that use this variable
-   * @member {Object} state
-   * @see Context#locals
-   */
-  get state() {
-    return this.locals;
-  }
-
-  set state(val) {
-    this.locals = val;
-  }
-
-  /**
-   * Run async function in the background
-   * @param {Function} scope - the first args is ctx
-   * ```js
-   * this.body = 'hi';
-   *
-   * this.runInBackground(async ctx => {
-   *   await ctx.mysql.query(sql);
-   *   await ctx.curl(url);
-   * });
-   * ```
-   */
-  runInBackground(scope: (ctx: Context) => Promise<void>, taskName?: string): void {
-    // try to use custom function name first
-    if (!taskName) {
-      taskName = Reflect.get(scope, '_name') || scope.name || utils.getCalleeFromStack(true);
-    }
-    // use setImmediate to ensure all sync logic will run async
-    setImmediate(() => {
-      this._runInBackground(scope, taskName!);
-    });
-  }
-
-  // let plugins or frameworks to reuse _runInBackground in some cases.
-  // e.g.: https://github.com/eggjs/egg-mock/pull/78
-  async _runInBackground(scope: (ctx: Context) => Promise<void>, taskName: string) {
-    const startTime = now();
-    try {
-      await scope(this as any);
-      this.coreLogger.info('[egg:background] task:%s success (%dms)', taskName, diff(startTime));
-    } catch (err: any) {
-      // background task process log
-      this.coreLogger.info('[egg:background] task:%s fail (%dms)', taskName, diff(startTime));
-
-      // emit error when promise catch, and set err.runInBackground flag
-      err.runInBackground = true;
-      this.app.emit('error', err, this);
-    }
-  }
-
-  /**
-   * @member {Boolean} Context#acceptJSON
-   * @see Request#acceptJSON
-   * @since 1.0.0
-   */
-  get acceptJSON(): boolean {
-    return this.request.acceptJSON;
-  }
-
-  get query(): Record<string, string> {
-    return this.request.query;
-  }
-
-  /**
-   * @member {Array} Context#queries
-   * @see Request#queries
-   * @since 1.0.0
-   */
-  get queries(): Record<string, string[]> {
-    return this.request.queries;
-  }
-
-  /**
-   * @member {string} Context#ip
-   * @see Request#ip
-   * @since 1.0.0
-   */
-  get ip(): string {
-    return this.request.ip;
-  }
-
-  set ip(val: string) {
-    this.request.ip = val;
-  }
-
-  /**
-   * @member {Number} Context#realStatus
-   * @see Response#realStatus
-   * @since 1.0.0
-   */
-  get realStatus(): number {
-    return this.response.realStatus;
-  }
-
-  set realStatus(val: number) {
-    this.response.realStatus = val;
-  }
-}
-
-declare module '@eggjs/core' {
-  // add Context overrides types
-  interface Context {
-    proxy: any;
-    performanceStarttime: number;
-    starttime: number;
-    runInBackground(scope: (ctx: Context) => Promise<void>, taskName?: string): void;
-    _runInBackground(scope: (ctx: Context) => Promise<void>, taskName: string): void;
-    get acceptJSON(): boolean;
-    get query(): Record<string, string>;
-    get queries(): Record<string, string[]>;
-    curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
-    get router(): Router;
-    set router(val: Router);
-    get helper(): Helper;
-    get httpclient(): HttpClient;
-    get httpClient(): HttpClient;
-    getLogger(name: string): EggLogger;
-    get logger(): EggLogger;
-    get coreLogger(): EggLogger;
-    get locals(): Record<string, any>;
-    get realStatus(): number;
-    set realStatus(val: number);
-  }
-}

package/src/app/extend/request.ts

@@ -1,300 +0,0 @@
-import querystring from 'node:querystring';
-import { Request as EggCoreRequest } from '@eggjs/core';
-import type { Application } from '../../lib/application.js';
-import type Context from './context.js';
-import Response from './response.js';
-
-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 = /[^\[\]]+\[\]$/;
-
-export default class Request extends EggCoreRequest {
-  declare app: Application;
-  declare ctx: Context;
-  declare response: Response;
-
-  /**
-   * Request body, parsed from koa-bodyparser or @eggjs/multipart
-   */
-  declare body: any;
-
-  /**
-   * Parse the "Host" header field host
-   * and support X-Forwarded-Host when a
-   * proxy is enabled.
-   * @member {String} Request#host
-   * @example
-   * ip + port
-   * ```js
-   * this.request.host
-   * => '127.0.0.1:7001'
-   * ```
-   * or domain
-   * ```js
-   * this.request.host
-   * => 'demo.eggjs.org'
-   * ```
-   */
-  get host(): string {
-    let host = this[HOST] as string | undefined;
-    if (host) {
-      return host;
-    }
-
-    if (this.app.config.proxy) {
-      host = getFromHeaders(this, this.app.config.hostHeaders);
-    }
-    host = host || this.get('host') || '';
-    this[HOST] = host = host.split(',')[0].trim();
-    return host;
-  }
-
-  /**
-   * @member {String} Request#protocol
-   * @example
-   * ```js
-   * this.request.protocol
-   * => 'https'
-   * ```
-   */
-  get protocol(): string {
-    let protocol = this[PROTOCOL] as string;
-    if (protocol) {
-      return protocol;
-    }
-    // detect encrypted socket
-    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] = protocol = proto.split(/\s*,\s*/)[0];
-        return 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.
-   * Enable only on `app.config.proxy = true`
-   *
-   * @member {Array} Request#ips
-   * @example
-   * ```js
-   * this.request.ips
-   * => ['100.23.1.2', '201.10.10.2']
-   * ```
-   */
-  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] = ips = [];
-      return ips;
-    }
-
-    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 > 0) {
-      // if maxIpsCount present, only keep `maxIpsCount` ips
-      // [ illegalIp, clientRealIp, proxyIp1, proxyIp2 ...]
-      this[IPS] = ips = ips.slice(-maxIpsCount);
-    }
-    return ips;
-  }
-
-  /**
-   * Get the request remote IPv4 address
-   * @member {String} Request#ip
-   * @return {String} IPv4 address
-   * @example
-   * ```js
-   * this.request.ip
-   * => '127.0.0.1'
-   * => '111.10.2.1'
-   * ```
-   */
-  get ip(): string {
-    if (this._ip) {
-      return this._ip;
-    }
-    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.startsWith('::ffff:') ? ip.substring(7) : ip;
-    return this._ip;
-  }
-
-  /**
-   * Set the request remote IPv4 address
-   * @member {String} Request#ip
-   * @param {String} ip - IPv4 address
-   * @example
-   * ```js
-   * this.request.ip
-   * => '127.0.0.1'
-   * => '111.10.2.1'
-   * ```
-   */
-  set ip(ip: string) {
-    this._ip = ip;
-  }
-
-  /**
-   * detect if response should be json
-   * 1. url path ends with `.json`
-   * 2. response type is set to json
-   * 3. detect by request accept header
-   *
-   * @member {Boolean} Request#acceptJSON
-   * @since 1.0.0
-   */
-  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: symbol, filter: (value: string | string[]) => string | string[]) {
-    const str = this.querystring || '';
-    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 === 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) {
-        if (!key) {
-          // key is '', like `a=b&`
-          continue;
-        }
-        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;
-          }
-        }
-      }
-    }
-    return cacheQuery;
-  }
-
-  /**
-   * get params pass by querystring, all values are of string type.
-   * @member {Object} Request#query
-   * @example
-   * ```js
-   * GET http://127.0.0.1:7001?name=Foo&age=20&age=21
-   * this.query
-   * => { 'name': 'Foo', 'age': '20' }
-   *
-   * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
-   * this.query
-   * =>
-   * {
-   *   "a": "b",
-   *   "o[foo]": "bar",
-   *   "b[]": "1",
-   *   "e": "val"
-   * }
-   * ```
-   */
-  get query() {
-    return this._customQuery(QUERY_CACHE, firstValue) as Record<string, string>;
-  }
-
-  /**
-   * get params pass by querystring, all value are Array type. {@link Request#query}
-   * @member {Array} Request#queries
-   * @example
-   * ```js
-   * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
-   * this.queries
-   * =>
-   * {
-   *   "a": ["b", "c"],
-   *   "o[foo]": ["bar"],
-   *   "b[]": ["1", "2"],
-   *   "e": ["val"]
-   * }
-   * ```
-   */
-  get queries() {
-    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.
-   */
-  set query(obj: Record<string, string>) {
-    this.querystring = querystring.stringify(obj);
-  }
-}
-
-declare module '@eggjs/core' {
-  // add Request overrides types
-  interface Request {
-    body: any;
-    get acceptJSON(): boolean;
-    get query(): Record<string, string>;
-    set query(obj: Record<string, string>);
-    get queries(): Record<string, string[]>;
-  }
-}
-
-function firstValue(value: string | string[]) {
-  if (Array.isArray(value)) {
-    value = value[0];
-  }
-  return value;
-}
-
-function arrayValue(value: string | string[]) {
-  if (!Array.isArray(value)) {
-    value = [ value ];
-  }
-  return value;
-}
-
-function getFromHeaders(request: Request, names: string) {
-  if (!names) return '';
-  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/middleware/body_parser.ts

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

package/src/app/middleware/meta.ts

@@ -1,27 +0,0 @@
-/**
- * meta middleware, should be the first middleware
- */
-
-import { performance } from 'node:perf_hooks';
-import type { Context, Next } from '../../lib/egg.js';
-
-export interface MetaMiddlewareOptions {
-  enable: boolean;
-  logging: boolean;
-}
-
-export default (options: MetaMiddlewareOptions) => {
-  return async function meta(ctx: Context, next: Next) {
-    if (options.logging) {
-      ctx.coreLogger.info('[meta] request started, host: %s, user-agent: %s',
-        ctx.host, ctx.header['user-agent']);
-    }
-    await next();
-    // total response time header
-    if (ctx.performanceStarttime) {
-      ctx.set('x-readtime', Math.floor((performance.now() - ctx.performanceStarttime) * 1000) / 1000);
-    } else {
-      ctx.set('x-readtime', Date.now() - ctx.starttime);
-    }
-  };
-};

package/src/app/middleware/notfound.ts

@@ -1,41 +0,0 @@
-import type { Next, Context } from '../../lib/egg.js';
-
-export interface NotFoundMiddlewareOptions {
-  enable: boolean;
-  pageUrl: string;
-}
-
-export default (options: NotFoundMiddlewareOptions) => {
-  return async function notfound(ctx: Context, next: Next) {
-    await next();
-
-    if (ctx.status !== 404 || ctx.body) {
-      return;
-    }
-
-    // set status first, make sure set body not set status
-    ctx.status = 404;
-
-    if (ctx.acceptJSON) {
-      ctx.body = {
-        message: 'Not Found',
-      };
-      return;
-    }
-
-    const notFoundHtml = '<h1>404 Not Found</h1>';
-
-    // notfound handler is unimplemented
-    if (options.pageUrl && ctx.path === options.pageUrl) {
-      ctx.body = `${notFoundHtml}<p><pre><code>config.notfound.pageUrl(${options.pageUrl})</code></pre> is unimplemented</p>`;
-      return;
-    }
-
-    if (options.pageUrl) {
-      ctx.realStatus = 404;
-      ctx.redirect(options.pageUrl);
-      return;
-    }
-    ctx.body = notFoundHtml;
-  };
-};

package/src/app/middleware/override_method.ts

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