navactor 0.5.3

A cli tool for creating and updating actors from piped input
Documentation
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
#![allow(clippy::useless_let_if_seq)]
use crate::actors::actor::Handle;
use crate::actors::genes::gene::GeneType;
use crate::actors::message::Message;
use crate::actors::message::MtHint;
use crate::utils::nvtime::extract_datetime;
use poem::{
    http::StatusCode, listener::TcpListener, web::Data, EndpointExt, Error, FromRequest, Request,
    RequestBody, Result, Route,
};
use std::ops::Deref;

use poem_openapi::{
    param::Path,
    payload::{Json, PlainText},
    ApiResponse, Object, OpenApi, OpenApiService,
};
use std::collections::HashMap;
use std::fmt;
use std::sync::Arc;
use tracing::debug;
use tracing::info;

pub struct HttpServerConfig {
    pub port: u16,
    pub interface: String,
    pub external_host: String,
    pub namespace: String,
}

impl HttpServerConfig {
    #[must_use]
    pub fn new(
        port: Option<u16>,
        interface: Option<String>,
        external_host: Option<String>,
        namespace: String,
    ) -> Self {
        Self {
            port: port.unwrap_or(8800),
            interface: interface.unwrap_or_else(|| "127.0.0.1".to_string()),
            external_host: external_host.unwrap_or_else(|| "http://localhost:8800".to_string()),
            namespace,
        }
    }
}

impl fmt::Display for HttpServerConfig {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "[{} on {}:{} as {}]",
            self.namespace, self.interface, self.port, self.external_host
        )
    }
}

#[derive(Object)]
pub struct ApiObservations {
    pub datetime: String,
    pub values: HashMap<i32, f64>,
    pub path: String,
}

#[derive(Object)]
struct ApiStateReport {
    datetime: String,
    path: String,
    values: HashMap<i32, f64>,
}

#[derive(Object)]
struct ApiGeneMapping {
    path: String,
    gene_type: String,
}

#[derive(ApiResponse)]
enum PostObservationResponse {
    #[oai(status = 200)]
    ApiStateReport(Json<ApiStateReport>),

    #[oai(status = 404)]
    NotFound(PlainText<String>),

    #[oai(status = 400)]
    BadRequest(PlainText<String>),

    #[oai(status = 409)]
    ConstraintViolation(PlainText<String>),

    #[oai(status = 500)]
    InternalServerError(PlainText<String>),
}

#[derive(ApiResponse)]
enum GetStateResponse {
    #[oai(status = 200)]
    ApiStateReport(Json<ApiStateReport>),

    #[oai(status = 404)]
    NotFound(PlainText<String>),

    #[oai(status = 500)]
    InternalServerError(PlainText<String>),
}

#[derive(ApiResponse)]
enum GetGeneMappingResponse {
    #[oai(status = 200)]
    ApiGeneMapping(Json<ApiGeneMapping>),

    #[oai(status = 404)]
    NotFound(PlainText<String>),

    #[oai(status = 500)]
    InternalServerError(PlainText<String>),
}

#[derive(ApiResponse)]
enum PostGeneMappingResponse {
    #[oai(status = 200)]
    ApiGeneMapping(Json<ApiGeneMapping>),

    #[oai(status = 409)]
    ConstraintViolation(PlainText<String>),

    #[oai(status = 500)]
    InternalServerError(PlainText<String>),
}

fn prepend_slash(mut s: String) -> String {
    if !s.starts_with('/') {
        s.insert(0, '/');
    }
    s
}

pub struct SharedHandle(Arc<Handle>);

impl Deref for SharedHandle {
    type Target = Handle;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

#[poem::async_trait]
impl<'a> FromRequest<'a> for SharedHandle {
    async fn from_request(req: &'a Request, _body: &mut RequestBody) -> Result<Self> {
        debug!("from_request");

        req.data::<Arc<Handle>>().map_or_else(
            || {
                Err(Error::from_string(
                    "error",
                    StatusCode::INTERNAL_SERVER_ERROR,
                ))
            },
            |shared_handle| Ok(Self(Arc::clone(shared_handle))),
        )
    }
}

struct ActorsApi;

#[OpenApi]
impl ActorsApi {
    #[oai(path = "/:namespace<.+/>:id", method = "get")]
    async fn get_state(
        &self,
        nv: Data<&SharedHandle>,
        namespace: Path<String>,
        id: Path<String>,
    ) -> Result<GetStateResponse, poem::Error> {
        let fullpath = format!("{}{}", namespace.as_str(), id.as_str());
        let fullpath = prepend_slash(fullpath);
        debug!("get state for {}", fullpath);
        // query state of actor one from above updates
        let cmd = Message::Query {
            path: fullpath,
            hint: MtHint::State,
        };
        match nv.ask(cmd).await {
            Ok(Message::StateReport {
                datetime: _,
                path: _,
                values,
            }) if values.is_empty() => Ok(GetStateResponse::NotFound(PlainText(format!(
                "No observations for id `{}`",
                id.0
            )))),
            Ok(Message::StateReport {
                datetime,
                path,
                values,
            }) => Ok(GetStateResponse::ApiStateReport(Json(ApiStateReport {
                datetime: datetime.to_string(),
                path,
                values,
            }))),
            m => Ok(GetStateResponse::InternalServerError(PlainText(format!(
                "server error for id {}: {:?}",
                id.0, m
            )))),
        }
    }

    #[oai(path = "/:namespace<.+/>:id", method = "post")]
    async fn post_observations(
        &self,
        nv: Data<&SharedHandle>,
        namespace: Path<String>,
        id: Path<String>,
        body: Json<ApiObservations>,
    ) -> Result<PostObservationResponse, poem::Error> {
        let ns = namespace.trim_end_matches('/').to_string();
        let ns = prepend_slash(ns);
        debug!("post observations {}/{}", ns, id.as_str());
        // record observation
        if let Ok(dt) = extract_datetime(&body.0.datetime) {
            let cmd = Message::Observations {
                path: body.0.path,
                datetime: dt,
                values: body.0.values,
            };

            match nv.ask(cmd).await {
                Ok(Message::StateReport {
                    datetime: _,
                    path: _,
                    values,
                }) if values.is_empty() => Ok(PostObservationResponse::NotFound(PlainText(
                    format!("No actor resurected with id `{}`", id.0),
                ))),
                Ok(Message::StateReport {
                    datetime,
                    path,
                    values,
                }) => Ok(PostObservationResponse::ApiStateReport(Json(
                    ApiStateReport {
                        datetime: datetime.to_string(),
                        path,
                        values,
                    },
                ))),
                Ok(Message::ConstraintViolation {}) => {
                    Ok(PostObservationResponse::ConstraintViolation(PlainText(
                        format!("contraint violation with id {}", id.0),
                    )))
                }
                e => Ok(PostObservationResponse::InternalServerError(PlainText(
                    format!("server error with id {}: {:?}", id.0, e),
                ))),
            }
        } else {
            // TODO: how can this be located near the parse???
            Ok(PostObservationResponse::BadRequest(PlainText(format!(
                "cannot parse datetime {} for id {}",
                body.0.datetime, id.0
            ))))
        }
    }
}

fn extract_gene_type(gene_type_str: &str) -> GeneType {
    match gene_type_str {
        "Gauge" => GeneType::Gauge,
        "Accum" => GeneType::Accum,
        _ => GeneType::GaugeAndAccum,
    }
}

struct GenesApi;

#[OpenApi]
impl GenesApi {
    #[oai(path = "/:namespace<.+/>:id", method = "get")]
    async fn get_gene(
        &self,
        nv: Data<&SharedHandle>,
        namespace: Path<String>,
        id: Path<String>,
    ) -> Result<GetGeneMappingResponse, poem::Error> {
        let fullpath = format!("{}{}", namespace.as_str(), id.as_str());
        let fullpath = prepend_slash(fullpath);
        debug!("get gene for {}", fullpath);
        // query state of actor one from above updates
        let cmd: Message<f64> = Message::Content {
            path: Some(fullpath),
            text: String::new(),
            hint: MtHint::GeneMappingQuery,
        };
        match nv.ask(cmd).await {
            Ok(Message::GeneMapping { path, gene_type }) => Ok(
                GetGeneMappingResponse::ApiGeneMapping(Json(ApiGeneMapping {
                    path,
                    gene_type: gene_type.to_string(),
                })),
            ),
            Ok(Message::NotFound { path }) => Ok(GetGeneMappingResponse::NotFound(PlainText(
                format!("No gene mapping for `{path}`"),
            ))),

            m => Ok(GetGeneMappingResponse::InternalServerError(PlainText(
                format!("server error for path {}: {:?}", id.0, m),
            ))),
        }
    }

    #[oai(path = "/:namespace<.+/>:id", method = "post")]
    async fn post_gene_mapping(
        &self,
        nv: Data<&SharedHandle>,
        namespace: Path<String>,
        id: Path<String>,
        body: Json<ApiGeneMapping>,
    ) -> Result<PostGeneMappingResponse, poem::Error> {
        let fullpath = format!("{}{}", namespace.as_str(), id.as_str());
        let fullpath = prepend_slash(fullpath);
        debug!("post gene mapping for {fullpath}");

        let cmd = Message::GeneMapping {
            path: fullpath,
            gene_type: extract_gene_type(&body.0.gene_type),
        };

        match nv.ask(cmd).await {
            Ok(Message::GeneMapping { path, gene_type }) => Ok(
                PostGeneMappingResponse::ApiGeneMapping(Json(ApiGeneMapping {
                    path,
                    gene_type: gene_type.to_string(),
                })),
            ),
            Ok(Message::ConstraintViolation {}) => {
                Ok(PostGeneMappingResponse::ConstraintViolation(PlainText(
                    format!("contraint violation with id {}", id.0),
                )))
            }
            e => Ok(PostGeneMappingResponse::InternalServerError(PlainText(
                format!("server error with id {}: {:?}", id.0, e),
            ))),
        }
    }
}

impl Clone for SharedHandle {
    fn clone(&self) -> Self {
        Self(Arc::clone(&self.0))
    }
}

/// start a server on port and interface
///
/// # Errors
///
/// Returns `Err` if server can not be started
pub async fn serve<'a>(
    nv: Arc<Handle>,
    server_config: HttpServerConfig,
    uipath: Option<String>,
    disable_ui: Option<bool>,
) -> Result<(), std::io::Error> {
    info!("starting server: {server_config}");

    let disui = disable_ui.unwrap_or(false);
    let ifc_host_str = format!("{}:{}", server_config.interface, server_config.port);
    let swagger_api_target = format!("{}/api", server_config.external_host);

    let actors_service =
        OpenApiService::new(ActorsApi, clap::crate_name!(), clap::crate_version!())
            .server(swagger_api_target.clone());

    let genes_service = OpenApiService::new(GenesApi, clap::crate_name!(), clap::crate_version!())
        .server(swagger_api_target.clone());

    let app = {
        if disui {
            Route::new()
                .nest("/api/actors", actors_service)
                .nest("/api/genes", genes_service)
                .data(SharedHandle(nv.clone()))
        } else {
            let uip = uipath
                .unwrap_or_default()
                .trim_start_matches('/')
                .to_string();
            let actors_ui = actors_service.swagger_ui();
            let genes_ui = genes_service.swagger_ui();
            Route::new()
                .nest(format!("/{uip}/actors"), actors_ui)
                .nest(format!("/{uip}/genes"), genes_ui)
                .nest("/api/actors", actors_service)
                .nest("/api/genes", genes_service)
                .data(SharedHandle(nv.clone()))
        }
    };

    let server = poem::Server::new(TcpListener::bind(ifc_host_str)).run(app);
    info!("navactor API is available at {}.", swagger_api_target);
    server.await
}