agent-workspace-contract 0.5.2

Transport-neutral contracts for Agent Infra workspace APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use super::*;

/// Provider-owned images used when product create APIs omit every Workspace
/// catalog snapshot/template selector. A configured catalog default still
/// takes precedence and is resolved to its provider external id by Runtime.
pub const E2B_PLATFORM_TEMPLATE_ID: &str = "code-interpreter-v1";
pub const E2B_BUILTIN_TEMPLATE_IDS: [&str; 3] = [
    E2B_PLATFORM_TEMPLATE_ID,
    "context-management-moc",
    "vpc-sandbox",
];
pub const MOULIN_PLATFORM_SNAPSHOT_ID: &str = "python";

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "snake_case")]
pub enum SnapshotVisibility {
    #[default]
    Private,
    Public,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum SnapshotBuildSpec {
    Dockerfile {
        dockerfile: String,
    },
    Template {
        #[serde(alias = "pipPackages")]
        pip_packages: String,
    },
    Git {
        #[serde(rename = "gitUrl", alias = "git_url")]
        git_url: String,
        #[serde(default, rename = "gitRef", alias = "git_ref")]
        git_ref: String,
    },
}

/// Product-facing snapshot recipe size limits. The build adapters impose
/// additional limits on fetched repository contents and generated archives.
pub const SNAPSHOT_DOCKERFILE_MAX_BYTES: usize = 1024 * 1024;
pub const SNAPSHOT_TEMPLATE_PACKAGES_MAX_BYTES: usize = 64 * 1024;

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct EnvironmentCatalogConfig {
    pub default_provider: Option<String>,
    pub default_snapshot_id: Option<String>,
    pub default_builds: BTreeMap<String, SnapshotBuildSpec>,
}

#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields, rename_all = "camelCase")]
pub struct CreateSnapshotResourceRequest {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub provider: Option<String>,
    #[serde(default)]
    pub visibility: SnapshotVisibility,
    #[serde(default)]
    pub owners: Vec<OwnerRef>,
    #[serde(default)]
    pub builtin: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub build: Option<SnapshotBuildSpec>,
}

#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields, rename_all = "camelCase")]
pub struct BuildBuiltinSnapshotRequest {
    pub provider: String,
    #[serde(default)]
    pub set_default: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub git_url: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub git_ref: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dockerfile: Option<String>,
}

pub const ADMIN_BUILD_BUILTIN_SNAPSHOTS_PATH: &str = "/admin/api/workspace-snapshots:build-builtin";
pub const ADMIN_SNAPSHOTS_PATH: &str = "/admin/api/workspace-snapshots";
pub const ADMIN_SNAPSHOT_PATH: &str = "/admin/api/workspace-snapshots/{snapshotId}";
pub const CATALOG_SNAPSHOT_PATH: &str = "/internal/v1/workspace/snapshots:catalog/{snapshotId}";

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields, rename_all = "camelCase")]
pub struct ProviderBuildHandle {
    pub build_id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resource_external_id: Option<String>,
}

/// Provider build observation captured by caller-driven polling. Logs are
/// bounded by the adapter/runtime and never contain provider credentials.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct EnvironmentBuildObservation {
    pub stage: Option<String>,
    pub logs: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum EnvironmentBuildStatus {
    Building(ProviderBuildHandle),
    BuildingObserved {
        handle: ProviderBuildHandle,
        observation: EnvironmentBuildObservation,
    },
    Ready(ProviderResourceRef),
    ReadyWithMetadata {
        provider_ref: ProviderResourceRef,
        digest: Option<String>,
        size_bytes: Option<u64>,
    },
    ReadyObserved {
        provider_ref: ProviderResourceRef,
        digest: Option<String>,
        size_bytes: Option<u64>,
        observation: EnvironmentBuildObservation,
    },
    Failed(String),
    FailedObserved {
        error: String,
        observation: EnvironmentBuildObservation,
    },
}

/// Build-only port. Implementations must not create Computer or Sandbox instances.
#[async_trait]
pub trait EnvironmentBuildPort: Send + Sync + Debug {
    async fn submit_environment_image(
        &self,
        provider: &str,
        spec: &SnapshotBuildSpec,
        idempotency_key: &str,
    ) -> Result<EnvironmentBuildStatus>;

    async fn poll_environment_image(
        &self,
        _provider: &str,
        _handle: &ProviderBuildHandle,
    ) -> Result<EnvironmentBuildStatus> {
        Err(anyhow::anyhow!(
            "build provider does not support caller-driven status polling"
        ))
    }
}