import asyncio import atexit import copy import json import os import random import shutil import string import tempfile from abc import abstractmethod from pathlib import Path from typing import Callable from zipfile import ZipFile from requests.exceptions import ConnectionError from openhands.core.config import AppConfig, SandboxConfig from openhands.core.exceptions import AgentRuntimeDisconnectedError from openhands.core.logger import openhands_logger as logger from openhands.events import EventSource, EventStream, EventStreamSubscriber from openhands.events.action import ( Action, ActionConfirmationStatus, BrowseInteractiveAction, BrowseURLAction, CmdRunAction, FileReadAction, FileWriteAction, IPythonRunCellAction, ) from openhands.events.event import Event from openhands.events.observation import ( CmdOutputObservation, ErrorObservation, FileReadObservation, NullObservation, Observation, UserRejectObservation, ) from openhands.events.serialization.action import ACTION_TYPE_TO_CLASS from openhands.microagent import ( BaseMicroAgent, load_microagents_from_dir, ) from openhands.runtime.plugins import ( JupyterRequirement, PluginRequirement, VSCodeRequirement, ) from openhands.runtime.utils.edit import FileEditRuntimeMixin from openhands.utils.async_utils import call_sync_from_async STATUS_MESSAGES = { 'STATUS$STARTING_RUNTIME': 'Starting runtime...', 'STATUS$STARTING_CONTAINER': 'Starting container...', 'STATUS$PREPARING_CONTAINER': 'Preparing container...', 'STATUS$CONTAINER_STARTED': 'Container started.', 'STATUS$WAITING_FOR_CLIENT': 'Waiting for client...', } def _default_env_vars(sandbox_config: SandboxConfig) -> dict[str, str]: ret = {} for key in os.environ: if key.startswith('SANDBOX_ENV_'): sandbox_key = key.removeprefix('SANDBOX_ENV_') ret[sandbox_key] = os.environ[key] if sandbox_config.enable_auto_lint: ret['ENABLE_AUTO_LINT'] = 'true' return ret class Runtime(FileEditRuntimeMixin): """The runtime is how the agent interacts with the external environment. This includes a bash sandbox, a browser, and filesystem interactions. sid is the session id, which is used to identify the current user session. """ sid: str config: AppConfig initial_env_vars: dict[str, str] attach_to_existing: bool status_callback: Callable | None def __init__( self, config: AppConfig, event_stream: EventStream, sid: str = 'default', plugins: list[PluginRequirement] | None = None, env_vars: dict[str, str] | None = None, status_callback: Callable | None = None, attach_to_existing: bool = False, headless_mode: bool = False, ): self.sid = sid self.event_stream = event_stream self.event_stream.subscribe( EventStreamSubscriber.RUNTIME, self.on_event, self.sid ) self.plugins = ( copy.deepcopy(plugins) if plugins is not None and len(plugins) > 0 else [] ) # add VSCode plugin if not in headless mode if not headless_mode: self.plugins.append(VSCodeRequirement()) self.status_callback = status_callback self.attach_to_existing = attach_to_existing self.config = copy.deepcopy(config) atexit.register(self.close) self.initial_env_vars = _default_env_vars(config.sandbox) if env_vars is not None: self.initial_env_vars.update(env_vars) self._vscode_enabled = any( isinstance(plugin, VSCodeRequirement) for plugin in self.plugins ) # Load mixins FileEditRuntimeMixin.__init__( self, enable_llm_editor=config.get_agent_config().codeact_enable_llm_editor ) def setup_initial_env(self) -> None: if self.attach_to_existing: return logger.debug(f'Adding env vars: {self.initial_env_vars.keys()}') self.add_env_vars(self.initial_env_vars) if self.config.sandbox.runtime_startup_env_vars: self.add_env_vars(self.config.sandbox.runtime_startup_env_vars) def close(self) -> None: pass def log(self, level: str, message: str) -> None: message = f'[runtime {self.sid}] {message}' getattr(logger, level)(message, stacklevel=2) def send_status_message(self, message_id: str): """Sends a status message if the callback function was provided.""" if self.status_callback: msg = STATUS_MESSAGES.get(message_id, '') self.status_callback('info', message_id, msg) def send_error_message(self, message_id: str, message: str): if self.status_callback: self.status_callback('error', message_id, message) # ==================================================================== def add_env_vars(self, env_vars: dict[str, str]) -> None: # Add env vars to the IPython shell (if Jupyter is used) if any(isinstance(plugin, JupyterRequirement) for plugin in self.plugins): code = 'import os\n' for key, value in env_vars.items(): # Note: json.dumps gives us nice escaping for free code += f'os.environ["{key}"] = {json.dumps(value)}\n' code += '\n' obs = self.run_ipython(IPythonRunCellAction(code)) self.log('debug', f'Added env vars to IPython: code={code}, obs={obs}') # Add env vars to the Bash shell cmd = '' for key, value in env_vars.items(): # Note: json.dumps gives us nice escaping for free cmd += f'export {key}={json.dumps(value)}; ' if not cmd: return cmd = cmd.strip() logger.debug(f'Adding env var: {cmd}') obs = self.run(CmdRunAction(cmd)) if not isinstance(obs, CmdOutputObservation) or obs.exit_code != 0: raise RuntimeError( f'Failed to add env vars [{env_vars.keys()}] to environment: {obs.content}' ) def on_event(self, event: Event) -> None: if isinstance(event, Action): asyncio.get_event_loop().run_until_complete(self._handle_action(event)) async def _handle_action(self, event: Action) -> None: if event.timeout is None: # We don't block the command if this is a default timeout action event.set_hard_timeout(self.config.sandbox.timeout, blocking=False) assert event.timeout is not None try: observation: Observation = await call_sync_from_async( self.run_action, event ) except Exception as e: err_id = '' if isinstance(e, ConnectionError) or isinstance( e, AgentRuntimeDisconnectedError ): err_id = 'STATUS$ERROR_RUNTIME_DISCONNECTED' error_message = f'{type(e).__name__}: {str(e)}' self.log('error', f'Unexpected error while running action: {error_message}') self.log('error', f'Problematic action: {str(event)}') self.send_error_message(err_id, error_message) self.close() return observation._cause = event.id # type: ignore[attr-defined] observation.tool_call_metadata = event.tool_call_metadata # this might be unnecessary, since source should be set by the event stream when we're here source = event.source if event.source else EventSource.AGENT self.event_stream.add_event(observation, source) # type: ignore[arg-type] def clone_repo(self, github_token: str, selected_repository: str) -> str: if not github_token or not selected_repository: raise ValueError( 'github_token and selected_repository must be provided to clone a repository' ) url = f'https://{github_token}@github.com/{selected_repository}.git' dir_name = selected_repository.split('/')[1] # add random branch name to avoid conflicts random_str = ''.join( random.choices(string.ascii_lowercase + string.digits, k=8) ) branch_name = f'openhands-workspace-{random_str}' action = CmdRunAction( command=f'git clone {url} {dir_name} ; cd {dir_name} ; git checkout -b {branch_name}', ) self.log('info', f'Cloning repo: {selected_repository}') self.run_action(action) return dir_name def get_microagents_from_selected_repo( self, selected_repository: str | None ) -> list[BaseMicroAgent]: """Load microagents from the selected repository. If selected_repository is None, load microagents from the current workspace. This is the main entry point for loading microagents. """ loaded_microagents: list[BaseMicroAgent] = [] workspace_root = Path(self.config.workspace_mount_path_in_sandbox) microagents_dir = workspace_root / '.openhands' / 'microagents' repo_root = None if selected_repository: repo_root = workspace_root / selected_repository.split('/')[1] microagents_dir = repo_root / '.openhands' / 'microagents' self.log( 'info', f'Selected repo: {selected_repository}, loading microagents from {microagents_dir} (inside runtime)', ) # Legacy Repo Instructions # Check for legacy .openhands_instructions file obs = self.read( FileReadAction(path=str(workspace_root / '.openhands_instructions')) ) if isinstance(obs, ErrorObservation) and repo_root is not None: # If the instructions file is not found in the workspace root, try to load it from the repo root self.log( 'debug', f'.openhands_instructions not present, trying to load from repository {microagents_dir=}', ) obs = self.read( FileReadAction(path=str(repo_root / '.openhands_instructions')) ) if isinstance(obs, FileReadObservation): self.log('info', 'openhands_instructions microagent loaded.') loaded_microagents.append( BaseMicroAgent.load( path='.openhands_instructions', file_content=obs.content ) ) # Load microagents from directory files = self.list_files(str(microagents_dir)) if files: self.log('info', f'Found {len(files)} files in microagents directory.') zip_path = self.copy_from(str(microagents_dir)) microagent_folder = tempfile.mkdtemp() # Properly handle the zip file with ZipFile(zip_path, 'r') as zip_file: zip_file.extractall(microagent_folder) # Add debug print of directory structure self.log('debug', 'Microagent folder structure:') for root, _, files in os.walk(microagent_folder): relative_path = os.path.relpath(root, microagent_folder) self.log('debug', f'Directory: {relative_path}/') for file in files: self.log('debug', f' File: {os.path.join(relative_path, file)}') # Clean up the temporary zip file zip_path.unlink() # Load all microagents using the existing function repo_agents, knowledge_agents, task_agents = load_microagents_from_dir( microagent_folder ) self.log( 'info', f'Loaded {len(repo_agents)} repo agents, {len(knowledge_agents)} knowledge agents, and {len(task_agents)} task agents', ) loaded_microagents.extend(repo_agents.values()) loaded_microagents.extend(knowledge_agents.values()) loaded_microagents.extend(task_agents.values()) shutil.rmtree(microagent_folder) return loaded_microagents def run_action(self, action: Action) -> Observation: """Run an action and return the resulting observation. If the action is not runnable in any runtime, a NullObservation is returned. If the action is not supported by the current runtime, an ErrorObservation is returned. """ if not action.runnable: return NullObservation('') if ( hasattr(action, 'confirmation_state') and action.confirmation_state == ActionConfirmationStatus.AWAITING_CONFIRMATION ): return NullObservation('') action_type = action.action # type: ignore[attr-defined] if action_type not in ACTION_TYPE_TO_CLASS: return ErrorObservation(f'Action {action_type} does not exist.') if not hasattr(self, action_type): return ErrorObservation( f'Action {action_type} is not supported in the current runtime.' ) if ( getattr(action, 'confirmation_state', None) == ActionConfirmationStatus.REJECTED ): return UserRejectObservation( 'Action has been rejected by the user! Waiting for further user input.' ) observation = getattr(self, action_type)(action) return observation # ==================================================================== # Context manager # ==================================================================== def __enter__(self) -> 'Runtime': return self def __exit__(self, exc_type, exc_value, traceback) -> None: self.close() @abstractmethod async def connect(self) -> None: pass # ==================================================================== # Action execution # ==================================================================== @abstractmethod def run(self, action: CmdRunAction) -> Observation: pass @abstractmethod def run_ipython(self, action: IPythonRunCellAction) -> Observation: pass @abstractmethod def read(self, action: FileReadAction) -> Observation: pass @abstractmethod def write(self, action: FileWriteAction) -> Observation: pass @abstractmethod def browse(self, action: BrowseURLAction) -> Observation: pass @abstractmethod def browse_interactive(self, action: BrowseInteractiveAction) -> Observation: pass # ==================================================================== # File operations # ==================================================================== @abstractmethod def copy_to(self, host_src: str, sandbox_dest: str, recursive: bool = False): raise NotImplementedError('This method is not implemented in the base class.') @abstractmethod def list_files(self, path: str | None = None) -> list[str]: """List files in the sandbox. If path is None, list files in the sandbox's initial working directory (e.g., /workspace). """ raise NotImplementedError('This method is not implemented in the base class.') @abstractmethod def copy_from(self, path: str) -> Path: """Zip all files in the sandbox and return a path in the local filesystem.""" raise NotImplementedError('This method is not implemented in the base class.') # ==================================================================== # VSCode # ==================================================================== @property def vscode_enabled(self) -> bool: return self._vscode_enabled @property def vscode_url(self) -> str | None: raise NotImplementedError('This method is not implemented in the base class.') @property def web_hosts(self) -> dict[str, int]: return {}