auv-api-server 0.0.22

Protocol adapters for AUV daemon control and capability APIs
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

//! Generated daemon JSON routes and dynamic Protobuf runner invocation.

use std::sync::Arc;

use axum::Router;
use axum::body::{Body, to_bytes};
use axum::extract::ws::WebSocketUpgrade;
use axum::extract::{Path, State};
use axum::http::{HeaderValue, Method, Request, StatusCode, header};
use axum::response::{IntoResponse, Response};
use axum::routing::{get, post};
use http_body_util::BodyExt as _;
use tonic::{Code, Status};

use crate::authentication::Authenticator;
use crate::control::Control;
use crate::middleware::authentication;
use crate::protocol::grpc::daemon::v1::{
  DeviceServiceGrpc, DiscoveryServiceGrpc, HealthServiceGrpc, PairingServiceGrpc, RunServiceGrpc, RunnerClassServiceGrpc, RunnerServiceGrpc,
};

const PROTOBUF_CONTENT_TYPE: &str = "application/protobuf";
const INVOKE_PATH: &str = "/apis/auv/runtime/v1/invoke";

// NOTICE(tonic-rest-codegen): the generator also emits a combined router. This
// adapter uses service routers so dynamic invoke routes can share their state.
#[allow(dead_code)]
mod generated {
  include!(concat!(env!("OUT_DIR"), "/daemon_rest.rs"));
}

#[derive(Clone)]
struct RestState {
  daemon: Arc<dyn Control>,
  authenticator: Authenticator,
}

pub(crate) fn router(daemon: Arc<dyn Control>, authenticator: Authenticator, id: String) -> Router {
  let pairing = Arc::new(PairingServiceGrpc::new(authenticator.pairing()));
  let discovery = Arc::new(DiscoveryServiceGrpc::new(Arc::clone(&daemon)));
  let health = Arc::new(HealthServiceGrpc { id });
  let devices = Arc::new(DeviceServiceGrpc::new(Arc::clone(&daemon)));
  let runs = Arc::new(RunServiceGrpc::new(Arc::clone(&daemon)));
  let runners = Arc::new(RunnerServiceGrpc::new(Arc::clone(&daemon)));
  let runner_classes = Arc::new(RunnerClassServiceGrpc::new(Arc::clone(&daemon)));

  // TODO(websocket-events): durable event subscriptions still need ordering,
  // cursor, and gap-recovery semantics. The invoke socket below is scoped to
  // one live Runner operation and does not define that separate event model.
  Router::new()
    .route("/apis/auv/runtime/v1/invoke/{service}/{method}", post(invoke_unary))
    .route(INVOKE_PATH, get(invoke_websocket))
    .with_state(RestState {
      daemon,
      authenticator,
    })
    .merge(generated::pairing_service_rest_router(pairing))
    .merge(generated::discovery_service_rest_router(discovery))
    .merge(generated::health_service_rest_router(health))
    .merge(generated::device_service_rest_router(devices))
    .merge(generated::run_service_rest_router(runs))
    .merge(generated::runner_service_rest_router(runners))
    .merge(generated::runner_class_service_rest_router(runner_classes))
}

async fn invoke_websocket(State(state): State<RestState>, upgrade: WebSocketUpgrade) -> Response {
  upgrade.on_upgrade(move |socket| crate::protocol::websocket::serve(socket, state.daemon, state.authenticator)).into_response()
}

async fn invoke_unary(
  State(state): State<RestState>,
  Path((service, method)): Path<(String, String)>,
  request: Request<Body>,
) -> Result<ProtobufBytes, RestError> {
  let (mut parts, body) = request.into_parts();

  let protobuf =
    to_bytes(body, usize::MAX).await.map_err(|error| RestError::new(StatusCode::BAD_REQUEST, "invalid_body", error.to_string()))?;
  let mut grpc_body = Vec::with_capacity(5 + protobuf.len());
  grpc_body.push(0);
  let length = u32::try_from(protobuf.len())
    .map_err(|_| RestError::new(StatusCode::PAYLOAD_TOO_LARGE, "request_too_large", "Protobuf request exceeds the gRPC frame length"))?;

  grpc_body.extend_from_slice(&length.to_be_bytes());
  grpc_body.extend_from_slice(&protobuf);

  parts.method = axum::http::Method::POST;
  parts.uri = format!("/{service}/{method}")
    .parse()
    .map_err(|error| RestError::new(StatusCode::BAD_REQUEST, "invalid_argument", format!("invalid gRPC method path: {error}")))?;
  parts.headers.remove(header::CONTENT_LENGTH);
  parts.headers.insert(header::CONTENT_TYPE, HeaderValue::from_static("application/grpc"));
  parts.headers.insert(header::TE, HeaderValue::from_static("trailers"));

  let request = Request::from_parts(parts, Body::from(grpc_body));
  let proxy = crate::server::runner_grpc_proxy::RunnerGrpcProxy::new(Arc::clone(&state.daemon));
  let response = proxy.forward(request).await;
  let (parts, body) = response.into_parts();
  let collected = body.collect().await.map_err(RestError::from)?;

  let grpc_status = parts
    .headers
    .get("grpc-status")
    .or_else(|| collected.trailers().and_then(|trailers| trailers.get("grpc-status")))
    .ok_or_else(|| RestError::new(StatusCode::BAD_GATEWAY, "invalid_grpc", "Runner response omitted grpc-status"))?
    .to_str()
    .map_err(|error| RestError::new(StatusCode::BAD_GATEWAY, "invalid_grpc", error.to_string()))?
    .parse::<i32>()
    .map_err(|error| RestError::new(StatusCode::BAD_GATEWAY, "invalid_grpc", error.to_string()))?;

  if grpc_status != 0 {
    let message = parts
      .headers
      .get("grpc-message")
      .or_else(|| collected.trailers().and_then(|trailers| trailers.get("grpc-message")))
      .and_then(|value| value.to_str().ok())
      .unwrap_or("Runner operation failed");
    return Err(RestError::from(Status::new(Code::from_i32(grpc_status), message)));
  }

  let bytes = collected.to_bytes();
  if bytes.len() < 5 || bytes[0] != 0 {
    return Err(RestError::new(StatusCode::BAD_GATEWAY, "invalid_grpc", "Runner returned an invalid unary gRPC frame"));
  }

  let length = u32::from_be_bytes(bytes[1..5].try_into().expect("five-byte gRPC prefix was checked")) as usize;
  if bytes.len() != length + 5 {
    return Err(RestError::new(StatusCode::BAD_GATEWAY, "invalid_grpc", "Runner returned more or less than one unary response"));
  }

  Ok(ProtobufBytes(bytes.slice(5..)))
}

struct ProtobufBytes(bytes::Bytes);

impl IntoResponse for ProtobufBytes {
  fn into_response(self) -> Response {
    let mut response = self.0.into_response();
    response.headers_mut().insert(header::CONTENT_TYPE, HeaderValue::from_static(PROTOBUF_CONTENT_TYPE));
    response
  }
}

pub(crate) struct RestError {
  status: StatusCode,
  code: &'static str,
  detail: String,
}

impl RestError {
  fn new(status: StatusCode, code: &'static str, detail: impl Into<String>) -> Self {
    Self {
      status,
      code,
      detail: detail.into(),
    }
  }
}

/// Preserves the connection identity and authentication metadata when a
/// generated Axum handler calls the existing Tonic service implementation.
pub(crate) fn build_tonic_request<T, E>(body: T, headers: &axum::http::HeaderMap, extension: Option<E>) -> tonic::Request<T>
where
  E: Clone + Send + Sync + 'static,
{
  let mut request = tonic::Request::new(body);
  if let Some(extension) = extension {
    request.extensions_mut().insert(extension);
  }
  for name in [
    "authorization",
    "user-agent",
    "x-forwarded-for",
    "x-real-ip",
  ] {
    let Some(value) = headers.get(name).and_then(|value| value.to_str().ok()) else {
      continue;
    };
    let Ok(key) = name.parse::<tonic::metadata::MetadataKey<tonic::metadata::Ascii>>() else {
      continue;
    };
    if let Ok(value) = value.parse() {
      request.metadata_mut().insert(key, value);
    }
  }
  request
}

/// Registers the authentication requirements owned by the REST routes.
pub(crate) fn register_authentication(builder: &mut authentication::Builder) {
  builder.websocket_open(Method::GET, INVOKE_PATH);
  // NOTICE(tonic-rest-public-methods): tonic-rest 0.1.5 emits public paths
  // without their HTTP methods. The configured public RPCs currently use GET
  // or POST, so register both; unmatched method/path pairs have no route. Ask
  // the generator for exact method/path pairs before adding another HTTP verb.
  for &path in generated::PUBLIC_REST_PATHS {
    builder.public(Method::GET, path);
    builder.public(Method::POST, path);
  }
}

impl From<Status> for RestError {
  fn from(status: Status) -> Self {
    let (http_status, code) = match status.code() {
      Code::InvalidArgument => (StatusCode::BAD_REQUEST, "invalid_argument"),
      Code::Unauthenticated => (StatusCode::UNAUTHORIZED, "unauthenticated"),
      Code::PermissionDenied => (StatusCode::FORBIDDEN, "permission_denied"),
      Code::NotFound => (StatusCode::NOT_FOUND, "not_found"),
      Code::FailedPrecondition => (StatusCode::CONFLICT, "failed_precondition"),
      Code::ResourceExhausted => (StatusCode::TOO_MANY_REQUESTS, "resource_exhausted"),
      Code::Unimplemented => (StatusCode::NOT_IMPLEMENTED, "unimplemented"),
      Code::Cancelled => (StatusCode::from_u16(499).expect("valid client-closed status"), "cancelled"),
      _ => (StatusCode::INTERNAL_SERVER_ERROR, "internal"),
    };
    Self::new(http_status, code, status.message())
  }
}

impl IntoResponse for RestError {
  fn into_response(self) -> Response {
    let body = serde_json::json!({
      "type": format!("urn:auv:error:{}", self.code),
      "title": self.code,
      "status": self.status.as_u16(),
      "detail": self.detail,
    });
    (self.status, [(header::CONTENT_TYPE, HeaderValue::from_static("application/problem+json"))], body.to_string()).into_response()
  }
}