schemaui 0.11.0

A Rust library for generating TUI and Web UIs from JSON Schemas for configuration management.
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

use std::net::{IpAddr, SocketAddr, TcpListener};
use std::thread;
use std::time::{Duration, Instant};

use reqwest::StatusCode;
use reqwest::{Client, blocking::Client as BlockingClient};
use serde_json::json;

use crate::web::session::ServeOptions;
use crate::{FrontendOptions, SchemaUI};

fn reserve_port() -> u16 {
    let listener = TcpListener::bind(("127.0.0.1", 0)).expect("bind ephemeral port");
    let port = listener.local_addr().expect("listener addr").port();
    drop(listener);
    port
}

fn wait_until_ready(client: &BlockingClient, base_url: &str) {
    let deadline = Instant::now() + Duration::from_secs(5);
    let session_url = format!("{base_url}/api/session");

    loop {
        let outcome = match client.get(&session_url).send() {
            Ok(response) if response.status() == StatusCode::OK => return,
            Ok(response) => format!("unexpected status: {}", response.status()),
            Err(err) => err.to_string(),
        };

        assert!(
            Instant::now() < deadline,
            "web session did not become ready at {base_url}; last outcome: {}",
            outcome
        );
        thread::sleep(Duration::from_millis(50));
    }
}

#[test]
fn web_frontend_exit_does_not_panic_when_runtime_is_dropped() {
    let port = reserve_port();
    let addr = SocketAddr::from(([127, 0, 0, 1], port));
    let base_url = format!("http://{addr}");
    let expected = json!({ "name": "alice" });
    let schema = json!({
        "type": "object",
        "properties": {
            "name": { "type": "string" }
        }
    });

    let handle = thread::spawn(move || {
        SchemaUI::from_schema(schema).run(FrontendOptions::Web(ServeOptions {
            host: IpAddr::from([127, 0, 0, 1]),
            port,
        }))
    });

    let client = BlockingClient::builder()
        .no_proxy()
        .timeout(Duration::from_secs(2))
        .build()
        .expect("build blocking reqwest client");
    wait_until_ready(&client, &base_url);

    let response = client
        .post(format!("{base_url}/api/exit"))
        .json(&json!({
            "data": expected.clone(),
            "commit": true
        }))
        .send()
        .expect("post exit request");
    assert_eq!(response.status(), StatusCode::OK);

    let result = handle
        .join()
        .expect("web frontend thread should not panic")
        .expect("web frontend should return the committed payload");
    assert_eq!(result, expected);
}

#[tokio::test(flavor = "multi_thread")]
async fn web_frontend_async_runner_works_inside_existing_runtime() {
    let port = reserve_port();
    let base_url = format!("http://127.0.0.1:{port}");
    let expected = json!({ "name": "bob" });
    let schema = json!({
        "type": "object",
        "properties": {
            "name": { "type": "string" }
        }
    });

    let task = tokio::spawn(async move {
        SchemaUI::from_schema(schema)
            .run_web_async(ServeOptions {
                host: IpAddr::from([127, 0, 0, 1]),
                port,
            })
            .await
    });

    let client = Client::builder()
        .no_proxy()
        .timeout(Duration::from_secs(2))
        .build()
        .expect("build reqwest client");
    wait_until_ready_async(&client, &base_url).await;

    let response = client
        .post(format!("{base_url}/api/exit"))
        .json(&json!({
            "data": expected.clone(),
            "commit": true
        }))
        .send()
        .await
        .expect("post exit request");
    assert_eq!(response.status(), StatusCode::OK);

    let result = task
        .await
        .expect("web frontend task should not panic")
        .expect("web frontend should return the committed payload");
    assert_eq!(result, expected);
}

async fn wait_until_ready_async(client: &Client, base_url: &str) {
    let deadline = Instant::now() + Duration::from_secs(5);
    let session_url = format!("{base_url}/api/session");

    loop {
        let outcome = match client.get(&session_url).send().await {
            Ok(response) if response.status() == StatusCode::OK => return,
            Ok(response) => format!("unexpected status: {}", response.status()),
            Err(err) => err.to_string(),
        };

        assert!(
            Instant::now() < deadline,
            "web session did not become ready at {base_url}; last outcome: {}",
            outcome
        );
        tokio::time::sleep(Duration::from_millis(50)).await;
    }
}