refactor: convert more tests to typescript

index-old.d.ts

@@ -218,30 +218,6 @@
 
 //   export type LoggerLevel = EggLoggerLevel;
 
-
-//   /**
-//    * egg app info
-//    * @example
-//    * ```js
-//    * // config/config.default.ts
-//    * import { EggAppInfo } from 'egg';
-//    *
-//    * export default (appInfo: EggAppInfo) => {
-//    *   return {
-//    *     keys: appInfo.name + '123456',
-//    *   };
-//    * }
-//    * ```
-//    */
-//   export interface EggAppInfo {
-//     pkg: any; // package.json
-//     name: string; // the application name from package.json
-//     baseDir: string; // current directory of application
-//     env: EggEnvType; // equals to serverEnv
-//     HOME: string; // home directory of the OS
-//     root: string; // baseDir when local and unittest, HOME when other environment
-//   }
-
 //   type IgnoreItem = string | RegExp | ((ctx: Context) => boolean);
 //   type IgnoreOrMatch = IgnoreItem | IgnoreItem[];
 
@@ -1082,40 +1058,6 @@
 //     urlFor(name: string, params?: PlainObject): string;
 //   }
 
-//   // egg env type
-//   export type EggEnvType = 'local' | 'unittest' | 'prod' | string;
-
-//   /**
-//    * plugin config item interface
-//    */
-//   export interface IEggPluginItem {
-//     env?: EggEnvType[];
-//     path?: string;
-//     package?: string;
-//     enable?: boolean;
-//   }
-
-//   export type EggPluginItem = IEggPluginItem | boolean;
-
-//   /**
-//    * build-in plugin list
-//    */
-//   export interface EggPlugin {
-//     [key: string]: EggPluginItem | undefined;
-//     onerror?: EggPluginItem;
-//     session?: EggPluginItem;
-//     i18n?: EggPluginItem;
-//     watcher?: EggPluginItem;
-//     multipart?: EggPluginItem;
-//     security?: EggPluginItem;
-//     development?: EggPluginItem;
-//     logrotator?: EggPluginItem;
-//     schedule?: EggPluginItem;
-//     static?: EggPluginItem;
-//     jsonp?: EggPluginItem;
-//     view?: EggPluginItem;
-//   }
-
 //   /**
 //    * Singleton instance in Agent Worker, extend {@link EggApplication}
 //    */

package.json

@@ -1,6 +1,6 @@
 {
   "name": "egg",
-  "version": "4.0.0-beta.11",
+  "version": "4.0.0-beta.15",
   "engines": {
     "node": ">= 18.19.0"
   },
@@ -21,13 +21,12 @@
   "dependencies": {
     "@eggjs/cluster": "^3.0.0",
     "@eggjs/cookies": "^3.0.0",
-    "@eggjs/core": "^6.2.5",
+    "@eggjs/core": "^6.2.13",
     "@eggjs/schedule": "^5.0.2",
-    "@eggjs/utils": "^4.1.5",
-    "@eggjs/watcher": "^4.0.1",
+    "@eggjs/utils": "^4.2.4",
+    "@eggjs/watcher": "^4.0.3",
     "circular-json-for-egg": "^1.0.0",
     "cluster-client": "^3.7.0",
-    "delegates": "^1.0.0",
     "egg-development": "^3.0.0",
     "egg-errors": "^2.3.1",
     "egg-i18n": "^2.1.1",
@@ -46,7 +45,7 @@
     "is-type-of": "^2.1.0",
     "koa-bodyparser": "^4.4.1",
     "koa-override": "^4.0.0",
-    "onelogger": "^1.0.0",
+    "onelogger": "^1.0.1",
     "performance-ms": "^1.1.0",
     "sendmessage": "^3.0.1",
     "urllib": "^4.6.11",
@@ -57,10 +56,9 @@
     "@arethetypeswrong/cli": "^0.17.1",
     "@eggjs/bin": "^7.0.0",
     "@eggjs/koa": "^2.19.1",
-    "@eggjs/mock": "^6.0.3",
+    "@eggjs/mock": "^6.0.5",
     "@eggjs/supertest": "^8.1.1",
     "@eggjs/tsconfig": "1",
-    "@types/delegates": "^1.0.3",
     "@types/koa-bodyparser": "^4.3.12",
     "@types/mocha": "^10.0.7",
     "@types/ms": "^0.7.34",
@@ -78,7 +76,7 @@
     "formstream": "^1.5.1",
     "koa-static": "^5.0.0",
     "mm": "^3.4.0",
-    "pedding": "^1.1.0",
+    "pedding": "^2.0.1",
     "prettier": "^2.7.1",
     "rimraf": "6",
     "runscript": "^2.0.1",

src/app/extend/context.ts

@@ -1,19 +1,17 @@
-import delegate from 'delegates';
 import { assign } from 'utility';
 import { now, diff } from 'performance-ms';
 import {
   utils, Context as EggCoreContext, Router,
-  type ContextDelegation as EggCoreContextDelegation,
 } from '@eggjs/core';
 import type { Cookies as ContextCookies } from '@eggjs/cookies';
-import { EggLogger } from 'egg-logger';
+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 Request from './request.js';
-import Response from './response.js';
+import type Request from './request.js';
+import type Response from './response.js';
 import type Helper from './helper.js';
 
 import './context.types.js';
@@ -33,7 +31,9 @@
 export default class Context extends EggCoreContext {
   declare app: Application;
   declare request: Request;
+  declare response: Response;
   declare service: BaseContextClass;
+  declare proxy: any;
 
   /**
    * Request start time
@@ -230,7 +230,7 @@
    * });
    * ```
    */
-  runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, taskName?: string): void {
+  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);
@@ -243,7 +243,7 @@
 
   // let plugins or frameworks to reuse _runInBackground in some cases.
   // e.g.: https://github.com/eggjs/egg-mock/pull/78
-  async _runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, taskName: string) {
+  async _runInBackground(scope: (ctx: Context) => Promise<void>, taskName: string) {
     const startTime = now();
     try {
       await scope(this as any);
@@ -257,46 +257,52 @@
       this.app.emit('error', err, this);
     }
   }
-}
-
-/**
- * Context delegation.
- */
 
-delegate(Context.prototype, 'request')
   /**
    * @member {Boolean} Context#acceptJSON
    * @see Request#acceptJSON
    * @since 1.0.0
    */
-  .getter('acceptJSON')
+  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
    */
-  .getter('queries')
-  /**
-   * @member {Boolean} Context#accept
-   * @see Request#accept
-   * @since 1.0.0
-   */
-  .getter('accept')
+  get queries(): Record<string, string[]> {
+    return this.request.queries;
+  }
+
   /**
    * @member {string} Context#ip
    * @see Request#ip
    * @since 1.0.0
    */
-  .access('ip');
+  get ip(): string {
+    return this.request.ip;
+  }
+
+  set ip(val: string) {
+    this.request.ip = val;
+  }
 
-delegate(Context.prototype, 'response')
   /**
    * @member {Number} Context#realStatus
    * @see Response#realStatus
    * @since 1.0.0
    */
-  .access('realStatus');
+  get realStatus(): number {
+    return this.response.realStatus;
+  }
 
-export type ContextDelegation = EggCoreContextDelegation & Context
-& Pick<Request, 'acceptJSON' | 'queries' | 'accept' | 'ip'>
-& Pick<Response, 'realStatus'>;
+  set realStatus(val: number) {
+    this.response.realStatus = val;
+  }
+}

src/app/extend/context.types.ts

@@ -1,11 +1,11 @@
 import type {
   Router,
 } from '@eggjs/core';
+import type { EggLogger } from 'egg-logger';
 import type {
   HttpClientRequestURL, HttpClientRequestOptions, HttpClient,
 } from '../../lib/core/httpclient.js';
 import type Helper from './helper.js';
-import type { EggLogger } from 'egg-logger';
 
 declare module '@eggjs/core' {
   // add Context overrides types
@@ -17,5 +17,8 @@ declare module '@eggjs/core' {
     get httpclient(): HttpClient;
     get httpClient(): HttpClient;
     getLogger(name: string): EggLogger;
+    get logger(): EggLogger;
+    get coreLogger(): EggLogger;
+    get locals(): Record<string, any>;
   }
 }

src/app/extend/request.ts

@@ -1,7 +1,7 @@
 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 type Context from './context.js';
 import Response from './response.js';
 
 const QUERY_CACHE = Symbol('request query cache');
@@ -11,11 +11,18 @@ const HOST = Symbol('request host');
 const IPS = Symbol('request ips');
 const RE_ARRAY_KEY = /[^\[\]]+\[\]$/;
 
+import './request.types.js';
+
 export default class Request extends EggCoreRequest {
   declare app: Application;
-  declare ctx: ContextDelegation;
+  declare ctx: Context;
   declare response: Response;
 
+  /**
+   * Request body, parsed from koa-bodyparser or egg-multipart
+   */
+  declare body: any;
+
   /**
    * Parse the "Host" header field host
    * and support X-Forwarded-Host when a

src/app/extend/request.types.ts

@@ -0,0 +1,10 @@
+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[]>;
+  }
+}

src/app/extend/response.ts

@@ -2,6 +2,8 @@ import { Response as KoaResponse } from '@eggjs/core';
 
 const REAL_STATUS = Symbol('response realStatus');
 
+import './response.types.js';
+
 export default class Response extends KoaResponse {
   /**
    * Get or set a real status code.

src/app/extend/response.types.ts

@@ -0,0 +1,7 @@
+declare module '@eggjs/core' {
+  // add Response overrides types
+  interface Response {
+    get realStatus(): number;
+    set realStatus(status: number);
+  }
+}

src/app/middleware/meta.ts

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

src/app/middleware/notfound.ts

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

src/app/middleware/site_file.ts

@@ -1,9 +1,9 @@
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { readFile } from 'node:fs/promises';
-import type { Next, ContextDelegation } from '../../lib/egg.js';
+import type { Next, Context } from '../../lib/egg.js';
 
-export type SiteFileContentFun = (ctx: ContextDelegation) => Promise<Buffer | string>;
+export type SiteFileContentFun = (ctx: Context) => Promise<Buffer | string>;
 
 export interface SiteFileMiddlewareOptions {
   enable: boolean;
@@ -14,7 +14,7 @@ export interface SiteFileMiddlewareOptions {
 const BUFFER_CACHE = Symbol('siteFile URL buffer cache');
 
 export default (options: SiteFileMiddlewareOptions) => {
-  return async function siteFile(ctx: ContextDelegation, next: Next) {
+  return async function siteFile(ctx: Context, next: Next) {
     if (ctx.method !== 'HEAD' && ctx.method !== 'GET') {
       return next();
     }

src/config/config.default.ts

@@ -1,7 +1,7 @@
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
 import type { EggAppInfo } from '@eggjs/core';
-import type { EggAppConfig } from '../lib/type.js';
+import type { EggAppConfig } from '../lib/types.js';
 import { getSourceFile } from '../lib/utils.js';
 
 /**

src/config/config.local.ts

@@ -1,4 +1,4 @@
-import type { EggAppConfig } from '../lib/type.js';
+import type { EggAppConfig } from '../lib/types.js';
 
 export default () => {
   return {