@eggjs/koa 2.21.0 → 2.22.1

package/src/context.ts

@@ -1,10 +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 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';
@@ -19,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) {
@@ -26,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 ?? '/';
   }
 
   /**
@@ -74,15 +77,24 @@ export class Context {
    * ```ts
    * this.assert(this.user, 401, 'Please login!');
    * ```
-   *
-   * @param {Mixed} value
-   * @param {Number} status
-   * @param {String} errorMessage
-   * @param {Object} errorProps
    */
-  assert(value: any, status?: number, errorProps?: Record<string, any>): void;
-  assert(value: any, status?: number, errorMessage?: string, errorProps?: Record<string, any>): void;
-  assert(value: any, status?: number, errorMessageOrProps?: string | Record<string, any>, errorProps?: Record<string, any>) {
+  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;
     }
@@ -131,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)
@@ -163,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));
@@ -171,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
@@ -187,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';
@@ -198,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);
   }
@@ -238,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);
   }
 
@@ -440,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';

package/src/request.ts

@@ -3,11 +3,13 @@ import { format as stringify } from 'node:url';
 import qs, { type ParsedUrlQuery } from 'node:querystring';
 import util from 'node:util';
 import type { IncomingMessage, ServerResponse } from 'node:http';
+
 import accepts, { type Accepts } from 'accepts';
 import contentType from 'content-type';
 import parse from 'parseurl';
 import typeis from 'type-is';
 import fresh from 'fresh';
+
 import type { Application } from './application.js';
 import type { Context } from './context.js';
 import type { Response } from './response.js';
@@ -25,12 +27,17 @@ export class Request {
   response: Response;
   originalUrl: string;
 
-  constructor(app: Application, ctx: Context, req: IncomingMessage, res: ServerResponse) {
+  constructor(
+    app: Application,
+    ctx: Context,
+    req: IncomingMessage,
+    res: ServerResponse
+  ) {
     this.app = app;
     this.req = req;
     this.res = res;
     this.ctx = ctx;
-    this.originalUrl = req.url!;
+    this.originalUrl = req.url ?? '/';
   }
 
   /**
@@ -70,7 +77,7 @@ export class Request {
    */
 
   get url() {
-    return this.req.url!;
+    return this.req.url ?? '/';
   }
 
   /**
@@ -95,7 +102,9 @@ export class Request {
 
   get href() {
     // support: `GET http://example.com/foo`
-    if (/^https?:\/\//i.test(this.originalUrl)) return this.originalUrl;
+    if (/^https?:\/\//i.test(this.originalUrl)) {
+      return this.originalUrl;
+    }
     return this.origin + this.originalUrl;
   }
 
@@ -104,34 +113,32 @@ export class Request {
    */
 
   get method() {
-    return this.req.method!;
+    return this.req.method ?? 'GET';
   }
 
   /**
    * Set request method.
    */
-
-  set method(val) {
+  set method(val: string) {
     this.req.method = val;
   }
 
   /**
    * Get request pathname.
    */
-
   get path() {
-    return parse(this.req)!.pathname as string;
+    return parse(this.req)?.pathname ?? '';
   }
 
   /**
    * Set pathname, retaining the query string when present.
    */
+  set path(pathname: string) {
+    const url = parse(this.req);
+    if (!url) return;
+    if (url.pathname === pathname) return;
 
-  set path(path) {
-    const url = parse(this.req)!;
-    if (url.pathname === path) return;
-
-    url.pathname = path;
+    url.pathname = pathname;
     url.path = null;
 
     this.url = stringify(url);
@@ -149,7 +156,8 @@ export class Request {
     }
     let parsedUrlQuery = this._parsedUrlQueryCache[str];
     if (!parsedUrlQuery) {
-      parsedUrlQuery = this._parsedUrlQueryCache[str] = qs.parse(str);
+      parsedUrlQuery = qs.parse(str);
+      this._parsedUrlQueryCache[str] = parsedUrlQuery;
     }
     return parsedUrlQuery;
   }
@@ -157,7 +165,6 @@ export class Request {
   /**
    * Set query string as an object.
    */
-
   set query(obj: ParsedUrlQuery) {
     this.querystring = qs.stringify(obj);
   }
@@ -165,18 +172,17 @@ export class Request {
   /**
    * Get query string.
    */
-
   get querystring() {
     if (!this.req) return '';
-    return parse(this.req)!.query as string || '';
+    return (parse(this.req)?.query as string) ?? '';
   }
 
   /**
    * Set query string.
    */
-
-  set querystring(str) {
-    const url = parse(this.req)!;
+  set querystring(str: string) {
+    const url = parse(this.req);
+    if (!url) return;
     if (url.search === `?${str}`) return;
 
     url.search = str;
@@ -188,18 +194,17 @@ export class Request {
    * Get the search string. Same as the query string
    * except it includes the leading ?.
    */
-
   get search() {
-    if (!this.querystring) return '';
-    return `?${this.querystring}`;
+    const querystring = this.querystring;
+    if (!querystring) return '';
+    return `?${querystring}`;
   }
 
   /**
    * Set the search string. Same as
    * request.querystring= but included for ubiquity.
    */
-
-  set search(str) {
+  set search(str: string) {
     this.querystring = str;
   }
 
@@ -257,7 +262,7 @@ export class Request {
         this._memoizedURL = Object.create(null);
       }
     }
-    return this._memoizedURL!;
+    return this._memoizedURL as URL;
   }
 
   /**
@@ -295,7 +300,7 @@ export class Request {
    * Check if the request is idempotent.
    */
   get idempotent() {
-    const methods = [ 'GET', 'HEAD', 'PUT', 'DELETE', 'OPTIONS', 'TRACE' ];
+    const methods = ['GET', 'HEAD', 'PUT', 'DELETE', 'OPTIONS', 'TRACE'];
     return methods.includes(this.method);
   }
 
@@ -326,7 +331,7 @@ export class Request {
     if (len === '') {
       return;
     }
-    return parseInt(len);
+    return Number.parseInt(len);
   }
 
   /**
@@ -371,9 +376,7 @@ export class Request {
   get ips() {
     const proxy = this.app.proxy;
     const val = this.get<string>(this.app.proxyIpHeader);
-    let ips = proxy && val
-      ? splitCommaSeparatedValues(val)
-      : [];
+    let ips = proxy && val ? splitCommaSeparatedValues(val) : [];
     if (this.app.maxIpsCount > 0) {
       ips = ips.slice(-this.app.maxIpsCount);
     }
@@ -413,10 +416,7 @@ export class Request {
     const offset = this.app.subdomainOffset;
     const hostname = this.hostname;
     if (net.isIP(hostname)) return [];
-    return hostname
-      .split('.')
-      .reverse()
-      .slice(offset);
+    return hostname.split('.').reverse().slice(offset);
   }
 
   protected _accept: Accepts;
@@ -471,8 +471,13 @@ export class Request {
    *     this.accepts('html', 'json');
    *     // => "json"
    */
-  accepts(...args: any[]): string | string[] | false {
-    return this.accept.types(...args);
+  accepts(args: string[]): string | string[] | false;
+  accepts(...args: string[]): string | string[] | false;
+  accepts(
+    args?: string | string[],
+    ...others: string[]
+  ): string | string[] | false {
+    return this.accept.types(args as string, ...others);
   }
 
   /**
@@ -486,14 +491,17 @@ export class Request {
   acceptsEncodings(): string[];
   acceptsEncodings(encodings: string[]): string | false;
   acceptsEncodings(...encodings: string[]): string | false;
-  acceptsEncodings(encodings?: string | string[], ...others: string[]): string[] | string | false {
+  acceptsEncodings(
+    encodings?: string | string[],
+    ...others: string[]
+  ): string[] | string | false {
     if (!encodings) {
       return this.accept.encodings();
     }
     if (Array.isArray(encodings)) {
-      encodings = [ ...encodings, ...others ];
+      encodings = [...encodings, ...others];
     } else {
-      encodings = [ encodings, ...others ];
+      encodings = [encodings, ...others];
     }
     return this.accept.encodings(...encodings);
   }
@@ -509,14 +517,17 @@ export class Request {
   acceptsCharsets(): string[];
   acceptsCharsets(charsets: string[]): string | false;
   acceptsCharsets(...charsets: string[]): string | false;
-  acceptsCharsets(charsets?: string | string[], ...others: string[]): string[] | string | false {
+  acceptsCharsets(
+    charsets?: string | string[],
+    ...others: string[]
+  ): string[] | string | false {
     if (!charsets) {
       return this.accept.charsets();
     }
     if (Array.isArray(charsets)) {
-      charsets = [ ...charsets, ...others ];
+      charsets = [...charsets, ...others];
     } else {
-      charsets = [ charsets, ...others ];
+      charsets = [charsets, ...others];
     }
     return this.accept.charsets(...charsets);
   }
@@ -532,14 +543,17 @@ export class Request {
   acceptsLanguages(): string[];
   acceptsLanguages(languages: string[]): string | false;
   acceptsLanguages(...languages: string[]): string | false;
-  acceptsLanguages(languages?: string | string[], ...others: string[]): string | string[] | false {
+  acceptsLanguages(
+    languages?: string | string[],
+    ...others: string[]
+  ): string | string[] | false {
     if (!languages) {
       return this.accept.languages();
     }
     if (Array.isArray(languages)) {
-      languages = [ ...languages, ...others ];
+      languages = [...languages, ...others];
     } else {
-      languages = [ languages, ...others ];
+      languages = [languages, ...others];
     }
     return this.accept.languages(...languages);
   }
@@ -566,9 +580,11 @@ export class Request {
    *     this.is('html'); // => false
    */
   is(type?: string | string[], ...types: string[]): string | false | null {
-    const testTypes: string[] = Array.isArray(type) ? type :
-      (type ? [ type ] : []);
-    return typeis(this.req, [ ...testTypes, ...types ]);
+    let testTypes: string[] = [];
+    if (type) {
+      testTypes = Array.isArray(type) ? type : [type];
+    }
+    return typeis(this.req, [...testTypes, ...types]);
   }
 
   /**
@@ -598,9 +614,9 @@ export class Request {
    *     this.get('Something');
    *     // => ''
    */
-  get<T = string | string []>(field: string): T {
+  get<T = string | string[]>(field: string): T {
     const req = this.req;
-    switch (field = field.toLowerCase()) {
+    switch ((field = field.toLowerCase())) {
       case 'referer':
       case 'referrer':
         return (req.headers.referrer || req.headers.referer || '') as T;
@@ -642,8 +658,11 @@ export class Request {
  *
  * @param {string} value - The comma-separated value string to split.
  * @param {number} [limit] - The maximum number of values to return.
- * @return {string[]} An array of values from the comma-separated string.
+ * @returns {string[]} An array of values from the comma-separated string.
  */
 function splitCommaSeparatedValues(value: string, limit?: number): string[] {
-  return value.split(',', limit).map(v => v.trim()).filter(v => v);
+  return value
+    .split(',', limit)
+    .map(v => v.trim())
+    .filter(v => v.length > 0);
 }