milkio 0.6.0 → 0.7.0-alpha.1

package/api-test/index.ts

@@ -1,6 +1,6 @@
+import chalk from "chalk";
 import schema from "../../../generated/api-schema";
 import { ExecuteResultFail, type MilkioApp } from "..";
-import chalk from "chalk";
 import { handleCatchError } from "../utils/handle-catch-error.ts";
 
 export const executeApiTests = async <Path extends Array<keyof (typeof schema)["apiTestsSchema"]>>(app: MilkioApp, path: Path | string | true | 1 | undefined) => {
@@ -16,9 +16,49 @@ export const executeApiTests = async <Path extends Array<keyof (typeof schema)["
 	const startedAt = new Date().getTime();
 	const apiTestHooks = await import("../../../src/api-test.ts");
 	await apiTestHooks.default.onBootstrap();
+	const clientPackage = apiTestHooks.default?.client ? (await apiTestHooks.default?.client()) : undefined;
 	const results: Array<{ path: string, case: number, fail: boolean, failMessage?: string }> = [];
 	console.log(chalk.hex("#0B346E")(`₋₋₋₋₋₋₋₋`));
 
+	if (!clientPackage) {
+		console.log(`🚨 For testing purposes, if the client package does not exist, subsequent operations might result in errors.`);
+		console.log(`🚨 To disable this warning and ensure the test system runs correctly:`);
+		console.log(` - Run: \`bun i packages/client && cd packages/client && bun i milkio-client\``);
+		console.log(` - Edit: \`src/api-test.ts\``);
+		console.log(` - Add: \`client: () => createClient({ baseUrl: "http://localhost:9000/", memoryStorage: true }),\``);
+		console.log(` - The \`createClient\` method is imported from your client package. If you haven't changed the name in \`packages/client/package.json\`, you can use: \`import { createClient } from 'client';\`.`);
+	} else {
+		let done = false;
+		for (let index = 0; index < 160; index++) {
+			let response;
+			try {
+				response = await fetch(typeof clientPackage.options.baseUrl === "string" ? clientPackage.options.baseUrl : await clientPackage.options.baseUrl(), { method: "HEAD" });
+			} catch (error: any) {
+				if (error?.status && error.status < 500) {
+					done = true;
+					break;
+				}
+			}
+			if (response?.status && response.status < 500) {
+				done = true;
+				break;
+			}
+			await new Promise((resolve) => setTimeout(resolve, 100));
+			continue;
+		}
+		if (!done) {
+			console.log(`🚨 The server startup exceeded the maximum waiting time (1600ms).`);
+			console.log(`This is likely an error encountered during the startup of the Milkio Server. Please check the 'Milkio Run & Watch' tab in your VS Code terminal panel. This is only a warning, and the tests will continue, but there is a chance they might fail due to network issues.\n`);
+		}
+	}
+
+	const client = clientPackage ? {
+		execute: async (options?: any) => clientPackage!.execute((path as any), options),
+		executeOther: async (path: any, options?: any) => clientPackage!.execute((path as any), options),
+		executeStream: async (options?: any) => clientPackage!.executeStream((path as any), options),
+		executeStreamOther: async (path: any, options?: any) => clientPackage!.executeStream((path as any), options),
+	} : undefined;
+
 	for (const pathRaw of pathArr) {
 		let path = pathRaw.replaceAll("\\", "/");
 		if (path.startsWith("/")) path = path.slice(1) as Path[number];
@@ -36,10 +76,11 @@ export const executeApiTests = async <Path extends Array<keyof (typeof schema)["
 				await cs.handler({
 					...((await apiTestHooks.default.onBefore()) ?? {}),
 					log: (...args: Array<unknown>) => console.log(...args),
-					// @ts-ignore
 					execute: async (options?: any) => app.execute((path as any), options),
 					executeOther: async (path: any, options?: any) => app.execute((path as any), options),
 					executeStream: async (options?: any) => app.executeStream((path as any), options),
+					executeStreamOther: async (path: any, options?: any) => app.executeStream((path as any), options),
+					client,
 					randParams: () => app.randParams(path as any),
 					randOtherParams: (path: any) => app.randParams(path),
 					reject: (message?: string) => {

package/defines/define-api-test.ts

@@ -25,6 +25,28 @@ export type ApiTestCases<ApiT extends Api> = {
 				getResult: () => ExecuteResult<undefined>,
 				stream: AsyncGenerator<Awaited<ReturnType<ApiT["action"]>>>
 			}>;
+			executeStreamOther: <Path extends keyof (typeof schema)["apiMethodsTypeSchema"], Result extends Awaited<ReturnType<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>>>(path: Path, options: { params: Parameters<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>[0] | string, headers?: Record<string, string> } & ExecuteOptions) => Promise<{
+				getResult: () => ExecuteResult<undefined>,
+				stream: AsyncGenerator<Result>
+			}>;
+			client: {
+				execute: (options: { params: Parameters<ApiT["action"]>[0], headers?: Record<string, string> } & ExecuteOptions) => Promise<ExecuteResult<Awaited<ReturnType<ApiT["action"]>>>>;
+				executeOther: <Path extends keyof (typeof schema)["apiMethodsTypeSchema"], Result extends Awaited<ReturnType<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>>>(
+					path: Path,
+					options: {
+						params: Parameters<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>[0] | string,
+						headers?: Record<string, string>
+					} & ExecuteOptions,
+				) => Promise<ExecuteResult<Result>>;
+				executeStream: (options: { params: Parameters<ApiT["action"]>[0], headers?: Record<string, string> } & ExecuteOptions) => Promise<{
+					getResult: () => ExecuteResult<undefined>,
+					stream: AsyncGenerator<Awaited<ReturnType<ApiT["action"]>>>
+				}>;
+				executeStreamOther: <Path extends keyof (typeof schema)["apiMethodsTypeSchema"], Result extends Awaited<ReturnType<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>>>(path: Path, options: { params: Parameters<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>[0] | string, headers?: Record<string, string> } & ExecuteOptions) => Promise<{
+					getResult: () => ExecuteResult<undefined>,
+					stream: AsyncGenerator<Result>
+				}>;
+			}
 			randParams: () => Promise<Parameters<ApiT["action"]>[0]>;
 			randOtherParams: <Path extends keyof (typeof schema)["apiMethodsTypeSchema"]>(path: Path) => Promise<Parameters<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>[0]>;
 			reject: (message?: string) => void;

package/package.json

@@ -2,7 +2,7 @@
   "name": "milkio",
   "type": "module",
   "module": "index.ts",
-  "version": "0.6.0",
+  "version": "0.7.0-alpha.1",
   "peerDependencies": {
     "typescript": "^5.4.2"
   },