egg 4.0.10 → 4.1.0-beta.10

package/dist/config/config.default.js

@@ -0,0 +1,260 @@
+import { defineConfig } from "../lib/types.js";
+import "../index.js";
+import path from "node:path";
+import { pathToFileURL } from "node:url";
+
+//#region src/config/config.default.ts
+/**
+* The configuration of egg application, can be access by `app.config`
+* @class Config
+* @since 1.0.0
+*/
+var config_default_default = defineConfig((appInfo) => {
+	const config = {
+		env: appInfo.env,
+		name: appInfo.name,
+		keys: "",
+		cookies: {},
+		proxy: false,
+		maxIpsCount: 0,
+		maxProxyCount: 0,
+		protocolHeaders: "x-forwarded-proto",
+		ipHeaders: "x-forwarded-for",
+		hostHeaders: "",
+		pkg: appInfo.pkg,
+		baseDir: appInfo.baseDir,
+		HOME: appInfo.HOME,
+		rundir: path.join(appInfo.baseDir, "run"),
+		dump: {
+			ignore: new Set([
+				"pass",
+				"pwd",
+				"passd",
+				"passwd",
+				"password",
+				"keys",
+				"masterKey",
+				"accessKey",
+				/secret/i
+			]),
+			timing: { slowBootActionMinDuration: 5e3 }
+		},
+		confusedConfigurations: {
+			bodyparser: "bodyParser",
+			notFound: "notfound",
+			sitefile: "siteFile",
+			middlewares: "middleware",
+			httpClient: "httpclient"
+		}
+	};
+	/**
+	* The options of `notfound` middleware
+	*
+	* It will return page or json depend on negotiation when 404,
+	* If pageUrl is set, it will redirect to the page.
+	*
+	* @member Config#notfound
+	* @property {String} pageUrl - the 404 page url
+	*/
+	config.notfound = {
+		enable: true,
+		pageUrl: ""
+	};
+	/**
+	* The option of `siteFile` middleware
+	*
+	* You can map some files using this options, it will response immediately when matching.
+	*
+	* @member {Object} Config#siteFile - key is path, and value is url or buffer.
+	* @property {String} cacheControl - files cache control, default is `public, max-age=2592000`
+	* @example
+	* ```ts
+	* // specific app's favicon, => '/favicon.ico': 'https://eggjs.org/favicon.png',
+	* config.siteFile = {
+	*   '/favicon.ico': 'https://eggjs.org/favicon.png',
+	* };
+	* ```
+	*/
+	config.siteFile = {
+		enable: true,
+		"/favicon.ico": pathToFileURL(path.join(import.meta.dirname, "favicon.png")),
+		cacheControl: "public, max-age=2592000"
+	};
+	/**
+	* The options of `bodyParser` middleware
+	*
+	* @member Config#bodyParser
+	* @property {Boolean} enable - enable bodyParser or not, default is 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's encoding type，default is utf8
+	* @property {String} formLimit - limit of the urlencoded body. If the body ends up being larger than this limit, a 413 error code is returned. Default is 1mb
+	* @property {String} jsonLimit - limit of the json body, default is 1mb
+	* @property {String} textLimit - limit of the text body, default is 1mb
+	* @property {Boolean} strict - when set to true, JSON parser will only accept arrays and objects. Default is true
+	* @property {Number} queryString.arrayLimit - urlencoded body array's max length, default is 100
+	* @property {Number} queryString.depth - urlencoded body object's max depth, default is 5
+	* @property {Number} queryString.parameterLimit - urlencoded body maximum parameters, default is 1000
+	*/
+	config.bodyParser = {
+		enable: true,
+		encoding: "utf8",
+		formLimit: "1mb",
+		jsonLimit: "1mb",
+		textLimit: "1mb",
+		strict: true,
+		queryString: {
+			arrayLimit: 100,
+			depth: 5,
+			parameterLimit: 1e3
+		},
+		onProtoPoisoning: "error",
+		onerror(err, ctx) {
+			err.message = `${err.message}, check bodyParser config`;
+			if (ctx.status === 404) {
+				ctx.status = 400;
+				if (!err.status) err.status = 400;
+			}
+			throw err;
+		}
+	};
+	/**
+	* 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, defaults to NONE elsewise
+	* @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 true
+	*/
+	config.logger = {
+		dir: path.join(appInfo.root, "logs", appInfo.name),
+		encoding: "utf8",
+		env: appInfo.env,
+		level: "INFO",
+		consoleLevel: "INFO",
+		disableConsoleAfterReady: appInfo.env !== "local" && appInfo.env !== "unittest",
+		outputJSON: false,
+		buffer: true,
+		appLogName: `${appInfo.name}-web.log`,
+		coreLogName: "egg-web.log",
+		agentLogName: "egg-agent.log",
+		errorLogName: "common-error.log",
+		coreLogger: {},
+		allowDebugAtProd: false,
+		enableFastContextLogger: true
+	};
+	/**
+	* The option for httpclient
+	* @member Config#httpclient
+	* @property {Boolean} enableDNSCache - Enable DNS lookup from local cache or not, default is false.
+	* @property {Boolean} dnsCacheLookupInterval - minimum interval of DNS query on the same hostname (default 10s).
+	*
+	* @property {Number} request.timeout - httpclient request default timeout, default is 5000 ms.
+	*
+	* @property {Boolean} httpAgent.keepAlive - Enable http agent keepalive or not, default is true
+	* @property {Number} httpAgent.freeSocketTimeout - http agent socket keepalive max free time, default is 4000 ms.
+	* @property {Number} httpAgent.maxSockets - http agent max socket number of one host, default is `Number.MAX_SAFE_INTEGER` @ses https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
+	* @property {Number} httpAgent.maxFreeSockets - http agent max free socket number of one host, default is 256.
+	*
+	* @property {Boolean} httpsAgent.keepAlive - Enable https agent keepalive or not, default is true
+	* @property {Number} httpsAgent.freeSocketTimeout - https agent socket keepalive max free time, default is 4000 ms.
+	* @property {Number} httpsAgent.maxSockets - https agent max socket number of one host, default is `Number.MAX_SAFE_INTEGER` @ses https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
+	* @property {Number} httpsAgent.maxFreeSockets - https agent max free socket number of one host, default is 256.
+	* @property {Boolean} useHttpClientNext - use urllib@3 HttpClient
+	*/
+	config.httpclient = { request: { timeout: 5e3 } };
+	/**
+	* The options of `meta` middleware
+	*
+	* @member Config#meta
+	* @property {Boolean} enable - enable meta or not, default is `true`
+	* @property {Boolean} logging - enable logging start request, default is `false`
+	*/
+	config.meta = {
+		enable: true,
+		logging: false
+	};
+	/**
+	* core enable middlewares
+	* @member {Array} Config#middleware
+	*/
+	config.coreMiddleware = [
+		"meta",
+		"siteFile",
+		"notfound",
+		"bodyParser",
+		"overrideMethod"
+	];
+	/**
+	* emit `startTimeout` if worker don't ready after `workerStartTimeout` ms
+	* @member {Number} Config.workerStartTimeout
+	*/
+	config.workerStartTimeout = 600 * 1e3;
+	/**
+	* server timeout in milliseconds, default to 0 (no timeout).
+	*
+	* for special request, just use `ctx.req.setTimeout(ms)`
+	*
+	* @member {Number} Config#serverTimeout
+	* @see https://nodejs.org/api/http.html#http_server_timeout
+	*/
+	config.serverTimeout = null;
+	/**
+	* The options of cluster
+	* @member {Object} Config#cluster
+	* @property {Object} listen - listen options, see {@link https://nodejs.org/api/http.html#http_server_listen_port_hostname_backlog_callback}
+	* @property {String} listen.path - set a unix sock path when server listen
+	* @property {Number} listen.port - set a port when server listen
+	* @property {String} listen.hostname - set a hostname binding server when server listen
+	*/
+	config.cluster = { listen: {
+		path: "",
+		port: 7001,
+		hostname: ""
+	} };
+	/**
+	* @property {Number} responseTimeout - response timeout, default is 60000
+	*/
+	config.clusterClient = {
+		maxWaitTime: 6e4,
+		responseTimeout: 6e4
+	};
+	/**
+	* This function / async function will be called when a client error occurred and return the response.
+	*
+	* The arguments are `err`, `socket` and `application` which indicate current client error object, current socket
+	* object and the application object.
+	*
+	* The response to be returned should include properties below:
+	*
+	* @member {Function} Config#onClientError
+	* @property [body] {String|Buffer} - the response body
+	* @property [status] {Number} - the response status code
+	* @property [headers] {Object} - the response header key-value pairs
+	*
+	* @example
+	* exports.onClientError = async (err, socket, app) => {
+	*   return {
+	*     body: 'error',
+	*     status: 400,
+	*     headers: {
+	*       'powered-by': 'Egg.js',
+	*     }
+	*   };
+	* }
+	*/
+	config.onClientError = void 0;
+	return config;
+});
+
+//#endregion
+export { config_default_default as default };

package/dist/config/config.local.d.ts

@@ -0,0 +1,10 @@
+//#region src/config/config.local.d.ts
+declare const _default: () => {
+  logger: {
+    coreLogger: {
+      consoleLevel: "WARN";
+    };
+  };
+};
+//#endregion
+export { _default as default };

package/dist/config/config.local.js

@@ -0,0 +1,7 @@
+//#region src/config/config.local.ts
+var config_local_default = () => {
+	return { logger: { coreLogger: { consoleLevel: "WARN" } } };
+};
+
+//#endregion
+export { config_local_default as default };

package/dist/config/config.unittest.d.ts

@@ -0,0 +1,9 @@
+//#region src/config/config.unittest.d.ts
+declare const _default: () => {
+  logger: {
+    consoleLevel: "WARN";
+    buffer: false;
+  };
+};
+//#endregion
+export { _default as default };

package/dist/config/config.unittest.js

@@ -0,0 +1,10 @@
+//#region src/config/config.unittest.ts
+var config_unittest_default = () => {
+	return { logger: {
+		consoleLevel: "WARN",
+		buffer: false
+	} };
+};
+
+//#endregion
+export { config_unittest_default as default };

package/{src/config/plugin.ts → dist/config/plugin.d.ts}

@@ -1,14 +1,14 @@
-export default {
+//#region src/config/plugin.d.ts
+declare const _default: {
   /**
    * app global Error Handling
    * @member {Object} Plugin#onerror
    * @property {Boolean} enable - `true` by default
    */
   onerror: {
-    enable: true,
-    package: '@eggjs/onerror',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * session
    * @member {Object} Plugin#session
@@ -16,10 +16,9 @@ export default {
    * @since 1.0.0
    */
   session: {
-    enable: true,
-    package: '@eggjs/session',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * i18n
    * @member {Object} Plugin#i18n
@@ -27,10 +26,9 @@ export default {
    * @since 1.0.0
    */
   i18n: {
-    enable: true,
-    package: '@eggjs/i18n',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * file and dir watcher
    * @member {Object} Plugin#watcher
@@ -38,10 +36,9 @@ export default {
    * @since 1.0.0
    */
   watcher: {
-    enable: true,
-    package: '@eggjs/watcher',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * multipart
    * @member {Object} Plugin#multipart
@@ -49,10 +46,9 @@ export default {
    * @since 1.0.0
    */
   multipart: {
-    enable: true,
-    package: '@eggjs/multipart',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * security middlewares and extends
    * @member {Object} Plugin#security
@@ -60,21 +56,19 @@ export default {
    * @since 1.0.0
    */
   security: {
-    enable: true,
-    package: '@eggjs/security',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * local development helper
    * @member {Object} Plugin#development
-   * @property {Boolean} enable - `true` by default
+   * @property {Boolean} enable - `true` by default. on CI, it's `false` to avoid unexpected errors.
    * @since 1.0.0
    */
   development: {
-    enable: true,
-    package: '@eggjs/development',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * logger file rotator
    * @member {Object} Plugin#logrotator
@@ -82,10 +76,9 @@ export default {
    * @since 1.0.0
    */
   logrotator: {
-    enable: true,
-    package: '@eggjs/logrotator',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * schedule tasks
    * @member {Object} Plugin#schedule
@@ -93,10 +86,9 @@ export default {
    * @since 2.7.0
    */
   schedule: {
-    enable: true,
-    package: '@eggjs/schedule',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * `app/public` dir static serve
    * @member {Object} Plugin#static
@@ -104,10 +96,9 @@ export default {
    * @since 1.0.0
    */
   static: {
-    enable: true,
-    package: '@eggjs/static',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * jsonp support for egg
    * @member {Function} Plugin#jsonp
@@ -115,10 +106,9 @@ export default {
    * @since 1.0.0
    */
   jsonp: {
-    enable: true,
-    package: '@eggjs/jsonp',
-  },
-
+    enable: boolean;
+    package: string;
+  };
   /**
    * view plugin
    * @member {Function} Plugin#view
@@ -126,7 +116,9 @@ export default {
    * @since 1.0.0
    */
   view: {
-    enable: true,
-    package: '@eggjs/view',
-  },
+    enable: boolean;
+    package: string;
+  };
 };
+//#endregion
+export { _default as default };

package/dist/config/plugin.js

@@ -0,0 +1,54 @@
+//#region src/config/plugin.ts
+var plugin_default = {
+	onerror: {
+		enable: true,
+		package: "@eggjs/onerror"
+	},
+	session: {
+		enable: true,
+		package: "@eggjs/session"
+	},
+	i18n: {
+		enable: true,
+		package: "@eggjs/i18n"
+	},
+	watcher: {
+		enable: true,
+		package: "@eggjs/watcher"
+	},
+	multipart: {
+		enable: true,
+		package: "@eggjs/multipart"
+	},
+	security: {
+		enable: true,
+		package: "@eggjs/security"
+	},
+	development: {
+		enable: process.env.CI ? false : true,
+		package: "@eggjs/development"
+	},
+	logrotator: {
+		enable: true,
+		package: "@eggjs/logrotator"
+	},
+	schedule: {
+		enable: true,
+		package: "@eggjs/schedule"
+	},
+	static: {
+		enable: true,
+		package: "@eggjs/static"
+	},
+	jsonp: {
+		enable: true,
+		package: "@eggjs/jsonp"
+	},
+	view: {
+		enable: true,
+		package: "@eggjs/view"
+	}
+};
+
+//#endregion
+export { plugin_default as default };

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { AppWorkerLoader } from "./lib/loader/AppWorkerLoader.js";
+import { AgentWorkerLoader } from "./lib/loader/AgentWorkerLoader.js";
+import { Agent } from "./lib/agent.js";
+import Helper from "./app/extend/helper.js";
+import { Application } from "./lib/application.js";
+import { EggContextHttpClient as HttpClient, HttpClientOptions, HttpClientRequestOptions, HttpClientRequestURL, HttpClientResponse } from "./lib/core/httpclient.js";
+import Context from "./app/extend/context.js";
+import { ClientErrorResponse, CustomLoaderConfig, EggAppConfig, EggAppInfo, EggConfigFactory, EggEnvType, EggLoggerConfig, EggPlugin, EggPluginItem, HttpClientConfig, IEggPluginItem, PartialDeep, PartialEggConfig, PowerPartial, RequestObjectBody, defineConfig } from "./lib/types.js";
+import { ContextHttpClient } from "./lib/core/context_httpclient.js";
+import { EggApplicationCore, EggApplicationCoreOptions, EggContext, IBoot as ILifecycleBoot, MiddlewareFunc, Next, Request, Response, Router } from "./lib/egg.js";
+import { BaseContextClass } from "./lib/core/base_context_class.js";
+import { SingleModeAgent, SingleModeApplication, StartEggOptions, startEgg } from "./lib/start.js";
+import { CookieLimitExceedError } from "./lib/error/CookieLimitExceedError.js";
+import { MessageUnhandledRejectionError } from "./lib/error/MessageUnhandledRejectionError.js";
+import { BaseHookClass } from "./lib/core/base_hook_class.js";
+import { Singleton, SingletonCreateMethod, SingletonOptions } from "@eggjs/core";
+import { EggLogger, LoggerLevel } from "egg-logger";
+export * from "@eggjs/cluster";
+export { Agent, AgentWorkerLoader, AppWorkerLoader, Application, BaseContextClass, BaseHookClass as Boot, ClientErrorResponse, Context, ContextHttpClient, BaseContextClass as Controller, BaseContextClass as Service, BaseContextClass as Subscription, CookieLimitExceedError, CustomLoaderConfig, EggAppConfig, EggAppInfo, EggApplicationCore, EggApplicationCoreOptions, EggConfigFactory, EggContext, HttpClient as EggContextHttpClient, HttpClient as EggHttpClient, HttpClient, EggEnvType, type EggLogger, EggLoggerConfig, EggPlugin, EggPluginItem, Helper, type Helper as IHelper, HttpClientConfig, HttpClientOptions, HttpClientRequestOptions, HttpClientRequestURL, HttpClientResponse, ILifecycleBoot as IBoot, ILifecycleBoot, IEggPluginItem, type LoggerLevel, MessageUnhandledRejectionError, MiddlewareFunc, Next, PartialDeep, PartialEggConfig, PowerPartial, Request, RequestObjectBody, Response, Router, type SingleModeAgent, type SingleModeApplication, Singleton, type SingletonCreateMethod, type SingletonOptions, StartEggOptions, defineConfig, startEgg as start, startEgg };

package/dist/index.js

@@ -0,0 +1,21 @@
+import { BaseHookClass } from "./lib/core/base_hook_class.js";
+import { BaseContextClass } from "./lib/core/base_context_class.js";
+import Context from "./app/extend/context.js";
+import { CookieLimitExceedError } from "./lib/error/CookieLimitExceedError.js";
+import { MessageUnhandledRejectionError } from "./lib/error/MessageUnhandledRejectionError.js";
+import { ContextHttpClient } from "./lib/core/context_httpclient.js";
+import { HttpClient } from "./lib/core/httpclient.js";
+import { EggApplicationCore, Request, Response, Router } from "./lib/egg.js";
+import { AppWorkerLoader } from "./lib/loader/AppWorkerLoader.js";
+import { AgentWorkerLoader } from "./lib/loader/AgentWorkerLoader.js";
+import "./lib/loader/index.js";
+import { Agent } from "./lib/agent.js";
+import Helper from "./app/extend/helper.js";
+import { Application } from "./lib/application.js";
+import { defineConfig } from "./lib/types.js";
+import { startEgg } from "./lib/start.js";
+import { Singleton } from "@eggjs/core";
+
+export * from "@eggjs/cluster"
+
+export { Agent, AgentWorkerLoader, AppWorkerLoader, Application, BaseContextClass, BaseHookClass as Boot, Context, ContextHttpClient, BaseContextClass as Controller, BaseContextClass as Service, BaseContextClass as Subscription, CookieLimitExceedError, EggApplicationCore, Helper, HttpClient, MessageUnhandledRejectionError, Request, Response, Router, Singleton, defineConfig, startEgg as start, startEgg };

package/dist/lib/agent.d.ts

@@ -0,0 +1,22 @@
+import { AgentWorkerLoader } from "./loader/AgentWorkerLoader.js";
+import { EggApplicationCore, EggApplicationCoreOptions } from "./egg.js";
+
+//#region src/lib/agent.d.ts
+declare const EGG_LOADER: unique symbol;
+/**
+ * Singleton instance in Agent Worker, extend {@link EggApplicationCore}
+ * @augments EggApplicationCore
+ */
+declare class Agent extends EggApplicationCore {
+  #private;
+  /**
+   * @class
+   * @param {Object} options - see {@link EggApplicationCore}
+   */
+  constructor(options?: Omit<EggApplicationCoreOptions, 'type'>);
+  get [EGG_LOADER](): typeof AgentWorkerLoader;
+  _wrapMessenger(): void;
+  close(): Promise<void>;
+}
+//#endregion
+export { Agent };

package/dist/lib/agent.js

@@ -0,0 +1,56 @@
+import { EggApplicationCore } from "./egg.js";
+import { AgentWorkerLoader } from "./loader/AgentWorkerLoader.js";
+import "./loader/index.js";
+
+//#region src/lib/agent.ts
+const EGG_LOADER = Symbol.for("egg#loader");
+/**
+* Singleton instance in Agent Worker, extend {@link EggApplicationCore}
+* @augments EggApplicationCore
+*/
+var Agent = class extends EggApplicationCore {
+	#agentAliveHandler;
+	/**
+	* @class
+	* @param {Object} options - see {@link EggApplicationCore}
+	*/
+	constructor(options) {
+		super({
+			...options,
+			type: "agent"
+		});
+		this.#agentAliveHandler = setInterval(() => {
+			this.coreLogger.info("[]");
+		}, 1440 * 60 * 1e3);
+	}
+	get [EGG_LOADER]() {
+		return AgentWorkerLoader;
+	}
+	_wrapMessenger() {
+		for (const methodName of [
+			"broadcast",
+			"sendTo",
+			"sendToApp",
+			"sendToAgent",
+			"sendRandom"
+		]) wrapMethod(methodName, this.messenger, this.coreLogger);
+		function wrapMethod(methodName, messenger, logger) {
+			const originMethod = messenger[methodName];
+			messenger[methodName] = function(...args) {
+				const stack = (/* @__PURE__ */ new Error()).stack.split("\n").slice(1).join("\n");
+				logger.warn("agent can't call %s before server started\n%s", methodName, stack);
+				originMethod.apply(this, args);
+			};
+			messenger.prependOnceListener("egg-ready", () => {
+				messenger[methodName] = originMethod;
+			});
+		}
+	}
+	async close() {
+		clearInterval(this.#agentAliveHandler);
+		await super.close();
+	}
+};
+
+//#endregion
+export { Agent };