@copilotkit/aimock 1.45.1 → 1.47.0

package/dist/gemini-interactions.js

@@ -1,12 +1,26 @@
-import { extractOverrides, flattenHeaders, generateToolCallId, getContext, getTestId, isCombinedFixtureResponse, isErrorResponse, isJsonObject, isTextResponse, isToolCallResponse, prepareOpenAIChatMisbehavior, requireEmittedFunctionToolCalls, resolveFixtureBlockOutcome, resolveOpenAIChatMisbehaviorUsage, resolveResponse, resolveStrictMode, servedToolArgs, strictNoMatchLogLine, strictNoMatchMessage, strictOverrideField } from "./helpers.js";
-import { calculateDelay, delay, writeErrorResponse } from "./sse-writer.js";
+import { renderError } from "./response/errors.js";
+import { resolveRequestDecisions, strictOverrideField } from "./response/policy.js";
+import { extractOverrides, flattenHeaders, generateToolCallId, getContext, getTestId, isCombinedFixtureResponse, isErrorResponse, isJsonObject, isRawResponse, isTextResponse, isToolCallResponse, prepareOpenAIChatMisbehavior, requireEmittedFunctionToolCalls, resolveFixtureBlockOutcome, resolveOpenAIChatMisbehaviorUsage, resolveResponse, servedToolArgs, strictNoMatchLogLine, strictNoMatchMessage } from "./helpers.js";
+import { sseCodec, writeErrorResponse } from "./sse-writer.js";
 import { applyChaosAsync } from "./chaos.js";
 import { planMisbehavior, recordMisbehaviorOutcome } from "./misbehavior.js";
 import { matchFixtureDiagnostic } from "./router.js";
 import { proxyAndRecord } from "./recorder.js";
-import { createInterruptionSignal } from "./interruption.js";
+import { misbehaviorPayloadLength, servedPayloadLength } from "./response/timing.js";
+import { deliverJson, deliverStream } from "./response/deliver.js";
+import { proxyInterruption, withHangUpDetection } from "./response/proxy.js";
+import { serveRawResponse } from "./response/raw.js";
+import { render } from "./response/usage/codecs/interactions.js";
 
 //#region src/gemini-interactions.ts
+/**
+* Google Gemini Interactions API support.
+*
+* Translates incoming Interactions requests into the ChatCompletionRequest
+* format used by the fixture router, and converts fixture responses back
+* into the Gemini Interactions format — either a single JSON response or
+* an SSE stream with event_type-based framing.
+*/
 /** Step types whose payload is a tool/agent result keyed by call_id. */
 const STEP_RESULT_TYPES = new Set([
 	"function_result",
@@ -185,18 +199,7 @@ function nextInteractionId() {
 	return `aimock-int-${interactionCounter++}`;
 }
 function interactionsUsage(overrides) {
-	if (!overrides?.usage) return {
-		total_input_tokens: 0,
-		total_output_tokens: 0,
-		total_tokens: 0
-	};
-	const input = overrides.usage.input_tokens ?? overrides.usage.prompt_tokens ?? overrides.usage.promptTokenCount ?? 0;
-	const output = overrides.usage.output_tokens ?? overrides.usage.completion_tokens ?? overrides.usage.candidatesTokenCount ?? 0;
-	return {
-		total_input_tokens: input,
-		total_output_tokens: output,
-		total_tokens: overrides.usage.total_tokens ?? overrides.usage.totalTokenCount ?? input + output
-	};
+	return render(overrides);
 }
 function buildInteractionsTextResponse(content, model, interactionId, overrides) {
 	return {
@@ -277,12 +280,6 @@ function buildInteractionsContentWithToolCallsResponse(content, toolCalls, model
 		usage: interactionsUsage(overrides)
 	};
 }
-function buildInteractionsErrorResponse(message, code) {
-	return { error: {
-		code: code ?? "INVALID_ARGUMENT",
-		message
-	} };
-}
 let eventIdCounter = 0;
 function resetEventIdCounter() {
 	eventIdCounter = 0;
@@ -495,33 +492,10 @@ function buildInteractionsContentWithToolCallsSSEEvents(content, toolCalls, inte
 	});
 	return events;
 }
-async function writeGeminiInteractionsSSEStream(res, events, optionsOrLatency) {
-	const opts = typeof optionsOrLatency === "number" ? { latency: optionsOrLatency } : optionsOrLatency ?? {};
-	const latency = opts.latency ?? 0;
-	const profile = opts.streamingProfile;
-	const { recordedTimings, replaySpeed } = opts;
-	const signal = opts.signal;
-	const onChunkSent = opts.onChunkSent;
-	if (res.writableEnded) return true;
-	res.setHeader("Content-Type", "text/event-stream");
-	res.setHeader("Cache-Control", "no-cache");
-	res.setHeader("Connection", "keep-alive");
-	let chunkIndex = 0;
-	for (const event of events) {
-		const chunkDelay = calculateDelay(chunkIndex, profile, latency, recordedTimings, replaySpeed);
-		if (chunkDelay > 0) await delay(chunkDelay, signal);
-		if (signal?.aborted) return false;
-		if (res.writableEnded) return true;
-		res.write(`data: ${JSON.stringify(event)}\n\n`);
-		if (event.event_type === "step.delta") {
-			onChunkSent?.();
-			chunkIndex++;
-		}
-		if (signal?.aborted) return false;
-	}
-	if (!res.writableEnded) res.end();
-	return true;
-}
+const interactionsCodec = {
+	...sseCodec({ done: false }),
+	counts: (event) => event.event_type === "step.delta"
+};
 function prepareInteractionsMisbehavior(plan, streaming) {
 	if (!streaming && plan.summary.fault === "stop-length-mid-tool") {
 		const response = plan.response;
@@ -570,7 +544,10 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 				fixture: null
 			}
 		});
-		writeErrorResponse(res, 400, JSON.stringify(buildInteractionsErrorResponse(`Malformed JSON body: ${detail}`, "INVALID_ARGUMENT")));
+		writeErrorResponse(res, 400, renderError("interactions", "validation", {
+			message: `Malformed JSON body: ${detail}`,
+			code: "INVALID_ARGUMENT"
+		}).body);
 		return;
 	}
 	if (!isJsonObject(interactionsReq)) {
@@ -584,7 +561,10 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 				fixture: null
 			}
 		});
-		writeErrorResponse(res, 400, JSON.stringify(buildInteractionsErrorResponse("Request body must be a JSON object", "INVALID_ARGUMENT")));
+		writeErrorResponse(res, 400, renderError("interactions", "validation", {
+			message: "Request body must be a JSON object",
+			code: "INVALID_ARGUMENT"
+		}).body);
 		return;
 	}
 	const validationError = validateInteractionsInput(interactionsReq.input) ?? validateInteractionsTools(interactionsReq.tools);
@@ -599,7 +579,10 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 				fixture: null
 			}
 		});
-		writeErrorResponse(res, 400, JSON.stringify(buildInteractionsErrorResponse(validationError, "INVALID_ARGUMENT")));
+		writeErrorResponse(res, 400, renderError("interactions", "validation", {
+			message: validationError,
+			code: "INVALID_ARGUMENT"
+		}).body);
 		return;
 	}
 	const completionReq = geminiInteractionsToCompletionRequest(interactionsReq);
@@ -608,7 +591,7 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 	const streaming = interactionsReq.stream !== false;
 	const model = completionReq.model;
 	const testId = getTestId(req);
-	const { fixture, skippedBySequenceOrTurn } = matchFixtureDiagnostic(fixtures, completionReq, journal.getFixtureMatchCountsForTest(testId), defaults.requestTransform);
+	const { fixture, skippedBySequenceOrTurn } = matchFixtureDiagnostic(fixtures, completionReq, journal.getFixtureMatchCountsForTest(testId), defaults.requestTransform, { wire: "gemini-interactions" });
 	if (fixture) journal.incrementFixtureMatchCount(fixture, fixtures, testId);
 	if (await applyChaosAsync(res, fixture, defaults.chaos, req.headers, req.url, journal, {
 		method: req.method ?? "POST",
@@ -617,7 +600,8 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 		body: completionReq
 	}, fixture ? "fixture" : "proxy", defaults.registry, defaults.logger)) return;
 	if (!fixture) {
-		if (resolveStrictMode(defaults.strict, req.headers)) {
+		const decisions = resolveRequestDecisions(defaults.strict, req.headers);
+		if (decisions.fixtureMiss) {
 			const strictStatus = 503;
 			const strictMessage = strictNoMatchMessage(skippedBySequenceOrTurn);
 			logger.error(strictNoMatchLogLine(req.method ?? "POST", urlPath, skippedBySequenceOrTurn));
@@ -632,11 +616,14 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 					...strictOverrideField(defaults.strict, req.headers)
 				}
 			});
-			writeErrorResponse(res, strictStatus, JSON.stringify(buildInteractionsErrorResponse(strictMessage, "UNAVAILABLE")));
+			writeErrorResponse(res, strictStatus, renderError("interactions", "strict-miss", {
+				message: strictMessage,
+				code: "UNAVAILABLE"
+			}).body);
 			return;
 		}
-		if (defaults.record) {
-			const outcome = await proxyAndRecord(req, res, completionReq, "gemini-interactions", urlPath, fixtures, defaults, raw);
+		if (decisions.upstream && defaults.record) {
+			const { outcome, clientHungUp } = await withHangUpDetection(req, res, () => proxyAndRecord(req, res, completionReq, "gemini-interactions", urlPath, fixtures, defaults, raw));
 			if (outcome === "handled_by_hook") return;
 			if (outcome !== "not_configured") {
 				journal.add({
@@ -647,7 +634,8 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 					response: {
 						status: res.statusCode ?? 200,
 						fixture: null,
-						source: "proxy"
+						source: "proxy",
+						...proxyInterruption(res, clientHungUp)
 					}
 				});
 				return;
@@ -664,7 +652,10 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 				...strictOverrideField(defaults.strict, req.headers)
 			}
 		});
-		writeErrorResponse(res, 404, JSON.stringify(buildInteractionsErrorResponse("No fixture matched", "NOT_FOUND")));
+		writeErrorResponse(res, 404, renderError("interactions", "fixture-miss", {
+			message: "No fixture matched",
+			code: "NOT_FOUND"
+		}).body);
 		return;
 	}
 	let response = await resolveResponse(fixture, completionReq);
@@ -696,7 +687,10 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 			testId
 		});
 		if (!misbehavior.summary?.evaluations.some((evaluation) => evaluation.outcome === "error")) logger.error(`${req.method ?? "POST"} ${urlPath}: ${misbehavior.message}`);
-		writeErrorResponse(res, misbehavior.status, JSON.stringify(buildInteractionsErrorResponse(misbehavior.message, misbehavior.code)));
+		writeErrorResponse(res, misbehavior.status, renderError("interactions", "misbehavior", {
+			message: misbehavior.message,
+			code: misbehavior.code
+		}).body);
 		return;
 	}
 	if (misbehavior.kind === "applied") {
@@ -707,6 +701,42 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 	const latency = fixture.latency ?? defaults.latency;
 	const chunkSize = Math.max(1, fixture.chunkSize ?? defaults.chunkSize);
 	const replaySpeed = fixture.replaySpeed ?? defaults.replaySpeed;
+	const streamTiming = {
+		latency,
+		streamingProfile: fixture.streamingProfile,
+		recordedTimings: fixture.recordedTimings,
+		replaySpeed
+	};
+	const applied = misbehavior.kind === "applied" ? misbehavior : void 0;
+	const jsonOpts = () => ({
+		surface: "other",
+		payloadLength: applied ? misbehaviorPayloadLength(applied, void 0) : servedPayloadLength(response),
+		chunkSize,
+		recordedTimings: fixture.recordedTimings,
+		duplicateId: !!applied?.duplicateId,
+		replaySpeed
+	});
+	const markIncomplete = (body) => applied?.summary.fault === "stop-length-mid-tool" ? {
+		...body,
+		status: "incomplete"
+	} : body;
+	if (isRawResponse(response)) {
+		await serveRawResponse({
+			wire: "gemini-interactions",
+			stream: streaming,
+			req,
+			res,
+			fixture,
+			response,
+			body: completionReq,
+			journal,
+			defaults,
+			testId,
+			misbehaviorSummary: misbehavior.summary,
+			errorWire: "interactions"
+		});
+		return;
+	}
 	if (isErrorResponse(response)) {
 		const status = response.status ?? 500;
 		recordMisbehaviorOutcome({
@@ -724,7 +754,10 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 			defaults,
 			testId
 		});
-		writeErrorResponse(res, status, JSON.stringify(buildInteractionsErrorResponse(response.error.message, response.error.type ?? "ERROR")), { retryAfter: response.retryAfter });
+		writeErrorResponse(res, status, renderError("interactions", "fixture", {
+			message: response.error.message,
+			code: response.error.type ?? "ERROR"
+		}).body, { retryAfter: response.retryAfter });
 		return;
 	}
 	if (misbehavior.kind === "applied" && misbehavior.summary.fault === "reasoning-only") {
@@ -745,15 +778,11 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 			testId
 		});
 		const interactionId = nextInteractionId();
-		const usage = {
-			...interactionsUsage({ usage: appliedUsage }),
-			total_output_tokens: 0,
-			total_thought_tokens: appliedUsage?.completion_tokens ?? 0
-		};
+		const usage = render({ usage: appliedUsage }, "applied-reasoning-only");
 		if (!streaming) {
 			const overrides = isTextResponse(response) || isToolCallResponse(response) || isCombinedFixtureResponse(response) ? extractOverrides(response) : void 0;
-			res.writeHead(200, { "Content-Type": "application/json" });
-			res.end(JSON.stringify({
+			const reasoning = misbehavior.reasoning ?? "";
+			await deliverJson(res, journalEntry, fixture, () => ({
 				id: interactionId,
 				model: overrides?.model ?? model,
 				status: "incomplete",
@@ -762,14 +791,14 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 					signature: "",
 					summary: [{
 						type: "text",
-						text: misbehavior.reasoning ?? ""
+						text: reasoning
 					}]
 				}],
 				usage
-			}));
+			}), jsonOpts());
 			return;
 		}
-		const events = [
+		await deliverStream(res, journalEntry, fixture, interactionsCodec, [
 			{
 				event_type: "interaction.created",
 				interaction: {
@@ -810,21 +839,7 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 				},
 				event_id: nextEventId()
 			}
-		];
-		const interruption = createInterruptionSignal(fixture);
-		if (!await writeGeminiInteractionsSSEStream(res, events, {
-			latency,
-			streamingProfile: fixture.streamingProfile,
-			recordedTimings: fixture.recordedTimings,
-			replaySpeed,
-			signal: interruption?.signal,
-			onChunkSent: interruption?.tick
-		})) {
-			if (!res.writableEnded) res.destroy();
-			journalEntry.response.interrupted = true;
-			journalEntry.response.interruptReason = interruption?.reason();
-		}
-		interruption?.cleanup();
+		], streamTiming);
 		return;
 	}
 	if (isCombinedFixtureResponse(response)) {
@@ -852,29 +867,10 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 		const functionToolCalls = requireEmittedFunctionToolCalls(response, "Gemini Interactions");
 		const interactionId = nextInteractionId();
 		if (!streaming) {
-			const body = buildInteractionsContentWithToolCallsResponse(response.content ?? "", functionToolCalls, model, interactionId, logger, overrides, response.blocks);
-			res.writeHead(200, { "Content-Type": "application/json" });
-			res.end(JSON.stringify(misbehavior.kind === "applied" && misbehavior.summary.fault === "stop-length-mid-tool" ? {
-				...body,
-				status: "incomplete"
-			} : body));
-		} else {
-			const events = buildInteractionsContentWithToolCallsSSEEvents(response.content ?? "", functionToolCalls, interactionId, chunkSize, logger, overrides, response.blocks);
-			const interruption = createInterruptionSignal(fixture);
-			if (!await writeGeminiInteractionsSSEStream(res, finalizeInteractionsMisbehavior(events, misbehavior), {
-				latency,
-				streamingProfile: fixture.streamingProfile,
-				recordedTimings: fixture.recordedTimings,
-				replaySpeed,
-				signal: interruption?.signal,
-				onChunkSent: interruption?.tick
-			})) {
-				if (!res.writableEnded) res.destroy();
-				journalEntry.response.interrupted = true;
-				journalEntry.response.interruptReason = interruption?.reason();
-			}
-			interruption?.cleanup();
-		}
+			const content = response.content ?? "";
+			const blocks = response.blocks;
+			await deliverJson(res, journalEntry, fixture, () => markIncomplete(buildInteractionsContentWithToolCallsResponse(content, functionToolCalls, model, interactionId, logger, overrides, blocks)), jsonOpts());
+		} else await deliverStream(res, journalEntry, fixture, interactionsCodec, finalizeInteractionsMisbehavior(buildInteractionsContentWithToolCallsSSEEvents(response.content ?? "", functionToolCalls, interactionId, chunkSize, logger, overrides, response.blocks), misbehavior), streamTiming);
 		return;
 	}
 	if (isTextResponse(response)) {
@@ -901,29 +897,9 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 		});
 		const interactionId = nextInteractionId();
 		if (!streaming) {
-			const body = buildInteractionsTextResponse(response.content, model, interactionId, overrides);
-			res.writeHead(200, { "Content-Type": "application/json" });
-			res.end(JSON.stringify(misbehavior.kind === "applied" && misbehavior.summary.fault === "stop-length-mid-tool" ? {
-				...body,
-				status: "incomplete"
-			} : body));
-		} else {
-			const events = buildInteractionsTextSSEEvents(response.content, interactionId, chunkSize, overrides);
-			const interruption = createInterruptionSignal(fixture);
-			if (!await writeGeminiInteractionsSSEStream(res, finalizeInteractionsMisbehavior(events, misbehavior), {
-				latency,
-				streamingProfile: fixture.streamingProfile,
-				recordedTimings: fixture.recordedTimings,
-				replaySpeed,
-				signal: interruption?.signal,
-				onChunkSent: interruption?.tick
-			})) {
-				if (!res.writableEnded) res.destroy();
-				journalEntry.response.interrupted = true;
-				journalEntry.response.interruptReason = interruption?.reason();
-			}
-			interruption?.cleanup();
-		}
+			const content = response.content;
+			await deliverJson(res, journalEntry, fixture, () => markIncomplete(buildInteractionsTextResponse(content, model, interactionId, overrides)), jsonOpts());
+		} else await deliverStream(res, journalEntry, fixture, interactionsCodec, finalizeInteractionsMisbehavior(buildInteractionsTextSSEEvents(response.content, interactionId, chunkSize, overrides), misbehavior), streamTiming);
 		return;
 	}
 	if (isToolCallResponse(response)) {
@@ -950,30 +926,8 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 		});
 		const functionToolCalls = requireEmittedFunctionToolCalls(response, "Gemini Interactions");
 		const interactionId = nextInteractionId();
-		if (!streaming) {
-			const body = buildInteractionsToolCallResponse(functionToolCalls, model, interactionId, logger, overrides);
-			res.writeHead(200, { "Content-Type": "application/json" });
-			res.end(JSON.stringify(misbehavior.kind === "applied" && misbehavior.summary.fault === "stop-length-mid-tool" ? {
-				...body,
-				status: "incomplete"
-			} : body));
-		} else {
-			const events = buildInteractionsToolCallSSEEvents(functionToolCalls, interactionId, logger, overrides);
-			const interruption = createInterruptionSignal(fixture);
-			if (!await writeGeminiInteractionsSSEStream(res, finalizeInteractionsMisbehavior(events, misbehavior), {
-				latency,
-				streamingProfile: fixture.streamingProfile,
-				recordedTimings: fixture.recordedTimings,
-				replaySpeed,
-				signal: interruption?.signal,
-				onChunkSent: interruption?.tick
-			})) {
-				if (!res.writableEnded) res.destroy();
-				journalEntry.response.interrupted = true;
-				journalEntry.response.interruptReason = interruption?.reason();
-			}
-			interruption?.cleanup();
-		}
+		if (!streaming) await deliverJson(res, journalEntry, fixture, () => markIncomplete(buildInteractionsToolCallResponse(functionToolCalls, model, interactionId, logger, overrides)), jsonOpts());
+		else await deliverStream(res, journalEntry, fixture, interactionsCodec, finalizeInteractionsMisbehavior(buildInteractionsToolCallSSEEvents(functionToolCalls, interactionId, logger, overrides), misbehavior), streamTiming);
 		return;
 	}
 	recordMisbehaviorOutcome({
@@ -991,7 +945,10 @@ async function handleGeminiInteractions(req, res, raw, fixtures, journal, defaul
 		defaults,
 		testId
 	});
-	writeErrorResponse(res, 500, JSON.stringify(buildInteractionsErrorResponse("Fixture response did not match any known type", "INTERNAL")));
+	writeErrorResponse(res, 500, renderError("interactions", "unknown-response", {
+		message: "Fixture response did not match any known type",
+		code: "INTERNAL"
+	}).body);
 }
 
 //#endregion