http-mel 0.10.0

Mélodium HTTP library
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
use crate::method::*;
use crate::status::*;
use async_ringbuf::{AsyncHeapRb, AsyncProducer, AsyncRb};
use async_std::sync::{Arc as AsyncArc, Barrier as AsyncBarrier, RwLock as AsyncRwLock};
use core::{fmt::Debug, mem::MaybeUninit};
use melodium_core::{common::executive::ResultStatus, *};
use melodium_macro::{mel_context, mel_model, mel_treatment};
use net_mel::ip::*;
use ringbuf::SharedRb;
use routefinder::RouteSpec;
use routefinder::Segment;
use std::sync::Arc;
use std::{
    collections::HashMap,
    sync::{RwLock, Weak},
};
use std_mel::data::string_map::*;
use trillium::HeaderName;
use trillium::HeaderValue;
use trillium::KnownHeaderName;
use trillium::{Body, Conn};
use trillium::{Method, Status};
use trillium_router::{Router, RouterConnExt};
use uuid::Uuid;

pub const SERVER: &str = concat!("http-mel/", env!("CARGO_PKG_VERSION"));

/// Describes HTTP request data.
///
/// - `id`: identifier of connection, it is an arbitrary number that uniquely identifies a HTTP connection to a server.
/// - `route`: the route used by the request.
/// - `path`: the path called by the request.
/// - `parameters`: the parameters from the route.
/// - `method`: the HTTP method used by the request.
#[mel_context]
pub struct HttpRequest {
    pub id: u128,
    pub route: string,
    pub path: string,
    pub parameters: StringMap,
    pub method: HttpMethod,
}

type AsyncProducerStatus =
    AsyncProducer<Status, Arc<AsyncRb<Status, SharedRb<Status, Vec<MaybeUninit<Status>>>>>>;
type AsyncProducerHeaders = AsyncProducer<
    StringMap,
    Arc<AsyncRb<StringMap, SharedRb<StringMap, Vec<MaybeUninit<StringMap>>>>>,
>;
type AsyncProducerOutgoing =
    AsyncProducer<u8, Arc<AsyncRb<u8, SharedRb<u8, Vec<MaybeUninit<u8>>>>>>;

/// A HTTP server for general use.
///
/// The HTTP server provides configuration for receiving and responding to HTTP incoming requests.
/// - `host`: the network address to bind with.
/// - `port`: the port to bind with.
///
/// `HttpServer` aims to be used with `connection` treatment.
/// Every time a new HTTP request matching a configured route comes, a new track is created with `@HttpRequest` context.
///
/// ℹ️ If server binding fails, `failedBinding` is emitted.
///
/// ⚠️ Use `HttpServer` with `connection` treatment, as using `incoming` source and `outgoing` treatment directly should be done carefully.
///
#[mel_model(
    param host Ip none
    param port u16 none
    source incoming (HttpRequest) (
        param method HttpMethod none
        param route string none
    ) (
        started Block<void>
        headers Block<StringMap>
        data Stream<byte>
        finished Block<void>
        completed Block<void>
        failed Block<void>
        error Block<string>
    )
    source failedBinding () () (
        failed Block<void>
        error Block<string>
    )
    continuous (continuous)
    shutdown shutdown
)]
pub struct HttpServer {
    model: Weak<HttpServerModel>,
    launch_barrier: AsyncArc<AsyncBarrier>,
    routes: RwLock<Vec<(Arc<HttpMethod>, String)>>,
    status: AsyncArc<AsyncRwLock<HashMap<Uuid, AsyncProducerStatus>>>,
    headers: AsyncArc<AsyncRwLock<HashMap<Uuid, AsyncProducerHeaders>>>,
    outgoing: AsyncArc<AsyncRwLock<HashMap<Uuid, AsyncProducerOutgoing>>>,
    #[cfg(feature = "real")]
    shutdown: trillium_async_std::Stopper,
}

impl Debug for HttpServer {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        #[cfg(feature = "real")]
        {
            f.debug_struct("HttpServer")
                .field("model", &self.model)
                .field("routes", &self.routes)
                .field("shutdown", &self.shutdown)
                .finish()
        }

        #[cfg(not(feature = "real"))]
        {
            f.debug_struct("HttpServer")
                .field("model", &self.model)
                .field("routes", &self.routes)
                .finish()
        }
    }
}

impl HttpServer {
    pub fn new(model: Weak<HttpServerModel>) -> Self {
        Self {
            model,
            launch_barrier: AsyncArc::new(AsyncBarrier::new(2)),
            routes: RwLock::new(Vec::new()),
            status: AsyncArc::new(AsyncRwLock::new(HashMap::new())),
            headers: AsyncArc::new(AsyncRwLock::new(HashMap::new())),
            outgoing: AsyncArc::new(AsyncRwLock::new(HashMap::new())),
            #[cfg(feature = "real")]
            shutdown: trillium_async_std::Stopper::new(),
        }
    }

    pub fn statuses(&self) -> AsyncArc<AsyncRwLock<HashMap<Uuid, AsyncProducerStatus>>> {
        AsyncArc::clone(&self.status)
    }

    pub fn headers(&self) -> AsyncArc<AsyncRwLock<HashMap<Uuid, AsyncProducerHeaders>>> {
        AsyncArc::clone(&self.headers)
    }

    pub fn outgoing(&self) -> AsyncArc<AsyncRwLock<HashMap<Uuid, AsyncProducerOutgoing>>> {
        AsyncArc::clone(&self.outgoing)
    }

    #[cfg(feature = "real")]
    async fn continuous(&self) {
        let model = self.model.upgrade().unwrap();

        self.launch_barrier.wait().await;

        let routes = self.routes.read().unwrap().clone();

        let status = self.status.clone();
        let headers = self.headers.clone();
        let outgoing = self.outgoing.clone();

        let mut router = Router::new();
        for (method, route) in routes {
            let route = match RouteSpec::try_from(route.as_str()) {
                Ok(route) => route,
                Err(_) => continue,
            };

            let handler = {
                let route = Arc::new(route.clone());
                let status = Arc::clone(&status);
                let headers = Arc::clone(&headers);
                let outgoing = Arc::clone(&outgoing);
                let model = Arc::clone(&model);
                let method = Arc::clone(&method);

                move |mut conn: Conn| {
                    let route = Arc::clone(&route);
                    let status = Arc::clone(&status);
                    let headers = Arc::clone(&headers);
                    let outgoing = Arc::clone(&outgoing);
                    let model = Arc::clone(&model);
                    let method = Arc::clone(&method);

                    async move {
                        let id = Uuid::new_v4();
                        let http_request = HttpRequest {
                            id: id.as_u128(),
                            route: conn.route().map(|r| r.to_string()).unwrap_or_default(),
                            path: conn.path().to_string(),
                            parameters: StringMap::new_with(
                                route
                                    .segments()
                                    .iter()
                                    .filter_map(|seg| {
                                        if let Segment::Param(param) = seg {
                                            conn.param(param)
                                                .map(|v| (param.to_string(), v.to_string()))
                                        } else {
                                            None
                                        }
                                    })
                                    .collect(),
                            ),
                            method: (*method).clone(),
                        };

                        let params = {
                            let mut params = HashMap::new();
                            params.insert(
                                "method".to_string(),
                                Value::Data(Arc::clone(&method) as Arc<dyn Data>),
                            );
                            params.insert("route".to_string(), route.to_string().into());
                            params
                        };

                        let status_buf = AsyncHeapRb::<Status>::new(1);
                        let (status_prod, mut status_cons) = status_buf.split();
                        let headers_buf = AsyncHeapRb::<StringMap>::new(1);
                        let (headers_prod, mut headers_cons) = headers_buf.split();
                        let outgoing_buf = AsyncHeapRb::<u8>::new(2usize.pow(20));
                        let (prod, cons) = outgoing_buf.split();

                        status.write().await.insert(id, status_prod);
                        headers.write().await.insert(id, headers_prod);
                        outgoing.write().await.insert(id, prod);

                        let incoming_headers = conn
                            .request_headers()
                            .iter()
                            .filter_map(|(name, value)| {
                                value
                                    .as_str()
                                    .map(|value| (name.to_string(), value.to_string()))
                            })
                            .collect();

                        // For now the reading of request is "one-shot", not allowing effective streaming of very large incoming requests.
                        let body = conn.request_body().await;
                        let (content, occured_failure) = match body.read_bytes().await {
                            Ok(content) => (content, None),
                            Err(err) => (Vec::new(), Some(err.to_string())),
                        };

                        model
                            .new_incoming(
                                None,
                                http_request,
                                &params,
                                Some(Box::new(move |mut outputs| {
                                    let started = outputs.get("started");
                                    let headers = outputs.get("headers");
                                    let data = outputs.get("data");
                                    let completed = outputs.get("completed");
                                    let failed = outputs.get("failed");
                                    let finished = outputs.get("finished");
                                    let error = outputs.get("error");

                                    vec![Box::new(Box::pin(async move {
                                        if let Some(occured_failure) = occured_failure {
                                            let _ = failed.send_one(().into()).await;
                                            let _ = error.send_one(occured_failure.into()).await;
                                        } else {
                                            let _ = started.send_one(().into()).await;
                                            started.close().await;
                                            let _ = headers
                                                .send_one(Value::Data(
                                                    Arc::new(StringMap::new_with(incoming_headers))
                                                        as Arc<dyn Data>,
                                                ))
                                                .await;
                                            headers.close().await;
                                            let _ = data
                                                .send_many(TransmissionValue::Byte(content.into()))
                                                .await;
                                            let _ = completed.send_one(().into()).await;
                                        }
                                        let _ = finished.send_one(().into()).await;

                                        headers.close().await;
                                        data.close().await;
                                        completed.close().await;
                                        finished.close().await;
                                        failed.close().await;
                                        error.close().await;
                                        ResultStatus::Ok
                                    }))]
                                })),
                            )
                            .await;

                        if let (Some(status), Some(headers)) =
                            futures::join!(status_cons.pop(), headers_cons.pop())
                        {
                            conn.set_status(status);
                            conn.response_headers_mut()
                                .insert(KnownHeaderName::Server, SERVER);

                            for (name, content) in &headers.map {
                                let header_name = HeaderName::from(name.to_string());
                                if header_name.is_valid() {
                                    let header_content = HeaderValue::from(content.clone());
                                    if header_content.is_valid() {
                                        conn.response_headers_mut()
                                            .insert(header_name.to_owned(), header_content);
                                    }
                                }
                            }

                            conn.set_body(Body::new_streaming(cons, None));
                        } else {
                            conn.set_status(Status::InternalServerError);
                        }

                        conn.halt()
                    }
                }
            };

            match method.0 {
                Method::Delete => router = router.delete(route, handler),
                Method::Get => router = router.get(route, handler),
                Method::Patch => router = router.patch(route, handler),
                Method::Post => router = router.post(route, handler),
                Method::Put => router = router.put(route, handler),
                _ => {}
            }
        }

        match async_std::net::TcpListener::bind((model.get_host().0, model.get_port())).await {
            Ok(listener) => {
                trillium_async_std::config()
                    .without_signals()
                    .with_stopper(self.shutdown.clone())
                    .with_prebound_server(listener)
                    .run_async(router)
                    .await
            }
            Err(err) => {
                model
                    .new_failedBinding(
                        None,
                        &HashMap::new(),
                        Some(Box::new(move |mut outputs| {
                            let error = outputs.get("error");
                            let failed = outputs.get("failed");
                            vec![Box::new(Box::pin(async move {
                                let _ = failed.send_one(().into()).await;
                                let _ = error.send_one(err.to_string().into()).await;
                                failed.close().await;
                                error.close().await;
                                ResultStatus::Ok
                            }))]
                        })),
                    )
                    .await
            }
        }
    }

    #[cfg(not(feature = "real"))]
    async fn continuous(&self) {}

    fn invoke_source(&self, source: &str, params: HashMap<String, Value>) {
        match source {
            "incoming" => {
                let method: Arc<HttpMethod> = melodium_core::GetData::<Arc<dyn Data>>::try_data(
                    params.get("method").unwrap().clone(),
                )
                .unwrap()
                .downcast_arc()
                .unwrap();
                let route = melodium_core::GetData::<String>::try_data(
                    params.get("route").unwrap().clone(),
                )
                .unwrap();

                self.routes.write().unwrap().push((method, route));
            }
            _ => {}
        }
    }

    fn shutdown(&self) {
        #[cfg(feature = "real")]
        self.shutdown.stop();
    }
}

#[mel_treatment(
    model http_server HttpServer
    input trigger Block<void>
)]
pub async fn start() {
    let model = HttpServerModel::into(http_server);
    let http_server = model.inner();

    if let Ok(_) = trigger.recv_one().await {
        http_server.launch_barrier.wait().await;
    }
}

#[mel_treatment(
    input status Block<HttpStatus>
    input headers Block<StringMap>
    input data Stream<byte>
    model http_server HttpServer
)]
pub async fn outgoing(id: u128) {
    let id = Uuid::from_u128(id);
    let model = HttpServerModel::into(http_server);
    let http_server = model.inner();

    let out_status;
    let out_headers;
    let output;
    {
        let statuses = http_server.statuses();
        let mut lock = statuses.write().await;
        out_status = lock.remove(&id);
    }
    {
        let headers = http_server.headers();
        let mut lock = headers.write().await;
        out_headers = lock.remove(&id);
    }
    {
        let outputs = http_server.outgoing();
        let mut lock = outputs.write().await;
        output = lock.remove(&id);
    }
    if let (Some(mut out_status), Some(mut out_headers), Some(mut output)) =
        (out_status, out_headers, output)
    {
        if let (Ok(status), Ok(headers)) = (
            status.recv_one().await.map(|val| {
                GetData::<Arc<dyn Data>>::try_data(val)
                    .unwrap()
                    .downcast_arc::<HttpStatus>()
                    .unwrap()
            }),
            headers.recv_one().await.map(|val| {
                GetData::<Arc<dyn Data>>::try_data(val)
                    .unwrap()
                    .downcast_arc::<StringMap>()
                    .unwrap()
            }),
        ) {
            match futures::join!(
                out_status.push(status.0),
                out_headers.push(Arc::unwrap_or_clone(headers))
            ) {
                (Ok(_), Ok(_)) => {
                    while let (Ok(data), false) = (
                        data.recv_many()
                            .await
                            .map(|values| TryInto::<Vec<byte>>::try_into(values).unwrap()),
                        output.is_closed(),
                    ) {
                        match output.push_iter(data.into_iter()).await {
                            Ok(_) => {}
                            Err(_) => break,
                        }
                    }
                }
                (_, _) => {}
            }
        }
    }
}