Skip to content

Commit ca7bdae

Browse files
charlesliencharleslien
committed
jsonToolResult returns array
1 parent 6a29160 commit ca7bdae

8 files changed

Lines changed: 131 additions & 164 deletions

File tree

‎backend/src/__tests__/main-prompt.integration.test.ts‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { getToolCallString } from '@codebuff/common/tools/utils'
77
import { getInitialSessionState } from '@codebuff/common/types/session-state'
88
import {
99
assistantMessage,
10-
toolJsonContent,
10+
jsonToolResult,
1111
} from '@codebuff/common/util/messages'
1212
import { afterEach, beforeEach, describe, expect, it, mock } from 'bun:test'
1313

@@ -342,12 +342,10 @@ export function getMessagesSubset(messages: Message[], otherTokens: number) {
342342
role: 'tool',
343343
toolName: 'read_files',
344344
toolCallId: 'test-id',
345-
content: [
346-
toolJsonContent({
347-
path: 'src/util/messages.ts',
348-
content: initialContent,
349-
}),
350-
],
345+
content: jsonToolResult({
346+
path: 'src/util/messages.ts',
347+
content: initialContent,
348+
}),
351349
},
352350
)
353351

@@ -415,12 +413,10 @@ export function getMessagesSubset(messages: Message[], otherTokens: number) {
415413
role: 'tool',
416414
toolName: 'read_files',
417415
toolCallId: 'test-id',
418-
content: [
419-
toolJsonContent({
420-
path: 'packages/backend/src/index.ts',
421-
content: initialContent,
422-
}),
423-
],
416+
content: jsonToolResult({
417+
path: 'packages/backend/src/index.ts',
418+
content: initialContent,
419+
}),
424420
},
425421
)
426422

‎common/src/util/__tests__/messages.test.ts‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import {
88
systemMessage,
99
userMessage,
1010
assistantMessage,
11-
toolJsonContent,
12-
toolMediaContent,
11+
jsonToolResult,
12+
mediaToolResult,
1313
} from '../messages'
1414

1515
import type { Message } from '../../types/messages/codebuff-message'
@@ -200,7 +200,7 @@ describe('convertCbToModelMessages', () => {
200200
role: 'tool',
201201
toolName: 'test_tool',
202202
toolCallId: 'call_123',
203-
content: [toolJsonContent({ result: 'success' })],
203+
content: jsonToolResult({ result: 'success' }),
204204
},
205205
]
206206

@@ -228,12 +228,10 @@ describe('convertCbToModelMessages', () => {
228228
role: 'tool',
229229
toolName: 'test_tool',
230230
toolCallId: 'call_123',
231-
content: [
232-
toolMediaContent({
233-
data: 'base64data',
234-
mediaType: 'image/png',
235-
}),
236-
],
231+
content: mediaToolResult({
232+
data: 'base64data',
233+
mediaType: 'image/png',
234+
}),
237235
},
238236
]
239237

@@ -261,8 +259,8 @@ describe('convertCbToModelMessages', () => {
261259
toolName: 'test_tool',
262260
toolCallId: 'call_123',
263261
content: [
264-
toolJsonContent({ result1: 'success' }),
265-
toolJsonContent({ result2: 'also success' }),
262+
{ type: 'json', value: { result1: 'success' } },
263+
{ type: 'json', value: { result2: 'also success' } },
266264
],
267265
},
268266
]

‎common/src/util/messages.ts‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -424,30 +424,31 @@ export function assistantMessage(
424424
}
425425
}
426426

427-
export function toolJsonContent<T extends JSONValue>(
427+
export function jsonToolResult<T extends JSONValue>(
428428
value: T,
429-
): ToolResultOutput & {
430-
type: 'json'
431-
value: T
432-
} {
433-
return {
434-
type: 'json',
435-
value,
436-
}
429+
): [
430+
Extract<ToolResultOutput, { type: 'json' }> & {
431+
value: T
432+
},
433+
] {
434+
return [
435+
{
436+
type: 'json',
437+
value,
438+
},
439+
]
437440
}
438441

439-
export function toolMediaContent(params: {
442+
export function mediaToolResult(params: {
440443
data: string
441444
mediaType: string
442-
}): ToolResultOutput & {
443-
type: 'media'
444-
data: string
445-
mediaType: string
446-
} {
445+
}): [Extract<ToolResultOutput, { type: 'media' }>] {
447446
const { data, mediaType } = params
448-
return {
449-
type: 'media',
450-
data,
451-
mediaType,
452-
}
447+
return [
448+
{
449+
type: 'media',
450+
data,
451+
mediaType,
452+
},
453+
]
453454
}

‎npm-app/src/background-process-manager.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import path from 'path'
1111
import process from 'process'
1212

1313
import { AnalyticsEvent } from '@codebuff/common/constants/analytics-events'
14-
import { toolJsonContent } from '@codebuff/common/util/messages'
14+
import { jsonToolResult } from '@codebuff/common/util/messages'
1515
import { truncateStringWithMessage } from '@codebuff/common/util/string'
1616
import { gray, red } from 'picocolors'
1717
import { z } from 'zod/v4'
@@ -181,7 +181,7 @@ export function getBackgroundProcessUpdates(): ToolMessage[] {
181181
role: 'tool',
182182
toolCallId,
183183
toolName: 'background_process_update',
184-
content: [toolJsonContent(update)],
184+
content: jsonToolResult(update),
185185
} satisfies ToolMessage
186186
})
187187
}

‎packages/agent-runtime/src/__tests__/run-programmatic-step.test.ts‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { TEST_AGENT_RUNTIME_IMPL } from '@codebuff/common/testing/impl/agent-run
44
import { getInitialSessionState } from '@codebuff/common/types/session-state'
55
import {
66
assistantMessage,
7-
toolJsonContent,
7+
jsonToolResult,
88
userMessage,
99
} from '@codebuff/common/util/messages'
1010
import {
@@ -319,14 +319,12 @@ describe('runProgrammaticStep', () => {
319319
role: 'tool',
320320
toolName: 'find_files',
321321
toolCallId: 'find-files-call-id',
322-
content: [
323-
toolJsonContent({
324-
files: [
325-
{ path: 'src/auth.ts', relevance: 0.9 },
326-
{ path: 'src/login.ts', relevance: 0.8 },
327-
],
328-
}),
329-
],
322+
content: jsonToolResult({
323+
files: [
324+
{ path: 'src/auth.ts', relevance: 0.9 },
325+
{ path: 'src/login.ts', relevance: 0.8 },
326+
],
327+
}),
330328
}
331329
options.toolResults.push(toolResult)
332330

‎packages/agent-runtime/src/tools/stream-parser.ts‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { toolNames } from '@codebuff/common/tools/constants'
22
import { buildArray } from '@codebuff/common/util/array'
33
import {
4-
toolJsonContent,
4+
jsonToolResult,
55
assistantMessage,
66
} from '@codebuff/common/util/messages'
77
import { generateCompactId } from '@codebuff/common/util/string'
@@ -175,11 +175,9 @@ export async function processStreamWithTools(
175175
role: 'tool',
176176
toolName,
177177
toolCallId: generateCompactId(),
178-
content: [
179-
toolJsonContent({
180-
errorMessage: error,
181-
}),
182-
],
178+
content: jsonToolResult({
179+
errorMessage: error,
180+
}),
183181
}
184182
toolResults.push(cloneDeep(toolResult))
185183
toolResultsToAddAfterStream.push(cloneDeep(toolResult))

‎packages/agent-runtime/src/tools/tool-executor.ts‎

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { endsAgentStepParam } from '@codebuff/common/tools/constants'
22
import { toolParams } from '@codebuff/common/tools/list'
3-
import { toolJsonContent } from '@codebuff/common/util/messages'
3+
import { jsonToolResult } from '@codebuff/common/util/messages'
44
import { generateCompactId } from '@codebuff/common/util/string'
55
import { cloneDeep } from 'lodash'
66
import z from 'zod/v4'
@@ -179,11 +179,9 @@ export function executeToolCall<T extends ToolName>(
179179
role: 'tool',
180180
toolName,
181181
toolCallId: toolCall.toolCallId,
182-
content: [
183-
toolJsonContent({
184-
errorMessage: toolCall.error,
185-
}),
186-
],
182+
content: jsonToolResult({
183+
errorMessage: toolCall.error,
184+
}),
187185
}
188186
toolResults.push(cloneDeep(toolResult))
189187
toolResultsToAddAfterStream.push(cloneDeep(toolResult))
@@ -216,11 +214,9 @@ export function executeToolCall<T extends ToolName>(
216214
role: 'tool',
217215
toolName,
218216
toolCallId: toolCall.toolCallId,
219-
content: [
220-
toolJsonContent({
221-
errorMessage: `Tool \`${toolName}\` is not currently available. Make sure to only use tools listed in the system instructions.`,
222-
}),
223-
],
217+
content: jsonToolResult({
218+
errorMessage: `Tool \`${toolName}\` is not currently available. Make sure to only use tools listed in the system instructions.`,
219+
}),
224220
}
225221
toolResults.push(cloneDeep(toolResult))
226222
toolResultsToAddAfterStream.push(cloneDeep(toolResult))
@@ -430,11 +426,9 @@ export async function executeCustomToolCall(
430426
role: 'tool',
431427
toolName,
432428
toolCallId: toolCall.toolCallId,
433-
content: [
434-
toolJsonContent({
435-
errorMessage: toolCall.error,
436-
}),
437-
],
429+
content: jsonToolResult({
430+
errorMessage: toolCall.error,
431+
}),
438432
}
439433
toolResults.push(cloneDeep(toolResult))
440434
toolResultsToAddAfterStream.push(cloneDeep(toolResult))
@@ -471,11 +465,9 @@ export async function executeCustomToolCall(
471465
role: 'tool',
472466
toolName,
473467
toolCallId: toolCall.toolCallId,
474-
content: [
475-
toolJsonContent({
476-
errorMessage: `Tool \`${toolName}\` is not currently available. Make sure to only use tools listed in the system instructions.`,
477-
}),
478-
],
468+
content: jsonToolResult({
469+
errorMessage: `Tool \`${toolName}\` is not currently available. Make sure to only use tools listed in the system instructions.`,
470+
}),
479471
}
480472
toolResults.push(cloneDeep(toolResult))
481473
toolResultsToAddAfterStream.push(cloneDeep(toolResult))

0 commit comments

Comments
 (0)