egg 4.1.0-beta.19 → 4.1.0-beta.20

package/dist/app/extend/request.js

@@ -1,226 +1,4 @@
-import "./response.js";
-import { Request as Request$1 } from "@eggjs/core";
-import querystring from "node:querystring";
+import "../../response-CDeQ9Sx2.js";
+import { Request } from "../../request-Cy_1DlaX.js";
 
-//#region src/app/extend/request.ts
-const QUERY_CACHE = Symbol("request query cache");
-const QUERIES_CACHE = Symbol("request queries cache");
-const PROTOCOL = Symbol("request protocol");
-const HOST = Symbol("request host");
-const IPS = Symbol("request ips");
-const RE_ARRAY_KEY = /[^[\]]+\[\]$/;
-var Request = class extends Request$1 {
-	/**
-	* Parse the "Host" header field host
-	* and support X-Forwarded-Host when a
-	* proxy is enabled.
-	* @member {String} Request#host
-	* @example
-	* ip + port
-	* ```js
-	* this.request.host
-	* => '127.0.0.1:7001'
-	* ```
-	* or domain
-	* ```js
-	* this.request.host
-	* => 'demo.eggjs.org'
-	* ```
-	*/
-	get host() {
-		let host = this[HOST];
-		if (host) return host;
-		if (this.app.config.proxy) host = getFromHeaders(this, this.app.config.hostHeaders);
-		host = host || this.get("host") || "";
-		this[HOST] = host = host.split(",")[0].trim();
-		return host;
-	}
-	/**
-	* @member {String} Request#protocol
-	* @example
-	* ```js
-	* this.request.protocol
-	* => 'https'
-	* ```
-	*/
-	get protocol() {
-		let protocol = this[PROTOCOL];
-		if (protocol) return protocol;
-		if (this.socket?.encrypted) {
-			this[PROTOCOL] = protocol = "https";
-			return protocol;
-		}
-		if (this.app.config.proxy) {
-			const proto = getFromHeaders(this, this.app.config.protocolHeaders);
-			if (proto) {
-				this[PROTOCOL] = protocol = proto.split(/\s*,\s*/)[0];
-				return protocol;
-			}
-		}
-		this[PROTOCOL] = protocol = this.app.config.protocol || "http";
-		return protocol;
-	}
-	/**
-	* Get all pass through ip addresses from the request.
-	* Enable only on `app.config.proxy = true`
-	*
-	* @member {Array} Request#ips
-	* @example
-	* ```js
-	* this.request.ips
-	* => ['100.23.1.2', '201.10.10.2']
-	* ```
-	*/
-	get ips() {
-		let ips = this[IPS];
-		if (ips) return ips;
-		if (!this.app.config.proxy) {
-			this[IPS] = ips = [];
-			return ips;
-		}
-		const val = getFromHeaders(this, this.app.config.ipHeaders);
-		this[IPS] = ips = val ? val.split(/\s*,\s*/) : [];
-		let maxIpsCount = this.app.config.maxIpsCount;
-		if (!maxIpsCount && this.app.config.maxProxyCount) maxIpsCount = this.app.config.maxProxyCount + 1;
-		if (maxIpsCount > 0) this[IPS] = ips = ips.slice(-maxIpsCount);
-		return ips;
-	}
-	/**
-	* Get the request remote IPv4 address
-	* @member {String} Request#ip
-	* @return {String} IPv4 address
-	* @example
-	* ```js
-	* this.request.ip
-	* => '127.0.0.1'
-	* => '111.10.2.1'
-	* ```
-	*/
-	get ip() {
-		if (this._ip) return this._ip;
-		const ip = this.ips[0] ?? this.socket.remoteAddress;
-		this._ip = ip && ip.startsWith("::ffff:") ? ip.substring(7) : ip;
-		return this._ip;
-	}
-	/**
-	* Set the request remote IPv4 address
-	* @member {String} Request#ip
-	* @param {String} ip - IPv4 address
-	* @example
-	* ```js
-	* this.request.ip
-	* => '127.0.0.1'
-	* => '111.10.2.1'
-	* ```
-	*/
-	set ip(ip) {
-		this._ip = ip;
-	}
-	/**
-	* detect if response should be json
-	* 1. url path ends with `.json`
-	* 2. response type is set to json
-	* 3. detect by request accept header
-	*
-	* @member {Boolean} Request#acceptJSON
-	* @since 1.0.0
-	*/
-	get acceptJSON() {
-		if (this.path.endsWith(".json")) return true;
-		if (this.response.type && this.response.type.indexOf("json") >= 0) return true;
-		if (this.accepts("html", "text", "json") === "json") return true;
-		return false;
-	}
-	_customQuery(cacheName, filter) {
-		const str = this.querystring || "";
-		let c = this[cacheName];
-		if (!c) c = this[cacheName] = {};
-		let cacheQuery = c[str];
-		if (!cacheQuery) {
-			cacheQuery = c[str] = {};
-			const isQueries = cacheName === QUERIES_CACHE;
-			const query = str ? querystring.parse(str) : {};
-			for (const key in query) {
-				if (!key) continue;
-				const value = filter(query[key]);
-				cacheQuery[key] = value;
-				if (isQueries && RE_ARRAY_KEY.test(key)) {
-					const subKey = key.substring(0, key.length - 2);
-					if (!cacheQuery[subKey]) cacheQuery[subKey] = value;
-				}
-			}
-		}
-		return cacheQuery;
-	}
-	/**
-	* get params pass by querystring, all values are of string type.
-	* @member {Object} Request#query
-	* @example
-	* ```js
-	* GET http://127.0.0.1:7001?name=Foo&age=20&age=21
-	* this.query
-	* => { 'name': 'Foo', 'age': '20' }
-	*
-	* GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
-	* this.query
-	* =>
-	* {
-	*   "a": "b",
-	*   "o[foo]": "bar",
-	*   "b[]": "1",
-	*   "e": "val"
-	* }
-	* ```
-	*/
-	get query() {
-		return this._customQuery(QUERY_CACHE, firstValue);
-	}
-	/**
-	* get params pass by querystring, all value are Array type. {@link Request#query}
-	* @member {Array} Request#queries
-	* @example
-	* ```js
-	* GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
-	* this.queries
-	* =>
-	* {
-	*   "a": ["b", "c"],
-	*   "o[foo]": ["bar"],
-	*   "b[]": ["1", "2"],
-	*   "e": ["val"]
-	* }
-	* ```
-	*/
-	get queries() {
-		return this._customQuery(QUERIES_CACHE, arrayValue);
-	}
-	/**
-	* Set query-string as an object.
-	*
-	* @function Request#query
-	* @param {Object} obj set querystring and query object for request.
-	*/
-	set query(obj) {
-		this.querystring = querystring.stringify(obj);
-	}
-};
-function firstValue(value) {
-	if (Array.isArray(value)) value = value[0];
-	return value;
-}
-function arrayValue(value) {
-	if (!Array.isArray(value)) value = [value];
-	return value;
-}
-function getFromHeaders(request, names) {
-	if (!names) return "";
-	const fields = names.split(/\s*,\s*/);
-	for (const name of fields) {
-		const value = request.get(name);
-		if (value) return value;
-	}
-	return "";
-}
-
-//#endregion
 export { Request as default };

package/dist/app/extend/response.d.ts

@@ -1,29 +1,2 @@
-import { Response as Response$1 } from "@eggjs/core";
-
-//#region src/app/extend/response.d.ts
-declare class Response extends Response$1 {
-  /**
-   * Get or set a real status code.
-   *
-   * e.g.: Using 302 status redirect to the global error page
-   * instead of show current 500 status page.
-   * And access log should save 500 not 302,
-   * then the `realStatus` can help us find out the real status code.
-   * @member {Number} Response#realStatus
-   * @return {Number} The status code to be set.
-   */
-  get realStatus(): number;
-  /**
-   * Set a real status code.
-   *
-   * e.g.: Using 302 status redirect to the global error page
-   * instead of show current 500 status page.
-   * And access log should save 500 not 302,
-   * then the `realStatus` can help us find out the real status code.
-   * @member {Number} Response#realStatus
-   * @param {Number} status The status code to be set.
-   */
-  set realStatus(status: number);
-}
-//#endregion
+import { Response } from "../../response-DlNYDj00.js";
 export { Response as default };

package/dist/app/extend/response.js

@@ -1,36 +1,3 @@
-import { Response as Response$1 } from "@eggjs/core";
+import { Response } from "../../response-CDeQ9Sx2.js";
 
-//#region src/app/extend/response.ts
-const REAL_STATUS = Symbol("response realStatus");
-var Response = class extends Response$1 {
-	/**
-	* Get or set a real status code.
-	*
-	* e.g.: Using 302 status redirect to the global error page
-	* instead of show current 500 status page.
-	* And access log should save 500 not 302,
-	* then the `realStatus` can help us find out the real status code.
-	* @member {Number} Response#realStatus
-	* @return {Number} The status code to be set.
-	*/
-	get realStatus() {
-		if (this[REAL_STATUS]) return this[REAL_STATUS];
-		return this.status;
-	}
-	/**
-	* Set a real status code.
-	*
-	* e.g.: Using 302 status redirect to the global error page
-	* instead of show current 500 status page.
-	* And access log should save 500 not 302,
-	* then the `realStatus` can help us find out the real status code.
-	* @member {Number} Response#realStatus
-	* @param {Number} status The status code to be set.
-	*/
-	set realStatus(status) {
-		this[REAL_STATUS] = status;
-	}
-};
-
-//#endregion
 export { Response as default };

package/dist/app/middleware/meta.d.ts

@@ -1,11 +1,12 @@
-import Context from "../extend/context.js";
-import { Next } from "../../lib/egg.js";
-
-//#region src/app/middleware/meta.d.ts
-interface MetaMiddlewareOptions {
-  enable: boolean;
-  logging: boolean;
-}
-declare const _default: (options: MetaMiddlewareOptions) => (ctx: Context, next: Next) => Promise<void>;
-//#endregion
+import "../../EggApplicationLoader-PnIvd5oV.js";
+import "../../AppWorkerLoader-CT875rYM.js";
+import "../../AgentWorkerLoader-DG_hAClt.js";
+import "../../index-CUPkUUOR.js";
+import { MetaMiddlewareOptions, _default$2 as _default } from "../../base_hook_class-R8A8gm1s.js";
+import "../../response-DlNYDj00.js";
+import "../../types.plugin-C3D5I7VD.js";
+import "../../IMessenger-C9g6ypSI.js";
+import "../../CookieLimitExceedError-CAW0HYJw.js";
+import "../../MessageUnhandledRejectionError-Lq5fWw24.js";
+import "../../index-CkgLZdB4.js";
 export { MetaMiddlewareOptions, _default as default };

package/dist/app/middleware/notfound.d.ts

@@ -1,11 +1,12 @@
-import Context from "../extend/context.js";
-import { Next } from "../../lib/egg.js";
-
-//#region src/app/middleware/notfound.d.ts
-interface NotFoundMiddlewareOptions {
-  enable: boolean;
-  pageUrl: string;
-}
-declare const _default: (options: NotFoundMiddlewareOptions) => (ctx: Context, next: Next) => Promise<void>;
-//#endregion
+import "../../EggApplicationLoader-PnIvd5oV.js";
+import "../../AppWorkerLoader-CT875rYM.js";
+import "../../AgentWorkerLoader-DG_hAClt.js";
+import "../../index-CUPkUUOR.js";
+import { NotFoundMiddlewareOptions, _default$1 as _default } from "../../base_hook_class-R8A8gm1s.js";
+import "../../response-DlNYDj00.js";
+import "../../types.plugin-C3D5I7VD.js";
+import "../../IMessenger-C9g6ypSI.js";
+import "../../CookieLimitExceedError-CAW0HYJw.js";
+import "../../MessageUnhandledRejectionError-Lq5fWw24.js";
+import "../../index-CkgLZdB4.js";
 export { NotFoundMiddlewareOptions, _default as default };

package/dist/app/middleware/site_file.d.ts

@@ -1,13 +1,12 @@
-import Context from "../extend/context.js";
-import { Next } from "../../lib/egg.js";
-
-//#region src/app/middleware/site_file.d.ts
-type SiteFileContentFun = (ctx: Context) => Promise<Buffer | string>;
-interface SiteFileMiddlewareOptions {
-  enable: boolean;
-  cacheControl: string;
-  [key: string]: string | Buffer | boolean | SiteFileContentFun | URL;
-}
-declare const _default: (options: SiteFileMiddlewareOptions) => (ctx: Context, next: Next) => Promise<void>;
-//#endregion
+import "../../EggApplicationLoader-PnIvd5oV.js";
+import "../../AppWorkerLoader-CT875rYM.js";
+import "../../AgentWorkerLoader-DG_hAClt.js";
+import "../../index-CUPkUUOR.js";
+import { SiteFileContentFun, SiteFileMiddlewareOptions, _default } from "../../base_hook_class-R8A8gm1s.js";
+import "../../response-DlNYDj00.js";
+import "../../types.plugin-C3D5I7VD.js";
+import "../../IMessenger-C9g6ypSI.js";
+import "../../CookieLimitExceedError-CAW0HYJw.js";
+import "../../MessageUnhandledRejectionError-Lq5fWw24.js";
+import "../../index-CkgLZdB4.js";
 export { SiteFileContentFun, SiteFileMiddlewareOptions, _default as default };

package/dist/application-DVwFQSa9.js

@@ -0,0 +1,208 @@
+import { CookieLimitExceedError } from "./CookieLimitExceedError-DLGakbeu.js";
+import { EggApplicationCore } from "./egg-DVo5e_lr.js";
+import { AppWorkerLoader } from "./AppWorkerLoader-CAtxJvGl.js";
+import { Helper } from "./helper-B3PKMPXq.js";
+import { utils } from "@eggjs/core";
+import path from "node:path";
+import { assign } from "utility";
+import fs from "node:fs";
+import http from "node:http";
+import { isGeneratorFunction } from "is-type-of";
+import { Socket } from "node:net";
+import { graceful } from "graceful";
+
+//#region src/lib/application.ts
+const EGG_LOADER = Symbol.for("egg#loader");
+const DEFAULT_BAD_REQUEST_HTML = `<html>
+  <head><title>400 Bad Request</title></head>
+  <body bgcolor="white">
+  <center><h1>400 Bad Request</h1></center>
+  <hr><center>❤</center>
+  </body>
+  </html>`;
+const DEFAULT_BAD_REQUEST_RESPONSE = `HTTP/1.1 400 Bad Request\r\nContent-Length: ${Buffer.byteLength(DEFAULT_BAD_REQUEST_HTML)}\r\n\r\n${DEFAULT_BAD_REQUEST_HTML}`;
+function escapeHeaderValue(value) {
+	return /[\r\n]/.test(value) ? value.replace(/[\r\n]+[ \t]*/g, "") : value;
+}
+/**
+* Singleton instance in App Worker, extend {@link EggApplicationCore}
+* @augments EggApplicationCore
+*/
+var Application = class extends EggApplicationCore {
+	server;
+	#locals = {};
+	/**
+	* reference to {@link Helper}
+	* @member {Helper} Application#Helper
+	*/
+	Helper = Helper;
+	/**
+	* @class
+	* @param {Object} options - see {@link EggApplicationCore}
+	*/
+	constructor(options) {
+		super({
+			...options,
+			type: "application"
+		});
+	}
+	async load() {
+		await super.load();
+		this.#warnConfusedConfig();
+		this.#bindEvents();
+	}
+	get [EGG_LOADER]() {
+		return AppWorkerLoader;
+	}
+	#responseRaw(socket, raw) {
+		if (!socket?.writable) return;
+		if (!raw) return socket.end(DEFAULT_BAD_REQUEST_RESPONSE);
+		const body = raw.body == null ? DEFAULT_BAD_REQUEST_HTML : raw.body;
+		const headers = raw.headers || {};
+		const status = raw.status || 400;
+		let responseHeaderLines = "";
+		const firstLine = `HTTP/1.1 ${status} ${http.STATUS_CODES[status] || "Unknown"}`;
+		for (const key of Object.keys(headers)) {
+			if (key.toLowerCase() === "content-length") {
+				delete headers[key];
+				continue;
+			}
+			responseHeaderLines += `${key}: ${escapeHeaderValue(headers[key])}\r\n`;
+		}
+		responseHeaderLines += `Content-Length: ${Buffer.byteLength(body)}\r\n`;
+		socket.end(`${firstLine}\r\n${responseHeaderLines}\r\n${body.toString()}`);
+	}
+	onClientError(err, socket) {
+		if (err.rawPacket) this.logger.warn("[egg:application] A client (%s:%d) error [%s] occurred: %s", socket.remoteAddress, socket.remotePort, err.code, err.message);
+		if (typeof this.config.onClientError === "function") utils.callFn(this.config.onClientError, [
+			err,
+			socket,
+			this
+		]).then((ret) => {
+			this.#responseRaw(socket, ret || {});
+		}).catch((err$1) => {
+			this.logger.error(err$1);
+			this.#responseRaw(socket);
+		});
+		else this.#responseRaw(socket);
+	}
+	onServer(server) {
+		this.server = server;
+		const serverGracefulIgnoreCode = this.config.serverGracefulIgnoreCode || [];
+		graceful({
+			server: [server],
+			error: (err, throwErrorCount) => {
+				const originMessage = err.message;
+				if (originMessage) Object.defineProperty(err, "message", {
+					get() {
+						return `${originMessage} (uncaughtException throw ${throwErrorCount} times on pid: ${process.pid})`;
+					},
+					configurable: true,
+					enumerable: false
+				});
+				this.coreLogger.error(err);
+			},
+			ignoreCode: serverGracefulIgnoreCode
+		});
+		server.on("clientError", (err, socket) => this.onClientError(err, socket));
+		if (typeof this.config.serverTimeout === "number") server.setTimeout(this.config.serverTimeout);
+	}
+	/**
+	* global locals for view
+	* @member {Object} Application#locals
+	* @see Context#locals
+	*/
+	get locals() {
+		return this.#locals;
+	}
+	set locals(val) {
+		assign(this.#locals, val);
+	}
+	/**
+	* save routers to `run/router.json`
+	* @private
+	*/
+	dumpConfig() {
+		super.dumpConfig();
+		const rundir = this.config.rundir;
+		const FULLPATH = this.loader.FileLoader.FULLPATH;
+		try {
+			const dumpRouterFile = path.join(rundir, "router.json");
+			const routers = [];
+			for (const layer of this.router.stack) routers.push({
+				name: layer.name,
+				methods: layer.methods,
+				paramNames: layer.paramNames,
+				path: layer.path,
+				regexp: layer.regexp.toString(),
+				stack: layer.stack.map((stack) => stack[FULLPATH] || stack._name || stack.name || "anonymous")
+			});
+			fs.writeFileSync(dumpRouterFile, JSON.stringify(routers, null, 2));
+		} catch (err) {
+			this.coreLogger.warn(`dumpConfig router.json error: ${err.message}`);
+		}
+	}
+	/**
+	* Run async function in the background
+	* @see Context#runInBackground
+	* @param {Function} scope - the first args is an anonymous ctx
+	*/
+	runInBackground(scope, req) {
+		const ctx = this.createAnonymousContext(req);
+		if (!scope.name) Reflect.set(scope, "_name", utils.getCalleeFromStack(true));
+		this.ctxStorage.run(ctx, () => {
+			return ctx.runInBackground(scope);
+		});
+	}
+	/**
+	* secret key for Application
+	* @member {String} Application#keys
+	*/
+	get keys() {
+		if (!this._keys) {
+			if (!this.config.keys) {
+				if (this.config.env === "local" || this.config.env === "unittest") {
+					const configPath = path.join(this.config.baseDir, "config/config.default.js");
+					console.error("Cookie need secret key to sign and encrypt.");
+					console.error("Please add `config.keys` in %s", configPath);
+				}
+				throw new Error("Please set config.keys first");
+			}
+			this._keys = this.config.keys.split(",").map((s) => s.trim());
+		}
+		return this._keys;
+	}
+	/**
+	* @deprecated keep compatible with egg 3.x
+	*/
+	toAsyncFunction(fn) {
+		if (isGeneratorFunction(fn)) throw new Error("Generator function is not supported");
+		return fn;
+	}
+	/**
+	* bind app's events
+	*
+	* @private
+	*/
+	#bindEvents() {
+		this.on("cookieLimitExceed", ({ name, value, ctx }) => {
+			const err = new CookieLimitExceedError(name, value);
+			ctx.coreLogger.error(err);
+		});
+		this.once("server", (server) => this.onServer(server));
+	}
+	/**
+	* warn when confused configurations are present
+	*
+	* @private
+	*/
+	#warnConfusedConfig() {
+		const confusedConfigurations = this.config.confusedConfigurations;
+		Object.keys(confusedConfigurations).forEach((key) => {
+			if (this.config[key] !== void 0) this.logger.warn("[egg:application] Unexpected config key `%o` exists, Please use `%o` instead.", key, confusedConfigurations[key]);
+		});
+	}
+};
+
+//#endregion
+export { Application };

package/dist/base-KLVtlzUD.d.ts

@@ -0,0 +1,12 @@
+import { EggApplicationCore } from "./base_hook_class-R8A8gm1s.js";
+import { EventEmitter, captureRejectionSymbol } from "node:events";
+
+//#region src/lib/core/messenger/base.d.ts
+declare class BaseMessenger extends EventEmitter {
+  protected readonly egg: EggApplicationCore;
+  constructor(egg: EggApplicationCore);
+  [captureRejectionSymbol](err: Error, event: string | symbol, ...args: any[]): void;
+  emit(eventName: string | symbol, ...args: any[]): boolean;
+}
+//#endregion
+export { BaseMessenger };

package/dist/base_context_class-Xc1OZql9.js

@@ -0,0 +1,19 @@
+import { BaseContextLogger } from "./base_context_logger-CZU59PGA.js";
+import { BaseContextClass } from "@eggjs/core";
+
+//#region src/lib/core/base_context_class.ts
+/**
+* BaseContextClass is a base class that can be extended,
+* it's instantiated in context level,
+* {@link Helper}, {@link Service} is extending it.
+*/
+var BaseContextClass$1 = class extends BaseContextClass {
+	#logger;
+	get logger() {
+		if (!this.#logger) this.#logger = new BaseContextLogger(this.ctx, this.pathName);
+		return this.#logger;
+	}
+};
+
+//#endregion
+export { BaseContextClass$1 as BaseContextClass };

package/dist/base_context_logger-CZU59PGA.js

@@ -0,0 +1,58 @@
+//#region src/lib/core/base_context_logger.ts
+var BaseContextLogger = class {
+	#ctx;
+	#pathName;
+	/**
+	* @class
+	* @param {Context} ctx - context instance
+	* @param {String} pathName - class path name
+	* @since 1.0.0
+	*/
+	constructor(ctx, pathName) {
+		/**
+		* @member {Context} BaseContextLogger#ctx
+		* @since 1.2.0
+		*/
+		this.#ctx = ctx;
+		this.#pathName = pathName;
+	}
+	_log(method, args) {
+		if (this.#pathName && typeof args[0] === "string") args[0] = `[${this.#pathName}] ${args[0]}`;
+		this.#ctx.app.logger[method](...args);
+	}
+	/**
+	* @member {Function} BaseContextLogger#debug
+	* @param {...any} args - log msg
+	* @since 1.2.0
+	*/
+	debug(...args) {
+		this._log("debug", args);
+	}
+	/**
+	* @member {Function} BaseContextLogger#info
+	* @param {...any} args - log msg
+	* @since 1.2.0
+	*/
+	info(...args) {
+		this._log("info", args);
+	}
+	/**
+	* @member {Function} BaseContextLogger#warn
+	* @param {...any} args - log msg
+	* @since 1.2.0
+	*/
+	warn(...args) {
+		this._log("warn", args);
+	}
+	/**
+	* @member {Function} BaseContextLogger#error
+	* @param {...any} args - log msg
+	* @since 1.2.0
+	*/
+	error(...args) {
+		this._log("error", args);
+	}
+};
+
+//#endregion
+export { BaseContextLogger };