fix: emit tool_call_end events in OpenAI handler when streaming ends

daniel-lxs · daniel-lxs · commit ae85d1b993b7 · 2025-12-22T15:28:30.000-05:00
The OpenAiHandler was not emitting tool_call_end events when the API stream ended with finish_reason === 'tool_calls'. This could cause the extension to appear stuck waiting for more stream data. Changes: - Added tracking of active tool call IDs in createMessage() and handleStreamResponse() - Emit tool_call_end events when finish_reason === 'tool_calls' - Added test coverage for both regular and O3 family models Closes: #10275 Linear: ROO-269
diff --git a/src/api/providers/__tests__/openai.spec.ts b/src/api/providers/__tests__/openai.spec.ts
@@ -295,6 +295,10 @@ describe("OpenAiHandler", () => {
 				name: undefined,
 				arguments: '"value"}',
 			})
+
+			// Verify tool_call_end event is emitted when finish_reason is "tool_calls"
+			const toolCallEndChunks = chunks.filter((chunk) => chunk.type === "tool_call_end")
+			expect(toolCallEndChunks).toHaveLength(1)
 		})
 
 		it("should yield tool calls even when finish_reason is not set (fallback behavior)", async () => {
@@ -855,6 +859,10 @@ describe("OpenAiHandler", () => {
 				name: undefined,
 				arguments: "{}",
 			})
+
+			// Verify tool_call_end event is emitted when finish_reason is "tool_calls"
+			const toolCallEndChunks = chunks.filter((chunk) => chunk.type === "tool_call_end")
+			expect(toolCallEndChunks).toHaveLength(1)
 		})
 
 		it("should yield tool calls for O3 model even when finish_reason is not set (fallback behavior)", async () => {
diff --git a/src/api/providers/openai.ts b/src/api/providers/openai.ts
@@ -194,9 +194,11 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
 			)
 
 			let lastUsage
+			const activeToolCallIds = new Set<string>()
 
 			for await (const chunk of stream) {
 				const delta = chunk.choices?.[0]?.delta ?? {}
+				const finishReason = chunk.choices?.[0]?.finish_reason
 
 				if (delta.content) {
 					for (const chunk of matcher.update(delta.content)) {
@@ -213,6 +215,9 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
 
 				if (delta.tool_calls) {
 					for (const toolCall of delta.tool_calls) {
+						if (toolCall.id) {
+							activeToolCallIds.add(toolCall.id)
+						}
 						yield {
 							type: "tool_call_partial",
 							index: toolCall.index,
@@ -223,6 +228,15 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
 					}
 				}
 
+				// Emit tool_call_end events when finish_reason is "tool_calls"
+				// This ensures tool calls are finalized even if the stream doesn't properly close
+				if (finishReason === "tool_calls" && activeToolCallIds.size > 0) {
+					for (const id of activeToolCallIds) {
+						yield { type: "tool_call_end", id }
+					}
+					activeToolCallIds.clear()
+				}
+
 				if (chunk.usage) {
 					lastUsage = chunk.usage
 				}
@@ -443,8 +457,11 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
 	}
 
 	private async *handleStreamResponse(stream: AsyncIterable<OpenAI.Chat.Completions.ChatCompletionChunk>): ApiStream {
+		const activeToolCallIds = new Set<string>()
+
 		for await (const chunk of stream) {
 			const delta = chunk.choices?.[0]?.delta
+			const finishReason = chunk.choices?.[0]?.finish_reason
 
 			if (delta) {
 				if (delta.content) {
@@ -457,6 +474,9 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
 				// Emit raw tool call chunks - NativeToolCallParser handles state management
 				if (delta.tool_calls) {
 					for (const toolCall of delta.tool_calls) {
+						if (toolCall.id) {
+							activeToolCallIds.add(toolCall.id)
+						}
 						yield {
 							type: "tool_call_partial",
 							index: toolCall.index,
@@ -468,6 +488,15 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
 				}
 			}
 
+			// Emit tool_call_end events when finish_reason is "tool_calls"
+			// This ensures tool calls are finalized even if the stream doesn't properly close
+			if (finishReason === "tool_calls" && activeToolCallIds.size > 0) {
+				for (const id of activeToolCallIds) {
+					yield { type: "tool_call_end", id }
+				}
+				activeToolCallIds.clear()
+			}
+
 			if (chunk.usage) {
 				yield {
 					type: "usage",
