@kubb/studio 5.2.4 → 5.2.6

package/dist/index.cjs

@@ -564,12 +564,14 @@ async function disconnect({ sessionId, token, studioUrl, slug }) {
 		});
 		console.log((0, node_util.styleText)("green", `[${tag}] Disconnected from Studio`));
 	} catch (error) {
+		const statusCode = error?.statusCode;
+		if (statusCode !== void 0 && statusCode >= 400 && statusCode < 500) return;
 		console.warn((0, node_util.styleText)("yellow", `[${tag}] Failed to notify Studio of disconnection: ${getErrorMessage(error)}`));
 	}
 }
 //#endregion
 //#region package.json
-var version = "5.2.4";
+var version = "5.2.6";
 //#endregion
 //#region src/hooks.ts
 /**
@@ -1522,6 +1524,9 @@ const CONNECT_TIMEOUT_MS = 5e3;
 */
 const eventSeqCounters = /* @__PURE__ */ new WeakMap();
 const require$1 = (0, node_module.createRequire)(require("url").pathToFileURL(__filename).href);
+function relativeStoragePath(root, filePath) {
+	return ((0, node_path.isAbsolute)(filePath) ? (0, node_path.relative)((0, node_path.resolve)(root), filePath) : filePath).replaceAll("\\", "/");
+}
 async function resolvePeerDependencies(names) {
 	const uniqueNames = [...new Set(names.map(toPackageName))];
 	const peerDependencies = {};
@@ -1576,9 +1581,10 @@ function sendAgentMessage(ws$3, message) {
 * Sends a single `kubb:error` payload to Studio, stamped from the same per-socket counter the event stream
 * uses so Studio can still order it against the generation events around it.
 */
-function sendErrorMessage(ws$4, error) {
+function sendErrorMessage(ws$4, error, jobId) {
 	sendAgentMessage(ws$4, {
 		type: "agent:data",
+		jobId,
 		payload: {
 			type: "kubb:error",
 			data: [{
@@ -1593,7 +1599,7 @@ function sendErrorMessage(ws$4, error) {
 /**
 * Forwards selected Kubb lifecycle events to Studio as data messages for the active session.
 */
-function setupEventsStream(ws$5, hooks) {
+function setupEventsStream(ws$5, hooks, jobId) {
 	const unhooks = [];
 	/**
 	* Registers a listener and keeps its remover, so one generation's listeners come off the session
@@ -1605,6 +1611,7 @@ function setupEventsStream(ws$5, hooks) {
 	function sendDataMessage(payload) {
 		sendAgentMessage(ws$5, {
 			type: "agent:data",
+			jobId,
 			payload: {
 				...payload,
 				timestamp: Date.now(),
@@ -1703,7 +1710,7 @@ function setupEventsStream(ws$5, hooks) {
 			limit: FILE_READ_CONCURRENCY,
 			run: async (path) => {
 				const content = await storage.readItem(path);
-				if (content !== null) files[path] = content;
+				if (content !== null) files[relativeStoragePath(config.root, path)] = content;
 			}
 		});
 		sendDataMessage({
@@ -1791,6 +1798,12 @@ function setupEventsStream(ws$5, hooks) {
 //#endregion
 //#region src/StudioSession.ts
 /**
+* How long the `agent:connect` handshake may go unacknowledged before `studio:ready` is given up
+* on for this open. A Studio that predates the ack never sends one, so this only ever produces a
+* warning, not a reconnect.
+*/
+const READY_TIMEOUT_MS = 1e4;
+/**
 * Fills in a host's options: the hosted Studio URL, the current working directory, and every
 * permission off unless granted. Idempotent, so a reconnect can pass an already-resolved bag
 * back in.
@@ -1858,9 +1871,11 @@ var StudioSession = class {
 	#session;
 	#ws;
 	#studioVersion;
+	#activeJobId = null;
 	#disposed = false;
 	#isGenerating = false;
 	#heartbeatTimer;
+	#readyTimer;
 	#lastPongAt = Date.now();
 	constructor(options) {
 		this.#options = applyStudioDefaults(options);
@@ -1904,7 +1919,7 @@ var StudioSession = class {
 			signal?.addEventListener("abort", this.#onAbort, { once: true });
 			this.#unhooks.push(() => signal?.removeEventListener("abort", this.#onAbort));
 			this.#heartbeatTimer = setInterval(() => this.#sendHeartbeat(), heartbeatInterval);
-			this.#unhooks.push(this.#hooks.hook("kubb:error", ({ error }) => sendErrorMessage(ws, error)));
+			this.#unhooks.push(this.#hooks.hook("kubb:error", ({ error }) => sendErrorMessage(ws, error, this.#activeJobId ?? "connection")));
 		} catch (error) {
 			await this.#hooks.callHook("studio:error", { error: toError(error) });
 			if (error instanceof InvalidAgentTokenError) throw error;
@@ -1994,10 +2009,24 @@ var StudioSession = class {
 		});
 		try {
 			await this.#sendConnectedPayload();
+			this.#waitForReady();
 		} catch (error) {
 			await this.#warn(`Failed to send the connect payload: ${getErrorMessage(error)}`);
 		}
 	}
+	/**
+	* Arms the timeout for Studio's `studio:ready` acknowledgement. Re-armed on every open, since a
+	* command sent while the agent is not attached is lost either way (see `#sendConnectedPayload`),
+	* so each reconnect needs its own fresh wait.
+	*/
+	#waitForReady() {
+		if (this.#disposed) return;
+		clearTimeout(this.#readyTimer);
+		this.#readyTimer = setTimeout(() => {
+			this.#readyTimer = void 0;
+			Promise.resolve(this.#warn(`Kubb Studio did not confirm the connection was ready within ${READY_TIMEOUT_MS}ms`)).catch(() => {});
+		}, READY_TIMEOUT_MS);
+	}
 	#onOpen = () => void this.#handleOpen().catch(() => {});
 	#onAbort = () => void this.#end({
 		reason: "shutdown",
@@ -2017,6 +2046,8 @@ var StudioSession = class {
 	dispose(reason = "cleanup") {
 		clearInterval(this.#heartbeatTimer);
 		this.#heartbeatTimer = void 0;
+		clearTimeout(this.#readyTimer);
+		this.#readyTimer = void 0;
 		try {
 			this.#ws?.close(1e3, reason);
 		} catch {}
@@ -2051,6 +2082,12 @@ var StudioSession = class {
 				this.#lastPongAt = Date.now();
 				return;
 			}
+			if (require_protocol.isStudioReadyMessage(data)) {
+				clearTimeout(this.#readyTimer);
+				this.#readyTimer = void 0;
+				await this.#hooks.callHook("studio:ready", {});
+				return;
+			}
 			if (require_protocol.isDisconnectMessage(data)) {
 				await this.#handleDisconnect(data.reason);
 				return;
@@ -2103,6 +2140,7 @@ var StudioSession = class {
 			return;
 		}
 		this.#isGenerating = true;
+		this.#activeJobId = data.jobId;
 		try {
 			const config = await loadConfig();
 			const patch = data.payload;
@@ -2115,7 +2153,7 @@ var StudioSession = class {
 				await this.#warn(`Ignored the spec from Studio; set ${remedy} to generate from it`);
 			}
 			const resolvedPlugins = plugins ?? config.plugins;
-			const detach = [setupHookListener(this.#hooks, root), setupEventsStream(ws, this.#hooks)];
+			const detach = [setupHookListener(this.#hooks, root), setupEventsStream(ws, this.#hooks, data.jobId)];
 			try {
 				await generate({
 					config: {
@@ -2143,6 +2181,7 @@ var StudioSession = class {
 			});
 		} finally {
 			this.#isGenerating = false;
+			this.#activeJobId = null;
 		}
 	}
 	async #handleSave(ws, data, command) {
@@ -2151,6 +2190,7 @@ var StudioSession = class {
 			await this.#warn("Ignored save: the message carried no edits");
 			sendAgentMessage(ws, {
 				type: "agent:save",
+				jobId: data.jobId,
 				payload: {
 					outcomes: [],
 					changed: false
@@ -2161,6 +2201,7 @@ var StudioSession = class {
 		const edits = data.edits;
 		const refuse = (reason) => sendAgentMessage(ws, {
 			type: "agent:save",
+			jobId: data.jobId,
 			payload: {
 				outcomes: edits.map((edit) => ({
 					edit,
@@ -2184,6 +2225,7 @@ var StudioSession = class {
 			if (changed) await (0, node_fs_promises.writeFile)(configFile, patched, "utf-8");
 			sendAgentMessage(ws, {
 				type: "agent:save",
+				jobId: data.jobId,
 				payload: {
 					outcomes,
 					changed,
@@ -2409,6 +2451,7 @@ exports.InvalidAgentTokenError = InvalidAgentTokenError;
 exports.PairingCanceledError = PairingCanceledError;
 exports.createClient = createClient;
 exports.createFileStorage = createFileStorage;
+exports.createJobId = require_protocol.createJobId;
 exports.defaultStudioUrl = defaultStudioUrl;
 exports.pollForPairingToken = pollForPairingToken;
 exports.runConnection = runConnection;