milkio 0.8.2 → 1.0.0-alpha.0

package/kernel/logger.ts

@@ -1,131 +0,0 @@
-import { ExecuteResultFail, runtime, type ExecuteId } from "..";
-import { loggerOptions, LoggerTags } from "../../../src/logger";
-
-export type LoggerItem = {
-	executeId: ExecuteId;
-	loggerLevel: LoggerLevel;
-	description: string;
-	params: Array<unknown>;
-};
-
-export type MilkioLoggerTags = {
-	executeId: string;
-	from?: "http-server" | "execute";
-	method?: "POST" | "GET" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | string;
-	ip?: string;
-	path?: string;
-	status?: number;
-	url?: string;
-	params?: any;
-	body?: string;
-	fail?: ExecuteResultFail;
-	timein?: number;
-	timeout?: number;
-	result?: unknown;
-	requestHeaders?: Record<string, string>;
-	responseHeaders?: Record<string, string>;
-};
-
-export type LoggerOptions = {
-	onInsert: (options: LoggerItem) => boolean;
-	onSubmit: (tags: MilkioLoggerTags & LoggerTags, logs: Array<LoggerItem>) => Promise<void> | void;
-};
-
-export type Logger = {
-	debug: (description: string, ...params: Array<unknown>) => void;
-	log: (description: string, ...params: Array<unknown>) => void;
-	info: (description: string, ...params: Array<unknown>) => void;
-	warn: (description: string, ...params: Array<unknown>) => void;
-	error: (description: string, ...params: Array<unknown>) => void;
-};
-
-export const loggerController = (() => {
-	const logs = new Map<ExecuteId, { __LOG_DETAIL__: Array<LoggerItem>; [key: string]: any }>();
-
-	const loggerPushTags = (executeId: ExecuteId, tags: Partial<MilkioLoggerTags & LoggerTags>) => {
-		if (!logs.has(executeId)) logs.set(executeId, { __LOG_DETAIL__: [] });
-		const logItem = logs.get(executeId);
-		for (const key in tags) {
-			logItem![key] = (tags as any)[key];
-		}
-	};
-
-	const loggerSubmit = async (executeId: ExecuteId) => {
-		if (!logs.has(executeId)) return;
-		if (executeId === "global") return;
-		const loggerSubmitOptions: any = {
-			executeId,
-		};
-		const log = logs.get(executeId)!;
-		for (const key in log) {
-			if (key === "__LOG_DETAIL__") continue;
-			loggerSubmitOptions[key] = log[key];
-		}
-		logs.delete(executeId);
-		loggerOptions.onSubmit(loggerSubmitOptions, log.__LOG_DETAIL__);
-	};
-
-	const loggerSubmitAll = async () => {
-		for (const executeId of logs.keys()) {
-			await loggerSubmit(executeId);
-		}
-	};
-
-	const insertItem = (executeId: ExecuteId, level: LoggerLevel, description: string, params: Array<unknown>): void => {
-		let executeIds: Array<string> = [];
-		if (executeId === "global") {
-			executeIds = Array.from(new Set([...Array.from(runtime.execute.executeIds), ...Array.from(runtime.execute.executeIds)]));
-		} else {
-			executeIds = [executeId];
-		}
-
-		for (const executeId of executeIds) {
-			if (!logs.has(executeId as ExecuteId)) logs.set(executeId as ExecuteId, { __LOG_DETAIL__: [] });
-			const loggerItem = {
-				executeId: executeId as ExecuteId,
-				loggerLevel: level,
-				description,
-				params,
-			} satisfies LoggerItem;
-			if (!loggerOptions.onInsert(loggerItem)) return;
-			logs.get(executeId as ExecuteId)!.__LOG_DETAIL__.push(loggerItem);
-		}
-	};
-
-	const useLogger = (executeId: ExecuteId) => {
-		return {
-			debug(description: string, ...params: Array<unknown>) {
-				insertItem(executeId, "debug", description, params);
-			},
-			log(description: string, ...params: Array<unknown>) {
-				insertItem(executeId, "log", description, params);
-			},
-			info(description: string, ...params: Array<unknown>) {
-				insertItem(executeId, "log", description, params);
-			},
-			warn(description: string, ...params: Array<unknown>) {
-				insertItem(executeId, "warn", description, params);
-			},
-			error(description: string, ...params: Array<unknown>) {
-				insertItem(executeId, "error", description, params);
-			},
-		} satisfies Logger;
-	};
-
-	return {
-		loggerPushTags,
-		loggerSubmit,
-		loggerSubmitAll,
-		useLogger,
-	};
-})();
-
-export const useLogger = loggerController.useLogger;
-
-export const loggerPushTags = loggerController.loggerPushTags;
-
-export const loggerSubmit = loggerController.loggerSubmit;
-
-export const loggerSubmitAll = loggerController.loggerSubmitAll;
-
-export type LoggerLevel = "debug" | "log" | "warn" | "error";

package/kernel/meta.ts

@@ -1,9 +0,0 @@
-import type { Meta } from "../../../src/meta";
-import schema from "../../../generated/api-schema";
-
-export async function useMeta(path: string): Promise<Meta> {
-	// @ts-ignore
-	const api = schema.apiMethodsSchema[path as keyof (typeof schema)["apiMethodsTypeSchema"]]();
-	const module = await api.module;
-	return module.api.meta;
-}

package/kernel/middleware.ts

@@ -1,51 +0,0 @@
-import type { Context } from "../../../src/context";
-import type { FrameworkHttpDetail } from "./context";
-import type { MilkioApp } from "milkio";
-
-export type BootstrapMiddleware = (milkio: MilkioApp) => Promise<void> | void;
-export type BeforeExecuteMiddleware = (context: Context) => Promise<void> | void;
-export type AfterExecuteMiddleware = (context: Context, response: { value: unknown }) => Promise<void> | void;
-export type AfterHttpRequestMiddleware = (headers: Headers, detail: FrameworkHttpDetail) => Promise<void> | void;
-export type BeforeHttpResponseMiddleware = (response: { value: string }, detail: FrameworkHttpDetail) => Promise<void> | void;
-export type HttpNotFoundMiddleware = (detail: FrameworkHttpDetail) => Promise<void> | void;
-
-export type MiddlewareOptions = {
-	bootstrap?: BootstrapMiddleware;
-	beforeExecute?: BeforeExecuteMiddleware;
-	afterExecute?: AfterExecuteMiddleware;
-	afterHttpRequest?: AfterHttpRequestMiddleware;
-	beforeHttpResponse?: BeforeHttpResponseMiddleware;
-	httpNotFound?: HttpNotFoundMiddleware;
-} & Record<string, (...args: Array<any>) => Promise<void> | void>;
-export type MiddlewareFn = (...args: Array<any>) => Promise<void> | void;
-export type MiddlewareT<T extends MiddlewareFn = MiddlewareFn> = { id: string; index: number; middleware: T };
-
-export const _middlewareEvents = new Map<string, (a: MiddlewareT, b: MiddlewareT) => number>();
-export const _middlewares = new Map<string, Array<MiddlewareT>>();
-
-export const MiddlewareEvent = (() => {
-	const defineMiddlewareEvent = (name: string, sortFn: (a: MiddlewareT, b: MiddlewareT) => number) => {
-		_middlewareEvents.set(name, sortFn);
-	};
-
-	const sortMiddlewareEvent = () => {
-		for (const [key, middleware] of _middlewares) {
-			const sort = _middlewareEvents.get(key);
-			if (sort) middleware.sort(sort);
-		}
-	};
-
-	const handleMiddleware = async (name: string, args: Array<any> /* Parameters<MiddlewareOptions[Name]> */) => {
-		const mds = _middlewares.get(name);
-		if (!mds) return;
-		for (const md of mds) {
-			await md.middleware(...args);
-		}
-	};
-
-	return {
-		define: defineMiddlewareEvent,
-		handle: handleMiddleware,
-		_sort: sortMiddlewareEvent,
-	};
-})();

package/kernel/milkio.ts

@@ -1,87 +0,0 @@
-import { type MiddlewareOptions, _middlewares, MiddlewareEvent } from "./middleware";
-import schema from "../../../generated/api-schema";
-import { runtime } from "..";
-import { createUlid } from "../utils/create-ulid";
-import { _validate } from "./validate";
-import { _execute, _call, _executeToJson, _executeStream } from "./execute";
-
-export type MilkioAppOptions = {
-	/**
-	 * bootstraps
-	 * @description
-	 * When Milkio is launched, all methods in this array will run **in parallel**.
-	 */
-	bootstraps?: () => Array<
-		/* This type is long, and its intention is to prevent someone from forgetting to add parentheses when adding bootstraps. Therefore, it allows all types except methods */ Promise<unknown> | void | string | number | boolean | null | undefined | Record<string | number | symbol, unknown> | Array<unknown>
-	>;
-	/**
-	 * middlewares
-	 * @description
-	 * When Milkio is launched, the closer it is to the front of the array, the more it is on the outer layer of the "onion".
-	 */
-	middlewares?: () => Array<MiddlewareOptions>;
-	/**
-	 * maxRunningTime (minutes)
-	 * @description
-	 * When the function runs for a long time, it is possible that the memory will continuously expand (not necessarily due to memory leaks, but also possibly due to having a large number of routes).
-	 * Set the maximum running time (in minutes). When milkio's running time reaches this value, terminate the process and automatically restart it from outside (K8S or other means).
-	 */
-	enableMaxRunningTimeoutLimit?: number | null | undefined;
-};
-
-export async function createMilkioApp(MilkioAppOptions: MilkioAppOptions = {}) {
-	if (MilkioAppOptions.enableMaxRunningTimeoutLimit && MilkioAppOptions.enableMaxRunningTimeoutLimit >= 1) {
-		setTimeout(
-			() => {
-				throw new Error('Milkio reached the limit of "maxRunningTimeout" in the options and automatically exited.');
-			},
-			MilkioAppOptions.enableMaxRunningTimeoutLimit * 60 * 1000,
-		);
-		runtime.maxRunningTimeout.enable = true;
-	}
-
-	const MilkioApp = {
-		randParams: _randParams,
-		execute: _execute,
-		executeToJson: _executeToJson,
-		executeStream: _executeStream,
-		_call,
-	};
-
-	if (MilkioAppOptions.bootstraps) {
-		await Promise.all(MilkioAppOptions.bootstraps());
-	}
-
-	if (MilkioAppOptions.middlewares) {
-		MiddlewareEvent.define("bootstrap", (a, b) => a.index - b.index);
-		MiddlewareEvent.define("beforeExecute", (a, b) => a.index - b.index);
-		MiddlewareEvent.define("afterExecute", (a, b) => b.index - a.index);
-		MiddlewareEvent.define("afterHttpRequest", (a, b) => a.index - b.index);
-		MiddlewareEvent.define("beforeHttpResponse", (a, b) => b.index - a.index);
-		MiddlewareEvent.define("httpNotFound", (a, b) => a.index - b.index);
-
-		const middlewares = MilkioAppOptions.middlewares();
-
-		for (let index = 0; index < middlewares.length; index++) {
-			const middlewareOptions = middlewares[index];
-			for (const name in middlewareOptions) {
-				let middleware = _middlewares.get(name);
-				if (middleware === undefined) {
-					middleware = [];
-					_middlewares.set(name, middleware);
-				}
-				const id = createUlid();
-				middleware.push({ id, index, middleware: middlewareOptions[name] });
-			}
-		}
-		MiddlewareEvent._sort();
-
-		await MiddlewareEvent.handle("bootstrap", [MilkioApp]);
-	}
-
-	return MilkioApp;
-}
-
-export async function _randParams<Path extends keyof (typeof schema)["apiMethodsTypeSchema"]>(path: Path): Promise<Parameters<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>[0]> {
-	return await (await schema.apiValidator.validate[path]()).randParams();
-}

package/kernel/runtime.ts

@@ -1,11 +0,0 @@
-import type { ExecuteId } from "..";
-
-export const runtime = {
-	execute: {
-		executeIds: new Set<ExecuteId>(),
-	},
-	maxRunningTimeout: {
-		enable: false,
-		expectedEndedAt: 0,
-	},
-};

package/kernel/validate.ts

@@ -1,16 +0,0 @@
-import type { IValidation } from "typia";
-import { reject } from "../kernel/fail";
-
-export function _validate(validator: IValidation.IFailure | IValidation.ISuccess): any {
-	if (validator.success) return validator.data;
-	const error = validator.errors[0];
-
-	if (error.value === undefined) error.value === "undefined";
-	if (error.value === null) error.value === "null";
-
-	throw reject("TYPE_SAFE_ERROR", {
-		path: error.path,
-		expected: error.expected,
-		value: error.value,
-	});
-}

package/scripts/gen-insignificant.ts

@@ -1,258 +0,0 @@
-import { $ } from "bun";
-import { join } from "node:path";
-import { cwd } from "node:process";
-import { existsSync } from "node:fs";
-import { writeFile, readFile, copyFile } from "node:fs/promises";
-import { type MilkioConfig, TSON, type Cookbook } from "..";
-
-export default async () => {
-	const schema = await import("../../../generated/api-schema");
-	const paths = Object.keys(schema.default.apiMethodsSchema);
-
-	console.log("");
-	console.time(`Cookbook Stage`);
-
-	const cookbook: Cookbook = {};
-	for (const path of paths) {
-		// const module = await import(/* @vite-ignore */ join(`../../../src/apps/${path}`));
-		const code = (await readFile(join(cwd(), `./src/apps/${path}.ts`))).toString();
-		const codeLines = code.split("\n");
-		let title;
-		let desc;
-		const descRaw = /\n\/\*\*\n[\s\S]+?\*\//.exec(code)?.[0] ?? "";
-
-		if (descRaw) {
-			const descRawLines = descRaw.split("\n");
-			if (descRawLines.at(0)?.trim() === "") descRawLines.shift();
-			if (descRawLines.at(-1)?.trim() === "") descRawLines.pop();
-			let first = true;
-			for (let index = 0; index < descRawLines.length; index++) {
-				const descRawLine = descRawLines[index].replace(/^[/ ]+?[*]*/, "").replace(/[*]*\/$/, "");
-
-				if (!descRawLine) continue;
-				if (first) {
-					title = descRawLine.replace(/#/g, "").trim();
-					// Originally the title was in the first line, desc is the rest of it, now desc contains complete markdown content.
-					// continue;
-				}
-				first = false;
-				desc = `${desc ?? ""}\n${descRawLine.trim()}`;
-			}
-		}
-
-		let apiParams = /action\([\s\S]+?\)/.exec(code)?.[0] ?? ""; // The intention of the following code is to extract the parameter part of the action.
-		apiParams = /\([\s\S]*,/.exec(apiParams)?.[0] ?? "";
-		apiParams = apiParams.slice(0, -1);
-		apiParams = apiParams.slice(/[\s\S]+?:/.exec(apiParams)?.[0].length);
-		const apiParamsLines = apiParams.split("\n"); // The intention of the following code is to remove extra spaces, which will make the code look more beautiful.
-		if (apiParamsLines.at(-1)?.trim() === "") apiParamsLines.pop();
-		if (apiParamsLines.at(-1)?.trim() === "") apiParamsLines.pop();
-		let spaceNumber = 0;
-		for (const char of apiParamsLines.at(-1) ?? "") {
-			if (char === " ") spaceNumber++;
-			else break;
-		}
-		for (let index = 0; index < apiParamsLines.length; index++) {
-			const line = apiParamsLines[index];
-			let spaceNumberForThisLine = 0;
-			for (const char of line) {
-				if (char === " ") spaceNumberForThisLine++;
-				else break;
-			}
-			if (spaceNumberForThisLine >= spaceNumber) {
-				apiParamsLines[index] = line.slice(spaceNumber);
-			} else {
-				apiParamsLines[index] = line.slice(spaceNumberForThisLine);
-			}
-		}
-		apiParams = apiParamsLines.join("\n");
-
-		// Find the code for the API testing section.
-		const apiTestsCodeChars = [];
-		let apiTestsStartIndex = undefined as undefined | number;
-		let semicolonMatch = 0;
-		let semicolonMax = 0;
-		for (let index = 0; index < codeLines.length; index++) {
-			const codeLine = codeLines[index];
-			if (apiTestsStartIndex === undefined && !codeLine.includes("defineApiTest(")) continue;
-			if (apiTestsStartIndex === undefined) apiTestsStartIndex = index;
-			const codeChars = codeLine.split("");
-			for (const codeChar of codeChars) {
-				if (codeChar === "[") {
-					semicolonMatch++;
-					semicolonMax++;
-				}
-				if (semicolonMatch !== 0) apiTestsCodeChars.push(codeChar);
-				if (codeChar === "]") semicolonMatch--;
-			}
-			if (semicolonMatch === 0 && semicolonMax >= 1) {
-				break;
-			}
-			apiTestsCodeChars.push("\n");
-		}
-
-		// Find the code for each API test case.
-		const apiCaseCodes: Array<string> = [];
-		let currentApiCaseCode = undefined as undefined | Array<string>;
-		let apiTestCaseStartIndex = undefined as undefined | number;
-		let apiTestCaseMatch = 0;
-		for (let index = 0; index < apiTestsCodeChars.length; index++) {
-			const apiTestsCodeChar = apiTestsCodeChars[index];
-			if (apiTestCaseStartIndex === undefined && apiTestsCodeChar === "{") {
-				currentApiCaseCode = [];
-				apiTestCaseStartIndex = index;
-			}
-			if (apiTestsCodeChar === "{") {
-				apiTestCaseMatch++;
-			}
-
-			if (apiTestCaseMatch !== 0) currentApiCaseCode!.push(apiTestsCodeChar);
-
-			if (apiTestsCodeChar === "}") {
-				apiTestCaseMatch--;
-				if (apiTestCaseMatch === 0) {
-					apiCaseCodes.push(currentApiCaseCode!.join(""));
-					currentApiCaseCode = undefined;
-					apiTestCaseStartIndex = undefined;
-				}
-			}
-		}
-
-		const apiCases: Array<{
-			name: string;
-			handler: string;
-		}> = [];
-
-		for (let index = 0; index < apiCaseCodes.length; index++) {
-			const code = apiCaseCodes[index];
-			const name = /name:[\s\S]+?,/.exec(code)?.[0]?.slice(5, -1)?.trim().slice(1, -1) ?? "";
-			const handlerChars = /handler:[\s\S]*/.exec(code)?.[0]?.split("") ?? [];
-			let handler = ""; // Find the main code of the handler.
-			let handlerStartIndex = undefined as undefined | number;
-			let handlerMatch = 0;
-			for (let index = 0; index < handlerChars.length; index++) {
-				const handlerChar = handlerChars[index];
-				if (handlerStartIndex !== undefined && handlerChar === "{") handlerStartIndex = index;
-				if (handlerChar === "{") handlerMatch++;
-				if (handlerMatch !== 0) handler = handler + handlerChar;
-				if (handlerChar === "}") handlerMatch--;
-				if (handlerStartIndex !== undefined && handlerMatch === 0) break;
-			}
-			handler = handler.slice(1, -1);
-
-			const handlerLines = handler.split("\n"); // The intention of the following code is to remove extra spaces, which will make the code look more beautiful.
-			if (handlerLines.at(-1)?.trim() === "") handlerLines.pop();
-			if (handlerLines.at(-1)?.trim() === "") handlerLines.pop();
-			if (handlerLines.at(0)?.trim() === "") handlerLines.shift();
-			if (handlerLines.at(0)?.trim() === "") handlerLines.shift();
-			let spaceNumber = 0;
-			for (const char of handlerLines.at(-1) ?? "") {
-				if (char === " ") spaceNumber++;
-				else break;
-			}
-			for (let index = 0; index < handlerLines.length; index++) {
-				const line = handlerLines[index];
-				let spaceNumberForThisLine = 0;
-				for (const char of line) {
-					if (char === " ") spaceNumberForThisLine++;
-					else break;
-				}
-				if (spaceNumberForThisLine >= spaceNumber) {
-					handlerLines[index] = line.slice(spaceNumber);
-				} else {
-					handlerLines[index] = line.slice(spaceNumberForThisLine);
-				}
-			}
-			handler = handlerLines.join("\n");
-
-			apiCases.push({
-				name,
-				handler,
-			});
-		}
-
-		// This value has been deprecated because TypeScript types can already replace it well
-		// let paramsSchema;
-		// try {
-		//   const moduleGenerated = await import(/* @vite-ignore */ `../../../generated/products/apps/${path}`);
-		//   paramsSchema = moduleGenerated.paramsSchema.schemas[0]?.properties?.data;
-		// } catch (error) {}
-
-		cookbook[path] = {
-			title,
-			desc,
-			params: apiParams,
-			cases: apiCases,
-		};
-	}
-
-	/**
-	 * -- indexes
-	 */
-
-	const indexes: Record<string, Array<string>> = {};
-	const folderIndexes: Record<string, Array<string>> = {};
-	indexes["(root)"] = [];
-	folderIndexes["(root)"] = [];
-	for (const path in cookbook) {
-		if (!path.includes("/")) indexes["(root)"].push(path);
-	}
-	for (const path in cookbook) {
-		const dirnames = path.split("/");
-		for (let index = 0; index < dirnames.length - 1; index++) {
-			const dirpath = dirnames.slice(0, index + 1).join("/");
-			if (!indexes[dirpath]) indexes[dirpath] = [];
-			if (!folderIndexes[dirpath]) folderIndexes[dirpath] = [];
-			if (index + 1 === dirnames.length - 1) {
-				indexes[dirpath].push(path);
-			} else {
-				const childDirpath = dirnames.slice(0, index + 2).join("/");
-				if (folderIndexes[dirpath].includes(childDirpath)) continue;
-				folderIndexes[dirpath].push(childDirpath);
-			}
-		}
-	}
-	for (const path in folderIndexes) {
-		if (path.includes("/") || path === "(root)") continue;
-		folderIndexes["(root)"].push(path);
-	}
-
-	const readme = (await readFile(join(cwd(), "src", "apps", "README.md"))).toString();
-	Object.keys(indexes).forEach((key) => indexes[key].length === 0 && delete indexes[key]);
-	const generatedAt = new Date();
-
-	await writeFile(
-		join(cwd(), `./generated/cookbook.json`),
-		TSON.stringify({
-			cookbook,
-			readme,
-			indexes,
-			folderIndexes,
-			generatedAt,
-		}),
-	);
-
-	console.timeEnd(`Cookbook Stage`);
-	console.log(``);
-
-	console.time(`Client Stage`);
-	try {
-		if (process.platform !== "win32") await $`bun run ./node_modules/typescript/bin/tsc --outDir './packages/client/project'`.quiet();
-		else await $`powershell.exe -command "bun run ./node_modules/typescript/bin/tsc --outDir './packages/client/project'"`.quiet();
-	} catch (error) {}
-	await copyFile(join(cwd(), "src", "fail-code.ts"), join(cwd(), "packages", "client", "project", "src", "fail-code.ts"));
-	await $`bun i`.cwd(join(cwd(), "packages", "client"));
-	console.timeEnd(`Client Stage`);
-	console.log(``);
-
-	if (!existsSync(join(cwd(), "milkio.toml"))) return;
-	const milkioConfig = (await import(join(cwd(), "milkio.toml"))).default as MilkioConfig;
-	if (!milkioConfig?.generate?.significant) return;
-	let i = 0;
-	for (const command of milkioConfig.generate.significant) {
-		++i;
-		console.time(`Insignificant Stage (LINE ${i})`);
-		await $`${{ raw: command }}`;
-		console.timeEnd(`Insignificant Stage (LINE ${i})`);
-	}
-};