Skip to content

fix(code_executors): Fix JSON field mismatches in AgentEngineSandboxCodeExecutor #4261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sudhendra wants to merge 8 commits into
base: main
Choose a base branch
from
+683 −146
Open

fix(code_executors): Fix JSON field mismatches in AgentEngineSandboxCodeExecutor #4261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7444ff9
fix(code_executors): Fix JSON field mismatches in AgentEngineSandboxC…
Sudhendra Jan 25, 2026
132028a
Merge branch 'main' into fix/issue-3690
Sudhendra Jan 26, 2026
3c1f18f
Merge branch 'main' into fix/issue-3690
Sudhendra Jan 28, 2026
f21a690
Update src/google/adk/code_executors/agent_engine_sandbox_code_execut…
Sudhendra Jan 29, 2026
72a23b3
Merge branch 'main' into fix/issue-3690
Sudhendra Jan 29, 2026
3aaff64
Merge branch 'google:main' into fix/issue-3690
Sudhendra Feb 1, 2026
d2b7e11
Merge branch 'main' into fix/issue-3690
Sudhendra Feb 6, 2026
7f8e42c
fix(code_executors): harden sandbox JSON parsing
Sudhendra Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
312 changes: 167 additions & 145 deletions src/google/adk/code_executors/agent_engine_sandbox_code_executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,161 +28,183 @@
from .code_execution_utils import CodeExecutionResult
from .code_execution_utils import File

logger = logging.getLogger('google_adk.' + __name__)
logger = logging.getLogger("google_adk." + __name__)


class AgentEngineSandboxCodeExecutor(BaseCodeExecutor):
"""A code executor that uses Agent Engine Code Execution Sandbox to execute code.

Attributes:
sandbox_resource_name: If set, load the existing resource name of the code
interpreter extension instead of creating a new one. Format:
projects/123/locations/us-central1/reasoningEngines/456/sandboxEnvironments/789
"""

sandbox_resource_name: str = None

def __init__(
self,
sandbox_resource_name: Optional[str] = None,
agent_engine_resource_name: Optional[str] = None,
**data,
):
"""Initializes the AgentEngineSandboxCodeExecutor.

Args:
sandbox_resource_name: If set, load the existing resource name of code
execution sandbox, if not set, create a new one. Format:
projects/123/locations/us-central1/reasoningEngines/456/
sandboxEnvironments/789
agent_engine_resource_name: The resource name of the agent engine to use
to create the code execution sandbox. Format:
projects/123/locations/us-central1/reasoningEngines/456, when both
sandbox_resource_name and agent_engine_resource_name are set,
agent_engine_resource_name will be ignored.
**data: Additional keyword arguments to be passed to the base class.
"""A code executor that uses Agent Engine Code Execution Sandbox to execute code.

Attributes:
sandbox_resource_name: If set, load the existing resource name of the code
interpreter extension instead of creating a new one. Format:
projects/123/locations/us-central1/reasoningEngines/456/sandboxEnvironments/789
"""
super().__init__(**data)
sandbox_resource_name_pattern = r'^projects/([a-zA-Z0-9-_]+)/locations/([a-zA-Z0-9-_]+)/reasoningEngines/(\d+)/sandboxEnvironments/(\d+)$'
agent_engine_resource_name_pattern = r'^projects/([a-zA-Z0-9-_]+)/locations/([a-zA-Z0-9-_]+)/reasoningEngines/(\d+)$'

if sandbox_resource_name is not None:
self.sandbox_resource_name = sandbox_resource_name
self._project_id, self._location = (
self._get_project_id_and_location_from_resource_name(
sandbox_resource_name, sandbox_resource_name_pattern
)
)
elif agent_engine_resource_name is not None:
from vertexai import types

self._project_id, self._location = (
self._get_project_id_and_location_from_resource_name(
agent_engine_resource_name, agent_engine_resource_name_pattern
)
)
# @TODO - Add TTL for sandbox creation after it is available
# in SDK.
operation = self._get_api_client().agent_engines.sandboxes.create(
spec={'code_execution_environment': {}},
name=agent_engine_resource_name,
config=types.CreateAgentEngineSandboxConfig(
display_name='default_sandbox'
),
)
self.sandbox_resource_name = operation.response.name
else:
raise ValueError(
'Either sandbox_resource_name or agent_engine_resource_name must be'
' set.'
)

@override
def execute_code(
self,
invocation_context: InvocationContext,
code_execution_input: CodeExecutionInput,
) -> CodeExecutionResult:
# Execute the code.
input_data = {
'code': code_execution_input.code,
}
if code_execution_input.input_files:
input_data['files'] = [
{
'name': f.name,
'contents': f.content,
'mimeType': f.mime_type,
}
for f in code_execution_input.input_files
]

code_execution_response = (
self._get_api_client().agent_engines.sandboxes.execute_code(
name=self.sandbox_resource_name,
input_data=input_data,
)
)
logger.debug('Executed code:\n```\n%s\n```', code_execution_input.code)
saved_files = []
stdout = ''
stderr = ''
for output in code_execution_response.outputs:
if output.mime_type == 'application/json' and (
output.metadata is None
or output.metadata.attributes is None
or 'file_name' not in output.metadata.attributes
):
json_output_data = json.loads(output.data.decode('utf-8'))
stdout = json_output_data.get('stdout', '')
stderr = json_output_data.get('stderr', '')
else:
file_name = ''
if (
output.metadata is not None
and output.metadata.attributes is not None
):
file_name = output.metadata.attributes.get('file_name', b'').decode(
'utf-8'
)
mime_type = output.mime_type
if not mime_type:
mime_type, _ = mimetypes.guess_type(file_name)
saved_files.append(
File(
name=file_name,
content=output.data,
mime_type=mime_type,

sandbox_resource_name: str = None

def __init__(
self,
sandbox_resource_name: Optional[str] = None,
agent_engine_resource_name: Optional[str] = None,
**data,
):
"""Initializes the AgentEngineSandboxCodeExecutor.

Args:
sandbox_resource_name: If set, load the existing resource name of code
execution sandbox, if not set, create a new one. Format:
projects/123/locations/us-central1/reasoningEngines/456/
sandboxEnvironments/789
agent_engine_resource_name: The resource name of the agent engine to use
to create the code execution sandbox. Format:
projects/123/locations/us-central1/reasoningEngines/456, when both
sandbox_resource_name and agent_engine_resource_name are set,
agent_engine_resource_name will be ignored.
**data: Additional keyword arguments to be passed to the base class.
"""
super().__init__(**data)
sandbox_resource_name_pattern = r"^projects/([a-zA-Z0-9-_]+)/locations/([a-zA-Z0-9-_]+)/reasoningEngines/(\d+)/sandboxEnvironments/(\d+)$"
agent_engine_resource_name_pattern = r"^projects/([a-zA-Z0-9-_]+)/locations/([a-zA-Z0-9-_]+)/reasoningEngines/(\d+)$"

if sandbox_resource_name is not None:
self.sandbox_resource_name = sandbox_resource_name
self._project_id, self._location = (
self._get_project_id_and_location_from_resource_name(
sandbox_resource_name, sandbox_resource_name_pattern
)
)
elif agent_engine_resource_name is not None:
from vertexai import types

self._project_id, self._location = (
self._get_project_id_and_location_from_resource_name(
agent_engine_resource_name, agent_engine_resource_name_pattern
)
)
# @TODO - Add TTL for sandbox creation after it is available
# in SDK.
operation = self._get_api_client().agent_engines.sandboxes.create(
spec={"code_execution_environment": {}},
name=agent_engine_resource_name,
config=types.CreateAgentEngineSandboxConfig(
display_name="default_sandbox"
),
)
self.sandbox_resource_name = operation.response.name
else:
raise ValueError(
"Either sandbox_resource_name or agent_engine_resource_name must be"
" set."
)
)

# Collect the final result.
return CodeExecutionResult(
stdout=stdout,
stderr=stderr,
output_files=saved_files,
)
@override
def execute_code(
self,
invocation_context: InvocationContext,
code_execution_input: CodeExecutionInput,
) -> CodeExecutionResult:
# Execute the code.
input_data = {
"code": code_execution_input.code,
}
if code_execution_input.input_files:
input_data["files"] = [
{
"name": f.name,
"content": f.content,
"mime_type": f.mime_type,
}
for f in code_execution_input.input_files
]

code_execution_response = (
self._get_api_client().agent_engines.sandboxes.execute_code(
name=self.sandbox_resource_name,
input_data=input_data,
)
)
logger.debug("Executed code:\n```\n%s\n```", code_execution_input.code)
saved_files = []
stdout = ""
stderr = ""
for output in code_execution_response.outputs:
if output.mime_type == "application/json" and (
output.metadata is None
or output.metadata.attributes is None
or "file_name" not in output.metadata.attributes
):
try:
json_output_data = json.loads(output.data.decode("utf-8"))
except json.JSONDecodeError:
logger.warning(
"Received invalid JSON from sandbox, cannot parse"
" stdout/stderr: %s",
output.data.decode("utf-8", errors="ignore"),
)
continue
if isinstance(json_output_data, dict):
# Primary fields returned by the API are msg_out/msg_err.
# Fall back to stdout/stderr for backward compatibility.
if "msg_out" in json_output_data:
stdout = json_output_data.get("msg_out") or ""
else:
stdout = json_output_data.get("stdout", "")
if "msg_err" in json_output_data:
stderr = json_output_data.get("msg_err") or ""
else:
stderr = json_output_data.get("stderr", "")
else:
logger.warning(
"Received non-dict JSON output from sandbox: %s",
json_output_data,
)
else:
file_name = ""
if (
output.metadata is not None
and output.metadata.attributes is not None
):
file_name = output.metadata.attributes.get("file_name", b"").decode(
"utf-8"
)
mime_type = output.mime_type
if not mime_type:
mime_type, _ = mimetypes.guess_type(file_name)
saved_files.append(
File(
name=file_name,
content=output.data,
mime_type=mime_type,
)
)

# Collect the final result.
return CodeExecutionResult(
stdout=stdout,
stderr=stderr,
output_files=saved_files,
)

def _get_api_client(self):
"""Instantiates an API client for the given project and location.
def _get_api_client(self):
"""Instantiates an API client for the given project and location.

It needs to be instantiated inside each request so that the event loop
management can be properly propagated.
It needs to be instantiated inside each request so that the event loop
management can be properly propagated.

Returns:
An API client for the given project and location.
"""
import vertexai
Returns:
An API client for the given project and location.
"""
import vertexai

return vertexai.Client(project=self._project_id, location=self._location)
return vertexai.Client(project=self._project_id, location=self._location)

def _get_project_id_and_location_from_resource_name(
self, resource_name: str, pattern: str
) -> tuple[str, str]:
"""Extracts the project ID and location from the resource name."""
match = re.fullmatch(pattern, resource_name)
def _get_project_id_and_location_from_resource_name(
self, resource_name: str, pattern: str
) -> tuple[str, str]:
"""Extracts the project ID and location from the resource name."""
match = re.fullmatch(pattern, resource_name)

if not match:
raise ValueError(f'resource name {resource_name} is not valid.')
if not match:
raise ValueError(f"resource name {resource_name} is not valid.")

return match.groups()[0], match.groups()[1]
return match.groups()[0], match.groups()[1]
Loading