alien_bindings/traits.rs
1use crate::error::Result;
2use crate::presigned::PresignedRequest;
3use alien_core::{BuildConfig, BuildExecution};
4use async_trait::async_trait;
5use object_store::path::Path;
6use object_store::ObjectStore;
7use serde::{Deserialize, Serialize};
8use std::collections::BTreeMap;
9use std::sync::Arc;
10use std::time::Duration;
11use url::Url;
12
13#[cfg(feature = "openapi")]
14use utoipa::ToSchema;
15
16/// Marker trait for all binding types.
17pub trait Binding: Send + Sync + std::fmt::Debug {}
18
19/// A storage binding that provides object store capabilities.
20#[async_trait]
21pub trait Storage: Binding + ObjectStore {
22 /// Gets the base directory path configured for this storage binding.
23 fn get_base_dir(&self) -> Path;
24 /// Gets the underlying URL configured for this storage binding.
25 fn get_url(&self) -> Url;
26
27 /// Creates a presigned request for uploading data to the specified path.
28 /// The request can be serialized, stored, and executed later.
29 async fn presigned_put(&self, path: &Path, expires_in: Duration) -> Result<PresignedRequest>;
30
31 /// Creates a presigned request for downloading data from the specified path.
32 /// The request can be serialized, stored, and executed later.
33 async fn presigned_get(&self, path: &Path, expires_in: Duration) -> Result<PresignedRequest>;
34
35 /// Creates a presigned request for deleting the object at the specified path.
36 /// The request can be serialized, stored, and executed later.
37 async fn presigned_delete(&self, path: &Path, expires_in: Duration)
38 -> Result<PresignedRequest>;
39}
40
41/// A provider-backed key for small wrap and unwrap operations.
42#[async_trait]
43pub trait Key: Binding {
44 async fn encrypt(
45 &self,
46 plaintext: &[u8],
47 context: Option<&BTreeMap<String, String>>,
48 ) -> Result<Vec<u8>>;
49
50 async fn decrypt(
51 &self,
52 ciphertext: &[u8],
53 context: Option<&BTreeMap<String, String>>,
54 ) -> Result<Vec<u8>>;
55}
56
57/// A build binding that provides build execution capabilities.
58#[async_trait]
59pub trait Build: Binding {
60 /// Starts a new build with the given configuration.
61 /// Returns the build execution information.
62 async fn start_build(&self, config: BuildConfig) -> Result<BuildExecution>;
63
64 /// Gets the status of a specific build execution.
65 async fn get_build_status(&self, build_id: &str) -> Result<BuildExecution>;
66
67 /// Stops or cancels a running build.
68 async fn stop_build(&self, build_id: &str) -> Result<()>;
69}
70
71/// AWS IAM Role service account information
72#[derive(Debug, Clone, Serialize, Deserialize)]
73#[serde(rename_all = "camelCase")]
74#[cfg_attr(feature = "openapi", derive(ToSchema))]
75pub struct AwsServiceAccountInfo {
76 /// The IAM role name
77 pub role_name: String,
78 /// The IAM role ARN (for AssumeRole)
79 pub role_arn: String,
80}
81
82/// GCP Service Account information
83#[derive(Debug, Clone, Serialize, Deserialize)]
84#[serde(rename_all = "camelCase")]
85#[cfg_attr(feature = "openapi", derive(ToSchema))]
86pub struct GcpServiceAccountInfo {
87 /// The service account email (for impersonation)
88 pub email: String,
89 /// The service account unique ID
90 pub unique_id: String,
91}
92
93/// Azure User-Assigned Managed Identity information
94#[derive(Debug, Clone, Serialize, Deserialize)]
95#[serde(rename_all = "camelCase")]
96#[cfg_attr(feature = "openapi", derive(ToSchema))]
97pub struct AzureServiceAccountInfo {
98 /// The managed identity client ID (for authentication)
99 pub client_id: String,
100 /// The managed identity resource ID (ARM ID)
101 pub resource_id: String,
102 /// The managed identity principal ID
103 pub principal_id: String,
104}
105
106/// Platform-specific service account information
107#[derive(Debug, Clone, Serialize, Deserialize)]
108#[serde(tag = "platform", rename_all = "camelCase")]
109#[cfg_attr(feature = "openapi", derive(ToSchema))]
110pub enum ServiceAccountInfo {
111 /// AWS IAM Role
112 Aws(AwsServiceAccountInfo),
113 /// GCP Service Account
114 Gcp(GcpServiceAccountInfo),
115 /// Azure User-Assigned Managed Identity
116 Azure(AzureServiceAccountInfo),
117}
118
119/// Configuration for impersonation
120#[derive(Debug, Clone)]
121pub struct ImpersonationRequest {
122 /// Optional session name (AWS only)
123 pub session_name: Option<String>,
124 /// Optional session duration in seconds
125 pub duration_seconds: Option<i32>,
126 /// Optional scopes (GCP only)
127 pub scopes: Option<Vec<String>>,
128}
129
130impl Default for ImpersonationRequest {
131 fn default() -> Self {
132 Self {
133 session_name: None,
134 duration_seconds: Some(3600), // 1 hour default
135 scopes: None,
136 }
137 }
138}
139
140/// A service account binding that provides identity and impersonation capabilities.
141#[async_trait]
142pub trait ServiceAccount: Binding {
143 /// Gets information about the service account
144 async fn get_info(&self) -> Result<ServiceAccountInfo>;
145
146 /// Impersonates the service account and returns credentials as a ClientConfig.
147 ///
148 /// This performs the cloud-specific impersonation:
149 /// - AWS: STS AssumeRole to get temporary credentials
150 /// - GCP: IAM Credentials API generateAccessToken
151 /// - Azure: Uses the attached managed identity (no API call needed)
152 async fn impersonate(&self, request: ImpersonationRequest) -> Result<alien_core::ClientConfig>;
153
154 /// Helper for downcasting trait object
155 fn as_any(&self) -> &dyn std::any::Any;
156}
157
158/// Response from repository operations.
159#[derive(Debug, Clone, Serialize, Deserialize)]
160#[serde(rename_all = "camelCase")]
161#[cfg_attr(feature = "openapi", derive(ToSchema))]
162pub struct RepositoryResponse {
163 /// The **routable name** of the repository — the full, platform-specific
164 /// path used for subsequent calls (`get_repository`, `delete_repository`,
165 /// `generate_credentials`, `*_cross_account_access`).
166 ///
167 /// Per-platform format (matches
168 /// `alien.dev/content/docs/infrastructure/artifact-registry/behavior.mdx`):
169 ///
170 /// | Platform | Format |
171 /// |---|---|
172 /// | AWS (ECR) | `{registry_prefix}-{logical}` (e.g. `alien-artifacts-my-app`) |
173 /// | GCP (GAR) | `{project_id}/{gar_repo}/{logical}` |
174 /// | Azure (ACR) | `{logical}` (used directly) |
175 /// | Local | `{binding_name}/{logical}` |
176 ///
177 /// **Round-trip invariant:** callers MUST be able to pass this value back
178 /// to any other method on the trait without further transformation.
179 /// Implementations MUST NOT re-apply prefixing in receivers — assume
180 /// `repo_id` arguments are already routable.
181 pub name: String,
182 /// Repository URI for pushing/pulling images. None if repository is not ready yet.
183 pub uri: Option<String>,
184 /// Optional creation timestamp in ISO8601 format.
185 pub created_at: Option<String>,
186}
187
188/// Permissions level for artifact registry access.
189#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
190#[serde(rename_all = "kebab-case")]
191#[cfg_attr(feature = "openapi", derive(ToSchema))]
192pub enum ArtifactRegistryPermissions {
193 /// Pull-only access (download artifacts).
194 Pull,
195 /// Push and pull access (upload and download artifacts).
196 PushPull,
197}
198
199/// How the registry expects credentials to be presented.
200#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
201#[serde(rename_all = "lowercase")]
202#[cfg_attr(feature = "openapi", derive(ToSchema))]
203pub enum RegistryAuthMethod {
204 /// HTTP Basic auth (username:password). Used by ECR, GAR, Local.
205 Basic,
206 /// HTTP Bearer token. Used by ACR (Azure).
207 Bearer,
208}
209
210/// Credentials for accessing a repository.
211#[derive(Debug, Clone, Serialize, Deserialize)]
212#[serde(rename_all = "camelCase")]
213#[cfg_attr(feature = "openapi", derive(ToSchema))]
214pub struct ArtifactRegistryCredentials {
215 /// How to present these credentials to the registry.
216 pub auth_method: RegistryAuthMethod,
217 /// Username for authentication (empty for Bearer auth).
218 pub username: String,
219 /// Password or token for authentication.
220 pub password: String,
221 /// Optional expiration time in ISO8601 format.
222 pub expires_at: Option<String>,
223}
224
225/// Types of compute services that can access artifact registries.
226#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
227#[serde(rename_all = "kebab-case")]
228#[cfg_attr(feature = "openapi", derive(ToSchema))]
229pub enum ComputeServiceType {
230 /// Serverless functions
231 Worker,
232 // In the future, we could add Container, VirtualMachine, Kubernetes, etc.
233}
234
235/// Cross-account access configuration for AWS artifact registries.
236#[derive(Debug, Clone, Serialize, Deserialize)]
237#[serde(rename_all = "camelCase")]
238#[cfg_attr(feature = "openapi", derive(ToSchema))]
239pub struct AwsCrossAccountAccess {
240 /// AWS account IDs that should have cross-account access.
241 pub account_ids: Vec<String>,
242 /// AWS regions where the target Lambda functions run.
243 /// Used to construct `aws:sourceArn` patterns for the Lambda service principal condition.
244 pub regions: Vec<String>,
245 /// Types of compute services that should have access.
246 pub allowed_service_types: Vec<ComputeServiceType>,
247 /// Specific IAM role ARNs to grant access to.
248 /// These are typically deployment/management roles or service-specific roles.
249 pub role_arns: Vec<String>,
250}
251
252/// Cross-account access configuration for GCP artifact registries.
253#[derive(Debug, Clone, Serialize, Deserialize)]
254#[serde(rename_all = "camelCase")]
255#[cfg_attr(feature = "openapi", derive(ToSchema))]
256pub struct GcpCrossAccountAccess {
257 /// GCP project numbers that should have access.
258 pub project_numbers: Vec<String>,
259 /// Types of compute services that should have access.
260 pub allowed_service_types: Vec<ComputeServiceType>,
261 /// Additional service account emails to grant access to.
262 /// These are typically deployment/management service accounts.
263 pub service_account_emails: Vec<String>,
264}
265
266/// Platform-specific cross-account access configuration.
267#[derive(Debug, Clone, Serialize, Deserialize)]
268#[serde(tag = "platform", rename_all = "lowercase")]
269#[cfg_attr(feature = "openapi", derive(ToSchema))]
270pub enum CrossAccountAccess {
271 /// AWS-specific cross-account access configuration.
272 Aws(AwsCrossAccountAccess),
273 /// GCP-specific cross-account access configuration.
274 Gcp(GcpCrossAccountAccess),
275}
276
277/// Current cross-account access permissions for a repository.
278#[derive(Debug, Clone, Serialize, Deserialize)]
279#[serde(rename_all = "camelCase")]
280#[cfg_attr(feature = "openapi", derive(ToSchema))]
281pub struct CrossAccountPermissions {
282 /// Platform-specific access configuration currently applied.
283 pub access: CrossAccountAccess,
284 /// Timestamp when permissions were last updated.
285 pub last_updated: Option<String>,
286}
287
288/// A trait for artifact registry bindings that provide container image repository management.
289#[async_trait]
290pub trait ArtifactRegistry: Binding {
291 /// Returns the raw registry endpoint URL (e.g., "https://123456.dkr.ecr.us-east-1.amazonaws.com"
292 /// or "http://localhost:5000"). Used by the push proxy to forward requests transparently.
293 ///
294 /// Default returns empty string — cloud provider implementations should override.
295 fn registry_endpoint(&self) -> String {
296 String::new()
297 }
298
299 /// Returns the OCI repository path prefix used for upstream operations.
300 ///
301 /// This identifier serves two related roles, both pointing at the same
302 /// upstream location:
303 ///
304 /// 1. **Proxy routing.** When the push proxy forwards push/pull requests
305 /// to the upstream registry, this prefix is prepended to the image
306 /// name portion of the OCI path.
307 /// 2. **Shared deployment-image repository name.** `alien release` pushes
308 /// every function image as `{prefix}:{logical}-{hash}` into one shared
309 /// repository whose routable name is exactly this prefix. Pass it as
310 /// `repo_id` when calling `add_cross_account_access` /
311 /// `remove_cross_account_access` for the deployment cross-account
312 /// flow.
313 ///
314 /// Examples:
315 /// - ECR: `"alien-e2e"` — flat repo prefix; also the routable repo name
316 /// for the shared deployment-image repository
317 /// - GAR: `"my-project/alien-e2e"` — project/repo structure
318 /// - ACR: `"alien-e2e"` when configured, or `""` for registry-root
319 /// repositories; principal pull access is granted on the parent registry
320 /// - Local: `"artifacts"` or similar — cross-account not supported
321 ///
322 /// An empty return value indicates the platform has no shared
323 /// deployment-image repo at the binding level.
324 ///
325 /// Default returns empty string.
326 fn upstream_repository_prefix(&self) -> String {
327 String::new()
328 }
329
330 /// Creates a repository within the artifact registry.
331 ///
332 /// `repo_name` is the **logical** identifier the caller chose (e.g.
333 /// `"my-app"`). The implementation transforms it to the routable
334 /// platform-specific form before calling any backend API; what's
335 /// returned in [`RepositoryResponse::name`] is the routable form.
336 ///
337 /// On platforms where image paths are implicit (GAR, ACR, Local),
338 /// this may not call any backend API — but it still returns a valid
339 /// routable name.
340 async fn create_repository(&self, repo_name: &str) -> Result<RepositoryResponse>;
341
342 /// Gets repository details. `repo_id` is the routable name returned by
343 /// [`Self::create_repository`]; implementations MUST NOT re-apply
344 /// prefixing.
345 async fn get_repository(&self, repo_id: &str) -> Result<RepositoryResponse>;
346
347 /// Adds cross-account access permissions for a repository.
348 /// This adds the specified permissions to any existing cross-account permissions.
349 ///
350 /// `repo_id` is the routable name from [`Self::create_repository`].
351 ///
352 /// For AWS: grants access to specified account IDs with configurable principals and compute service types (ECR repository policy).
353 /// For GCP: grants access to serverless robots and service accounts on the parent GAR registry (image-path-level IAM is not supported).
354 /// For Azure: not supported — returns `OperationNotSupported`.
355 async fn add_cross_account_access(
356 &self,
357 repo_id: &str,
358 access: CrossAccountAccess,
359 ) -> Result<()>;
360
361 /// Removes cross-account access permissions for a repository.
362 ///
363 /// `repo_id` is the routable name from [`Self::create_repository`].
364 ///
365 /// For AWS: removes access from the ECR repository policy.
366 /// For GCP: removes IAM bindings on the parent GAR registry.
367 /// For Azure: not supported — returns `OperationNotSupported`.
368 async fn remove_cross_account_access(
369 &self,
370 repo_id: &str,
371 access: CrossAccountAccess,
372 ) -> Result<()>;
373
374 /// Gets the current cross-account access permissions for a repository.
375 ///
376 /// `repo_id` is the routable name from [`Self::create_repository`].
377 /// For Azure: not supported — returns `OperationNotSupported`.
378 async fn get_cross_account_access(&self, repo_id: &str) -> Result<CrossAccountPermissions>;
379
380 /// Generates credentials for accessing a repository with the specified
381 /// permissions.
382 ///
383 /// `repo_id` is the routable name from [`Self::create_repository`].
384 ///
385 /// Most platforms produce registry-scoped (not repo-scoped) credentials,
386 /// so `repo_id` typically only affects logging — not the credentials
387 /// themselves.
388 async fn generate_credentials(
389 &self,
390 repo_id: &str,
391 permissions: ArtifactRegistryPermissions,
392 ttl_seconds: Option<u32>,
393 ) -> Result<ArtifactRegistryCredentials>;
394
395 /// Deletes a repository and all contained images.
396 ///
397 /// `repo_id` is the routable name from [`Self::create_repository`].
398 /// Implementations MUST NOT delete the *parent* registry (which is owned
399 /// by `alien-infra`); on platforms with implicit image paths (GAR, ACR,
400 /// Local) this is a no-op.
401 async fn delete_repository(&self, repo_id: &str) -> Result<()>;
402}
403
404/// A trait for vault bindings that provide secure secret management.
405#[async_trait]
406pub trait Vault: Binding {
407 /// Gets a secret value by name.
408 async fn get_secret(&self, secret_name: &str) -> Result<String>;
409
410 /// Sets a secret value, creating it if it doesn't exist or updating it if it does.
411 async fn set_secret(&self, secret_name: &str, value: &str) -> Result<()>;
412
413 /// Deletes a secret by name.
414 async fn delete_secret(&self, secret_name: &str) -> Result<()>;
415
416 /// Lists the names of all secrets stored in this vault.
417 ///
418 /// Returned names are in the vault's own namespace (any provider-specific
419 /// prefix is stripped), so each name can be passed straight back to
420 /// [`Vault::get_secret`].
421 ///
422 /// Implementations backed by a flat namespace (a single string prefix
423 /// with no reserved separator, e.g. `"{vault_prefix}-{secret_name}"`)
424 /// cannot implement this safely with a prefix/`BeginsWith` scan: a vault
425 /// named `"app"` would also match a sibling vault named `"app-prod"`,
426 /// aliasing across vaults. Such providers should return
427 /// `OperationNotSupported` rather than list under this hazard.
428 async fn list_secrets(&self) -> Result<Vec<String>>;
429}
430
431/// TLS policy used when building a Postgres connection string.
432#[derive(Debug, Clone, Copy, PartialEq, Eq)]
433pub enum SslMode {
434 /// Plain TCP, no TLS (Local or an explicit BYO opt-out).
435 Disable,
436 /// Require TLS and verify the server certificate against a trusted CA.
437 VerifyCa,
438 /// Require TLS and verify both the trusted CA chain and the dialed hostname
439 /// (BYO / External default, Aurora, and Flexible Server).
440 VerifyFull,
441}
442
443impl SslMode {
444 /// The `sslmode` query-parameter value, and the wire form embedders (the napi addon)
445 /// hand to their own callers.
446 pub fn as_str(self) -> &'static str {
447 match self {
448 SslMode::Disable => "disable",
449 SslMode::VerifyCa => "verify-ca",
450 SslMode::VerifyFull => "verify-full",
451 }
452 }
453}
454
455/// Invalid PEM roots supplied to a verified Postgres TLS policy.
456#[derive(Debug, Clone, Copy, PartialEq, Eq)]
457pub struct InvalidPostgresCaCertificates;
458
459impl std::fmt::Display for InvalidPostgresCaCertificates {
460 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
461 f.write_str("expected one or more non-empty PEM certificates")
462 }
463}
464
465impl std::error::Error for InvalidPostgresCaCertificates {}
466
467/// A complete Postgres TLS policy.
468///
469/// The fields are private so callers cannot pair plaintext with CA roots or construct
470/// `verify-ca` without a root. Cloning the policy is cheap: certificate bundles are
471/// reference-counted and copied only when crossing an FFI boundary.
472#[derive(Clone, PartialEq, Eq)]
473pub struct PostgresTlsPolicy {
474 sslmode: SslMode,
475 ca_certificates: Arc<[String]>,
476}
477
478impl std::fmt::Debug for PostgresTlsPolicy {
479 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
480 f.debug_struct("PostgresTlsPolicy")
481 .field("sslmode", &self.sslmode)
482 .field("ca_certificate_count", &self.ca_certificates.len())
483 .finish()
484 }
485}
486
487impl PostgresTlsPolicy {
488 /// Plain TCP with no certificate roots.
489 pub fn disabled() -> Self {
490 Self {
491 sslmode: SslMode::Disable,
492 ca_certificates: Arc::default(),
493 }
494 }
495
496 /// TLS with CA verification but no hostname verification.
497 ///
498 /// This mode requires at least one valid PEM root.
499 pub fn verify_ca(
500 ca_certificates: Vec<String>,
501 ) -> std::result::Result<Self, InvalidPostgresCaCertificates> {
502 Self::verified(SslMode::VerifyCa, ca_certificates, true)
503 }
504
505 /// TLS with CA and hostname verification.
506 ///
507 /// An empty root set intentionally selects the runtime's system trust store.
508 pub fn verify_full(
509 ca_certificates: Vec<String>,
510 ) -> std::result::Result<Self, InvalidPostgresCaCertificates> {
511 Self::verified(SslMode::VerifyFull, ca_certificates, false)
512 }
513
514 /// TLS with CA and hostname verification using the runtime's system trust store.
515 pub fn verify_full_with_system_roots() -> Self {
516 Self {
517 sslmode: SslMode::VerifyFull,
518 ca_certificates: Arc::default(),
519 }
520 }
521
522 fn verified(
523 sslmode: SslMode,
524 ca_certificates: Vec<String>,
525 require_roots: bool,
526 ) -> std::result::Result<Self, InvalidPostgresCaCertificates> {
527 if (require_roots && ca_certificates.is_empty())
528 || ca_certificates.iter().any(|certificate| {
529 let certificate = certificate.trim();
530 !certificate.starts_with("-----BEGIN CERTIFICATE-----")
531 || !certificate.ends_with("-----END CERTIFICATE-----")
532 })
533 {
534 return Err(InvalidPostgresCaCertificates);
535 }
536
537 Ok(Self {
538 sslmode,
539 ca_certificates: ca_certificates.into(),
540 })
541 }
542
543 /// The libpq-compatible `sslmode` represented by this complete policy.
544 pub fn sslmode(&self) -> SslMode {
545 self.sslmode
546 }
547
548 /// PEM-encoded roots, or an empty slice when this policy uses no roots or the
549 /// runtime's system trust store.
550 pub fn ca_certificates(&self) -> &[String] {
551 &self.ca_certificates
552 }
553}
554
555/// Resolved connection details for a Postgres database.
556#[derive(Clone)]
557pub struct PostgresConnectionParams {
558 pub host: String,
559 pub port: u16,
560 pub database: String,
561 pub username: String,
562 pub password: String,
563 pub tls: PostgresTlsPolicy,
564}
565
566// Hand-written Debug so the resolved password never reaches logs, error chains, or panic output
567// (`Binding`/`BindingsProviderApi` require Debug). Mirrors the KV providers' redacting Debug.
568impl std::fmt::Debug for PostgresConnectionParams {
569 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
570 f.debug_struct("PostgresConnectionParams")
571 .field("host", &self.host)
572 .field("port", &self.port)
573 .field("database", &self.database)
574 .field("username", &self.username)
575 .field("password", &"<redacted>")
576 .field("tls", &self.tls)
577 .finish()
578 }
579}
580
581impl PostgresConnectionParams {
582 /// Creates resolved connection details from a complete, internally consistent TLS
583 /// policy.
584 pub fn new(
585 host: String,
586 port: u16,
587 database: String,
588 username: String,
589 password: String,
590 tls: PostgresTlsPolicy,
591 ) -> Self {
592 Self {
593 host,
594 port,
595 database,
596 username,
597 password,
598 tls,
599 }
600 }
601
602 /// The libpq-compatible TLS mode used by this connection.
603 pub fn sslmode(&self) -> SslMode {
604 self.tls.sslmode()
605 }
606
607 /// PEM-encoded root CA certificates.
608 pub fn ca_certificates(&self) -> &[String] {
609 self.tls.ca_certificates()
610 }
611
612 /// Builds a `postgres://` URL. Username and password are percent-encoded so a
613 /// generated password containing URL-special characters can never corrupt it.
614 pub fn connection_string(&self) -> String {
615 format!(
616 "postgres://{}:{}@{}:{}/{}?sslmode={}",
617 encode_userinfo(&self.username),
618 encode_userinfo(&self.password),
619 self.host,
620 self.port,
621 // Encode the database path segment so this URL stays byte-identical to the TS
622 // resolver's `encodeUserinfo` (the same RFC 3986 unreserved-set encoding).
623 encode_userinfo(&self.database),
624 self.sslmode().as_str(),
625 )
626 }
627}
628
629/// Percent-encodes a URL userinfo component; the RFC 3986 unreserved set passes through.
630fn encode_userinfo(value: &str) -> String {
631 let mut out = String::with_capacity(value.len());
632 for byte in value.bytes() {
633 match byte {
634 b'A'..=b'Z' | b'a'..=b'z' | b'0'..=b'9' | b'-' | b'.' | b'_' | b'~' => {
635 out.push(byte as char)
636 }
637 _ => out.push_str(&format!("%{:02X}", byte)),
638 }
639 }
640 out
641}
642
643/// Connection-only Postgres binding. Unlike every other resource, Postgres ships no
644/// gRPC service and wraps no operations (by design): every backend
645/// speaks the same wire protocol, so the binding returns connection details and the
646/// application uses its own driver.
647pub trait Postgres: Binding {
648 fn connection_params(&self) -> &PostgresConnectionParams;
649
650 /// `postgres://` connection string, derived from `connection_params` and never stored.
651 fn connection_string(&self) -> String {
652 self.connection_params().connection_string()
653 }
654}
655
656/// A precondition for a KV put operation.
657#[derive(Debug, Clone, Default, PartialEq, Eq)]
658pub enum PutCondition {
659 /// Replace any current value, or create the key when it is absent.
660 #[default]
661 None,
662 /// Create the key only when it is absent or logically expired.
663 Absent,
664 /// Replace the value only when the key still has this opaque version.
665 Version(String),
666}
667
668/// Options for KV put operations.
669#[derive(Debug, Clone, Default)]
670pub struct PutOptions {
671 /// Optional TTL for automatic expiration (soft hint - items MAY be deleted after expiry)
672 pub ttl: Option<Duration>,
673 /// Optional atomic write precondition.
674 pub condition: PutCondition,
675}
676
677/// A KV entry together with its opaque version.
678#[derive(Debug, Clone, PartialEq, Eq)]
679pub struct KvEntry {
680 /// Stored key.
681 pub key: String,
682 /// Stored value bytes.
683 pub value: Vec<u8>,
684 /// Provider-neutral version for conditional writes. Callers must treat it as opaque.
685 pub version: String,
686}
687
688/// Represents the result of a scan operation.
689#[derive(Debug)]
690pub struct ScanResult {
691 /// Entries found (may be ≤ limit, no guarantee to fill).
692 pub items: Vec<KvEntry>,
693 /// Opaque, prefix-bound cursor for pagination. None if the traversal is complete.
694 /// A non-empty cursor may lead to an empty page when records expire between pages.
695 pub next_cursor: Option<String>,
696}
697
698/// A trait for key-value store bindings that provide minimal, platform-agnostic KV operations.
699/// This API is designed to work consistently across DynamoDB, Firestore, Azure Table Storage,
700/// and the local provider.
701#[async_trait]
702pub trait Kv: Binding {
703 /// Get an entry by key. Returns `None` if the key doesn't exist or has expired.
704 ///
705 /// **TTL Behavior**: TTL is a soft hint for automatic cleanup. If `now >= expires_at`,
706 /// implementations SHOULD behave as if the key is absent, even if the item still exists
707 /// physically in the backend. Physical deletion is eventual and not guaranteed.
708 ///
709 /// **Validation**: Keys are validated against MAX_KEY_BYTES and portable charset.
710 /// Invalid keys return `KvError::InvalidKey` immediately.
711 async fn get(&self, key: &str) -> Result<Option<KvEntry>>;
712
713 /// Put a value with optional options. Conditional writes return `false` when their precondition
714 /// does not match. Unconditional writes return `true`.
715 ///
716 /// **Size Limits**:
717 /// - Keys: ≤ MAX_KEY_BYTES (512 bytes) with portable ASCII charset
718 /// - Values: ≤ MAX_VALUE_BYTES (24,576 bytes = 24 KiB)
719 ///
720 /// **Validation**: Size and charset constraints are enforced before backend calls.
721 /// Invalid inputs return `KvError::InvalidKey` or `KvError::InvalidValue` immediately.
722 ///
723 /// **TTL Behavior**: TTL is a soft hint for automatic cleanup. If TTL is specified,
724 /// item expires at `put_time + ttl`. Expired items SHOULD appear absent on subsequent
725 /// reads, but physical deletion is eventual and not guaranteed.
726 ///
727 /// **Conditional Logic**: [`PutCondition::Absent`] uses each backend's atomic create
728 /// primitive, with a version-guarded takeover when an expired row still exists physically.
729 /// [`PutCondition::Version`] uses DynamoDB conditions, Firestore update-time preconditions,
730 /// Azure entity tags, or the local database's conditional update.
731 async fn put(&self, key: &str, value: Vec<u8>, options: Option<PutOptions>) -> Result<bool>;
732
733 /// Delete a key. No error if key doesn't exist.
734 ///
735 /// **Validation**: Keys are validated against MAX_KEY_BYTES and portable charset.
736 /// Invalid keys return `KvError::InvalidKey` immediately.
737 /// When `if_version` is supplied, delete only if the key still has that opaque version.
738 /// Returns `false` when a conditional delete finds the key absent, expired, or changed.
739 /// Unconditional deletes return `true`, including when the key is already absent.
740 async fn delete(&self, key: &str, if_version: Option<&str>) -> Result<bool>;
741
742 /// Check if a key exists without retrieving the value.
743 ///
744 /// **TTL Behavior**: TTL is a soft hint for automatic cleanup. If `now >= expires_at`,
745 /// SHOULD return false even if physically present. Physical deletion is eventual and not guaranteed.
746 ///
747 /// **Validation**: Keys are validated against MAX_KEY_BYTES and portable charset.
748 /// Invalid keys return `KvError::InvalidKey` immediately.
749 async fn exists(&self, key: &str) -> Result<bool>;
750
751 /// Scan keys with a prefix, with pagination support.
752 ///
753 /// **Scan Contract**:
754 /// - Returns an **arbitrary, unordered subset** in backend-natural order
755 /// - **No ordering guarantees** across backends (for example, Azure partition fan-out)
756 /// - **May return ≤ limit items** (not guaranteed to fill even if more data exists)
757 /// - **Clients MUST de-duplicate** keys across pages (backends may return duplicates)
758 /// - **No completeness guarantee** under concurrent writes (may miss or duplicate)
759 /// - Without concurrent changes, following every returned cursor until `None`
760 /// visits every matching, unexpired key visible to the backend
761 ///
762 /// **Cursor Behavior**:
763 /// - Opaque string, implementation-specific format
764 /// - Bound to the prefix that created it; using it with another prefix is invalid
765 /// - May become invalid after backend state changes
766 /// - **No TTL guarantees** - can expire without notice
767 /// - Passing invalid cursor should return error, not partial results
768 ///
769 /// **TTL Behavior**: TTL is a soft hint for automatic cleanup. Expired items SHOULD
770 /// be filtered out from results, but physical deletion is eventual and not guaranteed.
771 ///
772 /// **Validation**: Prefix follows same key validation rules.
773 /// Invalid prefix returns `KvError::InvalidKey` immediately.
774 async fn scan_prefix(
775 &self,
776 prefix: &str,
777 limit: Option<usize>,
778 cursor: Option<String>,
779 ) -> Result<ScanResult>;
780}
781
782/// JSON/Text message payload for Queue
783#[derive(Debug, Clone, Serialize, Deserialize)]
784#[serde(tag = "type", rename_all = "lowercase")]
785#[cfg_attr(feature = "openapi", derive(ToSchema))]
786pub enum MessagePayload {
787 /// JSON-serializable value
788 Json(serde_json::Value),
789 /// UTF-8 text payload
790 Text(String),
791}
792
793/// A queue message with payload and receipt handle for acknowledgment
794#[derive(Debug, Clone, Serialize, Deserialize)]
795#[serde(rename_all = "camelCase")]
796#[cfg_attr(feature = "openapi", derive(ToSchema))]
797pub struct QueueMessage {
798 /// JSON-first message payload
799 pub payload: MessagePayload,
800 /// Opaque receipt handle for acknowledgment (backend-specific, short-lived)
801 pub receipt_handle: String,
802 /// Delivery attempt for this message, 1-based (1 = first delivery).
803 ///
804 /// Providers that do not report redelivery counts always set 1; the local
805 /// provider reports the real per-message count so handlers can enforce
806 /// retry limits.
807 #[serde(default = "first_attempt")]
808 pub attempt: u32,
809}
810
811/// Serde default for [`QueueMessage::attempt`]: treat missing counts as the
812/// first delivery.
813fn first_attempt() -> u32 {
814 1
815}
816
817/// Maximum message size in bytes (64 KiB = 65,536 bytes)
818///
819/// This limit ensures compatibility across all queue backends:
820/// - **AWS SQS**: 256KB message limit (much higher, not constraining)
821/// - **Azure Service Bus**: 1MB message limit (much higher, not constraining)
822/// - **GCP Pub/Sub**: 10MB message limit (much higher, not constraining)
823///
824/// The 64KB limit provides:
825/// - Reasonable message sizes for most use cases
826/// - Fast network transfer and low latency
827/// - Consistent behavior across all cloud providers
828/// - Efficient memory usage during batch processing
829pub const MAX_MESSAGE_BYTES: usize = 65_536; // 64 KiB
830
831/// Maximum number of messages per receive call
832///
833/// This limit balances throughput with processing simplicity:
834/// - **AWS SQS**: Supports up to 10 messages per ReceiveMessage call
835/// - **Azure Service Bus**: Can receive multiple messages via prefetch/batching
836/// - **GCP Pub/Sub**: Supports configurable max_messages per Pull request
837///
838/// The 10-message limit ensures:
839/// - Portable batch sizes across all backends
840/// - Manageable memory usage
841/// - Reasonable processing latency per batch
842pub const MAX_BATCH_SIZE: usize = 10;
843
844/// Fixed lease duration in seconds
845///
846/// Messages are leased for exactly 30 seconds after delivery:
847/// - Long enough for most processing tasks
848/// - Short enough to enable fast retry on failures
849/// - Eliminates complexity of dynamic lease management
850/// - Consistent across all platforms
851pub const LEASE_SECONDS: u64 = 30;
852
853/// A trait for queue bindings providing minimal, portable queue operations.
854#[async_trait]
855pub trait Queue: Binding {
856 /// Send a message to the specified queue
857 async fn send(&self, queue: &str, message: MessagePayload) -> Result<()>;
858
859 /// Receive up to `max_messages` (1..=10) from the specified queue
860 async fn receive(&self, queue: &str, max_messages: usize) -> Result<Vec<QueueMessage>>;
861
862 /// Acknowledge a message using its receipt handle (idempotent)
863 async fn ack(&self, queue: &str, receipt_handle: &str) -> Result<()>;
864
865 /// Negative-acknowledge a message: release its lease so it becomes
866 /// immediately available for redelivery, without waiting out the
867 /// visibility timeout. Receipt-handle rules mirror [`Queue::ack`].
868 async fn nack(&self, queue: &str, receipt_handle: &str) -> Result<()>;
869
870 /// Delete every message in the queue, whether visible or in flight.
871 async fn purge(&self, queue: &str) -> Result<()>;
872}
873
874/// Request for invoking a function directly
875#[derive(Debug, Clone, Serialize, Deserialize)]
876#[serde(rename_all = "camelCase")]
877#[cfg_attr(feature = "openapi", derive(ToSchema))]
878pub struct WorkerInvokeRequest {
879 /// Worker identifier (name, ARN, URL, etc.)
880 pub target_worker: String,
881 /// HTTP method
882 pub method: String,
883 /// Request path
884 pub path: String,
885 /// HTTP headers
886 pub headers: BTreeMap<String, String>,
887 /// Request body bytes
888 pub body: Vec<u8>,
889 /// Optional timeout for the invocation
890 pub timeout: Option<Duration>,
891}
892
893/// Response from worker invocation.
894#[derive(Debug, Clone, Serialize, Deserialize)]
895#[serde(rename_all = "camelCase")]
896#[cfg_attr(feature = "openapi", derive(ToSchema))]
897pub struct WorkerInvokeResponse {
898 /// HTTP status code
899 pub status: u16,
900 /// HTTP response headers
901 pub headers: BTreeMap<String, String>,
902 /// Response body bytes
903 pub body: Vec<u8>,
904}
905
906/// A trait for worker bindings that enable direct worker-to-worker calls.
907#[async_trait]
908pub trait Worker: Binding {
909 /// Invoke a worker with HTTP request data.
910 ///
911 /// This enables direct, low-latency worker-to-worker communication within
912 /// the same cloud environment, bypassing Commands for internal calls.
913 ///
914 /// Platform implementations:
915 /// - AWS: Uses InvokeWorker API directly
916 /// - GCP: Calls private service URL directly
917 /// - Azure: Calls private container app URL directly
918 /// - Kubernetes: HTTP call to internal service
919 async fn invoke(&self, request: WorkerInvokeRequest) -> Result<WorkerInvokeResponse>;
920
921 /// Get the public URL of the worker, if available.
922 ///
923 /// Returns the worker's public URL if it exists and is accessible.
924 /// This is useful for exposing public endpoints or getting URLs for
925 /// external integration.
926 ///
927 /// Platform implementations:
928 /// - AWS: Uses GetWorkerUrlConfig API or returns URL from binding
929 /// - GCP: Returns Cloud Run service URL or calls get_service API
930 /// - Azure: Returns Container App URL or calls get_container_app API
931 async fn get_worker_url(&self) -> Result<Option<String>>;
932
933 /// Get a reference to this object as `Any` for dynamic casting
934 fn as_any(&self) -> &dyn std::any::Any;
935}
936
937/// A trait for container bindings that enable container-to-container communication
938#[async_trait]
939pub trait Container: Binding {
940 /// Get the internal URL for container-to-container communication.
941 ///
942 /// This returns the internal service discovery URL that other containers
943 /// in the same network can use to communicate with this container.
944 ///
945 /// Platform implementations:
946 /// - Managed cloud (AWS/GCP/Azure): Returns internal DNS URL (e.g., "http://api.svc:8080")
947 /// - Local (Docker): Returns Docker network DNS URL (e.g., "http://api.svc:3000")
948 fn get_internal_url(&self) -> &str;
949
950 /// Get the public URL of the container, if available.
951 ///
952 /// Returns the container's public URL if it exists and is accessible
953 /// from outside the cluster/network.
954 ///
955 /// Platform implementations:
956 /// - Managed cloud: Returns load balancer URL if exposed publicly
957 /// - Local: Returns localhost URL with mapped port (e.g., "http://localhost:62844")
958 fn get_public_url(&self) -> Option<&str>;
959
960 /// Get the container name/ID.
961 fn get_container_name(&self) -> &str;
962
963 /// Get a reference to this object as `Any` for dynamic casting
964 fn as_any(&self) -> &dyn std::any::Any;
965}
966
967/// A request to create a sandbox session.
968#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
969#[cfg_attr(feature = "openapi", derive(ToSchema))]
970#[serde(rename_all = "camelCase")]
971pub struct CreateSessionRequest {
972 /// Session id to reconnect to, for the verbs that take one. AWS, Azure and GCP always
973 /// allocate their own on `create` and ignore this; only Local and Kubernetes honor it as the
974 /// new session's id. Read the id back from the response rather than assume the one sent.
975 #[serde(skip_serializing_if = "Option::is_none")]
976 pub session_id: Option<String>,
977 /// Opaque tenant key. Never sent to a provider verbatim — the binding derives a
978 /// fixed-length identifier from it with a deployment-scoped HMAC.
979 #[serde(skip_serializing_if = "Option::is_none")]
980 pub tenant_key: Option<String>,
981 /// Environment variables to place in the session.
982 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
983 pub env: BTreeMap<String, String>,
984}
985
986/// A live sandbox session.
987#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
988#[cfg_attr(feature = "openapi", derive(ToSchema))]
989#[serde(rename_all = "camelCase")]
990pub struct SandboxSession {
991 /// Provider-scoped session identifier
992 pub session_id: String,
993 /// Current lifecycle state
994 pub state: SandboxSessionState,
995 /// Lifecycle generation. A capability from another generation is rejected, which is how
996 /// terminate revokes without distributing a revocation list.
997 ///
998 /// Differs by backend: AWS/Azure allocate a fresh id per session, so a constant carries the
999 /// whole meaning; GCP has none, so this is the guest's boot id — which a snapshot restore
1000 /// reports unchanged, so restore and replacement need the resource name too to tell apart.
1001 pub generation: u64,
1002}
1003
1004/// Lifecycle state of a sandbox session.
1005#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1006#[cfg_attr(feature = "openapi", derive(ToSchema))]
1007#[serde(rename_all = "camelCase")]
1008pub enum SandboxSessionState {
1009 /// Created but not yet able to run a command.
1010 ///
1011 /// A real state, not a placeholder: a MicroVM takes seconds to reach `RUNNING`, and calling
1012 /// that Running would tell a caller to send commands to something that cannot answer.
1013 Starting,
1014 /// Executing, consuming CPU and memory
1015 Running,
1016 /// Suspended with state preserved
1017 Suspended,
1018 /// Terminated; the id will not run again
1019 Terminated,
1020}
1021
1022/// A command to run inside a sandbox.
1023#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1024#[cfg_attr(feature = "openapi", derive(ToSchema))]
1025#[serde(rename_all = "camelCase")]
1026pub struct RunCommandRequest {
1027 /// Command and arguments
1028 pub command: Vec<String>,
1029 /// Working directory inside the sandbox
1030 #[serde(skip_serializing_if = "Option::is_none")]
1031 pub working_directory: Option<String>,
1032 /// Environment overlaid on the session's own
1033 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
1034 pub env: BTreeMap<String, String>,
1035 /// How long the command may run. Required — a defaulted deadline is a hang waiting for a slow
1036 /// day.
1037 ///
1038 /// It bounds the command, not the call, and the call lands just after it. Where the agent
1039 /// supervises the process it kills the process group; where the data plane has no timeout of
1040 /// its own the command runs under `timeout` inside the session. Either way the session stays
1041 /// usable. Only a session that cannot run `timeout` is ended instead, and that call returns
1042 /// once the session is gone.
1043 ///
1044 /// On every backend `deadlineExceeded` is reported only once the command has verifiably
1045 /// stopped — the agent waits for its kill, and where there is no agent the session kills the
1046 /// command itself and says so. It is never reported on a stop that was merely requested: a
1047 /// deadline that leaves untrusted code running is not a deadline.
1048 ///
1049 /// What stops is the command and its process group. A descendant that detaches itself into a
1050 /// session of its own is beyond any signal sent from inside, on every backend; it is bounded
1051 /// by the sandbox session, which ends on terminate or at its own lifetime ceiling.
1052 pub deadline: Duration,
1053}
1054
1055/// One frame of a running command's output.
1056#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1057#[cfg_attr(feature = "openapi", derive(ToSchema))]
1058#[serde(rename_all = "camelCase", tag = "type")]
1059pub enum CommandOutput {
1060 /// Bytes written to stdout
1061 #[serde(rename_all = "camelCase")]
1062 Stdout {
1063 /// Monotonic across both streams, so a caller can interleave them in production order
1064 seq: u64,
1065 /// Raw bytes; command output is not necessarily UTF-8
1066 data: Vec<u8>,
1067 },
1068 /// Bytes written to stderr
1069 #[serde(rename_all = "camelCase")]
1070 Stderr {
1071 /// Monotonic across both streams
1072 seq: u64,
1073 /// Raw bytes
1074 data: Vec<u8>,
1075 },
1076 /// The command finished. Exactly one terminal frame is emitted, always last.
1077 #[serde(rename_all = "camelCase")]
1078 Exit {
1079 /// Process exit code
1080 code: i32,
1081 /// Set when output was cut short by a bound rather than by the command finishing
1082 #[serde(default)]
1083 truncated: bool,
1084 },
1085}
1086
1087/// The id a started job answers to.
1088#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1089#[cfg_attr(feature = "openapi", derive(ToSchema))]
1090#[serde(rename_all = "camelCase")]
1091pub struct JobStart {
1092 /// Identifier every later poll and cancel addresses
1093 pub job_id: String,
1094}
1095
1096/// A job's output so far, and how it ended once it has.
1097#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1098#[cfg_attr(feature = "openapi", derive(ToSchema))]
1099#[serde(rename_all = "camelCase")]
1100pub struct JobPoll {
1101 /// Whether the command is still running
1102 pub running: bool,
1103 /// Output produced after the polled sequence. The ending is `exit` or `error`, never a frame.
1104 pub frames: Vec<CommandOutput>,
1105 /// How the command exited, once it has
1106 #[serde(skip_serializing_if = "Option::is_none")]
1107 pub exit: Option<JobExit>,
1108 /// Why the command ended without exiting
1109 #[serde(skip_serializing_if = "Option::is_none")]
1110 pub error: Option<JobError>,
1111}
1112
1113/// How a job's command exited.
1114#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1115#[cfg_attr(feature = "openapi", derive(ToSchema))]
1116#[serde(rename_all = "camelCase")]
1117pub struct JobExit {
1118 /// Process exit code
1119 pub code: i32,
1120 /// Set when output was cut short by a bound rather than by the command finishing
1121 #[serde(default)]
1122 pub truncated: bool,
1123}
1124
1125/// Why a job ended without its command exiting.
1126#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1127#[cfg_attr(feature = "openapi", derive(ToSchema))]
1128#[serde(rename_all = "camelCase")]
1129pub struct JobError {
1130 /// Machine-readable cause, e.g. `deadlineExceeded`
1131 pub code: String,
1132 /// Human-readable detail
1133 pub message: String,
1134}
1135
1136/// An authenticated, port-scoped capability to reach a service inside a sandbox.
1137///
1138/// Not a URL string: AWS needs a JWE and a port header, Azure an Entra token, and a bare
1139/// string cannot carry either. Returning one would push callers into building the request
1140/// themselves and getting the auth wrong.
1141#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1142#[cfg_attr(feature = "openapi", derive(ToSchema))]
1143#[serde(rename_all = "camelCase")]
1144pub struct PreviewCapability {
1145 /// Endpoint the request must be sent to
1146 pub endpoint: String,
1147 /// Headers that must accompany every request
1148 pub headers: BTreeMap<String, String>,
1149 /// Ports this capability admits. A request to any other port is refused upstream.
1150 pub allowed_ports: Vec<u16>,
1151 /// Seconds until the capability expires
1152 pub expires_in_seconds: u64,
1153}
1154
1155/// A sandbox binding: create sessions, run untrusted code in them, and tear them down.
1156///
1157/// Capabilities differ per platform. Call `capabilities()` and branch, or call and handle the
1158/// typed error — an unsupported capability is never a silent no-op.
1159#[async_trait]
1160pub trait Sandbox: Binding {
1161 /// What this platform's backend supports.
1162 fn capabilities(&self) -> alien_core::SandboxCapabilities;
1163
1164 /// Creates a session that can already take work.
1165 ///
1166 /// Returning before the session can serve pushes a readiness poll into every caller for a
1167 /// condition only the backend can observe, and the resulting race fails a fraction of the
1168 /// time rather than every time. A backend whose start API returns early waits here.
1169 async fn create(&self, request: CreateSessionRequest) -> Result<SandboxSession>;
1170
1171 /// Fetches a session by id, or `None` if it does not exist.
1172 ///
1173 /// Requires `reconnect`. `None` means the session does not exist; a backend that cannot
1174 /// answer the question returns the typed error instead, so an absent session and an
1175 /// unreachable one are never the same result.
1176 async fn get(&self, session_id: &str) -> Result<Option<SandboxSession>>;
1177
1178 /// Fetches a session, creating it if absent.
1179 async fn get_or_create(&self, request: CreateSessionRequest) -> Result<SandboxSession>;
1180
1181 /// Lists sessions belonging to this sandbox's parent.
1182 ///
1183 /// Offered only where the backend has a verb for it and the grant covers it — GCP lists
1184 /// under its engine. AWS and Azure raise `OperationNotSupported`: enumerating there costs an
1185 /// account-wide grant the session role deliberately withholds. Reaching a known id is `get`.
1186 async fn list(&self) -> Result<Vec<SandboxSession>>;
1187
1188 /// Runs a command, streaming output frames until exactly one terminal frame.
1189 ///
1190 /// The stream carries backpressure: a consumer that stops reading stops the sandbox's
1191 /// writer, rather than buffering without bound.
1192 async fn run_command(
1193 &self,
1194 session_id: &str,
1195 request: RunCommandRequest,
1196 ) -> Result<futures::stream::BoxStream<'static, Result<CommandOutput>>>;
1197
1198 /// Starts a command as a job, which outlives the call that started it. Requires `jobs`.
1199 ///
1200 /// A start that goes unanswered is `SANDBOX_OUTCOME_UNKNOWN` and not retryable: the sandbox
1201 /// may have taken the command, and repeating it would run it twice.
1202 async fn start_job(&self, session_id: &str, request: RunCommandRequest) -> Result<JobStart>;
1203
1204 /// Reads a job's output after `since_seq`, and its ending once it has one. Requires `jobs`.
1205 ///
1206 /// `None` reads from the first frame. Repeating a poll costs nothing and changes nothing, so
1207 /// a sandbox that cannot be reached is `SANDBOX_UNREACHABLE` and retryable.
1208 async fn poll_job(
1209 &self,
1210 session_id: &str,
1211 job_id: &str,
1212 since_seq: Option<u64>,
1213 ) -> Result<JobPoll>;
1214
1215 /// Cancels a job, stopping its command. Requires `jobs`.
1216 ///
1217 /// Classified like `poll_job`: a cancel that is repeated stops nothing a second time.
1218 async fn cancel_job(&self, session_id: &str, job_id: &str) -> Result<()>;
1219
1220 /// Reads a file out of the sandbox. Requires `files`. Paths are normalised and may not
1221 /// escape the root.
1222 async fn read_file(&self, session_id: &str, path: &str) -> Result<Vec<u8>>;
1223
1224 /// Writes files into the sandbox. Requires `files`.
1225 async fn write_files(&self, session_id: &str, files: BTreeMap<String, Vec<u8>>) -> Result<()>;
1226
1227 /// Creates a directory inside the sandbox. Requires `files`.
1228 async fn mkdir(&self, session_id: &str, path: &str) -> Result<()>;
1229
1230 /// Mints a capability to reach a declared port. Requires `preview`.
1231 async fn preview(&self, session_id: &str, port: u16) -> Result<PreviewCapability>;
1232
1233 /// Suspends a session, preserving state. Requires `suspendResume`.
1234 async fn suspend(&self, session_id: &str) -> Result<()>;
1235
1236 /// Resumes a suspended session. Requires `suspendResume`.
1237 async fn resume(&self, session_id: &str) -> Result<()>;
1238
1239 /// Captures full session state and returns its identifier. Requires `snapshot`.
1240 async fn snapshot(&self, session_id: &str) -> Result<String>;
1241
1242 /// Terminates a session. Idempotent: terminating an absent session succeeds.
1243 async fn terminate(&self, session_id: &str) -> Result<()>;
1244
1245 /// Get a reference to this object as `Any` for dynamic casting
1246 fn as_any(&self) -> &dyn std::any::Any;
1247}
1248
1249/// A provider must implement methods to load the various types of bindings
1250/// based on environment variables or other configuration sources.
1251#[async_trait]
1252pub trait BindingsProviderApi: Send + Sync + std::fmt::Debug {
1253 /// Given a binding identifier, builds a Storage implementation.
1254 async fn load_storage(&self, binding_name: &str) -> Result<Arc<dyn Storage>>;
1255
1256 /// Given a binding identifier, builds a Key implementation.
1257 async fn load_key(&self, binding_name: &str) -> Result<Arc<dyn Key>> {
1258 Err(alien_error::AlienError::new(
1259 crate::error::ErrorData::OperationNotSupported {
1260 operation: "load_key".to_string(),
1261 reason: format!("Key resource '{binding_name}' is not supported by this provider"),
1262 },
1263 ))
1264 }
1265
1266 /// Given a binding identifier, builds a Build implementation.
1267 async fn load_build(&self, binding_name: &str) -> Result<Arc<dyn Build>>;
1268
1269 /// Given a binding identifier, builds an ArtifactRegistry implementation.
1270 async fn load_artifact_registry(&self, binding_name: &str)
1271 -> Result<Arc<dyn ArtifactRegistry>>;
1272
1273 /// Given a binding identifier, builds a Vault implementation.
1274 async fn load_vault(&self, binding_name: &str) -> Result<Arc<dyn Vault>>;
1275
1276 /// Given a binding identifier, builds a KV implementation.
1277 async fn load_kv(&self, binding_name: &str) -> Result<Arc<dyn Kv>>;
1278
1279 /// Given a binding identifier, builds a Postgres implementation.
1280 ///
1281 /// Every backend is resolved here. Local and External carry their password inline;
1282 /// Aurora, Cloud SQL, and Azure Flexible Server carry only a locator for it and read
1283 /// the value from that cloud's secret store during this call, using the workload's own
1284 /// identity. Resolution happens once per load, so the returned handle is synchronous.
1285 async fn load_postgres(&self, binding_name: &str) -> Result<Arc<dyn Postgres>>;
1286
1287 /// Given a binding identifier, builds a Queue implementation.
1288 async fn load_queue(&self, binding_name: &str) -> Result<Arc<dyn Queue>>;
1289
1290 /// Given a binding identifier, builds a Worker implementation.
1291 async fn load_worker(&self, binding_name: &str) -> Result<Arc<dyn Worker>>;
1292
1293 /// Given a binding identifier, builds a Container implementation.
1294 async fn load_container(&self, binding_name: &str) -> Result<Arc<dyn Container>>;
1295
1296 /// Given a binding identifier, builds a ServiceAccount implementation.
1297 async fn load_service_account(&self, binding_name: &str) -> Result<Arc<dyn ServiceAccount>>;
1298
1299 /// Given a binding identifier, builds a Sandbox implementation.
1300 async fn load_sandbox(&self, binding_name: &str) -> Result<Arc<dyn Sandbox>>;
1301
1302 /// Runtime-only binding env vars (a local Postgres connection with its password, a local
1303 /// BYO-key AI binding) for the given resource — re-resolved on every (re)start so the secret
1304 /// reaches the worker process but is never written to persisted worker metadata. The resource
1305 /// type routes resolution to the right local source. Default `None`: cloud providers carry a
1306 /// secret locator (not a raw secret) and use the normal persisted path.
1307 async fn resolve_runtime_only_binding_env(
1308 &self,
1309 _binding_name: &str,
1310 _resource_type: &str,
1311 ) -> Result<Option<std::collections::HashMap<String, String>>> {
1312 Ok(None)
1313 }
1314}