@kubb/studio 5.9.4 → 5.9.5

package/README.md

@@ -74,7 +74,7 @@ running in a developer's project and a container running a fixed plugin set.
 | `connect.ts`     | `connectAgent`: the socket loop and the `Agent` that serves Studio's calls.      |
 | `pair.ts`        | `pairAgent`: RFC 8628 device pairing.                                            |
 | `snapshot.ts`    | `createSnapshot` for CI, and packing a generation into an npm tarball.           |
-| `generations.ts` | Running a generation and keeping its files for `readFiles`.                      |
+| `generations.ts` | Running a generation and keeping its files and AST for `readFiles`/`readInput`.  |
 | `configFile.ts`  | Reading and patching plugin options in `kubb.config.ts`.                         |
 
 ## Connection
@@ -107,7 +107,7 @@ Every permission is off by default, and each covers one trust boundary:
 | `allowWrite`      | Generated files are written to disk. Off means they exist only in memory and stream to Studio. |
 | `allowExec`       | The formatter, the linter, and `output.postGenerate` run as child processes.                   |
 | `allowConfigEdit` | Studio may change plugin options in `kubb.config.ts`.                                          |
-| `allowRead`       | Studio may read back the files a generation produced.                                          |
+| `allowRead`       | Studio may read back the files a generation produced and its parsed spec.                      |
 
 A sandbox never writes or edits config, and always allows reads.
 

package/dist/index.cjs

@@ -37,6 +37,7 @@ let capnweb = require("capnweb");
 let magicast = require("magicast");
 let node_module = require("node:module");
 let node_util = require("node:util");
+let _kubb_ast = require("@kubb/ast");
 let ofetch = require("ofetch");
 let node_zlib = require("node:zlib");
 //#region ../../internals/utils/src/casing.ts
@@ -176,7 +177,7 @@ function getElapsedMs(hrStart) {
 }
 //#endregion
 //#region package.json
-var version = "5.9.4";
+var version = "5.9.5";
 //#endregion
 //#region src/resolveConfig.ts
 /**
@@ -1107,7 +1108,10 @@ function relativeStoragePath({ root, filePath }) {
 * The content fingerprint Studio compares snapshots by. Agent runs and CI uploads must agree on it.
 */
 const hashOf = (content) => (0, node_crypto.createHash)("sha1").update(content).digest("hex").slice(0, 16);
-const totalBytes = (entries) => entries.reduce((sum, { output, disk }) => sum + output.bytes + (disk?.bytes ?? 0), 0);
+/**
+* The bytes `entries` keep on disk: output, written files, and kept input.
+*/
+const totalBytes = (entries) => entries.reduce((sum, { output, disk, inputBytes }) => sum + output.bytes + (disk?.bytes ?? 0) + (inputBytes ?? 0), 0);
 function positiveNumber(value) {
 	const parsed = Number(value);
 	return value && Number.isFinite(parsed) && parsed > 0 ? parsed : void 0;
@@ -1150,7 +1154,11 @@ async function generate({ config, hooks, signal, allowExec }) {
 		hooks,
 		signal
 	});
-	const result = await kubb.generate();
+	let input = null;
+	const unhook = kubb.hooks.hook("kubb:build:end", (ctx) => {
+		if (ctx.config === kubb.config) input = kubb.driver.inputNode;
+	});
+	const result = await kubb.generate().finally(unhook);
 	if (!result.success) throw generationFailure(result.diagnostics);
 	const { storage, root } = kubb.config;
 	return {
@@ -1159,7 +1167,8 @@ async function generate({ config, hooks, signal, allowExec }) {
 		paths: new Set(result.files.map((file) => relativeStoragePath({
 			root,
 			filePath: file.path
-		})))
+		}))),
+		input
 	};
 }
 /**
@@ -1240,6 +1249,33 @@ function createGenerationStore({ storage, maxCount, maxMb, ttlMs, now = Date.now
 	return {
 		keep,
 		drop,
+		/**
+		* Keeps the `InputNode` of `jobId` and returns its size in bytes, or 0 when it keeps none. A ref schema loses
+		* the copy of its target, which `input.schemas` holds: with it, a large spec outgrows what `JSON.stringify` can return.
+		*/
+		async keepInput({ jobId, input, maxSetMb }) {
+			if (!input) return 0;
+			let json;
+			try {
+				json = JSON.stringify(_kubb_ast.ast.transform(input, { schema: (node) => node.type === "ref" && node.schema ? {
+					...node,
+					schema: void 0
+				} : void 0 }));
+			} catch {
+				return 0;
+			}
+			const bytes = Buffer.byteLength(json);
+			if (bytes > maxSetMb * MB) return 0;
+			await storage.writeItem(`${dirOf(jobId)}input.json`, json);
+			return bytes;
+		},
+		/**
+		* The input `keepInput` kept for `jobId`, or `undefined` when there is none.
+		*/
+		async readInput(jobId) {
+			const stored = await storage.readItem(`${dirOf(jobId)}input.json`);
+			return stored === null ? void 0 : JSON.parse(stored);
+		},
 		get: async (jobId) => (await load()).find((generation) => generation.jobId === jobId && isLive(generation)),
 		async add(generation) {
 			const current = await load();
@@ -1690,6 +1726,7 @@ var Agent = class extends capnweb.RpcTarget {
 			}
 		});
 	}
+	/** Runs one job and keeps its output, and its input with `allowRead`, for later reads. */
 	async #runGeneration(input, controller) {
 		this.#assertConnected();
 		if (this.#session.closed) throw new Error("Connection is closed");
@@ -1777,11 +1814,17 @@ var Agent = class extends capnweb.RpcTarget {
 			files,
 			maxSetMb: this.#limits.maxMb
 		});
+		const inputBytes = await this.#generations.keepInput({
+			jobId,
+			input: this.#permissions.allowRead ? files.input : null,
+			maxSetMb: this.#limits.maxMb
+		});
 		if (!output.paths.length && Object.keys(output.hashes).length) await this.#warn({ message: "Kept only the hashes of this generation: its output is too large to keep" });
 		await this.#generations.add({
 			jobId,
 			output,
-			disk
+			disk,
+			inputBytes
 		});
 		await this.#logCommand("generate", `${activePlugins.length} plugin${activePlugins.length === 1 ? "" : "s"}, ${this.#permissions.allowWrite ? "written to disk" : "in memory"}${studioInput !== void 0 ? ", from a Studio spec" : ""}`);
 		return {
@@ -1833,10 +1876,30 @@ var Agent = class extends capnweb.RpcTarget {
 			return refuse(getErrorMessage(error));
 		}
 	}
+	/**
+	* Returns the Kubb AST a kept job parsed its spec into. Refused without `allowRead`.
+	*/
+	async readInput(input) {
+		this.#assertConnected();
+		if (!this.#permissions.allowRead) return this.#refuse({
+			message: require_protocol.READ_NOT_ALLOWED_MESSAGE,
+			permission: "allowRead"
+		});
+		if (typeof input.jobId !== "string" || !input.jobId) return this.#refuse({ message: "The request must name a job" });
+		const generation = await this.#generations.get(input.jobId);
+		if (!generation) return this.#refuse({ message: require_protocol.GENERATION_GONE_MESSAGE });
+		const kept = generation.inputBytes ? await this.#generations.readInput(input.jobId) : void 0;
+		if (!kept) return this.#refuse({ message: require_protocol.NO_INPUT_MESSAGE });
+		await this.#logCommand("readInput", "read the API input");
+		return { input: kept };
+	}
+	/**
+	* Returns the requested files of a kept job, one page of lines at a time. Refused without `allowRead`.
+	*/
 	async readFiles(input) {
 		this.#assertConnected();
 		if (!this.#permissions.allowRead) return this.#refuse({
-			message: "The agent was not granted permission to read generated files",
+			message: require_protocol.READ_NOT_ALLOWED_MESSAGE,
 			permission: "allowRead"
 		});
 		if (!Array.isArray(input.paths) || typeof input.jobId !== "string" || !input.jobId) return this.#refuse({ message: "The request must name a job and carry paths" });