@geekmidas/constructs 10.0.0-alpha.2 → 10.0.0-alpha.21

package/dist/adaptors/testing.mjs

@@ -1,25 +1,26 @@
-import "../Construct-BD5neF7w.mjs";
-import "../construct-interface-Z4CpS8tK.mjs";
-import { FunctionBuilder } from "../functions-Cxbo-pEd.mjs";
-import "../clone-DblgEZZa.mjs";
-import { Endpoint, ResponseBuilder } from "../Endpoint-VIOpSo0S.mjs";
-import { createCookieHeaderAccessor, createObjectHeaders, publishConstructEvents, publishEvents } from "../lazyAccessors-BoJN3SMd.mjs";
-import { executeWithAuditTransaction } from "../processAudits-Dmts9H_b.mjs";
-import { HonoEndpoint } from "../HonoEndpointAdaptor-NKQQQbBY.mjs";
+import { BetterAuth } from "../auth.mjs";
+import { t as FunctionBuilder } from "../functions-faoJOUmr.mjs";
+import { n as ResponseBuilder, t as Endpoint } from "../Endpoint-DCr5tlbJ.mjs";
+import { Email } from "../email.mjs";
+import { KyselyDatabase } from "../database/kysely.mjs";
+import { c as createObjectHeaders, l as publishConstructEvents, r as createCookieHeaderAccessor, u as publishEvents } from "../lazyAccessors-BHtcqgz2.mjs";
+import { t as HonoEndpoint } from "../HonoEndpointAdaptor-Be6UdK0r.mjs";
+import { n as executeWithAuditTransaction } from "../processAudits-BpRlPQMW.mjs";
+import { provideKey } from "@geekmidas/manifest";
 import { ForbiddenError } from "@geekmidas/errors";
 import { EnvironmentParser } from "@geekmidas/envkit";
-import { ServiceDiscovery, runWithRequestContext } from "@geekmidas/services";
-import { DefaultAuditor } from "@geekmidas/audit";
+import { ServiceDiscovery, runWithRequestContext, serviceContext } from "@geekmidas/services";
 import { Hono } from "hono";
+import { DefaultAuditor } from "@geekmidas/audit";
+import { TEST_CONTEXT_HEADER, currentTestContext, installContextFetch, runAsServer, runInTestContext, testContextOf } from "@geekmidas/testkit/context";
 import { http } from "msw";
-
+import { randomUUID } from "node:crypto";
+import { Browser } from "@geekmidas/testkit/browser";
+import { createMailbox } from "@geekmidas/testkit/mailbox";
+import { TransactionRegistry } from "@geekmidas/testkit/transactions";
+import { setupServer } from "msw/node";
+import { afterAll, beforeAll, test } from "vitest";
 //#region src/endpoints/MswEndpointAdaptor.ts
-/**
-* Header used to identify which test context a request belongs to.
-* Each concurrent test registers its own context (services, db transaction, etc.)
-* and the MSW handler looks it up by this header value.
-*/
-const TEST_CONTEXT_HEADER = "x-test-context-id";
 const MSW_HTTP_METHODS = [
 	"get",
 	"post",
@@ -111,7 +112,6 @@ function createMswHandlers(endpoints, options) {
 		registerContext
 	};
 }
-
 //#endregion
 //#region src/endpoints/TestEndpointAdaptor.ts
 /**
@@ -131,6 +131,8 @@ function serializeCookie(name, value, options) {
 	return cookieString;
 }
 var TestEndpointAdaptor = class TestEndpointAdaptor {
+	endpoint;
+	serviceDiscovery;
 	static getDefaultServiceDiscover(_endpoint) {
 		return ServiceDiscovery.getInstance(new EnvironmentParser({}));
 	}
@@ -165,7 +167,7 @@ var TestEndpointAdaptor = class TestEndpointAdaptor {
 				cookie,
 				...rawDb !== void 0 && { db: rawDb }
 			});
-			const isAuthorized = await this.endpoint.authorize({
+			if (!await this.endpoint.authorize({
 				header,
 				cookie,
 				services: ctx.services,
@@ -175,8 +177,7 @@ var TestEndpointAdaptor = class TestEndpointAdaptor {
 				body,
 				query,
 				params
-			});
-			if (!isAuthorized) {
+			})) {
 				logger.warn("Forbidden access attempt");
 				throw new ForbiddenError("Forbidden access to the endpoint", "You do not have permission to access this resource.");
 			}
@@ -198,24 +199,22 @@ var TestEndpointAdaptor = class TestEndpointAdaptor {
 				} catch (error) {
 					logger.error(error, "Failed to extract actor for audits");
 				}
-				const auditor = new DefaultAuditor({
-					actor,
-					storage: auditorStorage,
-					metadata: {
-						endpoint: this.endpoint.route,
-						method: this.endpoint.method
-					}
-				});
 				auditContext = {
-					auditor,
+					auditor: new DefaultAuditor({
+						actor,
+						storage: auditorStorage,
+						metadata: {
+							endpoint: this.endpoint.route,
+							method: this.endpoint.method
+						}
+					}),
 					storage: auditorStorage
 				};
 			}
 			const audits = this.endpoint.audits;
 			if (!auditContext && audits?.length) logger.warn("No auditor storage service available");
-			const result = await executeWithAuditTransaction(auditContext, async (auditor) => {
-				const trx = auditor?.getTransaction?.();
-				const db = trx ?? rawDb;
+			const { output, metadata } = await executeWithAuditTransaction(auditContext, async (auditor) => {
+				const db = auditor?.getTransaction?.() ?? rawDb;
 				const responseBuilder = new ResponseBuilder();
 				const response = await this.endpoint.handler({
 					body,
@@ -230,36 +229,34 @@ var TestEndpointAdaptor = class TestEndpointAdaptor {
 					db
 				}, responseBuilder);
 				let data = response;
-				let metadata$1 = responseBuilder.getMetadata();
+				let metadata = responseBuilder.getMetadata();
 				if (Endpoint.hasMetadata(response)) {
 					data = response.data;
-					metadata$1 = response.metadata;
+					metadata = response.metadata;
 				}
-				const output$1 = await this.endpoint.parseOutput(data);
 				return {
-					output: output$1,
-					metadata: metadata$1,
+					output: await this.endpoint.parseOutput(data),
+					metadata,
 					responseBuilder
 				};
-			}, async (result$1, auditor) => {
+			}, async (result, auditor) => {
 				if (!audits?.length) return;
 				for (const audit of audits) {
-					if (audit.when && !audit.when(result$1.output)) continue;
-					const payload = audit.payload(result$1.output);
-					const entityId = audit.entityId?.(result$1.output);
+					if (audit.when && !audit.when(result.output)) continue;
+					const payload = audit.payload(result.output);
+					const entityId = audit.entityId?.(result.output);
 					auditor.audit(audit.type, payload, {
 						table: audit.table,
 						entityId
 					});
 				}
 			}, { db: rawDb });
-			const { output, metadata } = result;
 			ctx.publisher && await this.serviceDiscovery.register([ctx.publisher]);
 			await publishConstructEvents(this.endpoint, output, this.serviceDiscovery);
 			const headers = { ...metadata.headers || {} };
 			if (metadata.cookies && metadata.cookies.size > 0) {
 				const setCookieValues = [];
-				for (const [name, cookie$1] of metadata.cookies.entries()) setCookieValues.push(serializeCookie(name, cookie$1.value, cookie$1.options));
+				for (const [name, cookie] of metadata.cookies.entries()) setCookieValues.push(serializeCookie(name, cookie.value, cookie.options));
 				headers["set-cookie"] = setCookieValues;
 			}
 			return {
@@ -270,14 +267,14 @@ var TestEndpointAdaptor = class TestEndpointAdaptor {
 		});
 	}
 	async request(ctx) {
-		const response = await this.fullRequest(ctx);
-		return response.body;
+		return (await this.fullRequest(ctx)).body;
 	}
 };
-
 //#endregion
 //#region src/functions/TestFunctionAdaptor.ts
 var TestFunctionAdaptor = class TestFunctionAdaptor {
+	fn;
+	serviceDiscovery;
 	static getDefaultServiceDiscovery(_fn) {
 		return ServiceDiscovery.getInstance(new EnvironmentParser({}));
 	}
@@ -293,15 +290,11 @@ var TestFunctionAdaptor = class TestFunctionAdaptor {
 		else services = await this.serviceDiscovery.register(this.fn.services);
 		let db;
 		if ("db" in ctx && ctx.db !== void 0) db = ctx.db;
-		else if (this.fn.databaseService) {
-			const dbServices = await this.serviceDiscovery.register([this.fn.databaseService]);
-			db = dbServices[this.fn.databaseService.serviceName];
-		}
+		else if (this.fn.databaseService) db = (await this.serviceDiscovery.register([this.fn.databaseService]))[this.fn.databaseService.serviceName];
 		let auditor;
 		if ("auditor" in ctx && ctx.auditor !== void 0) auditor = ctx.auditor;
 		else if (this.fn.auditorStorageService) {
-			const auditServices = await this.serviceDiscovery.register([this.fn.auditorStorageService]);
-			const storage = auditServices[this.fn.auditorStorageService.serviceName];
+			const storage = (await this.serviceDiscovery.register([this.fn.auditorStorageService]))[this.fn.auditorStorageService.serviceName];
 			auditor = new DefaultAuditor({
 				actor: {
 					id: "system",
@@ -315,11 +308,10 @@ var TestFunctionAdaptor = class TestFunctionAdaptor {
 			});
 		}
 		const requestId = `test-${Date.now()}`;
-		const startTime = Date.now();
 		return runWithRequestContext({
 			logger,
 			requestId,
-			startTime
+			startTime: Date.now()
 		}, async () => {
 			const response = await this.fn.fn({
 				input: parsedInput,
@@ -341,7 +333,6 @@ var TestFunctionAdaptor = class TestFunctionAdaptor {
 		});
 	}
 };
-
 //#endregion
 //#region src/queue/TestQueueAdaptor.ts
 /**
@@ -354,6 +345,8 @@ var TestFunctionAdaptor = class TestFunctionAdaptor {
 * await adapter.invoke({ messages: [{ orderId: '123' }] });
 */
 var TestQueueAdaptor = class TestQueueAdaptor {
+	queue;
+	serviceDiscovery;
 	static getDefaultServiceDiscovery() {
 		return ServiceDiscovery.getInstance(new EnvironmentParser({}));
 	}
@@ -365,11 +358,10 @@ var TestQueueAdaptor = class TestQueueAdaptor {
 		const logger = this.queue.logger.child({ test: true });
 		const services = request.services ?? await this.serviceDiscovery.register(this.queue.services);
 		const requestId = `test-${Date.now()}`;
-		const startTime = Date.now();
 		return runWithRequestContext({
 			logger,
 			requestId,
-			startTime
+			startTime: Date.now()
 		}, () => this.queue.handler({
 			messages: request.messages,
 			services,
@@ -377,10 +369,11 @@ var TestQueueAdaptor = class TestQueueAdaptor {
 		}));
 	}
 };
-
 //#endregion
 //#region src/subscribers/TestSubscriberAdaptor.ts
 var TestSubscriberAdaptor = class TestSubscriberAdaptor {
+	subscriber;
+	serviceDiscovery;
 	static getDefaultServiceDiscovery() {
 		return ServiceDiscovery.getInstance(new EnvironmentParser({}));
 	}
@@ -396,11 +389,10 @@ var TestSubscriberAdaptor = class TestSubscriberAdaptor {
 		const filteredEvents = this.filterEvents(request.events);
 		if (filteredEvents.length === 0) return { batchItemFailures: [] };
 		const requestId = `test-${Date.now()}`;
-		const startTime = Date.now();
 		return runWithRequestContext({
 			logger,
 			requestId,
-			startTime
+			startTime: Date.now()
 		}, async () => {
 			const result = await this.subscriber.handler({
 				events: filteredEvents,
@@ -422,7 +414,201 @@ var TestSubscriberAdaptor = class TestSubscriberAdaptor {
 		return events.filter((event) => this.subscriber.subscribedEvents.includes(event.type));
 	}
 };
-
 //#endregion
-export { TEST_CONTEXT_HEADER, TestEndpointAdaptor, TestFunctionAdaptor, TestQueueAdaptor, TestSubscriberAdaptor, createMswHandlers };
+//#region src/testing/featureTest.ts
+/**
+* `featureTest`: an app, driven the way it runs deployed.
+*
+* A browser signs in and calls the API; the API calls the auth server; each
+* over its URL, each database in its own transaction. Nothing runs as a server:
+* every URL an app's constructs answer on is served in-process through MSW,
+* from the real handler, for the test that made the request. Everything else
+* with a real local equivalent — Postgres, Mailpit, MinIO — is used directly.
+*
+* ```ts
+* // test/config.ts
+* export const it = featureTest({
+*   modules: import.meta.glob(['../../constructs/*.ts', '../src/endpoints/**\/*.ts'], { eager: true }),
+*   database,
+*   browser: Browser,
+* });
+*
+* // a test
+* it('shows the signed-in user their profile', async ({ browser, mailbox }) => {
+*   await browser.auth.signIn.magicLink({ email: 'ada@shop.test' });
+*   await browser.visit((await mailbox('ada@shop.test').last()).link!);
+*   expect(await browser.api.get('/profile')).toMatchObject({ email: 'ada@shop.test' });
+* });
+* ```
+*/
+/** Every test in flight in this process, by id. */
+const contexts = /* @__PURE__ */ new Map();
+/** Databases already resolving to test transactions — patched once each. */
+const bound = /* @__PURE__ */ new WeakSet();
+function featureTest(options) {
+	const env = options.env ?? process.env;
+	const envParser = new EnvironmentParser({ ...env });
+	const found = discover(options.modules);
+	const BrowserClass = options.browser ?? Browser;
+	for (const database of found.databases) bindToTests(database);
+	const network = setupServer(...surfaceHandlers(found.endpoints, env), ...found.auths.map((auth) => authHandler(auth, env, envParser)));
+	const inbox = found.emails.map((email) => env[provideKey(email.id, "inboxUrl")]).find(Boolean);
+	const readMail = inbox ? createMailbox({ inbox }) : void 0;
+	let restoreFetch = () => {};
+	beforeAll(() => {
+		network.listen({ onUnhandledRequest(request, print) {
+			if (isLocal(new URL(request.url))) return;
+			print.error();
+		} });
+		restoreFetch = installContextFetch();
+	});
+	afterAll(() => {
+		restoreFetch();
+		network.close();
+	});
+	const run = (fn) => async () => {
+		const id = randomUUID();
+		const state = {
+			transactions: new TransactionRegistry(),
+			discovery: new ServiceDiscovery(envParser),
+			surfaces: /* @__PURE__ */ new Map(),
+			auth: /* @__PURE__ */ new Map(),
+			addresses: /* @__PURE__ */ new Set()
+		};
+		contexts.set(id, state);
+		try {
+			await runInTestContext(id, async () => {
+				const browser = new BrowserClass();
+				const restore = browser.install();
+				try {
+					await fn({
+						browser,
+						db: options.database ? await state.transactions.get(options.database.id, urlOf(options.database, envParser)) : void 0,
+						mailbox: (address) => {
+							if (!readMail) throw new NoInbox();
+							state.addresses.add(address);
+							return readMail(address);
+						}
+					});
+				} finally {
+					restore();
+				}
+			});
+		} finally {
+			contexts.delete(id);
+			await Promise.all([state.transactions.rollbackAll(), ...[...state.addresses].map((address) => readMail?.(address).clear())]);
+		}
+	};
+	const it = ((name, fn, timeout) => test(name, run(fn), timeout));
+	it.only = (name, fn, timeout) => test.only(name, run(fn), timeout);
+	it.skip = (name, fn, timeout) => test.skip(name, run(fn), timeout);
+	return it;
+}
+/** What an app's modules export, sorted by what a test does with it. */
+function discover(modules) {
+	const values = (Array.isArray(modules) ? modules : Object.values(modules)).flatMap((module) => module && typeof module === "object" ? Object.values(module) : []);
+	return {
+		endpoints: values.filter((value) => Endpoint.isEndpoint(value)),
+		databases: values.filter((value) => value instanceof KyselyDatabase),
+		auths: values.filter((value) => value instanceof BetterAuth),
+		emails: values.filter((value) => value instanceof Email)
+	};
+}
+/**
+* Make a database resolve, inside a test, to that test's transaction.
+*
+* Everything reaches a database through its service — an endpoint through
+* service discovery, the auth server through its tenant directly — so this is
+* the one place a test's connection can be handed over. Outside a test it is
+* the database it always was.
+*/
+function bindToTests(database) {
+	if (bound.has(database)) return;
+	bound.add(database);
+	const service = database.service;
+	const register = service.register;
+	service.register = (options) => {
+		const context = currentTestContext();
+		const state = context && contexts.get(context.id);
+		if (!state) return register(options);
+		return state.transactions.get(database.id, urlOf(database, options.envParser));
+	};
+}
+function urlOf(database, envParser) {
+	return envParser.create((get) => ({ url: get(provideKey(database.id, "url")).string() })).parse().url;
+}
+/** Each surface's endpoints, served at its URL for the test that asked. */
+function surfaceHandlers(endpoints, env) {
+	const bySurface = /* @__PURE__ */ new Map();
+	for (const endpoint of endpoints) {
+		const surface = endpoint.surface?.id;
+		if (!surface) continue;
+		bySurface.set(surface, [...bySurface.get(surface) ?? [], endpoint]);
+	}
+	return [...bySurface].flatMap(([surface, served]) => {
+		const base = env[provideKey(surface, "url")];
+		if (!base) return [];
+		return http.all(`${trim(base)}/*`, ({ request }) => serve(request, async (state) => {
+			let app = state.surfaces.get(surface);
+			if (!app) {
+				app = Promise.resolve().then(() => {
+					const hono = new Hono();
+					HonoEndpoint.addRoutes(served, state.discovery, hono);
+					return hono;
+				});
+				state.surfaces.set(surface, app);
+			}
+			return (await app).fetch(request);
+		}));
+	});
+}
+/** An auth server, served at its URL, on the transaction of the test that asked. */
+function authHandler(auth, env, envParser) {
+	const base = trim(env[provideKey(auth.id, "url")] ?? "");
+	return http.all(`${base}${auth.basePath}/*`, ({ request }) => serve(request, async (state) => {
+		let app = state.auth.get(auth);
+		if (!app) {
+			app = auth.server({
+				envParser,
+				context: serviceContext
+			}).then(({ app }) => app);
+			state.auth.set(auth, app);
+		}
+		return (await app).fetch(request);
+	}));
+}
+/** Handle a request as the server side of the test it was made for. */
+async function serve(request, handle) {
+	const id = testContextOf(request);
+	const state = id ? contexts.get(id) : void 0;
+	if (!id || !state) throw new UnknownTestContext(request.url, id);
+	return runAsServer(id, () => handle(state));
+}
+function trim(url) {
+	return url.replace(/\/$/, "");
+}
+function isLocal(url) {
+	return url.hostname === "localhost" || url.hostname === "127.0.0.1" || url.hostname.endsWith(".localhost");
+}
+/** A request reached an in-process server without a test to belong to. */
+var UnknownTestContext = class extends Error {
+	url;
+	id;
+	constructor(url, id) {
+		super(id ? `${url} was requested for test ${id}, which is not running. A request that outlives its test — an un-awaited call — lands here.` : `${url} was requested outside any test. Make the request inside a featureTest, so it reaches that test's transactions.`);
+		this.url = url;
+		this.id = id;
+		this.name = "UnknownTestContext";
+	}
+};
+/** `mailbox` was used in an app that declares no Email construct. */
+var NoInbox = class extends Error {
+	constructor() {
+		super("mailbox() reads the inbox of the app's Email construct, and none was found in featureTest's modules — or `gkm test` did not inject its <ID>_INBOX_URL.");
+		this.name = "NoInbox";
+	}
+};
+//#endregion
+export { NoInbox, TEST_CONTEXT_HEADER, TestEndpointAdaptor, TestFunctionAdaptor, TestQueueAdaptor, TestSubscriberAdaptor, UnknownTestContext, createMswHandlers, featureTest };
+
 //# sourceMappingURL=testing.mjs.map