@eggjs/koa 2.20.7 → 2.22.0

package/src/application.ts

@@ -1,15 +1,16 @@
-import { debuglog } from 'node:util';
+import util, { debuglog } from 'node:util';
 import Emitter from 'node:events';
-import util from 'node:util';
 import Stream from 'node:stream';
 import http from 'node:http';
 import type { AsyncLocalStorage } from 'node:async_hooks';
 import type { IncomingMessage, ServerResponse } from 'node:http';
+
 import { getAsyncLocalStorage } from 'gals';
 import { isGeneratorFunction } from 'is-type-of';
 import onFinished from 'on-finished';
 import statuses from 'statuses';
 import compose from 'koa-compose';
+
 import { HttpError } from 'http-errors';
 import { Context } from './context.js';
 import { Request } from './request.js';
@@ -18,10 +19,13 @@ import type { CustomError, AnyProto } from './types.js';
 
 const debug = debuglog('@eggjs/koa/application');
 
-export type ProtoImplClass<T = object> = new(...args: any[]) => T;
+// oxlint-disable-next-line typescript/no-explicit-any
+export type ProtoImplClass<T = object> = new (...args: any[]) => T;
 export type Next = () => Promise<void>;
 type _MiddlewareFunc<T> = (ctx: T, next: Next) => Promise<void> | void;
-export type MiddlewareFunc<T = Context> = _MiddlewareFunc<T> & { _name?: string };
+export type MiddlewareFunc<T extends Context = Context> = _MiddlewareFunc<T> & {
+  _name?: string;
+};
 
 /**
  * Expose `Application` class.
@@ -53,15 +57,15 @@ export class Application extends Emitter {
 
   /**
    * Initialize a new `Application`.
-    *
-    * @param {object} [options] Application options
-    * @param {string} [options.env='development'] Environment
-    * @param {string[]} [options.keys] Signed cookie keys
-    * @param {boolean} [options.proxy] Trust proxy headers
-    * @param {number} [options.subdomainOffset] Subdomain offset
-    * @param {string} [options.proxyIpHeader] Proxy IP header, defaults to X-Forwarded-For
-    * @param {number} [options.maxIpsCount] Max IPs read from proxy IP header, default to 0 (means infinity)
-    */
+   *
+   * @param {object} [options] Application options
+   * @param {string} [options.env] Environment, default is `development`
+   * @param {string[]} [options.keys] Signed cookie keys
+   * @param {boolean} [options.proxy] Trust proxy headers
+   * @param {number} [options.subdomainOffset] Subdomain offset
+   * @param {string} [options.proxyIpHeader] Proxy IP header, defaults to X-Forwarded-For
+   * @param {number} [options.maxIpsCount] Max IPs read from proxy IP header, default to 0 (means infinity)
+   */
 
   constructor(options?: {
     proxy?: boolean;
@@ -84,11 +88,14 @@ export class Application extends Emitter {
     this.middleware = [];
     this.ctxStorage = getAsyncLocalStorage();
     this.silent = false;
-    this.ContextClass = class ApplicationContext extends Context {} as ProtoImplClass<Context>;
+    this.ContextClass =
+      class ApplicationContext extends Context {} as ProtoImplClass<Context>;
     this.context = this.ContextClass.prototype;
-    this.RequestClass = class ApplicationRequest extends Request {} as ProtoImplClass<Request>;
+    this.RequestClass =
+      class ApplicationRequest extends Request {} as ProtoImplClass<Request>;
     this.request = this.RequestClass.prototype;
-    this.ResponseClass = class ApplicationResponse extends Response {} as ProtoImplClass<Response>;
+    this.ResponseClass =
+      class ApplicationResponse extends Response {} as ProtoImplClass<Response>;
     this.response = this.ResponseClass.prototype;
   }
 
@@ -119,6 +126,7 @@ export class Application extends Emitter {
    *
    *    http.createServer(app.callback()).listen(...)
    */
+  // oxlint-disable-next-line typescript/no-explicit-any
   listen(...args: any[]) {
     debug('listen with args: %o', args);
     const server = http.createServer(this.callback());
@@ -151,16 +159,19 @@ export class Application extends Emitter {
   /**
    * Use the given middleware `fn`.
    */
-  use(fn: MiddlewareFunc) {
-    if (typeof fn !== 'function') throw new TypeError('middleware must be a function!');
+  use<T extends Context = Context>(fn: MiddlewareFunc<T>) {
+    if (typeof fn !== 'function')
+      throw new TypeError('middleware must be a function!');
     const name = fn._name || fn.name || '-';
     if (isGeneratorFunction(fn)) {
-      throw new TypeError(`Support for generators was removed, middleware: ${name}. ` +
-        'See the documentation for examples of how to convert old middleware ' +
-        'https://github.com/koajs/koa/blob/master/docs/migration.md');
+      throw new TypeError(
+        `Support for generators was removed, middleware: ${name}. ` +
+          'See the documentation for examples of how to convert old middleware ' +
+          'https://github.com/koajs/koa/blob/master/docs/migration.md'
+      );
     }
     debug('use %o #%d', name, this.middleware.length);
-    this.middleware.push(fn);
+    this.middleware.push(fn as MiddlewareFunc<Context>);
     return this;
   }
 
@@ -196,12 +207,16 @@ export class Application extends Emitter {
    * Handle request in callback.
    * @private
    */
-  protected async handleRequest(ctx: Context, fnMiddleware: (ctx: Context) => Promise<void>) {
+  protected async handleRequest(
+    ctx: Context,
+    fnMiddleware: (ctx: Context) => Promise<void>
+  ) {
     this.emit('request', ctx);
     const res = ctx.res;
     res.statusCode = 404;
-    const onerror = (err: any) => ctx.onerror(err);
-    onFinished(res, (err: any) => {
+    const onerror = (err: CustomError) => ctx.onerror(err);
+    // oxlint-disable-next-line promise/prefer-await-to-callbacks
+    onFinished(res, (err: CustomError | null) => {
       if (err) {
         onerror(err);
       }
@@ -211,7 +226,7 @@ export class Application extends Emitter {
       await fnMiddleware(ctx);
       return this._respond(ctx);
     } catch (err) {
-      return onerror(err);
+      return onerror(err as CustomError);
     }
   }
 
@@ -232,15 +247,18 @@ export class Application extends Emitter {
     // When dealing with cross-globals a normal `instanceof` check doesn't work properly.
     // See https://github.com/koajs/koa/issues/1466
     // We can probably remove it once jest fixes https://github.com/facebook/jest/issues/2549.
-    const isNativeError = err instanceof Error ||
+    const isNativeError =
+      err instanceof Error ||
       Object.prototype.toString.call(err) === '[object Error]';
-    if (!isNativeError) throw new TypeError(util.format('non-error thrown: %j', err));
+    if (!isNativeError)
+      throw new TypeError(util.format('non-error thrown: %j', err));
 
     if (err.status === 404 || err.expose) return;
     if (this.silent) return;
 
     const msg = err.stack || err.toString();
-    console.error(`\n${msg.replace(/^/gm, '  ')}\n`);
+    // oxlint-disable-next-line no-console
+    console.error(`\n${msg.replaceAll(/^/gm, '  ')}\n`);
   }
 
   /**
@@ -272,7 +290,7 @@ export class Application extends Emitter {
     }
 
     // status body
-    if (body == null) {
+    if (body === null || body === undefined) {
       if (ctx.response._explicitNullBody) {
         ctx.response.remove('Content-Type');
         ctx.response.remove('Transfer-Encoding');

package/src/context.ts

@@ -1,11 +1,12 @@
 import util from 'node:util';
 import type { IncomingMessage, ServerResponse } from 'node:http';
-import { ParsedUrlQuery } from 'node:querystring';
+import type { ParsedUrlQuery } from 'node:querystring';
+
 import createError from 'http-errors';
-import httpAssert from 'http-assert';
 import statuses from 'statuses';
 import Cookies from 'cookies';
-import { type Accepts } from 'accepts';
+import type { Accepts } from 'accepts';
+
 import type { Application } from './application.js';
 import type { Request } from './request.js';
 import type { Response } from './response.js';
@@ -20,6 +21,7 @@ export class Context {
   response: Response & AnyProto;
   originalUrl: string;
   respond?: boolean;
+  // oxlint-disable-next-line typescript/no-explicit-any
   #state: Record<string, any> = {};
 
   constructor(app: Application, req: IncomingMessage, res: ServerResponse) {
@@ -27,10 +29,10 @@ export class Context {
     this.req = req;
     this.res = res;
     this.request = new app.RequestClass(app, this, req, res);
-    this.response = new app.ResponseClass(app, this as any, req, res);
+    this.response = new app.ResponseClass(app, this, req, res);
     this.request.response = this.response;
     this.response.request = this.request;
-    this.originalUrl = req.url!;
+    this.originalUrl = req.url ?? '/';
   }
 
   /**
@@ -72,20 +74,37 @@ export class Context {
   /**
    * Similar to .throw(), adds assertion.
    *
-   *    this.assert(this.user, 401, 'Please login!');
-   *
-   * See: https://github.com/jshttp/http-assert
-   * @param {Mixed} value
-   * @param {Number} status
-   * @param {String} opts
+   * ```ts
+   * this.assert(this.user, 401, 'Please login!');
+   * ```
    */
-  assert(value: any, status?: number, opts?: Record<string, any>): void;
-  assert(value: any, status?: number, msg?: string, opts?: Record<string, any>): void;
-  assert(value: any, status?: number, msgOrOptions?: string | Record<string, any>, opts?: Record<string, any>) {
-    if (typeof msgOrOptions === 'string') {
-      return httpAssert(value, status, msgOrOptions, opts);
+  assert(
+    value: unknown,
+    status?: number,
+    errorProps?: Record<string, unknown>
+  ): void;
+  assert(
+    value: unknown,
+    status?: number,
+    errorMessage?: string,
+    errorProps?: Record<string, unknown>
+  ): void;
+  assert(
+    value: unknown,
+    status?: number,
+    errorMessageOrProps?: string | Record<string, unknown>,
+    errorProps?: Record<string, unknown>
+  ) {
+    if (value) {
+      return;
+    }
+    status = status ?? 500;
+    if (typeof errorMessageOrProps === 'string') {
+      // assert(value, status, errorMessage, errorProps?)
+      throw createError(status, errorMessageOrProps, errorProps ?? {});
     }
-    return httpAssert(value, status, msgOrOptions);
+    // assert(value, status, errorProps?)
+    throw createError(status, errorMessageOrProps ?? {});
   }
 
   /**
@@ -124,7 +143,12 @@ export class Context {
   throw(error: Error, errorProps: object): void;
   throw(error: Error, status: number): void;
   throw(error: Error, status: number, errorProps: object): void;
-  throw(arg1: number | string | Error, arg2?: number | string | Error | object, errorProps?: object) {
+  throw(
+    arg1: number | string | Error,
+    arg2?: number | string | Error | object,
+    errorProps?: object
+  ) {
+    // oxlint-disable-next-line typescript/no-explicit-any
     const args: any[] = [];
     if (typeof arg2 === 'number') {
       // throw(error, status)
@@ -156,7 +180,8 @@ export class Context {
     // When dealing with cross-globals a normal `instanceof` check doesn't work properly.
     // See https://github.com/koajs/koa/issues/1466
     // We can probably remove it once jest fixes https://github.com/facebook/jest/issues/2549.
-    const isNativeError = err instanceof Error ||
+    const isNativeError =
+      err instanceof Error ||
       Object.prototype.toString.call(err) === '[object Error]';
     if (!isNativeError) {
       err = new Error(util.format('non-error thrown: %j', err));
@@ -164,7 +189,8 @@ export class Context {
 
     let headerSent = false;
     if (this.response.headerSent || !this.response.writable) {
-      headerSent = (err as any).headerSent = true;
+      headerSent = true;
+      err.headerSent = true;
     }
 
     // delegate
@@ -180,10 +206,14 @@ export class Context {
     const { res } = this;
 
     // first unset all headers
-    res.getHeaderNames().forEach(name => res.removeHeader(name));
+    for (const name of res.getHeaderNames()) {
+      res.removeHeader(name);
+    }
 
     // then set those specified
-    if (err.headers) this.response.set(err.headers);
+    if (err.headers) {
+      this.response.set(err.headers);
+    }
 
     // force text/plain
     this.response.type = 'text';
@@ -191,15 +221,20 @@ export class Context {
     let statusCode = err.status || err.statusCode;
 
     // ENOENT support
-    if (err.code === 'ENOENT') statusCode = 404;
+    if (err.code === 'ENOENT') {
+      statusCode = 404;
+    }
 
     // default to 500
-    if (typeof statusCode !== 'number' || !statuses.message[statusCode]) statusCode = 500;
+    if (typeof statusCode !== 'number' || !statuses.message[statusCode]) {
+      statusCode = 500;
+    }
 
     // respond
     const statusMessage = statuses.message[statusCode] as string;
     const msg = err.expose ? err.message : statusMessage;
-    this.response.status = err.status = statusCode;
+    err.status = statusCode;
+    this.response.status = statusCode;
     this.response.length = Buffer.byteLength(msg);
     res.end(msg);
   }
@@ -231,29 +266,43 @@ export class Context {
   acceptsLanguages(): string[];
   acceptsLanguages(languages: string[]): string | false;
   acceptsLanguages(...languages: string[]): string | false;
-  acceptsLanguages(languages?: string | string[], ...others: string[]): string | string[] | false {
-    return this.request.acceptsLanguages(languages as any, ...others);
+  acceptsLanguages(
+    languages?: string | string[],
+    ...others: string[]
+  ): string | string[] | false {
+    return this.request.acceptsLanguages(languages as string, ...others);
   }
 
   acceptsEncodings(): string[];
   acceptsEncodings(encodings: string[]): string | false;
   acceptsEncodings(...encodings: string[]): string | false;
-  acceptsEncodings(encodings?: string | string[], ...others: string[]): string[] | string | false {
-    return this.request.acceptsEncodings(encodings as any, ...others);
+  acceptsEncodings(
+    encodings?: string | string[],
+    ...others: string[]
+  ): string[] | string | false {
+    return this.request.acceptsEncodings(encodings as string, ...others);
   }
 
   acceptsCharsets(): string[];
   acceptsCharsets(charsets: string[]): string | false;
   acceptsCharsets(...charsets: string[]): string | false;
-  acceptsCharsets(charsets?: string | string[], ...others: string[]): string[] | string | false {
-    return this.request.acceptsCharsets(charsets as any, ...others);
+  acceptsCharsets(
+    charsets?: string | string[],
+    ...others: string[]
+  ): string[] | string | false {
+    return this.request.acceptsCharsets(charsets as string, ...others);
   }
 
-  accepts(...args: Parameters<Request['accepts']>): string | string[] | false {
-    return this.request.accepts(...args);
+  accepts(args: string[]): string | string[] | false;
+  accepts(...args: string[]): string | string[] | false;
+  accepts(
+    args?: string | string[],
+    ...others: string[]
+  ): string | string[] | false {
+    return this.request.accepts(args as string, ...others);
   }
 
-  get<T = string | string []>(field: string): T {
+  get<T = string | string[]>(field: string): T {
     return this.request.get(field);
   }
 
@@ -433,10 +482,12 @@ export class Context {
     this.response.message = msg;
   }
 
+  // oxlint-disable-next-line typescript/no-explicit-any
   get body(): any {
     return this.response.body;
   }
 
+  // oxlint-disable-next-line typescript/no-explicit-any
   set body(val: any) {
     this.response.body = val;
   }

package/src/index.ts

@@ -6,4 +6,4 @@ export * from './application.js';
 export * from './context.js';
 export * from './request.js';
 export * from './response.js';
-export * from './types.js';
+export type { CustomError, AnyProto } from './types.js';