egg 3.26.1 → 4.0.0-beta.0

package/src/lib/loader/AgentWorkerLoader.ts

@@ -0,0 +1,21 @@
+import { EggApplicationLoader } from './EggApplicationLoader.js';
+
+/**
+ * Agent worker process loader
+ * @see https://github.com/eggjs/egg-core/blob/master/src/loader/egg_loader.ts
+ */
+export class AgentWorkerLoader extends EggApplicationLoader {
+  /**
+   * loadPlugin first, then loadConfig
+   */
+  async loadConfig() {
+    await this.loadPlugin();
+    await super.loadConfig();
+  }
+
+  async load() {
+    await this.loadAgentExtend();
+    await this.loadContextExtend();
+    await this.loadCustomAgent();
+  }
+}

package/src/lib/loader/AppWorkerLoader.ts

@@ -0,0 +1,42 @@
+import { EggApplicationLoader } from './EggApplicationLoader.js';
+
+/**
+ * App worker process Loader, will load plugins
+ * @see https://github.com/eggjs/egg-core/blob/master/src/loader/egg_loader.ts
+ */
+export class AppWorkerLoader extends EggApplicationLoader {
+  /**
+   * loadPlugin first, then loadConfig
+   * @since 1.0.0
+   */
+  async loadConfig() {
+    await this.loadPlugin();
+    await super.loadConfig();
+  }
+
+  /**
+   * Load all directories in convention
+   * @since 1.0.0
+   */
+  async load() {
+    // app > plugin > core
+    await this.loadApplicationExtend();
+    await this.loadRequestExtend();
+    await this.loadResponseExtend();
+    await this.loadContextExtend();
+    await this.loadHelperExtend();
+
+    await this.loadCustomLoader();
+
+    // app > plugin
+    await this.loadCustomApp();
+    // app > plugin
+    await this.loadService();
+    // app > plugin > core
+    await this.loadMiddleware();
+    // app
+    await this.loadController();
+    // app
+    await this.loadRouter(); // Depend on controllers
+  }
+}

package/src/lib/loader/EggApplicationLoader.ts

@@ -0,0 +1,5 @@
+import { EggLoader } from '@eggjs/core';
+
+export abstract class EggApplicationLoader extends EggLoader {
+  abstract load(): Promise<void>;
+}

package/src/lib/loader/index.ts

@@ -0,0 +1,3 @@
+export { EggApplicationLoader } from './EggApplicationLoader.js';
+export * from './AppWorkerLoader.js';
+export * from './AgentWorkerLoader.js';

package/src/lib/start.ts

@@ -0,0 +1,56 @@
+import path from 'node:path';
+import { readJSON } from 'utility';
+import { importModule } from '@eggjs/utils';
+import { Agent } from './agent.js';
+import { Application } from './application.js';
+
+export interface StartEggOptions {
+  /** specify framework that can be absolute path or npm package */
+  framework?: string;
+  /** directory of application, default to `process.cwd()` */
+  baseDir?: string;
+  /** ignore single process mode warning */
+  ignoreWarning?: boolean;
+  mode?: 'single';
+  env?: string;
+}
+
+/**
+ * Start egg with single process
+ */
+export async function startEgg(options: StartEggOptions = {}) {
+  options.baseDir = options.baseDir ?? process.cwd();
+  options.mode = 'single';
+
+  // get agent from options.framework and package.egg.framework
+  if (!options.framework) {
+    try {
+      const pkg = await readJSON(path.join(options.baseDir, 'package.json'));
+      options.framework = pkg.egg.framework;
+    } catch (_) {
+      // ignore
+    }
+  }
+  let AgentClass = Agent;
+  let ApplicationClass = Application;
+  if (options.framework) {
+    const framework = await importModule(options.framework, { paths: [ options.baseDir ] });
+    AgentClass = framework.Agent;
+    ApplicationClass = framework.Application;
+  }
+
+  const agent = new AgentClass({
+    ...options,
+  });
+  await agent.ready();
+  const application = new ApplicationClass({
+    ...options,
+  });
+  application.agent = agent;
+  agent.application = application;
+  await application.ready();
+
+  // emit egg-ready message in agent and application
+  application.messenger.broadcast('egg-ready');
+  return application;
+}

package/src/lib/type.ts

@@ -0,0 +1,329 @@
+import type { Socket } from 'node:net';
+import type { EggCoreContext } from '@eggjs/core';
+import type {
+  RequestOptions as HttpClientRequestOptions,
+} from 'urllib';
+import type {
+  EggLoggerOptions, EggLoggersOptions,
+} from 'egg-logger';
+import type {
+  FileLoaderOptions,
+} from '@eggjs/core';
+import type {
+  EggApplicationCore,
+} from './egg.js';
+import type { MetaMiddlewareOptions } from '../app/middleware/meta.js';
+import type { NotFoundMiddlewareOptions } from '../app/middleware/notfound.js';
+import type { SiteFileMiddlewareOptions } from '../app/middleware/site_file.js';
+
+type IgnoreItem = string | RegExp | ((ctx: EggCoreContext) => boolean);
+type IgnoreOrMatch = IgnoreItem | IgnoreItem[];
+
+export type Next = () => Promise<void>;
+
+export interface ClientErrorResponse {
+  body: string | Buffer;
+  status: number;
+  headers: { [key: string]: string };
+}
+
+/** egg env type */
+export type EggEnvType = 'local' | 'unittest' | 'prod' | string;
+
+/** logger config of egg */
+export interface EggLoggerConfig extends Omit<EggLoggersOptions, 'type'> {
+  /** custom config of coreLogger */
+  coreLogger?: Partial<EggLoggerOptions>;
+  /** allow debug log at prod, defaults to `false` */
+  allowDebugAtProd?: boolean;
+  /** disable logger console after app ready. defaults to `false` on local and unittest env, others is `true`. */
+  disableConsoleAfterReady?: boolean;
+  /** [deprecated] Defaults to `true`. */
+  enablePerformanceTimer?: boolean;
+  /** using the app logger instead of EggContextLogger, defaults to `false` */
+  enableFastContextLogger?: boolean;
+}
+
+/** Custom Loader Configuration */
+export interface CustomLoaderConfig extends Omit<FileLoaderOptions, 'inject' | 'target'> {
+  /**
+   * an object you wanner load to, value can only be 'ctx' or 'app'. default to app
+   */
+  inject?: 'ctx' | 'app';
+  /**
+   * whether need to load files in plugins or framework, default to false
+   */
+  loadunit?: boolean;
+}
+
+export interface EggAppConfig {
+  workerStartTimeout: number;
+  baseDir: string;
+  middleware: string[];
+  coreMiddleware: string[];
+
+  /**
+   * The option of `bodyParser` middleware
+   *
+   * @member Config#bodyParser
+   * @property {Boolean} enable - enable bodyParser or not, default to true
+   * @property {String | RegExp | Function | Array} ignore - won't parse request body when url path hit ignore pattern, can not set `ignore` when `match` presented
+   * @property {String | RegExp | Function | Array} match - will parse request body only when url path hit match pattern
+   * @property {String} encoding - body encoding config, default utf8
+   * @property {String} formLimit - form body size limit, default 1mb
+   * @property {String} jsonLimit - json body size limit, default 1mb
+   * @property {String} textLimit - json body size limit, default 1mb
+   * @property {Boolean} strict - json body strict mode, if set strict value true, then only receive object and array json body
+   * @property {Number} queryString.arrayLimit - from item array length limit, default 100
+   * @property {Number} queryString.depth - json value deep length, default 5
+   * @property {Number} queryString.parameterLimit - parameter number limit, default 1000
+   * @property {String[]} enableTypes - parser will only parse when request type hits enableTypes, default is ['json', 'form']
+   * @property {Object} extendTypes - support extend types
+   * @property {String} onProtoPoisoning - Defines what action must take when parsing a JSON object with `__proto__`. Possible values are `'error'`, `'remove'` and `'ignore'`. Default is `'error'`, it will return `400` response when `Prototype-Poisoning` happen.
+   */
+  bodyParser: {
+    enable: boolean;
+    encoding: string;
+    formLimit: string;
+    jsonLimit: string;
+    textLimit: string;
+    strict: boolean;
+    queryString: {
+      arrayLimit: number;
+      depth: number;
+      parameterLimit: number;
+    };
+    ignore?: IgnoreOrMatch;
+    match?: IgnoreOrMatch;
+    enableTypes?: string[];
+    extendTypes?: {
+      json: string[];
+      form: string[];
+      text: string[];
+    };
+    /** Default is `'error'`, it will return `400` response when `Prototype-Poisoning` happen. */
+    onProtoPoisoning: 'error' | 'remove' | 'ignore';
+    onerror(err: any, ctx: EggCoreContext): void;
+  };
+
+  /**
+   * logger options
+   * @member Config#logger
+   * @property {String} dir - directory of log files
+   * @property {String} encoding - log file encoding, defaults to utf8
+   * @property {String} level - default log level, could be: DEBUG, INFO, WARN, ERROR or NONE, defaults to INFO in production
+   * @property {String} consoleLevel - log level of stdout, defaults to `INFO` in local serverEnv, defaults to `WARN` in unittest, others is `NONE`
+   * @property {Boolean} disableConsoleAfterReady - disable logger console after app ready. defaults to `false` on local and unittest env, others is `true`.
+   * @property {Boolean} outputJSON - log as JSON or not, defaults to `false`
+   * @property {Boolean} buffer - if enabled, flush logs to disk at a certain frequency to improve performance, defaults to true
+   * @property {String} errorLogName - file name of errorLogger
+   * @property {String} coreLogName - file name of coreLogger
+   * @property {String} agentLogName - file name of agent worker log
+   * @property {Object} coreLogger - custom config of coreLogger
+   * @property {Boolean} allowDebugAtProd - allow debug log at prod, defaults to false
+   * @property {Boolean} enableFastContextLogger - using the app logger instead of EggContextLogger, defaults to false
+   */
+  logger: Partial<EggLoggerConfig>;
+
+  /** custom logger of egg */
+  customLogger: {
+    [key: string]: EggLoggerOptions;
+  };
+
+  /** Configuration of httpclient in egg. */
+  httpclient: {
+    /** Request timeout */
+    timeout?: number;
+    /** Default request args for httpclient */
+    request?: HttpClientRequestOptions;
+  };
+
+  development: {
+    /**
+     * dirs needed watch, when files under these change, application will reload, use relative path
+     */
+    watchDirs: string[];
+    /**
+     * dirs don't need watch, including subdirectories, use relative path
+     */
+    ignoreDirs: string[];
+    /**
+     * don't wait all plugins ready, default is true.
+     */
+    fastReady: boolean;
+    /**
+     * whether reload on debug, default is true.
+     */
+    reloadOnDebug: boolean;
+    /**
+     * whether override default watchDirs, default is false.
+     */
+    overrideDefault: boolean;
+    /**
+     * whether override default ignoreDirs, default is false.
+     */
+    overrideIgnore: boolean;
+    /**
+     * whether to reload, use https://github.com/sindresorhus/multimatch
+     */
+    reloadPattern: string[] | string;
+  };
+
+  /**
+   * customLoader config
+   */
+  customLoader: {
+    [key: string]: CustomLoaderConfig;
+  };
+
+  /**
+   * It will ignore special keys when dumpConfig
+   */
+  dump: {
+    ignore: Set<string | RegExp>;
+    timing: {
+      slowBootActionMinDuration: number;
+    };
+  };
+
+  /**
+   * The environment of egg
+   */
+  env: EggEnvType;
+
+  /**
+   * The current HOME directory
+   */
+  HOME: string;
+
+  hostHeaders: string;
+
+  /**
+   * I18n options
+   */
+  i18n: {
+    /**
+     * default value EN_US
+     */
+    defaultLocale: string;
+    /**
+     * i18n resource file dir, not recommend to change default value
+     */
+    dirs: string[];
+    /**
+     * custom the locale value field, default `query.locale`, you can modify this config, such as `query.lang`
+     */
+    queryField: string;
+    /**
+     * The locale value key in the cookie, default is locale.
+     */
+    cookieField: string;
+    /**
+     * Locale cookie expire time, default `1y`, If pass number value, the unit will be ms
+     */
+    cookieMaxAge: string | number;
+  };
+
+  /**
+   * Detect request' ip from specified headers, not case-sensitive. Only worked when config.proxy set to true.
+   */
+  ipHeaders: string;
+
+  protocolHeaders: string;
+  maxProxyCount: number;
+  maxIpsCount: number;
+  proxy: boolean;
+  cookies: {
+    sameSite?: string;
+    httpOnly?: boolean;
+  };
+
+  /**
+   * jsonp options
+   * @member Config#jsonp
+   * @property {String} callback - jsonp callback method key, default to `_callback`
+   * @property {Number} limit - callback method name's max length, default to `50`
+   * @property {Boolean} csrf - enable csrf check or not. default to false
+   * @property {String|RegExp|Array} whiteList - referrer white list
+   */
+  jsonp: {
+    limit: number;
+    callback: string;
+    csrf: boolean;
+    whiteList: string | RegExp | Array<string | RegExp>;
+  };
+
+  /**
+   * The key that signing cookies. It can contain multiple keys separated by .
+   */
+  keys: string;
+
+  /**
+   * The name of the application
+   */
+  name: string;
+
+  /**
+   * package.json
+   */
+  pkg: Record<string, any>;
+
+  rundir: string;
+
+  security: {
+    domainWhiteList: string[];
+    protocolWhiteList: string[];
+    defaultMiddleware: string;
+    csrf: any;
+    ssrf: {
+      ipBlackList: string[];
+      ipExceptionList: string[];
+      checkAddress?(ip: string): boolean;
+    };
+    xframe: {
+      enable: boolean;
+      value: 'SAMEORIGIN' | 'DENY' | 'ALLOW-FROM';
+    };
+    hsts: any;
+    methodnoallow: { enable: boolean };
+    noopen: { enable: boolean; }
+    xssProtection: any;
+    csp: any;
+  };
+
+  siteFile: SiteFileMiddlewareOptions;
+  meta: MetaMiddlewareOptions;
+  notfound: NotFoundMiddlewareOptions;
+  overrideMethod: {
+    enable: boolean;
+    allowedMethods: string[];
+  };
+
+  watcher: Record<string, any>;
+
+  onClientError?(err: Error, socket: Socket, app: EggApplicationCore): ClientErrorResponse | Promise<ClientErrorResponse>;
+
+  /**
+   * server timeout in milliseconds, default to 0 (no timeout).
+   *
+   * for special request, just use `ctx.req.setTimeout(ms)`
+   *
+   * @see https://nodejs.org/api/http.html#http_server_timeout
+   */
+  serverTimeout: number | null;
+
+  cluster: {
+    listen: {
+      path: string,
+      port: number,
+      hostname: string,
+    };
+  };
+
+  clusterClient: {
+    maxWaitTime: number;
+    responseTimeout: number;
+  };
+
+  [prop: string]: any;
+}

package/agent.js

@@ -1,11 +0,0 @@
-'use strict';
-
-const BaseHookClass = require('./lib/core/base_hook_class');
-
-class EggAgentHook extends BaseHookClass {
-  configDidLoad() {
-    this.agent._wrapMessenger();
-  }
-}
-
-module.exports = EggAgentHook;

package/app/middleware/body_parser.js

@@ -1,3 +0,0 @@
-'use strict';
-
-module.exports = require('koa-bodyparser');

package/app/middleware/override_method.js

@@ -1,3 +0,0 @@
-'use strict';
-
-module.exports = require('koa-override');

package/app/middleware/site_file.js

@@ -1,31 +0,0 @@
-'use strict';
-
-const path = require('path');
-
-module.exports = options => {
-  return async function siteFile(ctx, next) {
-    if (ctx.method !== 'HEAD' && ctx.method !== 'GET') return next();
-    /* istanbul ignore if */
-    if (ctx.path[0] !== '/') return next();
-
-    let content = options[ctx.path];
-    if (!content) return next();
-
-    // '/favicon.ico': 'https://eggjs.org/favicon.ico' or '/favicon.ico': async (ctx) => 'https://eggjs.org/favicon.ico'
-    // content is function
-    if (typeof content === 'function') content = await content(ctx);
-    // content is url
-    if (typeof content === 'string') return ctx.redirect(content);
-
-    // '/robots.txt': Buffer <xx..
-    // content is buffer
-    if (Buffer.isBuffer(content)) {
-      ctx.set('cache-control', options.cacheControl);
-      ctx.body = content;
-      ctx.type = path.extname(ctx.path);
-      return;
-    }
-
-    return next();
-  };
-};

package/config/config.local.js

@@ -1,7 +0,0 @@
-'use strict';
-
-exports.logger = {
-  coreLogger: {
-    consoleLevel: 'WARN',
-  },
-};

package/config/config.unittest.js

@@ -1,8 +0,0 @@
-'use strict';
-
-module.exports = {
-  logger: {
-    consoleLevel: 'WARN',
-    buffer: false,
-  },
-};