@copilotkit/aimock 1.45.1 → 1.47.0

package/dist/ws-realtime.js

@@ -1,10 +1,13 @@
+import { buildOpenAIError } from "./response/errors.js";
 import { DEFAULT_TEST_ID } from "./constants.js";
-import { fixtureToolCallErrorCode, flattenHeaders, generateToolCallId, isCombinedFixtureResponse, isErrorResponse, isFixtureToolCallError, isTextResponse, isToolCallResponse, isTranscriptionResponse, journalFixtureToolCallError, prepareOpenAIChatMisbehavior, rejectResponsesOnlyToolCalls, requireServedFunctionToolCalls, resolveFixtureBlocks, resolveOpenAIChatMisbehaviorUsage, resolveResponse, resolveStrictMode, strictNoMatchLogLine, strictNoMatchMessage, strictOverrideField } from "./helpers.js";
+import { resolveRequestDecisions, strictOverrideField } from "./response/policy.js";
+import { fixtureToolCallErrorCode, flattenHeaders, generateToolCallId, isCombinedFixtureResponse, isErrorResponse, isFixtureToolCallError, isTextResponse, isToolCallResponse, isTranscriptionResponse, journalFixtureToolCallError, prepareOpenAIChatMisbehavior, rejectResponsesOnlyToolCalls, requireServedFunctionToolCalls, resolveFixtureBlocks, resolveOpenAIChatMisbehaviorUsage, resolveResponse, strictNoMatchLogLine, strictNoMatchMessage } from "./helpers.js";
 import { calculateDelay, delay } from "./sse-writer.js";
 import { planMisbehavior, recordMisbehaviorOutcome } from "./misbehavior.js";
 import { matchFixtureDiagnostic } from "./router.js";
 import "./journal.js";
-import { createInterruptionSignal } from "./interruption.js";
+import { markInterrupted, markWsTurnStopped, watchWsClose, wsLifecycle } from "./response/lifecycle.js";
+import { render } from "./response/usage/codecs/realtime.js";
 import { randomBytes } from "node:crypto";
 
 //#region src/ws-realtime.ts
@@ -315,11 +318,11 @@ function sendEvent(ws, event, isBeta) {
 function buildErrorRealtimeEvent(ws, message, isBeta, type = "invalid_request_error", code) {
 	sendEvent(ws, {
 		type: "error",
-		error: {
+		error: buildOpenAIError({
 			message,
 			type,
 			code
-		}
+		})
 	}, isBeta);
 }
 /**
@@ -365,6 +368,7 @@ function rejectRetiredBetaShape(ws, logger) {
 function handleWebSocketRealtime(ws, fixtures, journal, defaults) {
 	const { logger } = defaults;
 	const sessionId = realtimeId("sess");
+	watchWsClose(ws);
 	const isBeta = defaults.upgradeHeaders?.["openai-beta"] ? String(defaults.upgradeHeaders["openai-beta"]).includes("realtime=v1") : false;
 	if (isBeta) {
 		rejectRetiredBetaShape(ws, logger);
@@ -435,11 +439,11 @@ async function processMessage(raw, ws, fixtures, journal, defaults, session, con
 				if (!validTypes.has(s.type)) {
 					sendEvent(ws, {
 						type: "error",
-						error: {
+						error: buildOpenAIError({
 							message: `Invalid session type: ${s.type}`,
 							type: "invalid_request_error",
 							code: "invalid_session_config"
-						}
+						})
 					}, isBeta);
 					return;
 				}
@@ -494,11 +498,11 @@ async function processMessage(raw, ws, fixtures, journal, defaults, session, con
 				Object.assign(session, prevSession);
 				sendEvent(ws, {
 					type: "error",
-					error: {
+					error: buildOpenAIError({
 						message: `Model ${candidateTranscriptionModel} does not support session type transcription`,
 						type: "invalid_request_error",
 						code: "invalid_session_config"
-					}
+					})
 				}, isBeta);
 				return;
 			}
@@ -506,11 +510,11 @@ async function processMessage(raw, ws, fixtures, journal, defaults, session, con
 				Object.assign(session, prevSession);
 				sendEvent(ws, {
 					type: "error",
-					error: {
+					error: buildOpenAIError({
 						message: `Model ${s.model ?? prevSession.model} does not support session type translation`,
 						type: "invalid_request_error",
 						code: "invalid_session_config"
-					}
+					})
 				}, isBeta);
 				return;
 			}
@@ -585,7 +589,7 @@ async function emitLiveTranscriptionEvents(ws, fixtures, journal, defaults, sess
 	const { fixture, skippedBySequenceOrTurn } = matchFixtureDiagnostic(fixtures, request, journal.getFixtureMatchCountsForTest(testId), defaults.requestTransform);
 	const itemId = audioItem.id ?? realtimeId("item");
 	if (!fixture) {
-		if (resolveStrictMode(defaults.strict, defaults.upgradeHeaders)) {
+		if (resolveRequestDecisions(defaults.strict, defaults.upgradeHeaders).fixtureMiss) {
 			const strictMessage = strictNoMatchMessage(skippedBySequenceOrTurn);
 			defaults.logger.error(strictNoMatchLogLine("WS", "/v1/realtime", skippedBySequenceOrTurn));
 			journal.add({
@@ -673,18 +677,17 @@ async function emitLiveTranscriptionEvents(ws, fixtures, journal, defaults, sess
 	const latency = fixture.latency ?? defaults.latency;
 	const chunkSize = Math.max(1, fixture.chunkSize ?? defaults.chunkSize);
 	const replaySpeed = fixture.replaySpeed ?? defaults.replaySpeed;
-	const interruption = createInterruptionSignal(fixture);
+	const lifecycle = wsLifecycle(ws, fixture);
 	let chunkIndex = 0;
 	for (let index = 0; index < transcript.length; index += chunkSize) {
 		const chunkDelay = calculateDelay(chunkIndex, fixture.streamingProfile, latency, fixture.recordedTimings, replaySpeed);
-		if (chunkDelay > 0) await delay(chunkDelay, interruption?.signal);
-		if (interruption?.signal.aborted || ws.isClosed) {
-			if (interruption?.signal.aborted) {
-				journalEntry.response.interrupted = true;
-				journalEntry.response.interruptReason = interruption.reason();
+		if (chunkDelay > 0) await delay(chunkDelay, lifecycle.signal);
+		if (lifecycle.signal.aborted || ws.isClosed) {
+			if (lifecycle.signal.aborted) {
+				markInterrupted(journalEntry, lifecycle.reason());
 				ws.destroy();
-			}
-			interruption?.cleanup();
+			} else markWsTurnStopped(journalEntry, ws, lifecycle);
+			lifecycle.dispose();
 			return;
 		}
 		sendEvent(ws, {
@@ -693,14 +696,13 @@ async function emitLiveTranscriptionEvents(ws, fixtures, journal, defaults, sess
 			content_index: 0,
 			delta: transcript.slice(index, index + chunkSize)
 		}, isBeta);
-		interruption?.tick();
+		lifecycle.tick();
 		chunkIndex++;
 	}
-	if (interruption?.signal.aborted) {
-		journalEntry.response.interrupted = true;
-		journalEntry.response.interruptReason = interruption.reason();
+	if (lifecycle.signal.aborted || ws.isClosed) {
+		markWsTurnStopped(journalEntry, ws, lifecycle);
 		ws.destroy();
-		interruption.cleanup();
+		lifecycle.dispose();
 		return;
 	}
 	sendEvent(ws, {
@@ -711,7 +713,7 @@ async function emitLiveTranscriptionEvents(ws, fixtures, journal, defaults, sess
 		usage,
 		...response.transcription.languages !== void 0 ? { languages: response.transcription.languages } : {}
 	}, isBeta);
-	interruption?.cleanup();
+	lifecycle.dispose();
 }
 function sendLiveTranscriptionFailure(ws, itemId, error, isBeta) {
 	sendEvent(ws, {
@@ -762,11 +764,7 @@ function checkRealtimeFixtureToolCalls(ws, journalEntry, responseId, isBeta, log
 						code: fixtureToolCallErrorCode(err)
 					}
 				},
-				usage: {
-					total_tokens: 0,
-					input_tokens: 0,
-					output_tokens: 0
-				}
+				usage: render({ kind: "ordinary-zero" })
 			}
 		}, isBeta);
 		return;
@@ -794,7 +792,7 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 	const responseId = realtimeId("resp");
 	if (fixture) journal.incrementFixtureMatchCount(fixture, fixtures, testId);
 	if (!fixture) {
-		if (resolveStrictMode(defaults.strict, defaults.upgradeHeaders)) {
+		if (resolveRequestDecisions(defaults.strict, defaults.upgradeHeaders).fixtureMiss) {
 			const strictMessage = strictNoMatchMessage(skippedBySequenceOrTurn);
 			defaults.logger.error(strictNoMatchLogLine("WS", "/v1/realtime", skippedBySequenceOrTurn));
 			journal.add({
@@ -848,11 +846,7 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 						code: "no_fixture_match"
 					}
 				},
-				usage: {
-					total_tokens: 0,
-					input_tokens: 0,
-					output_tokens: 0
-				}
+				usage: render({ kind: "ordinary-zero" })
 			}
 		}, isBeta);
 		return;
@@ -916,11 +910,10 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 		const usage = resolveOpenAIChatMisbehaviorUsage(misbehavior, completionReq, false);
 		await streamRealtimeBlocks(ws, blocks, responseId, fixture, defaults, latency, chunkSize, isBeta, conversationItems, journalEntry, {
 			stop: misbehavior.stop,
-			usage: {
-				input_tokens: usage.prompt_tokens,
-				output_tokens: usage.completion_tokens,
-				total_tokens: usage.total_tokens
-			}
+			usage: render({
+				kind: "applied-misbehavior",
+				usage
+			})
 		});
 		return;
 	}
@@ -952,11 +945,7 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 						code: response.error.code
 					}
 				},
-				usage: {
-					total_tokens: 0,
-					input_tokens: 0,
-					output_tokens: 0
-				}
+				usage: render({ kind: "ordinary-zero" })
 			}
 		}, isBeta);
 		return;
@@ -986,7 +975,7 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 				usage: null
 			}
 		}, isBeta);
-		const interruption = createInterruptionSignal(fixture);
+		const lifecycle = wsLifecycle(ws, fixture);
 		let interrupted = false;
 		const allOutputItems = [];
 		const textItemId = realtimeId("item");
@@ -1034,8 +1023,8 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 		for (let i = 0; i < content.length; i += chunkSize) {
 			if (ws.isClosed) break;
 			const chunkDelay = calculateDelay(eventIndex, void 0, latency, recordedTimings, replaySpeed);
-			if (chunkDelay > 0) await delay(chunkDelay, interruption?.signal);
-			if (interruption?.signal.aborted) {
+			if (chunkDelay > 0) await delay(chunkDelay, lifecycle.signal);
+			if (lifecycle.signal.aborted) {
 				interrupted = true;
 				break;
 			}
@@ -1055,21 +1044,21 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 				break;
 			}
 			eventIndex++;
-			interruption?.tick();
-			if (interruption?.signal.aborted) {
+			lifecycle.tick();
+			if (lifecycle.signal.aborted) {
 				interrupted = true;
 				break;
 			}
 		}
 		if (interrupted) {
 			ws.destroy();
-			journalEntry.response.interrupted = true;
-			journalEntry.response.interruptReason = interruption?.reason();
-			interruption?.cleanup();
+			markInterrupted(journalEntry, lifecycle.reason());
+			lifecycle.dispose();
 			return;
 		}
 		if (ws.isClosed) {
-			interruption?.cleanup();
+			markWsTurnStopped(journalEntry, ws, lifecycle);
+			lifecycle.dispose();
 			return;
 		}
 		sendEvent(ws, {
@@ -1081,7 +1070,8 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 			text: content
 		}, isBeta);
 		if (ws.isClosed) {
-			interruption?.cleanup();
+			markWsTurnStopped(journalEntry, ws, lifecycle);
+			lifecycle.dispose();
 			return;
 		}
 		sendEvent(ws, {
@@ -1096,7 +1086,8 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 			}
 		}, isBeta);
 		if (ws.isClosed) {
-			interruption?.cleanup();
+			markWsTurnStopped(journalEntry, ws, lifecycle);
+			lifecycle.dispose();
 			return;
 		}
 		sendEvent(ws, {
@@ -1120,7 +1111,8 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 			}
 		}, isBeta);
 		if (ws.isClosed) {
-			interruption?.cleanup();
+			markWsTurnStopped(journalEntry, ws, lifecycle);
+			lifecycle.dispose();
 			return;
 		}
 		allOutputItems.push(textOutputItem);
@@ -1156,8 +1148,8 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 			for (let i = 0; i < args.length; i += chunkSize) {
 				if (ws.isClosed) break;
 				const chunkDelay = calculateDelay(eventIndex, void 0, latency, recordedTimings, replaySpeed);
-				if (chunkDelay > 0) await delay(chunkDelay, interruption?.signal);
-				if (interruption?.signal.aborted) {
+				if (chunkDelay > 0) await delay(chunkDelay, lifecycle.signal);
+				if (lifecycle.signal.aborted) {
 					interrupted = true;
 					break;
 				}
@@ -1177,8 +1169,8 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 					break;
 				}
 				eventIndex++;
-				interruption?.tick();
-				if (interruption?.signal.aborted) {
+				lifecycle.tick();
+				if (lifecycle.signal.aborted) {
 					interrupted = true;
 					break;
 				}
@@ -1220,13 +1212,15 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 		}
 		if (interrupted) {
 			ws.destroy();
-			journalEntry.response.interrupted = true;
-			journalEntry.response.interruptReason = interruption?.reason();
-			interruption?.cleanup();
+			markInterrupted(journalEntry, lifecycle.reason());
+			lifecycle.dispose();
+			return;
+		}
+		lifecycle.dispose();
+		if (ws.isClosed) {
+			markWsTurnStopped(journalEntry, ws, lifecycle);
 			return;
 		}
-		interruption?.cleanup();
-		if (ws.isClosed) return;
 		sendEvent(ws, {
 			type: "response.done",
 			response: {
@@ -1234,11 +1228,7 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 				object: "realtime.response",
 				status: "completed",
 				output: allOutputItems,
-				usage: {
-					total_tokens: 0,
-					input_tokens: 0,
-					output_tokens: 0
-				}
+				usage: render({ kind: "ordinary-zero" })
 			}
 		}, isBeta);
 		conversationItems.push({
@@ -1306,14 +1296,14 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 		const content = response.content ?? "";
 		const replaySpeed = fixture.replaySpeed ?? defaults.replaySpeed;
 		const { recordedTimings } = fixture;
-		const interruption = createInterruptionSignal(fixture);
+		const lifecycle = wsLifecycle(ws, fixture);
 		let interrupted = false;
 		let eventIndex = 0;
 		for (let i = 0; i < content.length; i += chunkSize) {
 			if (ws.isClosed) break;
 			const chunkDelay = calculateDelay(eventIndex, void 0, latency, recordedTimings, replaySpeed);
-			if (chunkDelay > 0) await delay(chunkDelay, interruption?.signal);
-			if (interruption?.signal.aborted) {
+			if (chunkDelay > 0) await delay(chunkDelay, lifecycle.signal);
+			if (lifecycle.signal.aborted) {
 				interrupted = true;
 				break;
 			}
@@ -1333,21 +1323,23 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 				break;
 			}
 			eventIndex++;
-			interruption?.tick();
-			if (interruption?.signal.aborted) {
+			lifecycle.tick();
+			if (lifecycle.signal.aborted) {
 				interrupted = true;
 				break;
 			}
 		}
 		if (interrupted) {
 			ws.destroy();
-			journalEntry.response.interrupted = true;
-			journalEntry.response.interruptReason = interruption?.reason();
-			interruption?.cleanup();
+			markInterrupted(journalEntry, lifecycle.reason());
+			lifecycle.dispose();
+			return;
+		}
+		lifecycle.dispose();
+		if (ws.isClosed) {
+			markWsTurnStopped(journalEntry, ws, lifecycle);
 			return;
 		}
-		interruption?.cleanup();
-		if (ws.isClosed) return;
 		sendEvent(ws, {
 			type: "response.output_text.done",
 			response_id: responseId,
@@ -1394,11 +1386,7 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 				object: "realtime.response",
 				status: "completed",
 				output: [outputItem],
-				usage: {
-					total_tokens: 0,
-					input_tokens: 0,
-					output_tokens: 0
-				}
+				usage: render({ kind: "ordinary-zero" })
 			}
 		}, isBeta);
 		conversationItems.push({
@@ -1428,7 +1416,7 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 			}
 		}, isBeta);
 		const outputItems = [];
-		const interruption = createInterruptionSignal(fixture);
+		const lifecycle = wsLifecycle(ws, fixture);
 		const replaySpeed = fixture.replaySpeed ?? defaults.replaySpeed;
 		const { recordedTimings } = fixture;
 		let interrupted = false;
@@ -1463,8 +1451,8 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 			for (let i = 0; i < args.length; i += chunkSize) {
 				if (ws.isClosed) break;
 				const chunkDelay = calculateDelay(eventIndex, void 0, latency, recordedTimings, replaySpeed);
-				if (chunkDelay > 0) await delay(chunkDelay, interruption?.signal);
-				if (interruption?.signal.aborted) {
+				if (chunkDelay > 0) await delay(chunkDelay, lifecycle.signal);
+				if (lifecycle.signal.aborted) {
 					interrupted = true;
 					break;
 				}
@@ -1484,8 +1472,8 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 					break;
 				}
 				eventIndex++;
-				interruption?.tick();
-				if (interruption?.signal.aborted) {
+				lifecycle.tick();
+				if (lifecycle.signal.aborted) {
 					interrupted = true;
 					break;
 				}
@@ -1525,13 +1513,15 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 		}
 		if (interrupted) {
 			ws.destroy();
-			journalEntry.response.interrupted = true;
-			journalEntry.response.interruptReason = interruption?.reason();
-			interruption?.cleanup();
+			markInterrupted(journalEntry, lifecycle.reason());
+			lifecycle.dispose();
+			return;
+		}
+		lifecycle.dispose();
+		if (ws.isClosed) {
+			markWsTurnStopped(journalEntry, ws, lifecycle);
 			return;
 		}
-		interruption?.cleanup();
-		if (ws.isClosed) return;
 		sendEvent(ws, {
 			type: "response.done",
 			response: {
@@ -1539,11 +1529,7 @@ async function handleResponseCreate(ws, fixtures, journal, defaults, session, co
 				object: "realtime.response",
 				status: "completed",
 				output: outputItems,
-				usage: {
-					total_tokens: 0,
-					input_tokens: 0,
-					output_tokens: 0
-				}
+				usage: render({ kind: "ordinary-zero" })
 			}
 		}, isBeta);
 		for (const item of outputItems) conversationItems.push(item);
@@ -1573,7 +1559,7 @@ async function streamRealtimeBlocks(ws, blocks, responseId, fixture, defaults, l
 			usage: null
 		}
 	}, isBeta);
-	const interruption = createInterruptionSignal(fixture);
+	const lifecycle = wsLifecycle(ws, fixture);
 	let interrupted = false;
 	const allOutputItems = [];
 	const replaySpeed = fixture.replaySpeed ?? defaults.replaySpeed;
@@ -1625,8 +1611,8 @@ async function streamRealtimeBlocks(ws, blocks, responseId, fixture, defaults, l
 			for (let i = 0; i < text.length; i += chunkSize) {
 				if (ws.isClosed) break;
 				const chunkDelay = calculateDelay(eventIndex, void 0, latency, recordedTimings, replaySpeed);
-				if (chunkDelay > 0) await delay(chunkDelay, interruption?.signal);
-				if (interruption?.signal.aborted) {
+				if (chunkDelay > 0) await delay(chunkDelay, lifecycle.signal);
+				if (lifecycle.signal.aborted) {
 					interrupted = true;
 					break;
 				}
@@ -1646,8 +1632,8 @@ async function streamRealtimeBlocks(ws, blocks, responseId, fixture, defaults, l
 					break;
 				}
 				eventIndex++;
-				interruption?.tick();
-				if (interruption?.signal.aborted) {
+				lifecycle.tick();
+				if (lifecycle.signal.aborted) {
 					interrupted = true;
 					break;
 				}
@@ -1726,8 +1712,8 @@ async function streamRealtimeBlocks(ws, blocks, responseId, fixture, defaults, l
 			for (let i = 0; i < args.length; i += chunkSize) {
 				if (ws.isClosed) break;
 				const chunkDelay = calculateDelay(eventIndex, void 0, latency, recordedTimings, replaySpeed);
-				if (chunkDelay > 0) await delay(chunkDelay, interruption?.signal);
-				if (interruption?.signal.aborted) {
+				if (chunkDelay > 0) await delay(chunkDelay, lifecycle.signal);
+				if (lifecycle.signal.aborted) {
 					interrupted = true;
 					break;
 				}
@@ -1747,8 +1733,8 @@ async function streamRealtimeBlocks(ws, blocks, responseId, fixture, defaults, l
 					break;
 				}
 				eventIndex++;
-				interruption?.tick();
-				if (interruption?.signal.aborted) {
+				lifecycle.tick();
+				if (lifecycle.signal.aborted) {
 					interrupted = true;
 					break;
 				}
@@ -1790,13 +1776,15 @@ async function streamRealtimeBlocks(ws, blocks, responseId, fixture, defaults, l
 	}
 	if (interrupted) {
 		ws.destroy();
-		journalEntry.response.interrupted = true;
-		journalEntry.response.interruptReason = interruption?.reason();
-		interruption?.cleanup();
+		markInterrupted(journalEntry, lifecycle.reason());
+		lifecycle.dispose();
+		return;
+	}
+	lifecycle.dispose();
+	if (ws.isClosed) {
+		markWsTurnStopped(journalEntry, ws, lifecycle);
 		return;
 	}
-	interruption?.cleanup();
-	if (ws.isClosed) return;
 	sendEvent(ws, {
 		type: "response.done",
 		response: {
@@ -1808,11 +1796,7 @@ async function streamRealtimeBlocks(ws, blocks, responseId, fixture, defaults, l
 				reason: fault.stop === "length" ? "max_output_tokens" : "content_filter"
 			} } : {},
 			output: allOutputItems,
-			usage: fault?.usage ?? {
-				total_tokens: 0,
-				input_tokens: 0,
-				output_tokens: 0
-			}
+			usage: fault?.usage ?? render({ kind: "ordinary-zero" })
 		}
 	}, isBeta);
 	for (const item of allOutputItems) {