boardwalk 1.0.0

Hypermedia server framework with reverse-tunnel federation
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
404
405
406
407
408
409
410
//! Router-level coverage for serving local resource routes from the actor runtime.

use std::collections::BTreeMap;
use std::sync::Arc;

use axum::body::Body;
use axum::http::{Request as HttpRequest, StatusCode};
use serde_json::Value as JsonValue;
use tower::ServiceExt;

use crate::http::{Core, router};
use crate::runtime::{
    Actor, DynFuture, NodeBuilder, Resource, ResourceCtx, ResourceError, ResourceSnapshot,
    ResourceSpec, TransitionAffordance, TransitionCtx, TransitionError, TransitionInput,
    TransitionOutcome, TransitionSpec,
};

#[derive(Default)]
struct RuntimeLed {
    on: bool,
}

impl RuntimeLed {
    fn snapshot(&self) -> ResourceSnapshot {
        let state = if self.on { "on" } else { "off" };
        ResourceSnapshot {
            id: "placeholder".into(),
            kind: "led".into(),
            name: Some("Runtime LED".into()),
            state: Some(state.into()),
            node: "placeholder".into(),
            properties: serde_json::Map::new(),
            labels: BTreeMap::new(),
            transitions: vec![
                TransitionAffordance {
                    spec: TransitionSpec {
                        name: "turn-on".into(),
                        ..Default::default()
                    },
                    available: !self.on,
                    unavailable_reason: self.on.then_some("already on".into()),
                },
                TransitionAffordance {
                    spec: TransitionSpec {
                        name: "turn-off".into(),
                        ..Default::default()
                    },
                    available: self.on,
                    unavailable_reason: (!self.on).then_some("already off".into()),
                },
            ],
            streams: Vec::new(),
            revision: None,
            metadata: serde_json::Map::new(),
        }
    }
}

impl Resource for RuntimeLed {
    fn spec(&self) -> ResourceSpec {
        ResourceSpec {
            kind: "led".into(),
            name: Some("Runtime LED".into()),
            labels: BTreeMap::new(),
            property_schema: None,
            streams: Vec::new(),
        }
    }

    fn snapshot<'a>(
        &'a self,
        _ctx: ResourceCtx,
    ) -> DynFuture<'a, Result<ResourceSnapshot, ResourceError>> {
        Box::pin(async move { Ok(self.snapshot()) })
    }
}

impl Actor for RuntimeLed {
    fn transition<'a>(
        &'a mut self,
        _ctx: TransitionCtx,
        name: &'a str,
        _input: TransitionInput,
    ) -> DynFuture<'a, Result<TransitionOutcome, TransitionError>> {
        Box::pin(async move {
            match name {
                "turn-on" if !self.on => {
                    self.on = true;
                    Ok(TransitionOutcome::Completed {
                        output: None,
                        snapshot: self.snapshot(),
                    })
                }
                "turn-off" if self.on => {
                    self.on = false;
                    Ok(TransitionOutcome::Completed {
                        output: None,
                        snapshot: self.snapshot(),
                    })
                }
                other => Err(TransitionError::NotAllowed(format!(
                    "transition `{other}` is not available"
                ))),
            }
        })
    }
}

#[derive(Default)]
struct RefreshUnavailableLed {
    led: RuntimeLed,
    unavailable: bool,
}

impl Resource for RefreshUnavailableLed {
    fn spec(&self) -> ResourceSpec {
        self.led.spec()
    }

    fn snapshot<'a>(
        &'a self,
        _ctx: ResourceCtx,
    ) -> DynFuture<'a, Result<ResourceSnapshot, ResourceError>> {
        Box::pin(async move {
            if self.unavailable {
                return Err(ResourceError::Unavailable("runtime led unavailable".into()));
            }
            Ok(self.led.snapshot())
        })
    }
}

impl Actor for RefreshUnavailableLed {
    fn transition<'a>(
        &'a mut self,
        ctx: TransitionCtx,
        name: &'a str,
        input: TransitionInput,
    ) -> DynFuture<'a, Result<TransitionOutcome, TransitionError>> {
        Box::pin(async move {
            let outcome = self.led.transition(ctx, name, input).await?;
            self.unavailable = true;
            Ok(outcome)
        })
    }
}

struct UnavailableResource;

impl Resource for UnavailableResource {
    fn spec(&self) -> ResourceSpec {
        ResourceSpec {
            kind: "unavailable".into(),
            name: None,
            labels: BTreeMap::new(),
            property_schema: None,
            streams: Vec::new(),
        }
    }

    fn snapshot<'a>(
        &'a self,
        _ctx: ResourceCtx,
    ) -> DynFuture<'a, Result<ResourceSnapshot, ResourceError>> {
        Box::pin(async { Err(ResourceError::Unavailable("resource unavailable".into())) })
    }
}

impl Actor for UnavailableResource {
    fn transition<'a>(
        &'a mut self,
        _ctx: TransitionCtx,
        _name: &'a str,
        _input: TransitionInput,
    ) -> DynFuture<'a, Result<TransitionOutcome, TransitionError>> {
        Box::pin(async { Err(TransitionError::NotAllowed("unavailable".into())) })
    }
}

#[tokio::test]
async fn reusable_router_serves_actor_runtime_resources() {
    let node = Arc::new(NodeBuilder::new("hub").build());
    node.register_with_id("runtime-led".into(), RuntimeLed::default())
        .await
        .expect("actor registers");
    let app = router(Core::from_node(node));

    let response = app
        .clone()
        .oneshot(
            HttpRequest::builder()
                .uri("/resources")
                .body(Body::empty())
                .expect("resources request builds"),
        )
        .await
        .expect("resources request completes");
    assert_eq!(response.status(), StatusCode::OK);
    let body = response_json(response).await;
    assert_eq!(body["entities"][0]["properties"]["id"], "runtime-led");
    assert_eq!(body["entities"][0]["properties"]["kind"], "led");

    let response = app
        .clone()
        .oneshot(
            HttpRequest::builder()
                .uri("/resources/runtime-led")
                .body(Body::empty())
                .expect("resource request builds"),
        )
        .await
        .expect("resource request completes");
    assert_eq!(response.status(), StatusCode::OK);
    let body = response_json(response).await;
    assert_eq!(body["properties"]["id"], "runtime-led");
    assert_eq!(body["properties"]["state"], "off");
    assert_eq!(body["actions"][0]["name"], "turn-on");

    let response = app
        .clone()
        .oneshot(
            HttpRequest::builder()
                .uri("/resources?ql=where%20kind%20%3D%20%22led%22")
                .body(Body::empty())
                .expect("query request builds"),
        )
        .await
        .expect("query request completes");
    assert_eq!(response.status(), StatusCode::OK);
    let body = response_json(response).await;
    assert_eq!(
        body["class"],
        serde_json::json!(["resources", "search-results"])
    );
    assert_eq!(body["entities"][0]["properties"]["id"], "runtime-led");

    let response = app
        .clone()
        .oneshot(
            HttpRequest::builder()
                .uri("/resources?ql=where%20kind%20%3D")
                .body(Body::empty())
                .expect("invalid query request builds"),
        )
        .await
        .expect("invalid query request completes");
    assert_eq!(response.status(), StatusCode::BAD_REQUEST);
    let body = response_json(response).await;
    assert_eq!(body["error"], "query-parse-error");

    let response = app
        .clone()
        .oneshot(
            HttpRequest::builder()
                .uri("/meta")
                .body(Body::empty())
                .expect("metadata request builds"),
        )
        .await
        .expect("metadata request completes");
    assert_eq!(response.status(), StatusCode::OK);
    let body = response_json(response).await;
    let transitions = body["entities"][0]["properties"]["transitions"]
        .as_array()
        .expect("metadata transitions");
    let names: Vec<&str> = transitions
        .iter()
        .map(|transition| transition["name"].as_str().unwrap())
        .collect();
    assert_eq!(names, vec!["turn-on", "turn-off"]);

    let response = app
        .oneshot(
            HttpRequest::builder()
                .method("POST")
                .uri("/resources/runtime-led/transitions/turn-on")
                .header(http::header::CONTENT_TYPE, "application/json")
                .body(Body::from("{}"))
                .expect("transition request builds"),
        )
        .await
        .expect("transition request completes");
    assert_eq!(response.status(), StatusCode::OK);
    let body = response_json(response).await;
    assert_eq!(body["snapshot"]["id"], "runtime-led");
    assert_eq!(body["snapshot"]["state"], "on");
}

#[tokio::test]
async fn actor_runtime_resource_unavailable_maps_to_503() {
    let node = Arc::new(NodeBuilder::new("hub").build());
    node.register_with_id("offline".into(), UnavailableResource)
        .await
        .expect("actor registers");
    let app = router(Core::from_node(node));

    let response = app
        .oneshot(
            HttpRequest::builder()
                .uri("/resources/offline")
                .body(Body::empty())
                .expect("resource request builds"),
        )
        .await
        .expect("resource request completes");
    assert_eq!(response.status(), StatusCode::SERVICE_UNAVAILABLE);
    let body = response_json(response).await;
    assert_eq!(body["error"], "resource-unavailable");
}

#[tokio::test]
async fn unavailable_actor_remains_visible_in_list_query_and_meta() {
    let node = Arc::new(NodeBuilder::new("hub").build());
    node.register_with_id("offline".into(), UnavailableResource)
        .await
        .expect("actor registers");
    let app = router(Core::from_node(node));

    let response = app
        .clone()
        .oneshot(
            HttpRequest::builder()
                .uri("/resources")
                .body(Body::empty())
                .expect("resources request builds"),
        )
        .await
        .expect("resources request completes");
    assert_eq!(response.status(), StatusCode::OK);
    let body = response_json(response).await;
    assert_eq!(body["entities"][0]["properties"]["id"], "offline");
    assert_eq!(body["entities"][0]["properties"]["kind"], "unavailable");
    assert!(body["entities"][0]["properties"]["state"].is_null());

    let response = app
        .clone()
        .oneshot(
            HttpRequest::builder()
                .uri("/resources?ql=where%20kind%20%3D%20%22unavailable%22")
                .body(Body::empty())
                .expect("query request builds"),
        )
        .await
        .expect("query request completes");
    assert_eq!(response.status(), StatusCode::OK);
    let body = response_json(response).await;
    assert_eq!(body["entities"][0]["properties"]["id"], "offline");

    let response = app
        .clone()
        .oneshot(
            HttpRequest::builder()
                .uri("/meta")
                .body(Body::empty())
                .expect("metadata request builds"),
        )
        .await
        .expect("metadata request completes");
    assert_eq!(response.status(), StatusCode::OK);
    let body = response_json(response).await;
    assert_eq!(body["entities"][0]["properties"]["kind"], "unavailable");
    assert_eq!(
        body["entities"][0]["properties"]["transitions"],
        serde_json::json!([])
    );

    let response = app
        .oneshot(
            HttpRequest::builder()
                .uri("/meta/unavailable")
                .body(Body::empty())
                .expect("metadata type request builds"),
        )
        .await
        .expect("metadata type request completes");
    assert_eq!(response.status(), StatusCode::OK);
    let body = response_json(response).await;
    assert_eq!(body["properties"]["kind"], "unavailable");
}

#[tokio::test]
async fn actor_runtime_transition_snapshot_unavailable_maps_to_503() {
    let node = Arc::new(NodeBuilder::new("hub").build());
    node.register_with_id("flaky-led".into(), RefreshUnavailableLed::default())
        .await
        .expect("actor registers");
    let app = router(Core::from_node(node));

    let response = app
        .oneshot(
            HttpRequest::builder()
                .method("POST")
                .uri("/resources/flaky-led/transitions/turn-on")
                .header(http::header::CONTENT_TYPE, "application/json")
                .body(Body::from("{}"))
                .expect("transition request builds"),
        )
        .await
        .expect("transition request completes");
    assert_eq!(response.status(), StatusCode::SERVICE_UNAVAILABLE);
    let body = response_json(response).await;
    assert_eq!(body["error"], "resource-unavailable");
}

async fn response_json(resp: axum::response::Response) -> JsonValue {
    let bytes = axum::body::to_bytes(resp.into_body(), usize::MAX)
        .await
        .unwrap();
    serde_json::from_slice(&bytes).unwrap()
}