Refactor spawn agents to not just pass all params through. Passes all context params and then is explicit about subagent params

Author: jahooma

packages/agent-runtime/src/run-agent-step.ts

@@ -506,6 +506,7 @@ export async function loopAgentSteps(
       | 'system'
       | 'template'
       | 'toolCallParams'
+      | 'tools'
     > &
     ParamsExcluding<typeof getAgentTemplate, 'agentId'> &
     ParamsExcluding<

packages/agent-runtime/src/tools/handlers/tool/spawn-agent-inline.ts

@@ -4,6 +4,7 @@ import {
   logAgentSpawn,
   executeSubagent,
   createAgentState,
+  extractSubagentContextParams,
 } from './spawn-agent-utils'
 
 import type { CodebuffToolHandlerFunction } from '../handler-function-type'
@@ -75,9 +76,13 @@ export const handleSpawnAgentInline = (async (
   await previousToolCallFinished
 
   const { agentTemplate, agentType } = await validateAndGetAgentTemplate({
-    ...params,
     agentTypeStr,
     parentAgentTemplate,
+    localAgentTemplates: params.localAgentTemplates,
+    logger,
+    fetchAgentFromDatabase: params.fetchAgentFromDatabase,
+    databaseAgentCache: params.databaseAgentCache,
+    apiKey: params.apiKey,
   })
 
   validateAgentInput(agentTemplate, agentType, prompt, spawnParams)
@@ -105,18 +110,24 @@ export const handleSpawnAgentInline = (async (
   }
 
   logAgentSpawn({
-    ...params,
     agentTemplate: inlineTemplate,
     agentType,
     agentId: childAgentState.agentId,
     parentId: childAgentState.parentId,
     prompt,
     spawnParams,
     inline: true,
+    logger,
   })
 
+  // Extract common context params to avoid bugs from spreading all params
+  const contextParams = extractSubagentContextParams(params)
+
   const result = await executeSubagent({
-    ...params,
+    ...contextParams,
+
+    // Spawn-specific params
+    ancestorRunIds: parentAgentState.ancestorRunIds,
     userInputId: `${userInputId}-inline-${agentType}${childAgentState.agentId}`,
     prompt: prompt || '',
     spawnParams,

packages/agent-runtime/src/tools/handlers/tool/spawn-agent-utils.ts

@@ -7,6 +7,10 @@ import { getAgentTemplate } from '../../../templates/agent-registry'
 import { filterUnfinishedToolCalls, withSystemTags } from '../../../util/messages'
 
 import type { AgentTemplate } from '@codebuff/common/types/agent-template'
+import type {
+  AgentRuntimeDeps,
+  AgentRuntimeScopedDeps,
+} from '@codebuff/common/types/contracts/agent-runtime'
 import type { Logger } from '@codebuff/common/types/contracts/logger'
 import type {
   ParamsExcluding,
@@ -19,8 +23,80 @@ import type {
   AgentTemplateType,
   Subgoal,
 } from '@codebuff/common/types/session-state'
+import type { ProjectFileContext } from '@codebuff/common/util/file'
 import { Message } from '@codebuff/common/types/messages/codebuff-message'
 
+/**
+ * Common context params needed for spawning subagents.
+ * These are the params that don't change between different spawn calls
+ * and are passed through from the parent agent runtime.
+ */
+export type SubagentContextParams = AgentRuntimeDeps &
+  AgentRuntimeScopedDeps & {
+    clientSessionId: string
+    fileContext: ProjectFileContext
+    localAgentTemplates: Record<string, AgentTemplate>
+    repoId: string | undefined
+    repoUrl: string | undefined
+    signal: AbortSignal
+    userId: string | undefined
+  }
+
+/**
+ * Extracts the common context params needed for spawning subagents.
+ * This avoids bugs from spreading all params with `...params` which can
+ * accidentally pass through params that should be overridden.
+ */
+export function extractSubagentContextParams(
+  params: SubagentContextParams,
+): SubagentContextParams {
+  return {
+    // AgentRuntimeDeps - Environment
+    clientEnv: params.clientEnv,
+    ciEnv: params.ciEnv,
+    // AgentRuntimeDeps - Database
+    getUserInfoFromApiKey: params.getUserInfoFromApiKey,
+    fetchAgentFromDatabase: params.fetchAgentFromDatabase,
+    startAgentRun: params.startAgentRun,
+    finishAgentRun: params.finishAgentRun,
+    addAgentStep: params.addAgentStep,
+    // AgentRuntimeDeps - Billing
+    consumeCreditsWithFallback: params.consumeCreditsWithFallback,
+    // AgentRuntimeDeps - LLM
+    promptAiSdkStream: params.promptAiSdkStream,
+    promptAiSdk: params.promptAiSdk,
+    promptAiSdkStructured: params.promptAiSdkStructured,
+    // AgentRuntimeDeps - Mutable State
+    databaseAgentCache: params.databaseAgentCache,
+    liveUserInputRecord: params.liveUserInputRecord,
+    sessionConnections: params.sessionConnections,
+    // AgentRuntimeDeps - Analytics
+    trackEvent: params.trackEvent,
+    // AgentRuntimeDeps - Other
+    logger: params.logger,
+    fetch: params.fetch,
+
+    // AgentRuntimeScopedDeps - Client (WebSocket)
+    handleStepsLogChunk: params.handleStepsLogChunk,
+    requestToolCall: params.requestToolCall,
+    requestMcpToolData: params.requestMcpToolData,
+    requestFiles: params.requestFiles,
+    requestOptionalFile: params.requestOptionalFile,
+    sendAction: params.sendAction,
+    sendSubagentChunk: params.sendSubagentChunk,
+    apiKey: params.apiKey,
+
+    // Core context params
+    clientSessionId: params.clientSessionId,
+    fileContext: params.fileContext,
+    localAgentTemplates: params.localAgentTemplates,
+    repoId: params.repoId,
+    repoUrl: params.repoUrl,
+    signal: params.signal,
+    userId: params.userId,
+  }
+}
+
 /**
  * Checks if a parent agent is allowed to spawn a child agent
  */

packages/agent-runtime/src/tools/handlers/tool/spawn-agents.ts

@@ -6,6 +6,7 @@ import {
   createAgentState,
   logAgentSpawn,
   executeSubagent,
+  extractSubagentContextParams,
 } from './spawn-agent-utils'
 
 import type { CodebuffToolHandlerFunction } from '../handler-function-type'
@@ -111,8 +112,14 @@ export const handleSpawnAgents = (async (
           logger,
         })
 
+        // Extract common context params to avoid bugs from spreading all params
+        const contextParams = extractSubagentContextParams(params)
+
         const result = await executeSubagent({
-          ...params,
+          ...contextParams,
+
+          // Spawn-specific params
+          ancestorRunIds: parentAgentState.ancestorRunIds,
           userInputId: `${userInputId}-${agentType}${subAgentState.agentId}`,
           prompt: prompt || '',
           spawnParams,
@@ -122,6 +129,7 @@ export const handleSpawnAgents = (async (
           fingerprintId,
           isOnlyChild: agents.length === 1,
           excludeToolFromMessageHistory: false,
+          fromHandleSteps: false,
           parentSystemPrompt,
           parentTools: agentTemplate.inheritParentSystemPrompt
             ? parentTools