progenitor-middleware-impl 0.12.4

An OpenAPI client generator - core implementation
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

// Copyright 2024 Oxide Computer Company

use dropshot::{
    endpoint, ApiDescription, Body, ConfigDropshot, ConfigLogging, ConfigLoggingLevel,
    EmptyScanParams, HttpError, HttpResponseOk, HttpResponseUpdatedNoContent, HttpServerStarter,
    PaginationParams, Path, Query, RequestContext, ResultsPage, TypedBody,
};
use futures::StreamExt;
use http::Response;
use openapiv3::OpenAPI;
use progenitor_middleware_impl::{space_out_items, GenerationSettings, Generator, InterfaceStyle};
use schemars::JsonSchema;
use serde::Deserialize;
use std::{
    net::{Ipv4Addr, SocketAddr},
    str::from_utf8,
    sync::{Arc, Mutex},
};

fn generate_formatted(generator: &mut Generator, spec: &OpenAPI) -> String {
    let content = generator.generate_tokens(spec).unwrap();
    let rustfmt_config = rustfmt_wrapper::config::Config {
        normalize_doc_attributes: Some(true),
        wrap_comments: Some(true),
        ..Default::default()
    };
    space_out_items(rustfmt_wrapper::rustfmt_config(rustfmt_config, content).unwrap()).unwrap()
}

#[allow(dead_code)]
#[derive(Deserialize, JsonSchema)]
struct CursedPath {
    #[serde(rename = "ref")]
    reef: String,
    #[serde(rename = "type")]
    tripe: String,
    #[serde(rename = "trait")]
    trade: String,
}

#[allow(dead_code)]
#[derive(Deserialize, JsonSchema)]
struct CursedQuery {
    #[serde(rename = "if")]
    iffy: String,
    #[serde(rename = "in")]
    inn: String,
    #[serde(rename = "use")]
    youse: String,
}

#[endpoint {
    method = GET,
    path = "/{ref}/{type}/{trait}",
}]
async fn renamed_parameters(
    _rqctx: RequestContext<()>,
    _path: Path<CursedPath>,
    _query: Query<CursedQuery>,
) -> Result<HttpResponseUpdatedNoContent, HttpError> {
    unreachable!();
}

/// Test parameters that conflict with Rust reserved words and therefore must
/// be renamed.
#[test]
fn test_renamed_parameters() {
    let mut api = ApiDescription::new();
    api.register(renamed_parameters).unwrap();

    let mut out = Vec::new();

    api.openapi("pagination-demo", semver::Version::new(9000, 0, 0))
        .write(&mut out)
        .unwrap();

    let out = from_utf8(&out).unwrap();

    let spec = serde_json::from_str::<OpenAPI>(out).unwrap();

    let mut generator = Generator::default();
    let output = generate_formatted(&mut generator, &spec);
    expectorate::assert_contents(
        format!("tests/output/src/{}.rs", "test_renamed_parameters"),
        &output,
    )
}

#[endpoint {
    method = GET,
    path = "/",
}]
async fn freeform_response(_rqctx: RequestContext<()>) -> Result<Response<Body>, HttpError> {
    unreachable!();
}

/// Test freeform responses.
#[test]
fn test_freeform_response() {
    let mut api = ApiDescription::new();
    api.register(freeform_response).unwrap();

    let mut out = Vec::new();

    api.openapi("pagination-demo", semver::Version::new(9000, 0, 0))
        .write(&mut out)
        .unwrap();

    let out = from_utf8(&out).unwrap();
    let spec = serde_json::from_str::<OpenAPI>(out).unwrap();

    let mut generator = Generator::default();
    let output = generate_formatted(&mut generator, &spec);
    expectorate::assert_contents(
        format!("tests/output/src/{}.rs", "test_freeform_response"),
        &output,
    )
}

#[derive(Deserialize, JsonSchema)]
#[allow(dead_code)]
struct BodyWithDefaults {
    s: String,
    #[serde(default)]
    yes: bool,
    #[serde(default = "forty_two", rename = "forty-two")]
    forty_two: u32,
    #[serde(default = "yes_yes")]
    something: Option<bool>,
}

fn forty_two() -> u32 {
    42
}

fn yes_yes() -> Option<bool> {
    Some(true)
}

#[endpoint {
    method = POST,
    path = "/",
}]
async fn default_params(
    _rqctx: RequestContext<()>,
    _body: TypedBody<BodyWithDefaults>,
) -> Result<Response<Body>, HttpError> {
    unreachable!();
}

/// Test default type values.
#[test]
fn test_default_params() {
    let mut api = ApiDescription::new();
    api.register(default_params).unwrap();

    let mut out = Vec::new();

    api.openapi("pagination-demo", semver::Version::new(9000, 0, 0))
        .write(&mut out)
        .unwrap();

    let out = from_utf8(&out).unwrap();
    let spec = serde_json::from_str::<OpenAPI>(out).unwrap();

    let mut generator = Generator::default();
    let output = generate_formatted(&mut generator, &spec);
    expectorate::assert_contents(
        format!("tests/output/src/{}.rs", "test_default_params_positional"),
        &output,
    );

    let mut generator =
        Generator::new(GenerationSettings::default().with_interface(InterfaceStyle::Builder));
    let output = generate_formatted(&mut generator, &spec);
    expectorate::assert_contents(
        format!("tests/output/src/{}.rs", "test_default_params_builder"),
        &output,
    );
}

#[derive(Debug)]
struct PaginatedU32sContext {
    all_values: std::ops::Range<u32>,
    // Record of `(offset, limit)` pairs we received
    page_pairs: Mutex<Vec<(usize, usize)>>,
}

#[endpoint {
    method = GET,
    path = "/",
}]
async fn paginated_u32s(
    rqctx: RequestContext<Arc<PaginatedU32sContext>>,
    query_params: Query<PaginationParams<EmptyScanParams, u32>>,
) -> Result<HttpResponseOk<ResultsPage<u32>>, HttpError> {
    let ctx = rqctx.context();
    let page_params = query_params.into_inner();
    let limit = usize::try_from(
        rqctx
            .page_limit(&page_params)
            .expect("invalid page limit")
            .get(),
    )
    .expect("non-usize limit");

    let offset = match page_params.page {
        dropshot::WhichPage::First(EmptyScanParams {}) => 0,
        dropshot::WhichPage::Next(offset) => usize::try_from(offset + 1).expect("non-usize offset"),
    };

    ctx.page_pairs.lock().unwrap().push((offset, limit));
    let values = ctx.all_values.clone().skip(offset).take(limit).collect();
    let result = ResultsPage::new(values, &(), |&x, &()| x).expect("bad results page");

    Ok(HttpResponseOk(result))
}

#[tokio::test]
async fn test_stream_pagination() {
    const TEST_NAME: &str = "test_stream_pagination";

    let mut api = ApiDescription::new();
    api.register(paginated_u32s).unwrap();

    let mut out = Vec::new();

    api.openapi(TEST_NAME, semver::Version::new(1, 0, 0))
        .write(&mut out)
        .unwrap();

    let out = from_utf8(&out).unwrap();
    let spec = serde_json::from_str::<OpenAPI>(out).unwrap();

    // Test both interface styles.
    let mut generator =
        Generator::new(GenerationSettings::new().with_interface(InterfaceStyle::Positional));
    let output = generate_formatted(&mut generator, &spec);
    expectorate::assert_contents(
        format!("tests/output/src/{TEST_NAME}_positional.rs"),
        &output,
    );
    let mut generator =
        Generator::new(GenerationSettings::new().with_interface(InterfaceStyle::Builder));
    let output = generate_formatted(&mut generator, &spec);
    expectorate::assert_contents(format!("tests/output/src/{TEST_NAME}_builder.rs"), &output);

    // Run the Dropshot server.
    let config_dropshot = ConfigDropshot {
        bind_address: SocketAddr::from((Ipv4Addr::LOCALHOST, 0)),
        ..Default::default()
    };
    let config_logging = ConfigLogging::StderrTerminal {
        level: ConfigLoggingLevel::Debug,
    };
    let log = config_logging
        .to_logger(TEST_NAME)
        .expect("failed to create logger");
    let server_ctx = Arc::new(PaginatedU32sContext {
        all_values: 0..35,
        page_pairs: Mutex::default(),
    });
    let server = HttpServerStarter::new(&config_dropshot, api, Arc::clone(&server_ctx), &log)
        .expect("failed to create server")
        .start();

    let server_addr = format!("http://{}", server.local_addr());

    // Test the positional client.
    #[allow(dead_code)]
    mod gen_client_positional {
        // This is weird: we're now `include!`ing the file we just used to
        // confirm the generated code is what we expect. If changes are made to
        // progenitor that affect this generated code, keep in mind that when
        // this test executes, the above check is against what we _currently_
        // produce, while this `include!` is what was on disk before the test
        // ran. This can be surprising if you're running the test with
        // `EXPECTORATE=overwrite`, because the above check will overwrite the
        // file on disk, but then the test proceeds and gets to this point,
        // where it uses what was on disk _before_ expectorate overwrote it.
        include!("output/src/test_stream_pagination_positional.rs");
    }

    let client = gen_client_positional::Client::new(&server_addr);

    let page_limit = 10.try_into().unwrap();
    let mut stream = client.paginated_u32s_stream(Some(page_limit));

    let mut all_values = Vec::new();
    while let Some(result) = stream.next().await {
        match result {
            Ok(value) => {
                all_values.push(value);
            }
            Err(err) => {
                panic!("unexpected error: {err}");
            }
        }
    }

    // Ensure we got all the results we expected.
    let expected_values = (0..35).collect::<Vec<_>>();
    assert_eq!(expected_values, all_values);

    // Ensure the server saw the page requests we expect: we should always see a
    // limit of 10, and we should see offsets increasing by 10 until we get to
    // (30, 10); that will return 5 items, so we should see one final (35, 10)
    // for the client to confirm there are no more results.
    let expected_pages = vec![(0, 10), (10, 10), (20, 10), (30, 10), (35, 10)];
    assert_eq!(expected_pages, *server_ctx.page_pairs.lock().unwrap());

    // Repeat the test with the builder client.
    server_ctx.page_pairs.lock().unwrap().clear();

    #[allow(dead_code, unused_imports)]
    mod gen_client_builder {
        // This is weird: we're now `include!`ing the file we just used to
        // confirm the generated code is what we expect. If changes are made to
        // progenitor that affect this generated code, keep in mind that when
        // this test executes, the above check is against what we _currently_
        // produce, while this `include!` is what was on disk before the test
        // ran. This can be surprising if you're running the test with
        // `EXPECTORATE=overwrite`, because the above check will overwrite the
        // file on disk, but then the test proceeds and gets to this point,
        // where it uses what was on disk _before_ expectorate overwrote it.
        include!("output/src/test_stream_pagination_builder.rs");
    }

    let client = gen_client_builder::Client::new(&server_addr);

    let mut stream = client.paginated_u32s().limit(page_limit).stream();

    let mut all_values = Vec::new();
    while let Some(result) = stream.next().await {
        match result {
            Ok(value) => {
                all_values.push(value);
            }
            Err(err) => {
                panic!("unexpected error: {err}");
            }
        }
    }

    // Ensure we got all the results we expected.
    let expected_values = (0..35).collect::<Vec<_>>();
    assert_eq!(expected_values, all_values);

    // Ensure the server saw the page requests we expect: we should always see a
    // limit of 10, and we should see offsets increasing by 10 until we get to
    // (30, 10); that will return 5 items, so we should see one final (35, 10)
    // for the client to confirm there are no more results.
    let expected_pages = vec![(0, 10), (10, 10), (20, 10), (30, 10), (35, 10)];
    assert_eq!(expected_pages, *server_ctx.page_pairs.lock().unwrap());

    server.close().await.expect("failed to close server");
}