Skip to main content

folk_plugin_grpc/
service.rs

1use std::io::{Read as _, Write as _};
2use std::pin::Pin;
3use std::sync::Arc;
4use std::task::{Context, Poll};
5
6use axum::extract::State;
7use axum::response::IntoResponse;
8use base64::Engine;
9use bytes::Bytes;
10use folk_api::Executor;
11use http::{HeaderMap, HeaderValue, Response};
12use http_body::Frame;
13use http_body_util::BodyExt;
14use tracing::debug;
15
16use crate::metrics::GrpcMetrics;
17
18#[derive(serde::Serialize, serde::Deserialize, Debug)]
19pub struct GrpcEnvelope {
20    pub service: String,
21    pub method: String,
22    pub payload: Vec<u8>,
23    pub metadata: std::collections::HashMap<String, String>,
24}
25
26const B64: base64::engine::general_purpose::GeneralPurpose =
27    base64::engine::general_purpose::STANDARD;
28
29#[derive(Clone)]
30pub struct GrpcState {
31    pub executor: Arc<dyn Executor>,
32    pub max_recv_message_size: usize,
33    pub max_send_message_size: usize,
34    pub compression: bool,
35    pub metrics: Option<GrpcMetrics>,
36}
37
38pub async fn grpc_handler(
39    State(state): State<GrpcState>,
40    req: axum::extract::Request,
41) -> impl IntoResponse {
42    let tracker = state.metrics.as_ref().map(|m| m.track_start());
43
44    let path = req.uri().path().to_string();
45
46    let parts: Vec<&str> = path.trim_start_matches('/').splitn(2, '/').collect();
47    let (service, method) = match parts.as_slice() {
48        [s, m] => (s.to_string(), m.to_string()),
49        _ => {
50            if let Some(t) = tracker {
51                t.finish("", "", 12, 0, 0);
52            }
53            return grpc_response(Bytes::new(), 12, "unimplemented: bad path", false);
54        }
55    };
56
57    // Check if client accepts gzip
58    let client_accepts_gzip = state.compression
59        && req
60            .headers()
61            .get("grpc-accept-encoding")
62            .and_then(|v| v.to_str().ok())
63            .is_some_and(|v| v.split(',').any(|e| e.trim() == "gzip"));
64
65    let metadata: std::collections::HashMap<String, String> = req
66        .headers()
67        .iter()
68        .filter(|(k, _)| {
69            let k = k.as_str();
70            !k.starts_with(':')
71                && k != "content-type"
72                && k != "te"
73                && k != "user-agent"
74                && k != "grpc-timeout"
75                && k != "grpc-encoding"
76                && k != "grpc-accept-encoding"
77        })
78        .filter_map(|(k, v)| {
79            v.to_str()
80                .ok()
81                .map(|v| (k.as_str().to_string(), v.to_string()))
82        })
83        .collect();
84
85    let body_bytes = match req.into_body().collect().await {
86        Ok(collected) => collected.to_bytes(),
87        Err(e) => {
88            if let Some(t) = tracker {
89                t.finish(&service, &method, 13, 0, 0);
90            }
91            return grpc_response(Bytes::new(), 13, &format!("body: {e}"), false);
92        }
93    };
94
95    if body_bytes.len() < 5 {
96        if let Some(t) = tracker {
97            t.finish(&service, &method, 13, 0, 0);
98        }
99        return grpc_response(Bytes::new(), 13, "incomplete gRPC frame", false);
100    }
101
102    // Parse gRPC frame: [compression_flag(1)][length(4)][payload]
103    let compressed = body_bytes[0] == 1;
104    let raw_payload = body_bytes.slice(5..);
105
106    // Decompress incoming if needed
107    let proto_bytes = if compressed {
108        match gzip_decompress(&raw_payload) {
109            Ok(decompressed) => Bytes::from(decompressed),
110            Err(e) => {
111                if let Some(t) = tracker {
112                    t.finish(&service, &method, 13, raw_payload.len(), 0);
113                }
114                return grpc_response(Bytes::new(), 13, &format!("decompress: {e}"), false);
115            }
116        }
117    } else {
118        raw_payload
119    };
120
121    let recv_bytes = proto_bytes.len();
122
123    // Enforce max incoming message size (after decompression)
124    if recv_bytes > state.max_recv_message_size {
125        if let Some(t) = tracker {
126            t.finish(&service, &method, 11, recv_bytes, 0);
127        }
128        return grpc_response(
129            Bytes::new(),
130            11, // RESOURCE_EXHAUSTED
131            &format!(
132                "received message larger than max ({recv_bytes} vs {} bytes)",
133                state.max_recv_message_size
134            ),
135            false,
136        );
137    }
138
139    debug!(service, method, payload_len = recv_bytes, "gRPC call");
140
141    // Build payload as serde_json::Value (base64 for binary protobuf data)
142    let payload_value = serde_json::json!({
143        "service": service,
144        "method": method,
145        "payload": B64.encode(&proto_bytes),
146        "metadata": metadata,
147    });
148
149    let response_value = match state
150        .executor
151        .execute_value("grpc.call", payload_value)
152        .await
153    {
154        Ok(v) => v,
155        Err(e) => {
156            if let Some(t) = tracker {
157                t.finish(&service, &method, 13, recv_bytes, 0);
158            }
159            return grpc_response(Bytes::new(), 13, &format!("worker: {e}"), false);
160        }
161    };
162
163    // Extract response: may be a string directly, or wrapped in {"__result": "..."}
164    let response_str = match &response_value {
165        serde_json::Value::String(s) => s.clone(),
166        serde_json::Value::Object(map) => {
167            if let Some(serde_json::Value::String(s)) = map.get("__result") {
168                s.clone()
169            } else if let Some(serde_json::Value::String(s)) = map.get("result") {
170                s.clone()
171            } else {
172                if let Some(t) = tracker {
173                    t.finish(&service, &method, 13, recv_bytes, 0);
174                }
175                return grpc_response(
176                    Bytes::new(),
177                    13,
178                    &format!("unexpected response: {response_value}"),
179                    false,
180                );
181            }
182        }
183        other => {
184            if let Some(t) = tracker {
185                t.finish(&service, &method, 13, recv_bytes, 0);
186            }
187            return grpc_response(
188                Bytes::new(),
189                13,
190                &format!("unexpected response type: {other}"),
191                false,
192            );
193        }
194    };
195
196    // Decode base64 protobuf bytes
197    let proto_response = match B64.decode(&response_str) {
198        Ok(bytes) => bytes,
199        Err(_) => response_str.into_bytes(),
200    };
201
202    let sent_bytes = proto_response.len();
203
204    // Enforce max outgoing message size
205    if sent_bytes > state.max_send_message_size {
206        if let Some(t) = tracker {
207            t.finish(&service, &method, 11, recv_bytes, sent_bytes);
208        }
209        return grpc_response(
210            Bytes::new(),
211            11, // RESOURCE_EXHAUSTED
212            &format!(
213                "response larger than max ({sent_bytes} vs {} bytes)",
214                state.max_send_message_size
215            ),
216            false,
217        );
218    }
219
220    // Build gRPC-framed response (optionally compressed)
221    if client_accepts_gzip {
222        if let Ok(compressed_data) = gzip_compress(&proto_response) {
223            let mut framed = Vec::with_capacity(5 + compressed_data.len());
224            framed.push(1u8); // compression flag
225            framed.extend_from_slice(&(compressed_data.len() as u32).to_be_bytes());
226            framed.extend_from_slice(&compressed_data);
227            if let Some(t) = tracker {
228                t.finish(&service, &method, 0, recv_bytes, sent_bytes);
229            }
230            return grpc_response(Bytes::from(framed), 0, "", true);
231        }
232    }
233
234    let mut framed = Vec::with_capacity(5 + proto_response.len());
235    framed.push(0u8);
236    framed.extend_from_slice(&(proto_response.len() as u32).to_be_bytes());
237    framed.extend_from_slice(&proto_response);
238
239    if let Some(t) = tracker {
240        t.finish(&service, &method, 0, recv_bytes, sent_bytes);
241    }
242    grpc_response(Bytes::from(framed), 0, "", false)
243}
244
245fn grpc_response(data: Bytes, status: u32, message: &str, gzip: bool) -> Response<GrpcBody> {
246    let mut trailers = HeaderMap::new();
247    trailers.insert("grpc-status", HeaderValue::from(status));
248    if !message.is_empty() {
249        if let Ok(v) = HeaderValue::from_str(message) {
250            trailers.insert("grpc-message", v);
251        }
252    }
253
254    let mut builder = Response::builder()
255        .status(200)
256        .header("content-type", "application/grpc");
257
258    if gzip {
259        builder = builder.header("grpc-encoding", "gzip");
260    }
261
262    builder
263        .body(GrpcBody {
264            data: Some(data),
265            trailers: Some(trailers),
266        })
267        .unwrap()
268}
269
270fn gzip_decompress(data: &[u8]) -> std::io::Result<Vec<u8>> {
271    let mut decoder = flate2::read::GzDecoder::new(data);
272    let mut out = Vec::new();
273    decoder.read_to_end(&mut out)?;
274    Ok(out)
275}
276
277fn gzip_compress(data: &[u8]) -> std::io::Result<Vec<u8>> {
278    let mut encoder = flate2::write::GzEncoder::new(Vec::new(), flate2::Compression::fast());
279    encoder.write_all(data)?;
280    encoder.finish()
281}
282
283/// Custom body type that sends data followed by gRPC trailers.
284pub struct GrpcBody {
285    data: Option<Bytes>,
286    trailers: Option<HeaderMap>,
287}
288
289impl http_body::Body for GrpcBody {
290    type Data = Bytes;
291    type Error = std::convert::Infallible;
292
293    fn poll_frame(
294        mut self: Pin<&mut Self>,
295        _cx: &mut Context<'_>,
296    ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>> {
297        if let Some(data) = self.data.take() {
298            if !data.is_empty() {
299                return Poll::Ready(Some(Ok(Frame::data(data))));
300            }
301        }
302        if let Some(trailers) = self.trailers.take() {
303            return Poll::Ready(Some(Ok(Frame::trailers(trailers))));
304        }
305        Poll::Ready(None)
306    }
307}