mirror of
https://github.com/openai/codex.git
synced 2026-10-27 16:02:59 +00:00
Max JohnsonandMichael Bolin
e2398d0b16
## Why
App-server clients that configure named execution environments need to
discover an environment's shell and working directory before selecting
it for a thread or turn. Because the environment can run on a different
operating system than app-server, its working directory is represented
as a canonical `file:` URI rather than a host-local path string. The
probe also needs a bounded response time: an exec-server that completes
initialization but never answers `environment/info` must not hold the
environment serialization queue indefinitely.
## What changed
- Add an experimental `environment/info` app-server RPC for named
environments.
- Route the probe through the managed environment connection and return
target-native shell metadata plus the default working directory as a
`PathUri`.
- Return connection and protocol failures as JSON-RPC errors.
- Bound the exec-server probe response to 30 seconds and remove
timed-out calls from the pending-request table so later environment
mutations can proceed.
- Cover successful responses, omitted working directories, unknown
environments, connection failures, and pending-call cleanup.
## Protocol examples
Request:
```json
{
"id": 42,
"method": "environment/info",
"params": {
"environmentId": "remote-a"
}
}
```
Successful response:
```json
{
"id": 42,
"result": {
"shell": {
"name": "zsh",
"path": "/bin/zsh"
},
"cwd": "file:///workspace"
}
}
```
If the exec-server initializes but does not answer the probe within 30
seconds:
```json
{
"id": 42,
"error": {
"code": -32603,
"message": "failed to get info for environment `remote-a`: exec-server protocol error: timed out waiting for exec-server `environment/info` response after 30s"
}
}
```
## Testing
- App-server integration coverage for successful info (including omitted
`cwd`), unknown environments, and connection failures.
- Exec-server RPC coverage verifying a timed-out call is removed from
the pending-request table.
---------
Co-authored-by: Michael Bolin <mbolin@openai.com>
56 lines
1.7 KiB
Rust
56 lines
1.7 KiB
Rust
use super::*;
|
|
use std::time::Duration;
|
|
|
|
#[derive(Clone)]
|
|
pub(crate) struct EnvironmentRequestProcessor {
|
|
environment_manager: Arc<EnvironmentManager>,
|
|
}
|
|
|
|
impl EnvironmentRequestProcessor {
|
|
pub(crate) fn new(environment_manager: Arc<EnvironmentManager>) -> Self {
|
|
Self {
|
|
environment_manager,
|
|
}
|
|
}
|
|
|
|
pub(crate) async fn environment_add(
|
|
&self,
|
|
params: EnvironmentAddParams,
|
|
) -> Result<Option<ClientResponsePayload>, JSONRPCErrorError> {
|
|
self.environment_manager
|
|
.upsert_environment(
|
|
params.environment_id,
|
|
params.exec_server_url,
|
|
params.connect_timeout_ms.map(Duration::from_millis),
|
|
)
|
|
.map_err(|err| invalid_request(err.to_string()))?;
|
|
Ok(Some(EnvironmentAddResponse {}.into()))
|
|
}
|
|
|
|
pub(crate) async fn environment_info(
|
|
&self,
|
|
params: EnvironmentInfoParams,
|
|
) -> Result<Option<ClientResponsePayload>, JSONRPCErrorError> {
|
|
let environment_id = params.environment_id;
|
|
let environment = self
|
|
.environment_manager
|
|
.get_environment(&environment_id)
|
|
.ok_or_else(|| invalid_request(format!("unknown environment id `{environment_id}`")))?;
|
|
let info = environment.info().await.map_err(|err| {
|
|
internal_error(format!(
|
|
"failed to get info for environment `{environment_id}`: {err}"
|
|
))
|
|
})?;
|
|
Ok(Some(
|
|
EnvironmentInfoResponse {
|
|
shell: EnvironmentShellInfo {
|
|
name: info.shell.name,
|
|
path: info.shell.path,
|
|
},
|
|
cwd: info.cwd,
|
|
}
|
|
.into(),
|
|
))
|
|
}
|
|
}
|