@copilotkit/aimock 1.43.0 → 1.45.0

package/dist/cohere.js

@@ -1,6 +1,7 @@
-import { extractOverrides, flattenHeaders, generateDeterministicEmbedding, generateMessageId, generateToolCallId, getContext, getTestId, isContentWithToolCallsResponse, isEmbeddingResponse, isErrorResponse, isJsonObject, isTextResponse, isToolCallResponse, resolveFixtureBlockOutcome, resolveReasoningForModel, resolveResponse, resolveStrictMode, serializeErrorResponse, strictNoMatchLogLine, strictNoMatchMessage, strictOverrideField, validateChatMessages, validateToolsField } from "./helpers.js";
+import { extractOverrides, flattenHeaders, generateDeterministicEmbedding, generateMessageId, generateToolCallId, getContext, getTestId, isCombinedFixtureResponse, isEmbeddingResponse, isErrorResponse, isJsonObject, isTextResponse, isToolCallResponse, prepareOpenAIChatMisbehavior, requireEmittedFunctionToolCalls, resolveFixtureBlockOutcome, resolveOpenAIChatMisbehaviorUsage, resolveReasoningForModel, resolveResponse, resolveStrictMode, serializeErrorResponse, servedToolArgs, strictNoMatchLogLine, strictNoMatchMessage, strictOverrideField, validateChatMessages, validateToolsField } from "./helpers.js";
 import { calculateDelay, delay, writeErrorResponse } from "./sse-writer.js";
 import { applyChaosAsync } from "./chaos.js";
+import { normalizeDirectToolSchema, planMisbehavior, recordMisbehaviorOutcome } from "./misbehavior.js";
 import { matchFixtureDiagnostic, recordMatchOptions } from "./router.js";
 import { proxyAndRecord } from "./recorder.js";
 import { createInterruptionSignal } from "./interruption.js";
@@ -96,12 +97,17 @@ function cohereToCompletionRequest(req) {
 				parameters: t.function.parameters
 			}
 		};
+		const schema = normalizeDirectToolSchema({ tools: [t] }, t.name);
 		return {
 			type: "function",
 			function: {
 				name: t.name,
 				description: t.description,
-				parameters: t.parameter_definitions
+				parameters: schema ? {
+					type: "object",
+					properties: schema.properties,
+					required: [...schema.required]
+				} : void 0
 			}
 		};
 	});
@@ -140,14 +146,7 @@ function buildCohereTextResponse(content, reasoning, overrides) {
 }
 function buildCohereToolCallResponse(toolCalls, logger, reasoning, overrides) {
 	const cohereCalls = toolCalls.map((tc) => {
-		let argsJson;
-		try {
-			JSON.parse(tc.arguments || "{}");
-			argsJson = tc.arguments || "{}";
-		} catch {
-			logger.warn(`Malformed JSON in fixture tool call arguments for "${tc.name}": ${tc.arguments}`);
-			argsJson = "{}";
-		}
+		const argsJson = servedToolArgs(tc, "string", logger).raw;
 		return {
 			id: tc.id || generateToolCallId(),
 			type: "function",
@@ -183,14 +182,7 @@ function buildCohereContentWithToolCallsResponse(content, toolCalls, logger, rea
 		arguments: b.arguments,
 		id: b.id
 	})) : toolCalls).map((tc) => {
-		let argsJson;
-		try {
-			JSON.parse(tc.arguments || "{}");
-			argsJson = tc.arguments || "{}";
-		} catch {
-			logger.warn(`Malformed JSON in fixture tool call arguments for "${tc.name}": ${tc.arguments}`);
-			argsJson = "{}";
-		}
+		const argsJson = servedToolArgs(tc, "string", logger).raw;
 		return {
 			id: tc.id || generateToolCallId(),
 			type: "function",
@@ -335,14 +327,7 @@ function buildCohereToolCallStreamEvents(toolCalls, chunkSize, logger, reasoning
 	for (let idx = 0; idx < toolCalls.length; idx++) {
 		const tc = toolCalls[idx];
 		const callId = tc.id || generateToolCallId();
-		let argsJson;
-		try {
-			JSON.parse(tc.arguments || "{}");
-			argsJson = tc.arguments || "{}";
-		} catch {
-			logger.warn(`Malformed JSON in fixture tool call arguments for "${tc.name}": ${tc.arguments}`);
-			argsJson = "{}";
-		}
+		const argsJson = servedToolArgs(tc, "string", logger).raw;
 		events.push({
 			type: "tool-call-start",
 			index: idx,
@@ -430,14 +415,7 @@ function buildCohereContentWithToolCallsStreamEvents(content, toolCalls, chunkSi
 					toolPlanEmitted = true;
 				}
 				const callId = block.id || generateToolCallId();
-				let argsJson;
-				try {
-					JSON.parse(block.arguments || "{}");
-					argsJson = block.arguments || "{}";
-				} catch {
-					logger.warn(`Malformed JSON in fixture tool call arguments for "${block.name}": ${block.arguments}`);
-					argsJson = "{}";
-				}
+				const argsJson = servedToolArgs(block, "string", logger).raw;
 				events.push({
 					type: "tool-call-start",
 					index: toolIdx,
@@ -517,14 +495,7 @@ function buildCohereContentWithToolCallsStreamEvents(content, toolCalls, chunkSi
 	for (let idx = 0; idx < toolCalls.length; idx++) {
 		const tc = toolCalls[idx];
 		const callId = tc.id || generateToolCallId();
-		let argsJson;
-		try {
-			JSON.parse(tc.arguments || "{}");
-			argsJson = tc.arguments || "{}";
-		} catch {
-			logger.warn(`Malformed JSON in fixture tool call arguments for "${tc.name}": ${tc.arguments}`);
-			argsJson = "{}";
-		}
+		const argsJson = servedToolArgs(tc, "string", logger).raw;
 		events.push({
 			type: "tool-call-start",
 			index: idx,
@@ -581,7 +552,10 @@ async function writeCohereSSEStream(res, events, optionsOrLatency) {
 		if (signal?.aborted) return false;
 		chunkIndex++;
 	}
-	if (!res.writableEnded) res.end();
+	if (!res.writableEnded) {
+		if (opts.terminalSentinel && !signal?.aborted) res.write("data: [DONE]\n\n");
+		res.end();
+	}
 	return true;
 }
 async function handleCohere(req, res, raw, fixtures, journal, defaults, setCorsHeaders) {
@@ -642,7 +616,11 @@ async function handleCohere(req, res, raw, fixtures, journal, defaults, setCorsH
 		} }));
 		return;
 	}
-	const shapeError = validateChatMessages(cohereReq.messages) ?? validateToolsField(cohereReq.tools);
+	let shapeError = validateChatMessages(cohereReq.messages) ?? validateToolsField(cohereReq.tools);
+	if (!shapeError && Array.isArray(cohereReq.tools)) {
+		const nullFunctionIndex = cohereReq.tools.findIndex((tool) => "function" in tool && tool.function === null);
+		if (nullFunctionIndex !== -1) shapeError = `tools[${nullFunctionIndex}].function must be an object`;
+	}
 	if (shapeError) {
 		journal.add({
 			method: req.method ?? "POST",
@@ -732,29 +710,79 @@ async function handleCohere(req, res, raw, fixtures, journal, defaults, setCorsH
 		} }));
 		return;
 	}
-	const response = await resolveResponse(fixture, completionReq);
+	const resolvedResponse = await resolveResponse(fixture, completionReq);
+	const misbehavior = planMisbehavior({
+		wire: "cohere",
+		fixture,
+		response: resolvedResponse,
+		request: completionReq,
+		stream: cohereReq.stream === true,
+		emitsToolCallIds: true,
+		defaults,
+		rawHeaders: req.headers,
+		url: req.url
+	});
+	if (misbehavior.kind === "error") {
+		recordMisbehaviorOutcome({
+			entry: journal.add({
+				method: req.method ?? "POST",
+				path: req.url ?? "/v2/chat",
+				headers: flattenHeaders(req.headers),
+				body: completionReq,
+				response: {
+					status: misbehavior.status,
+					fixture
+				}
+			}),
+			summary: misbehavior.summary,
+			defaults,
+			testId
+		});
+		if (!misbehavior.summary?.evaluations.length) logger.error(misbehavior.message);
+		writeErrorResponse(res, misbehavior.status, JSON.stringify({
+			message: misbehavior.message,
+			code: misbehavior.code
+		}));
+		return;
+	}
+	const prepared = misbehavior.kind === "applied" ? prepareOpenAIChatMisbehavior(misbehavior) : void 0;
+	const observedK5Stream = cohereReq.stream === true && prepared?.summary.fault === "stop-length-mid-tool";
+	const appliedReasoning = prepared && "reasoning" in prepared.response ? resolveReasoningForModel(prepared.response.reasoning, cohereReq.model, resolveStrictMode(defaults.strict, req.headers), logger) : void 0;
+	const usage = prepared ? resolveOpenAIChatMisbehaviorUsage(prepared, completionReq, appliedReasoning !== void 0) : void 0;
+	const response = prepared && usage ? {
+		...prepared.response,
+		usage,
+		...prepared.stop ? { finishReason: observedK5Stream ? "tool_calls" : prepared.stop } : {}
+	} : resolvedResponse;
+	const summary = prepared?.summary ?? misbehavior.summary;
+	const empty = prepared?.summary.fault === "empty-response";
 	const latency = fixture.latency ?? defaults.latency;
 	const chunkSize = Math.max(1, fixture.chunkSize ?? defaults.chunkSize);
 	if (isErrorResponse(response)) {
 		const status = response.status ?? 500;
-		journal.add({
-			method: req.method ?? "POST",
-			path: req.url ?? "/v2/chat",
-			headers: flattenHeaders(req.headers),
-			body: completionReq,
-			response: {
-				status,
-				fixture
-			}
+		recordMisbehaviorOutcome({
+			entry: journal.add({
+				method: req.method ?? "POST",
+				path: req.url ?? "/v2/chat",
+				headers: flattenHeaders(req.headers),
+				body: completionReq,
+				response: {
+					status,
+					fixture
+				}
+			}),
+			summary,
+			defaults,
+			testId
 		});
 		writeErrorResponse(res, status, serializeErrorResponse(response), { retryAfter: response.retryAfter });
 		return;
 	}
-	if (isContentWithToolCallsResponse(response)) {
+	if (isCombinedFixtureResponse(response)) {
 		if (response.webSearches?.length) logger.warn("webSearches in fixture response are not supported for Cohere v2 Chat API — ignoring");
 		const overrides = extractOverrides(response);
 		const effectiveStrict = resolveStrictMode(defaults.strict, req.headers);
-		const effReasoning = resolveReasoningForModel(response.reasoning, cohereReq.model, effectiveStrict, logger);
+		const effReasoning = prepared ? appliedReasoning : resolveReasoningForModel(response.reasoning, cohereReq.model, effectiveStrict, logger);
 		const journalEntry = journal.add({
 			method: req.method ?? "POST",
 			path: req.url ?? "/v2/chat",
@@ -765,14 +793,22 @@ async function handleCohere(req, res, raw, fixtures, journal, defaults, setCorsH
 				fixture
 			}
 		});
+		recordMisbehaviorOutcome({
+			entry: journalEntry,
+			summary,
+			defaults,
+			testId
+		});
+		const functionToolCalls = requireEmittedFunctionToolCalls(response, "Cohere");
 		if (cohereReq.stream !== true) {
-			const body = buildCohereContentWithToolCallsResponse(response.content ?? "", response.toolCalls ?? [], logger, effReasoning, overrides, response.blocks);
+			const body = buildCohereContentWithToolCallsResponse(response.content ?? "", functionToolCalls, logger, effReasoning, overrides, response.blocks);
 			res.writeHead(200, { "Content-Type": "application/json" });
 			res.end(JSON.stringify(body));
 		} else {
-			const events = buildCohereContentWithToolCallsStreamEvents(response.content ?? "", response.toolCalls ?? [], chunkSize, logger, effReasoning, overrides, response.blocks);
+			const events = buildCohereContentWithToolCallsStreamEvents(response.content ?? "", functionToolCalls, chunkSize, logger, effReasoning, overrides, response.blocks);
 			const interruption = createInterruptionSignal(fixture);
 			if (!await writeCohereSSEStream(res, events, {
+				terminalSentinel: observedK5Stream,
 				latency,
 				streamingProfile: fixture.streamingProfile,
 				recordedTimings: fixture.recordedTimings,
@@ -792,7 +828,7 @@ async function handleCohere(req, res, raw, fixtures, journal, defaults, setCorsH
 		if (response.webSearches?.length) logger.warn("webSearches in fixture response are not supported for Cohere v2 Chat API — ignoring");
 		const overrides = extractOverrides(response);
 		const effectiveStrict = resolveStrictMode(defaults.strict, req.headers);
-		const effReasoning = resolveReasoningForModel(response.reasoning, cohereReq.model, effectiveStrict, logger);
+		const effReasoning = prepared ? appliedReasoning : resolveReasoningForModel(response.reasoning, cohereReq.model, effectiveStrict, logger);
 		const journalEntry = journal.add({
 			method: req.method ?? "POST",
 			path: req.url ?? "/v2/chat",
@@ -803,14 +839,30 @@ async function handleCohere(req, res, raw, fixtures, journal, defaults, setCorsH
 				fixture
 			}
 		});
+		recordMisbehaviorOutcome({
+			entry: journalEntry,
+			summary,
+			defaults,
+			testId
+		});
 		if (cohereReq.stream !== true) {
-			const body = buildCohereTextResponse(response.content, effReasoning, overrides);
+			const body = empty ? {
+				...buildCohereTextResponse("", void 0, overrides),
+				message: {
+					role: "assistant",
+					content: [],
+					tool_calls: [],
+					tool_plan: "",
+					citations: []
+				}
+			} : buildCohereTextResponse(response.content, effReasoning, overrides);
 			res.writeHead(200, { "Content-Type": "application/json" });
 			res.end(JSON.stringify(body));
 		} else {
-			const events = buildCohereTextStreamEvents(response.content, chunkSize, effReasoning, overrides);
+			const events = buildCohereTextStreamEvents(response.content, chunkSize, effReasoning, overrides).filter((event) => !empty || event.type === "message-start" || event.type === "message-end");
 			const interruption = createInterruptionSignal(fixture);
 			if (!await writeCohereSSEStream(res, events, {
+				terminalSentinel: observedK5Stream,
 				latency,
 				streamingProfile: fixture.streamingProfile,
 				recordedTimings: fixture.recordedTimings,
@@ -830,7 +882,7 @@ async function handleCohere(req, res, raw, fixtures, journal, defaults, setCorsH
 		if (response.webSearches?.length) logger.warn("webSearches in fixture response are not supported for Cohere v2 Chat API — ignoring");
 		const overrides = extractOverrides(response);
 		const effectiveStrict = resolveStrictMode(defaults.strict, req.headers);
-		const effReasoning = resolveReasoningForModel(response.reasoning, cohereReq.model, effectiveStrict, logger);
+		const effReasoning = prepared ? appliedReasoning : resolveReasoningForModel(response.reasoning, cohereReq.model, effectiveStrict, logger);
 		const journalEntry = journal.add({
 			method: req.method ?? "POST",
 			path: req.url ?? "/v2/chat",
@@ -841,14 +893,22 @@ async function handleCohere(req, res, raw, fixtures, journal, defaults, setCorsH
 				fixture
 			}
 		});
+		recordMisbehaviorOutcome({
+			entry: journalEntry,
+			summary,
+			defaults,
+			testId
+		});
+		const functionToolCalls = requireEmittedFunctionToolCalls(response, "Cohere");
 		if (cohereReq.stream !== true) {
-			const body = buildCohereToolCallResponse(response.toolCalls, logger, effReasoning, overrides);
+			const body = buildCohereToolCallResponse(functionToolCalls, logger, effReasoning, overrides);
 			res.writeHead(200, { "Content-Type": "application/json" });
 			res.end(JSON.stringify(body));
 		} else {
-			const events = buildCohereToolCallStreamEvents(response.toolCalls, chunkSize, logger, effReasoning, overrides);
+			const events = buildCohereToolCallStreamEvents(functionToolCalls, chunkSize, logger, effReasoning, overrides);
 			const interruption = createInterruptionSignal(fixture);
 			if (!await writeCohereSSEStream(res, events, {
+				terminalSentinel: observedK5Stream,
 				latency,
 				streamingProfile: fixture.streamingProfile,
 				recordedTimings: fixture.recordedTimings,
@@ -864,15 +924,20 @@ async function handleCohere(req, res, raw, fixtures, journal, defaults, setCorsH
 		}
 		return;
 	}
-	journal.add({
-		method: req.method ?? "POST",
-		path: req.url ?? "/v2/chat",
-		headers: flattenHeaders(req.headers),
-		body: completionReq,
-		response: {
-			status: 500,
-			fixture
-		}
+	recordMisbehaviorOutcome({
+		entry: journal.add({
+			method: req.method ?? "POST",
+			path: req.url ?? "/v2/chat",
+			headers: flattenHeaders(req.headers),
+			body: completionReq,
+			response: {
+				status: 500,
+				fixture
+			}
+		}),
+		summary,
+		defaults,
+		testId
 	});
 	writeErrorResponse(res, 500, JSON.stringify({ error: {
 		message: "Fixture response did not match any known type",
@@ -992,6 +1057,26 @@ async function handleCohereEmbed(req, res, raw, fixtures, journal, defaults, set
 		body: syntheticReq
 	}, fixture ? "fixture" : "proxy", defaults.registry, defaults.logger)) return;
 	const embeddingTypes = embedReq.embedding_types && embedReq.embedding_types.length > 0 ? embedReq.embedding_types : ["float"];
+	function rejectInvalidEmbeddingTypes() {
+		if (embedReq.embedding_types == null) return false;
+		const isArray = Array.isArray(embedReq.embedding_types);
+		if (isArray && embedReq.embedding_types.every((type) => typeof type === "string")) return false;
+		journal.add({
+			method: req.method ?? "POST",
+			path: req.url ?? "/v2/embed",
+			headers: flattenHeaders(req.headers),
+			body: syntheticReq,
+			response: {
+				status: 400,
+				fixture: fixture ?? null
+			}
+		});
+		writeErrorResponse(res, 400, JSON.stringify({ error: {
+			message: isArray ? "Invalid request: embedding_types must be an array of strings" : "Invalid request: embedding_types must be an array",
+			type: "invalid_request_error"
+		} }));
+		return true;
+	}
 	if (fixture) {
 		const response = await resolveResponse(fixture, syntheticReq);
 		if (isErrorResponse(response)) {
@@ -1010,6 +1095,7 @@ async function handleCohereEmbed(req, res, raw, fixtures, journal, defaults, set
 			return;
 		}
 		if (isEmbeddingResponse(response)) {
+			if (rejectInvalidEmbeddingTypes()) return;
 			journal.add({
 				method: req.method ?? "POST",
 				path: req.url ?? "/v2/embed",
@@ -1087,6 +1173,7 @@ async function handleCohereEmbed(req, res, raw, fixtures, journal, defaults, set
 			return;
 		}
 	}
+	if (rejectInvalidEmbeddingTypes()) return;
 	logger.warn(`No embedding fixture matched for "${combinedInput.slice(0, 80)}" — returning deterministic fallback`);
 	const dimensions = 1024;
 	const vectors = embedReq.texts.map((text) => generateDeterministicEmbedding(text, dimensions));