Skip to main content

aion_server/api/
deploy_grpc.rs

1//! tonic `DeployService` adapter over the shared deploy handlers.
2//!
3//! Added to the existing gRPC listener only when `[deploy].enabled` is true;
4//! a disabled surface answers `Unimplemented` (tonic's unknown-service
5//! response), exposing no deploy code path at all.
6
7use aion_proto::{
8    ProtoRouteVersionRequest, ProtoUnloadVersionRequest,
9    generated::{self, deploy_service_server::DeployServiceServer},
10};
11use tonic::{Code, Request, Response, Status};
12
13use super::grpc::{caller_from_metadata, status_from_wire_error, status_with_code};
14use crate::api::handlers::deploy::{self, DeployApiError};
15use crate::api::handlers::managed_workers;
16use crate::config::DEPLOY_MAX_ARCHIVE_BYTES_REQUIRED;
17use crate::worker::supervisor::SupervisionError;
18use crate::{CallerIdentity, ServerState};
19
20const TRANSPORT: &str = "grpc";
21
22/// Proto-framing slack over the archive ceiling for the unary
23/// `LoadPackageRequest`: the message wraps the archive bytes in one
24/// length-delimited field (tag byte plus a length varint of at most ten
25/// bytes), so a conformant archive of exactly `max_archive_bytes` always
26/// decodes. This is slack, not enforcement: an archive between the limit
27/// and limit + 64 still decodes here and is then rejected exactly by the
28/// handler's `deploy.max_archive_bytes` check, which is authoritative. The
29/// transport bound only caps buffering at limit + 64.
30const LOAD_PACKAGE_FRAMING_ALLOWANCE: usize = 64;
31
32/// Cloneable tonic implementation of the operator deploy service.
33#[derive(Clone)]
34pub struct DeployGrpcService {
35    state: ServerState,
36}
37
38impl DeployGrpcService {
39    /// Build a tonic deploy service from shared server state.
40    #[must_use]
41    pub const fn new(state: ServerState) -> Self {
42        Self { state }
43    }
44
45    async fn caller<T>(&self, request: &Request<T>) -> Result<CallerIdentity, Status> {
46        caller_from_metadata(request.metadata(), &self.state).await
47    }
48}
49
50/// Construct the generated tonic server wrapper with a decode ceiling sized
51/// from `deploy.max_archive_bytes`.
52///
53/// # Errors
54///
55/// Returns [`crate::ServerError::Config`] when the deploy surface is enabled
56/// without the required `deploy.max_archive_bytes` (defense in depth; config
57/// validation refuses this earlier).
58pub fn deploy_service(
59    state: ServerState,
60) -> Result<DeployServiceServer<DeployGrpcService>, crate::ServerError> {
61    let Some(limit) = state.runtime_config().deploy.max_archive_bytes else {
62        return Err(crate::ServerError::Config {
63            message: DEPLOY_MAX_ARCHIVE_BYTES_REQUIRED.to_owned(),
64        });
65    };
66    // Config validation guarantees the ceiling fits in usize on this
67    // platform; saturating is a defensive no-op kept over a panic path.
68    let limit = usize::try_from(limit).unwrap_or(usize::MAX);
69    Ok(DeployServiceServer::new(DeployGrpcService::new(state))
70        .max_decoding_message_size(limit.saturating_add(LOAD_PACKAGE_FRAMING_ALLOWANCE)))
71}
72
73#[tonic::async_trait]
74impl generated::deploy_service_server::DeployService for DeployGrpcService {
75    async fn load_package(
76        &self,
77        request: Request<generated::LoadPackageRequest>,
78    ) -> Result<Response<generated::LoadPackageResponse>, Status> {
79        let caller = self.caller(&request).await?;
80        let response = deploy::load_package(
81            &self.state,
82            &caller,
83            TRANSPORT,
84            request.into_inner().archive,
85        )
86        .await
87        .map_err(status_from_deploy_error)?;
88        Ok(Response::new(generated::LoadPackageResponse {
89            workflow_type: response.workflow_type,
90            content_hash: response.content_hash,
91            deployed_entry_module: response.deployed_entry_module,
92            entry_function: response.entry_function,
93            freshly_loaded: response.freshly_loaded,
94            route_changed: response.route_changed,
95            superseded_versions: response.superseded_versions,
96            auto_workers: response
97                .auto_workers
98                .into_iter()
99                .map(|worker| generated::AutoWorker {
100                    task_queue: worker.task_queue,
101                    decision: worker.decision,
102                    deployment: worker.deployment,
103                    detail: worker.detail,
104                })
105                .collect(),
106        }))
107    }
108
109    async fn list_versions(
110        &self,
111        request: Request<generated::ListVersionsRequest>,
112    ) -> Result<Response<generated::ListVersionsResponse>, Status> {
113        let caller = self.caller(&request).await?;
114        let response = deploy::list_versions(&self.state, &caller, TRANSPORT)
115            .map_err(status_from_deploy_error)?;
116        Ok(Response::new(generated::ListVersionsResponse {
117            versions: response
118                .versions
119                .into_iter()
120                .map(|version| generated::WorkflowVersion {
121                    workflow_type: version.workflow_type,
122                    content_hash: version.content_hash,
123                    deployed_entry_module: version.deployed_entry_module,
124                    entry_function: version.entry_function,
125                    manifest_version: version.manifest_version,
126                    loaded_at: version.loaded_at,
127                    route_active: version.route_active,
128                })
129                .collect(),
130        }))
131    }
132
133    async fn route_version(
134        &self,
135        request: Request<generated::RouteVersionRequest>,
136    ) -> Result<Response<generated::RouteVersionResponse>, Status> {
137        let caller = self.caller(&request).await?;
138        let inner = request.into_inner();
139        deploy::route_version(
140            &self.state,
141            &caller,
142            TRANSPORT,
143            ProtoRouteVersionRequest {
144                workflow_type: inner.workflow_type,
145                content_hash: inner.content_hash,
146            },
147        )
148        .await
149        .map_err(status_from_deploy_error)?;
150        Ok(Response::new(generated::RouteVersionResponse {}))
151    }
152
153    async fn unload_version(
154        &self,
155        request: Request<generated::UnloadVersionRequest>,
156    ) -> Result<Response<generated::UnloadVersionResponse>, Status> {
157        let caller = self.caller(&request).await?;
158        let inner = request.into_inner();
159        deploy::unload_version(
160            &self.state,
161            &caller,
162            TRANSPORT,
163            ProtoUnloadVersionRequest {
164                workflow_type: inner.workflow_type,
165                content_hash: inner.content_hash,
166            },
167        )
168        .await
169        .map_err(status_from_deploy_error)?;
170        Ok(Response::new(generated::UnloadVersionResponse {}))
171    }
172
173    async fn list_managed_workers(
174        &self,
175        request: Request<generated::ListManagedWorkersRequest>,
176    ) -> Result<Response<generated::ListManagedWorkersResponse>, Status> {
177        let caller = self.caller(&request).await?;
178        require_deploy_grant(&caller)?;
179        let report = self
180            .state
181            .worker_supervisor()
182            .report()
183            .await
184            .map_err(|error| status_from_supervision_error(&error))?;
185        Ok(Response::new(managed_workers::managed_worker_report(
186            report,
187        )))
188    }
189
190    async fn start_managed_worker(
191        &self,
192        request: Request<generated::ManagedWorkerRequest>,
193    ) -> Result<Response<generated::ManagedWorkerResponse>, Status> {
194        let caller = self.caller(&request).await?;
195        require_deploy_grant(&caller)?;
196        let name = request.into_inner().name;
197        let status = self
198            .state
199            .worker_supervisor()
200            .start(&name)
201            .await
202            .map_err(|error| status_from_supervision_error(&error))?;
203        Ok(Response::new(generated::ManagedWorkerResponse {
204            worker: Some(managed_workers::managed_worker(status)),
205        }))
206    }
207
208    async fn stop_managed_worker(
209        &self,
210        request: Request<generated::ManagedWorkerRequest>,
211    ) -> Result<Response<generated::ManagedWorkerResponse>, Status> {
212        let caller = self.caller(&request).await?;
213        require_deploy_grant(&caller)?;
214        let name = request.into_inner().name;
215        let status = self
216            .state
217            .worker_supervisor()
218            .stop(&name)
219            .await
220            .map_err(|error| status_from_supervision_error(&error))?;
221        Ok(Response::new(generated::ManagedWorkerResponse {
222            worker: Some(managed_workers::managed_worker(status)),
223        }))
224    }
225
226    async fn restart_managed_worker(
227        &self,
228        request: Request<generated::ManagedWorkerRequest>,
229    ) -> Result<Response<generated::ManagedWorkerResponse>, Status> {
230        let caller = self.caller(&request).await?;
231        require_deploy_grant(&caller)?;
232        let name = request.into_inner().name;
233        let status = self
234            .state
235            .worker_supervisor()
236            .restart(&name)
237            .await
238            .map_err(|error| status_from_supervision_error(&error))?;
239        Ok(Response::new(generated::ManagedWorkerResponse {
240            worker: Some(managed_workers::managed_worker(status)),
241        }))
242    }
243}
244
245/// Managed-worker lifecycle carries the SAME deployment-wide deploy authority
246/// as the deployment records it acts on (ADR-022 keeps this distinct from
247/// workflow-command authority).
248fn require_deploy_grant(caller: &CallerIdentity) -> Result<(), Status> {
249    if caller.deploy_granted() {
250        Ok(())
251    } else {
252        Err(status_from_wire_error(
253            aion_proto::WireError::deploy_denied(
254                "managed-worker administration requires the deployment-wide deploy grant",
255            ),
256        ))
257    }
258}
259
260/// Supervision failure mapping, over the SAME wire-error projection the HTTP
261/// surface uses, so a refusal reads identically on both.
262fn status_from_supervision_error(error: &SupervisionError) -> Status {
263    status_from_wire_error(managed_workers::wire_error(error))
264}
265
266/// Deploy failure mapping: drain/shutdown → `Unavailable`, oversized archive
267/// → `InvalidArgument`, everything else through the standard code table.
268/// The typed `ProtoWireError` detail rides every status.
269fn status_from_deploy_error(error: DeployApiError) -> Status {
270    match error {
271        DeployApiError::Unavailable(wire) => status_with_code(Code::Unavailable, wire),
272        DeployApiError::ArchiveTooLarge(wire) => status_with_code(Code::InvalidArgument, wire),
273        DeployApiError::Wire(wire) => status_from_wire_error(wire),
274    }
275}
276
277#[cfg(test)]
278mod tests {
279    use std::sync::Arc;
280
281    use aion::EngineBuilder;
282    use aion_proto::{ProtoWireError, WireError, WireErrorCode, generated};
283    use aion_store::{EventStore, InMemoryStore};
284    use prost::Message as _;
285    use tonic::{Code, Request, Status};
286
287    use super::DeployGrpcService;
288    use crate::config::{
289        AuthConfig, AuthoringConfig, DeployConfig, ListenConfig, MetricsConfig, NamespaceConfig,
290        NamespaceMode, OpsConsoleAssetSource, OpsConsoleConfig, RuntimeConfig, WebSocketConfig,
291        WorkerConfig,
292    };
293    use crate::{
294        NamespaceResolver, ServerState, StaticScheduleNamespaces, StaticWorkflowNamespaces,
295    };
296
297    /// Decode the typed `ProtoWireError` detail riding a deploy status.
298    fn decode_detail(status: &Status) -> Result<WireError, Box<dyn std::error::Error>> {
299        let proto = ProtoWireError::decode(status.details())?;
300        Ok(WireError::try_from(proto)?)
301    }
302
303    fn runtime_config() -> RuntimeConfig {
304        RuntimeConfig {
305            listen: ListenConfig {
306                grpc: std::net::SocketAddr::from(([127, 0, 0, 1], 50051)),
307                http: std::net::SocketAddr::from(([127, 0, 0, 1], 8080)),
308            },
309            tls: None,
310            auth: AuthConfig {
311                enabled: false,
312                jwks_url: None,
313                jwks_refresh_seconds: 300,
314            },
315            ops_console: OpsConsoleConfig {
316                source: OpsConsoleAssetSource::Embedded,
317            },
318            namespace: NamespaceConfig {
319                mode: NamespaceMode::SharedEngine,
320            },
321            worker: WorkerConfig {
322                heartbeat_window: std::time::Duration::from_secs(30),
323                ..WorkerConfig::default()
324            },
325            websocket: WebSocketConfig {
326                outbound_buffer_bound: 32,
327                event_broadcast_capacity: Some(64),
328                cluster_broadcast_capacity: Some(64),
329            },
330            workflow_packages: Vec::new(),
331            deploy: DeployConfig::default(),
332            authoring: AuthoringConfig::default(),
333            dev: crate::config::DevConfig::default(),
334            outbox: crate::config::OutboxConfig::default(),
335            observability: crate::config::ObservabilityConfig::with_flush_policy(64, 0),
336            mcp: crate::config::ResolvedMcpConfig::default(),
337            scheduler_threads: 1,
338            jit_threshold: None,
339            query_timeout: Some(std::time::Duration::from_secs(10)),
340            workloop_sweep_interval: Some(std::time::Duration::from_millis(50)),
341            default_namespace: "default".to_owned(),
342            auto_create: crate::config::AutoCreate::Open,
343            max_in_flight_activities: crate::config::DEFAULT_MAX_IN_FLIGHT_ACTIVITIES,
344            drain_timeout: std::time::Duration::from_secs(30),
345            metrics: MetricsConfig { enabled: true },
346            owned_shards: Vec::new(),
347            cors_allowed_origins: Vec::new(),
348        }
349    }
350
351    async fn deploy_state() -> Result<ServerState, Box<dyn std::error::Error>> {
352        let store: Arc<dyn EventStore> = Arc::new(InMemoryStore::default());
353        let engine = Arc::new(
354            EngineBuilder::new()
355                .store_arc(store)
356                .in_memory_visibility()
357                .scheduler_threads(1)
358                .build()
359                .await?,
360        );
361        let resolver = NamespaceResolver::from_parts(
362            NamespaceMode::SharedEngine,
363            Some(engine),
364            Arc::new(StaticWorkflowNamespaces::default()),
365            Arc::new(StaticScheduleNamespaces::default()),
366        );
367        let mut config = runtime_config();
368        config.deploy = DeployConfig {
369            enabled: true,
370            max_archive_bytes: Some(1024),
371            max_inflated_bytes: Some(2048),
372        };
373        Ok(ServerState::from_parts(resolver, config))
374    }
375
376    /// Shared-secret bearer accepted by the dev-token path (`auth.enabled =
377    /// true`, `not(feature = "auth")`), wired as the configured `jwks_url`.
378    #[cfg(not(feature = "auth"))]
379    const AUTH_TOKEN: &str = "deploy-secret";
380
381    /// Deploy-enabled state with authentication ON via the dev-token path, used
382    /// to prove the strict gate still denies an ungranted caller.
383    #[cfg(not(feature = "auth"))]
384    async fn auth_on_deploy_state() -> Result<ServerState, Box<dyn std::error::Error>> {
385        let store: Arc<dyn EventStore> = Arc::new(InMemoryStore::default());
386        let engine = Arc::new(
387            EngineBuilder::new()
388                .store_arc(store)
389                .in_memory_visibility()
390                .scheduler_threads(1)
391                .build()
392                .await?,
393        );
394        let resolver = NamespaceResolver::from_parts(
395            NamespaceMode::SharedEngine,
396            Some(engine),
397            Arc::new(StaticWorkflowNamespaces::default()),
398            Arc::new(StaticScheduleNamespaces::default()),
399        );
400        let mut config = runtime_config();
401        config.auth = AuthConfig {
402            enabled: true,
403            jwks_url: Some(AUTH_TOKEN.to_owned()),
404            jwks_refresh_seconds: 300,
405        };
406        config.deploy = DeployConfig {
407            enabled: true,
408            max_archive_bytes: Some(1024),
409            max_inflated_bytes: Some(2048),
410        };
411        Ok(ServerState::from_parts(resolver, config))
412    }
413
414    fn granted_request<T>(message: T) -> Result<Request<T>, Box<dyn std::error::Error>> {
415        let mut request = Request::new(message);
416        request
417            .metadata_mut()
418            .insert("x-aion-subject", "ci".parse()?);
419        request
420            .metadata_mut()
421            .insert("x-aion-deploy", "true".parse()?);
422        Ok(request)
423    }
424
425    /// Auth-off single-tenant operator mode: the gRPC caller IS the operator
426    /// and holds the deploy grant decided server-side, so deploy is authorized
427    /// with no `x-aion-deploy` metadata at all (mirrors the HTTP boundary).
428    #[tokio::test]
429    async fn auth_off_operator_is_deploy_granted_without_metadata()
430    -> Result<(), Box<dyn std::error::Error>> {
431        use generated::deploy_service_server::DeployService as _;
432
433        let service = DeployGrpcService::new(deploy_state().await?);
434        let mut request = Request::new(generated::ListVersionsRequest {});
435        request
436            .metadata_mut()
437            .insert("x-aion-subject", "ci".parse()?);
438
439        let response = service.list_versions(request).await?;
440        assert!(response.into_inner().versions.is_empty());
441        Ok(())
442    }
443
444    /// Auth-ENABLED (dev-token path): the strict gate stays strict. A caller
445    /// with a valid bearer and subject but NO deploy grant is still denied —
446    /// operator mode never leaks into the auth-on path.
447    #[cfg(not(feature = "auth"))]
448    #[tokio::test]
449    async fn auth_on_denies_caller_without_deploy_grant() -> Result<(), Box<dyn std::error::Error>>
450    {
451        use generated::deploy_service_server::DeployService as _;
452
453        let service = DeployGrpcService::new(auth_on_deploy_state().await?);
454        let mut request = Request::new(generated::ListVersionsRequest {});
455        // Valid shared-secret bearer + subject, but no x-aion-deploy grant.
456        request
457            .metadata_mut()
458            .insert("authorization", format!("Bearer {AUTH_TOKEN}").parse()?);
459        request
460            .metadata_mut()
461            .insert("x-aion-subject", "ci".parse()?);
462
463        let status = service
464            .list_versions(request)
465            .await
466            .err()
467            .ok_or("expected denial")?;
468        assert_eq!(status.code(), Code::PermissionDenied);
469        let detail = decode_detail(&status)?;
470        assert_eq!(detail.code, WireErrorCode::DeployDenied);
471        assert!(
472            detail.message.contains("x-aion-deploy"),
473            "denial must hint the dev header: {}",
474            detail.message
475        );
476        Ok(())
477    }
478
479    #[tokio::test]
480    async fn granted_metadata_lists_versions() -> Result<(), Box<dyn std::error::Error>> {
481        use generated::deploy_service_server::DeployService as _;
482
483        let service = DeployGrpcService::new(deploy_state().await?);
484        let response = service
485            .list_versions(granted_request(generated::ListVersionsRequest {})?)
486            .await?;
487        assert!(response.into_inner().versions.is_empty());
488        Ok(())
489    }
490
491    #[tokio::test]
492    async fn oversized_archive_is_invalid_argument_naming_the_key()
493    -> Result<(), Box<dyn std::error::Error>> {
494        use generated::deploy_service_server::DeployService as _;
495
496        let service = DeployGrpcService::new(deploy_state().await?);
497        let status = service
498            .load_package(granted_request(generated::LoadPackageRequest {
499                archive: vec![0_u8; 2048],
500            })?)
501            .await
502            .err()
503            .ok_or("expected oversize refusal")?;
504
505        assert_eq!(status.code(), Code::InvalidArgument);
506        assert!(
507            status.message().contains("deploy.max_archive_bytes"),
508            "refusal must name the config key: {}",
509            status.message()
510        );
511        Ok(())
512    }
513
514    #[tokio::test]
515    async fn route_to_unknown_version_is_not_found() -> Result<(), Box<dyn std::error::Error>> {
516        use generated::deploy_service_server::DeployService as _;
517
518        let service = DeployGrpcService::new(deploy_state().await?);
519        let status = service
520            .route_version(granted_request(generated::RouteVersionRequest {
521                workflow_type: "order".to_owned(),
522                content_hash: "a".repeat(64),
523            })?)
524            .await
525            .err()
526            .ok_or("expected unknown-version refusal")?;
527
528        assert_eq!(status.code(), Code::NotFound);
529        let detail = decode_detail(&status)?;
530        assert_eq!(detail.code, WireErrorCode::NotFound);
531        assert_eq!(detail.error_type.as_deref(), Some("UnknownVersion"));
532        Ok(())
533    }
534
535    #[tokio::test]
536    async fn malformed_hash_is_invalid_argument() -> Result<(), Box<dyn std::error::Error>> {
537        use generated::deploy_service_server::DeployService as _;
538
539        let service = DeployGrpcService::new(deploy_state().await?);
540        let status = service
541            .unload_version(granted_request(generated::UnloadVersionRequest {
542                workflow_type: "order".to_owned(),
543                content_hash: "not-a-hash".to_owned(),
544            })?)
545            .await
546            .err()
547            .ok_or("expected malformed-hash refusal")?;
548
549        assert_eq!(status.code(), Code::InvalidArgument);
550        assert!(
551            status.message().contains("not-a-hash"),
552            "refusal must name the malformed hash: {}",
553            status.message()
554        );
555        Ok(())
556    }
557
558    /// Drain: mutations refuse with `Unavailable`; the versions read model
559    /// keeps serving (operators watch rollouts through it).
560    #[tokio::test]
561    async fn drain_refuses_mutations_but_serves_listing() -> Result<(), Box<dyn std::error::Error>>
562    {
563        use generated::deploy_service_server::DeployService as _;
564
565        let state = deploy_state().await?;
566        assert!(state.drain_state().begin());
567        let service = DeployGrpcService::new(state);
568
569        let status = service
570            .route_version(granted_request(generated::RouteVersionRequest {
571                workflow_type: "order".to_owned(),
572                content_hash: "a".repeat(64),
573            })?)
574            .await
575            .err()
576            .ok_or("expected drain refusal")?;
577        assert_eq!(status.code(), Code::Unavailable);
578        assert!(
579            status.message().contains("draining"),
580            "drain refusal must be explicit: {}",
581            status.message()
582        );
583
584        let listing = service
585            .list_versions(granted_request(generated::ListVersionsRequest {})?)
586            .await?;
587        assert!(listing.into_inner().versions.is_empty());
588        Ok(())
589    }
590}