Skip to content

Rust SDK: Add sandbox config #2371

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
jcoc611-microsoft wants to merge 1 commit into
base: main
Choose a base branch
from
+80 −5
Open

Rust SDK: Add sandbox config #2371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
79 changes: 75 additions & 4 deletions rust/src/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2095,6 +2095,8 @@ pub struct SessionConfig {
pub enable_file_change_tracking: Option<bool>,
/// **Experimental.** Limits applied to this session's current accounting window.
pub session_limits: Option<SessionLimitsConfig>,
/// Resolved sandbox configuration applied before the session runtime starts.
pub sandbox_config: Option<SandboxConfig>,
/// Per-property overrides for model capabilities, deep-merged over
/// runtime defaults.
pub model_capabilities: Option<crate::generated::api_types::ModelCapabilitiesOverride>,
Expand Down Expand Up @@ -2288,6 +2290,10 @@ impl std::fmt::Debug for SessionConfig {
&self.enable_file_change_tracking,
)
.field("session_limits", &self.session_limits)
.field(
"sandbox_config",
&self.sandbox_config.as_ref().map(|_| "<configured>"),
)
.field("model_capabilities", &self.model_capabilities)
.field("memory", &self.memory)
.field("config_directory", &self.config_directory)
Expand Down Expand Up @@ -2408,6 +2414,7 @@ impl Default for SessionConfig {
enable_citations: None,
enable_file_change_tracking: None,
session_limits: None,
sandbox_config: None,
model_capabilities: None,
memory: None,
config_directory: None,
Expand Down Expand Up @@ -2573,6 +2580,7 @@ impl SessionConfig {
enable_citations: self.enable_citations,
enable_file_change_tracking: self.enable_file_change_tracking,
session_limits: self.session_limits,
sandbox_config: self.sandbox_config,
model_capabilities: self.model_capabilities,
memory: self.memory,
config_dir: self.config_directory,
Expand Down Expand Up @@ -3388,6 +3396,8 @@ pub struct ResumeSessionConfig {
pub enable_file_change_tracking: Option<bool>,
/// **Experimental.** Limits applied to this session's current accounting window.
pub session_limits: Option<SessionLimitsConfig>,
/// Resolved sandbox configuration applied before the resumed runtime starts.
pub sandbox_config: Option<SandboxConfig>,
/// Per-property model capability overrides on resume.
pub model_capabilities: Option<crate::generated::api_types::ModelCapabilitiesOverride>,
/// Per-session configuration for the runtime memory feature on resume.
Expand Down Expand Up @@ -3554,6 +3564,10 @@ impl std::fmt::Debug for ResumeSessionConfig {
&self.enable_file_change_tracking,
)
.field("session_limits", &self.session_limits)
.field(
"sandbox_config",
&self.sandbox_config.as_ref().map(|_| "<configured>"),
)
.field("model_capabilities", &self.model_capabilities)
.field("memory", &self.memory)
.field("config_directory", &self.config_directory)
Expand Down Expand Up @@ -3718,6 +3732,7 @@ impl ResumeSessionConfig {
enable_citations: self.enable_citations,
enable_file_change_tracking: self.enable_file_change_tracking,
session_limits: self.session_limits,
sandbox_config: self.sandbox_config,
model_capabilities: self.model_capabilities,
memory: self.memory,
config_dir: self.config_directory,
Expand Down Expand Up @@ -3815,6 +3830,7 @@ impl ResumeSessionConfig {
enable_citations: None,
enable_file_change_tracking: None,
session_limits: None,
sandbox_config: None,
model_capabilities: None,
memory: None,
config_directory: None,
Expand Down Expand Up @@ -5772,7 +5788,10 @@ pub use crate::generated::api_types::{
ModelCapabilitiesSupports, ModelList, ModelPolicy, PermissionDecision,
PermissionDecisionApproveOnce, PermissionDecisionContext, PermissionDecisionOutcome,
PermissionDecisionReject, PermissionDecisionSource, PermissionDecisionSurface,
PermissionDecisionUserNotAvailable,
PermissionDecisionUserNotAvailable, SandboxConfig, SandboxConfigAuth, SandboxConfigUserPolicy,
SandboxConfigUserPolicyExperimental, SandboxConfigUserPolicyExperimentalSeatbelt,
SandboxConfigUserPolicyFilesystem, SandboxConfigUserPolicyNetwork,
SandboxConfigUserPolicyNetworkProxy, SandboxConfigUserPolicySeatbelt,
};

/// Permission categories the CLI may request approval for.
Expand Down Expand Up @@ -5883,9 +5902,10 @@ mod tests {
ExpFlagValue, ExtensionInfo, GitHubMcpToolConfig, GitHubReferenceType,
InfiniteSessionConfig, LargeToolOutputConfig, McpServerConfig, McpStdioServerConfig,
MemoryConfiguration, NamedProviderConfig, ProviderConfig, ProviderModelConfig,
ReasoningSummary, ResumeSessionConfig, SessionConfig, SessionEvent, SessionId,
SystemMessageConfig, Tool, ToolBinaryResult, ToolResult, ToolResultExpanded,
ToolResultResponse, ensure_attachment_display_names,
ReasoningSummary, ResumeSessionConfig, SandboxConfig, SandboxConfigUserPolicy,
SandboxConfigUserPolicyNetwork, SandboxConfigUserPolicyNetworkProxy, SessionConfig,
SessionEvent, SessionId, SystemMessageConfig, Tool, ToolBinaryResult, ToolResult,
ToolResultExpanded, ToolResultResponse, ensure_attachment_display_names,
};
use crate::generated::session_events::TypedSessionEvent;

Expand Down Expand Up @@ -6190,6 +6210,57 @@ mod tests {
assert!(unset_resume_json.get("customAgentsLocalOnly").is_none());
}

#[test]
fn sandbox_config_serializes_on_create_and_resume() {
let sandbox_config = SandboxConfig {
enabled: true,
user_policy: Some(SandboxConfigUserPolicy {
network: Some(SandboxConfigUserPolicyNetwork {
allow_outbound: Some(false),
allow_local_network: Some(false),
proxy: Some(SandboxConfigUserPolicyNetworkProxy {
url: "http://127.0.0.1:4321".to_string(),
username: None,
password: None,
}),
}),
..Default::default()
}),
..Default::default()
};

let create_config = SessionConfig {
sandbox_config: Some(sandbox_config.clone()),
..Default::default()
};
let (create_wire, _) = create_config
.into_wire(Some(SessionId::from("create-sandbox")))
.expect("create config has no duplicate handlers");
let create_json = serde_json::to_value(&create_wire).unwrap();
assert_eq!(
create_json["sandboxConfig"]["userPolicy"]["network"]["proxy"]["url"],
"http://127.0.0.1:4321"
);

let mut resume_config = ResumeSessionConfig::new(SessionId::from("resume-sandbox"));
resume_config.sandbox_config = Some(sandbox_config);
let (resume_wire, _) = resume_config
.into_wire()
.expect("resume config has no duplicate handlers");
let resume_json = serde_json::to_value(&resume_wire).unwrap();
assert_eq!(resume_json["sandboxConfig"]["enabled"], true);

let (unset_wire, _) = SessionConfig::default()
.into_wire(Some(SessionId::from("sandbox-unset")))
.expect("unset config has no duplicate handlers");
assert!(
serde_json::to_value(&unset_wire)
.unwrap()
.get("sandboxConfig")
.is_none()
);
}

#[test]
fn session_config_enable_mcp_apps_sets_wire_flag_and_serializes() {
let cfg = SessionConfig::default().with_enable_mcp_apps(true);
Expand Down
6 changes: 5 additions & 1 deletion rust/src/wire.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use serde::Serialize;

use crate::canvas::CanvasDeclaration;
use crate::generated::api_types::{
ModelCapabilitiesOverride, OpenCanvasInstance, RemoteSessionMode,
ModelCapabilitiesOverride, OpenCanvasInstance, RemoteSessionMode, SandboxConfig,
};
use crate::generated::session_events::ReasoningSummary;
use crate::types::{
Expand Down Expand Up @@ -159,6 +159,8 @@ pub(crate) struct SessionCreateWire {
#[serde(skip_serializing_if = "Option::is_none")]
pub session_limits: Option<SessionLimitsConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub sandbox_config: Option<SandboxConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub model_capabilities: Option<ModelCapabilitiesOverride>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryConfiguration>,
Expand Down Expand Up @@ -309,6 +311,8 @@ pub(crate) struct SessionResumeWire {
#[serde(skip_serializing_if = "Option::is_none")]
pub session_limits: Option<SessionLimitsConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub sandbox_config: Option<SandboxConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub model_capabilities: Option<ModelCapabilitiesOverride>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryConfiguration>,
Expand Down
Loading