@kubb/studio 5.2.4 → 5.2.6

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-CRm0XQPb.js";
-import { a as AgentPermissions, c as ClientInfo } from "./index-V3fjg2mj.js";
+import { AgentPermissions, ClientInfo, createJobId } from "./protocol.js";
 import { Storage } from "unstorage";
 import { Config, Hookable, KubbHooks } from "@kubb/core";
 //#region src/api.d.ts
@@ -147,6 +147,11 @@ type StudioConnectedContext = {
     agent: string;
   };
 };
+/**
+ * Fired once Studio confirms the `agent:connect` handshake was received and the session is fully
+ * registered. Distinct from `studio:connected`, which only means the socket is open.
+ */
+type StudioReadyContext = Record<string, never>;
 type StudioDisconnectedContext = {
   /**
    * Why Studio ended the session.
@@ -187,6 +192,7 @@ declare global {
     interface KubbHooksRegistry {
       'studio:connecting': [ctx: StudioConnectingContext];
       'studio:connected': [ctx: StudioConnectedContext];
+      'studio:ready': [ctx: StudioReadyContext];
       'studio:disconnected': [ctx: StudioDisconnectedContext];
       'studio:command:start': [ctx: StudioCommandStartContext];
       'studio:command:end': [ctx: StudioCommandEndContext];
@@ -371,5 +377,5 @@ type PollOptions = {
  */
 export declare function pollForPairingToken({ studioUrl, session, signal }: PollOptions): Promise<PairingResult>;
 //#endregion
-export type { Client, ClientOptions, ConnectionOptions, StudioConnectedContext };
+export { type Client, type ClientOptions, type ConnectionOptions, type StudioConnectedContext, createJobId };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,9 +1,9 @@
 import { t as __name } from "./rolldown-runtime-CRm0XQPb.js";
-import { isCommandMessage, isDisconnectMessage, isStudioPingMessage } from "./protocol.js";
+import { createJobId, isCommandMessage, isDisconnectMessage, isStudioPingMessage, isStudioReadyMessage } from "./protocol.js";
 import { createRequire } from "node:module";
 import { styleText } from "node:util";
 import { readFile, writeFile } from "node:fs/promises";
-import path from "node:path";
+import path, { isAbsolute, relative, resolve } from "node:path";
 import { spawn } from "node:child_process";
 import { FetchError, ofetch } from "ofetch";
 import { hash, randomBytes } from "node:crypto";
@@ -559,12 +559,14 @@ async function disconnect({ sessionId, token, studioUrl, slug }) {
 		});
 		console.log(styleText("green", `[${tag}] Disconnected from Studio`));
 	} catch (error) {
+		const statusCode = error?.statusCode;
+		if (statusCode !== void 0 && statusCode >= 400 && statusCode < 500) return;
 		console.warn(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
 /**
@@ -1517,6 +1519,9 @@ const CONNECT_TIMEOUT_MS = 5e3;
 */
 const eventSeqCounters = /* @__PURE__ */ new WeakMap();
 const require = createRequire(import.meta.url);
+function relativeStoragePath(root, filePath) {
+	return (isAbsolute(filePath) ? relative(resolve(root), filePath) : filePath).replaceAll("\\", "/");
+}
 async function resolvePeerDependencies(names) {
 	const uniqueNames = [...new Set(names.map(toPackageName))];
 	const peerDependencies = {};
@@ -1571,9 +1576,10 @@ function sendAgentMessage(ws, 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, error) {
+function sendErrorMessage(ws, error, jobId) {
 	sendAgentMessage(ws, {
 		type: "agent:data",
+		jobId,
 		payload: {
 			type: "kubb:error",
 			data: [{
@@ -1588,7 +1594,7 @@ function sendErrorMessage(ws, error) {
 /**
 * Forwards selected Kubb lifecycle events to Studio as data messages for the active session.
 */
-function setupEventsStream(ws, hooks) {
+function setupEventsStream(ws, hooks, jobId) {
 	const unhooks = [];
 	/**
 	* Registers a listener and keeps its remover, so one generation's listeners come off the session
@@ -1600,6 +1606,7 @@ function setupEventsStream(ws, hooks) {
 	function sendDataMessage(payload) {
 		sendAgentMessage(ws, {
 			type: "agent:data",
+			jobId,
 			payload: {
 				...payload,
 				timestamp: Date.now(),
@@ -1698,7 +1705,7 @@ function setupEventsStream(ws, 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({
@@ -1786,6 +1793,12 @@ function setupEventsStream(ws, 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.
@@ -1853,9 +1866,11 @@ var StudioSession = class {
 	#session;
 	#ws;
 	#studioVersion;
+	#activeJobId = null;
 	#disposed = false;
 	#isGenerating = false;
 	#heartbeatTimer;
+	#readyTimer;
 	#lastPongAt = Date.now();
 	constructor(options) {
 		this.#options = applyStudioDefaults(options);
@@ -1899,7 +1914,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;
@@ -1989,10 +2004,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",
@@ -2012,6 +2041,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 {}
@@ -2046,6 +2077,12 @@ var StudioSession = class {
 				this.#lastPongAt = Date.now();
 				return;
 			}
+			if (isStudioReadyMessage(data)) {
+				clearTimeout(this.#readyTimer);
+				this.#readyTimer = void 0;
+				await this.#hooks.callHook("studio:ready", {});
+				return;
+			}
 			if (isDisconnectMessage(data)) {
 				await this.#handleDisconnect(data.reason);
 				return;
@@ -2098,6 +2135,7 @@ var StudioSession = class {
 			return;
 		}
 		this.#isGenerating = true;
+		this.#activeJobId = data.jobId;
 		try {
 			const config = await loadConfig();
 			const patch = data.payload;
@@ -2110,7 +2148,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: {
@@ -2138,6 +2176,7 @@ var StudioSession = class {
 			});
 		} finally {
 			this.#isGenerating = false;
+			this.#activeJobId = null;
 		}
 	}
 	async #handleSave(ws, data, command) {
@@ -2146,6 +2185,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
@@ -2156,6 +2196,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,
@@ -2179,6 +2220,7 @@ var StudioSession = class {
 			if (changed) await writeFile(configFile, patched, "utf-8");
 			sendAgentMessage(ws, {
 				type: "agent:save",
+				jobId: data.jobId,
 				payload: {
 					outcomes,
 					changed,
@@ -2400,6 +2442,6 @@ async function pollForPairingToken({ studioUrl = agentDefaults.studioUrl, sessio
 	throw new Error("The pairing code expired, pair again");
 }
 //#endregion
-export { InvalidAgentTokenError, PairingCanceledError, createClient, createFileStorage, defaultStudioUrl, pollForPairingToken, runConnection, setStorage, startPairing };
+export { InvalidAgentTokenError, PairingCanceledError, createClient, createFileStorage, createJobId, defaultStudioUrl, pollForPairingToken, runConnection, setStorage, startPairing };
 
 //# sourceMappingURL=index.js.map