olai-codegen 0.0.9

Proto-driven code generation for REST handlers, clients, and resource registries
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
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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
use std::path::PathBuf;

use olai_codegen::parsing::parse_file_descriptor_set;
use olai_codegen::{BindingsConfig, CodeGenConfig, CodeGenOutput, generate_code};
use protobuf::Message;
use protobuf::descriptor::FileDescriptorSet;
use tempfile::TempDir;

fn load_descriptor() -> FileDescriptorSet {
    let bytes = include_bytes!("../proto/example.bin");
    FileDescriptorSet::parse_from_bytes(bytes).expect("valid descriptor")
}

fn make_test_config(
    common: PathBuf,
    node_ts: PathBuf,
    python: PathBuf,
    node: PathBuf,
) -> CodeGenConfig {
    CodeGenConfig {
        context_type_path: "crate::Context".to_string(),
        result_type_path: "crate::Result".to_string(),
        models_path_template: "example_common::models::{service}::v1".to_string(),
        models_path_crate_template: "crate::models::{service}::v1".to_string(),
        resource_store_crate_name: "olai_store".to_string(),
        runtime: olai_codegen::Runtime::Prost,
        transport_type_path: olai_codegen::DEFAULT_TRANSPORT_TYPE_PATH.to_string(),
        dual_transport: false,
        client_protocols: olai_codegen::ClientProtocols::default(),
        connect_client_path: None,
        output: CodeGenOutput {
            common,
            models: None,
            models_subdir: "_gen".to_string(),
            server: None,
            client: None,
            python: Some(python),
            node: Some(node),
            node_ts: Some(node_ts),
            wasm: None,
            python_typings_filename: "example_client.pyi".to_string(),
            generate_resource_clients: false,
        },
        generate_resource_enum: false,
        generate_store_integration: false,
        error_type_path: None,
        generate_object_conversions: false,
        bindings: Some(BindingsConfig {
            aggregate_client_name: "ExampleClient".to_string(),
            client_crate_name: "example_client".to_string(),
            py_error_type: "PyExampleError".to_string(),
            py_result_type: "PyExampleResult".to_string(),
            python_api: olai_codegen::PythonApi::Both,
            napi_error_ext_trait: "NapiErrorExt".to_string(),
            typings_package_filter: Some(".example.".to_string()),
            ts_error_base_class: "ExampleError".to_string(),
            ts_error_code_prefix: "EX".to_string(),
        }),
    }
}

fn collect_generated_files(dir: &std::path::Path) -> Vec<String> {
    let mut contents = Vec::new();
    for entry in walkdir(dir) {
        if entry.is_file()
            && let Ok(text) = std::fs::read_to_string(&entry)
        {
            contents.push(text);
        }
    }
    contents
}

fn walkdir(dir: &std::path::Path) -> Vec<PathBuf> {
    let mut files = Vec::new();
    if let Ok(entries) = std::fs::read_dir(dir) {
        for entry in entries.flatten() {
            let path = entry.path();
            if path.is_dir() {
                files.extend(walkdir(&path));
            } else {
                files.push(path);
            }
        }
    }
    files
}

#[test]
fn test_codegen_produces_no_unitycatalog_strings() {
    let descriptor = load_descriptor();
    let metadata = parse_file_descriptor_set(&descriptor).expect("parse succeeded");

    let tmp = TempDir::new().expect("tempdir");
    let common_dir = tmp.path().join("common");
    let node_ts_dir = tmp.path().join("node_ts");
    let python_dir = tmp.path().join("python");
    let node_dir = tmp.path().join("node");

    for dir in &[&common_dir, &node_ts_dir, &python_dir, &node_dir] {
        std::fs::create_dir_all(dir).expect("create dir");
    }

    let config = make_test_config(
        common_dir.clone(),
        node_ts_dir.clone(),
        python_dir.clone(),
        node_dir.clone(),
    );

    generate_code(&metadata, &config).expect("generate_code succeeded");

    let all_dirs = [&common_dir, &node_ts_dir, &python_dir, &node_dir];
    let all_files: Vec<String> = all_dirs
        .iter()
        .flat_map(|d| collect_generated_files(d))
        .collect();

    assert!(
        !all_files.is_empty(),
        "expected generated files to be written"
    );

    for content in &all_files {
        let lower = content.to_lowercase();
        assert!(
            !lower.contains("unitycatalog"),
            "generated output contains 'unitycatalog': {content:.200}"
        );
        assert!(
            !lower.contains("pyunitycatalog"),
            "generated output contains 'pyunitycatalog'"
        );
        assert!(
            !lower.contains("napiunitycatalog"),
            "generated output contains 'napiunitycatalog'"
        );
    }
}

#[test]
fn test_codegen_uses_configured_error_base_class() {
    let descriptor = load_descriptor();
    let metadata = parse_file_descriptor_set(&descriptor).expect("parse succeeded");

    let tmp = TempDir::new().expect("tempdir");
    let common_dir = tmp.path().join("common");
    let node_ts_dir = tmp.path().join("node_ts");
    let python_dir = tmp.path().join("python");
    let node_dir = tmp.path().join("node");

    for dir in &[&common_dir, &node_ts_dir, &python_dir, &node_dir] {
        std::fs::create_dir_all(dir).expect("create dir");
    }

    let config = make_test_config(common_dir, node_ts_dir.clone(), python_dir, node_dir);

    generate_code(&metadata, &config).expect("generate_code succeeded");

    let ts_files = collect_generated_files(&node_ts_dir);
    assert!(!ts_files.is_empty(), "expected TypeScript files");

    let client_ts = ts_files
        .iter()
        .find(|f| f.contains("ExampleError"))
        .expect("expected ExampleError in TypeScript output");

    assert!(
        client_ts.contains("ExampleError"),
        "TypeScript output should use configured error base class"
    );
    assert!(
        client_ts.contains("EX:"),
        "TypeScript output should use configured error code prefix in regex"
    );
}

#[test]
fn test_codegen_uses_configured_aggregate_client_name() {
    let descriptor = load_descriptor();
    let metadata = parse_file_descriptor_set(&descriptor).expect("parse succeeded");

    let tmp = TempDir::new().expect("tempdir");
    let common_dir = tmp.path().join("common");
    let node_ts_dir = tmp.path().join("node_ts");
    let python_dir = tmp.path().join("python");
    let node_dir = tmp.path().join("node");

    for dir in &[&common_dir, &node_ts_dir, &python_dir, &node_dir] {
        std::fs::create_dir_all(dir).expect("create dir");
    }

    let config = make_test_config(
        common_dir,
        node_ts_dir.clone(),
        python_dir.clone(),
        node_dir,
    );

    generate_code(&metadata, &config).expect("generate_code succeeded");

    let ts_files = collect_generated_files(&node_ts_dir);
    let all_ts = ts_files.join("\n");
    assert!(
        all_ts.contains("ExampleClient"),
        "TypeScript output should use configured aggregate client name"
    );

    let py_files = collect_generated_files(&python_dir);
    let all_py = py_files.join("\n");
    assert!(
        all_py.contains("ExampleClient"),
        "Python output should use configured aggregate client name"
    );
}

/// Regression test for the Python emitter silently dropping
/// `RequestType::Custom(Pattern::Post | Pattern::Patch)` RPCs.
///
/// `GenerateCatalogToken` is a factory-style POST RPC without path
/// parameters — `is_collection_method` classifies it as a collection
/// method (alongside `List` and `Create`), and the emitter should emit
/// a `generate_catalog_token(...)` method on the aggregate client.
#[test]
fn test_python_emitter_handles_custom_post_rpcs() {
    let descriptor = load_descriptor();
    let metadata = parse_file_descriptor_set(&descriptor).expect("parse succeeded");

    let tmp = TempDir::new().expect("tempdir");
    let common_dir = tmp.path().join("common");
    let node_ts_dir = tmp.path().join("node_ts");
    let python_dir = tmp.path().join("python");
    let node_dir = tmp.path().join("node");

    for dir in &[&common_dir, &node_ts_dir, &python_dir, &node_dir] {
        std::fs::create_dir_all(dir).expect("create dir");
    }

    let config = make_test_config(common_dir, node_ts_dir, python_dir.clone(), node_dir);

    generate_code(&metadata, &config).expect("generate_code succeeded");

    let py_files = collect_generated_files(&python_dir);
    let all_py = py_files.join("\n");

    assert!(
        all_py.contains("generate_catalog_token"),
        "Python emitter dropped a `Custom(Post)` RPC; output should expose \
         `generate_catalog_token`"
    );

    // The `.pyi` typings emitter must also include `Custom(Post|Patch)`
    // RPCs — the runtime bindings and the type stubs must stay in sync.
    let pyi = py_files
        .iter()
        .find(|f| f.contains("class ExampleClient"))
        .expect("expected ExampleClient stub in generated Python output");
    assert!(
        pyi.contains("generate_catalog_token"),
        "Python `.pyi` emitter dropped a `Custom(Post)` RPC; expected \
         `generate_catalog_token` in the stub"
    );
}

/// Resource-less, composite-key services (e.g. tag assignments) must produce usable bindings:
/// every method lives on the root client and accepts ALL path params, and `Empty`-returning custom
/// RPCs lower to a unit/void result. This is the "flat binding lowering" regression guard.
#[test]
fn test_resource_less_service_emits_flat_bindings_with_path_params() {
    let descriptor = load_descriptor();
    let metadata = parse_file_descriptor_set(&descriptor).expect("parse succeeded");
    let tmp = TempDir::new().expect("tempdir");
    let common_dir = tmp.path().join("common");
    let node_ts_dir = tmp.path().join("node_ts");
    let python_dir = tmp.path().join("python");
    let node_dir = tmp.path().join("node");
    for dir in &[&common_dir, &node_ts_dir, &python_dir, &node_dir] {
        std::fs::create_dir_all(dir).expect("create dir");
    }
    let config = make_test_config(
        common_dir.clone(),
        node_ts_dir.clone(),
        python_dir.clone(),
        node_dir.clone(),
    );
    generate_code(&metadata, &config).expect("generate_code succeeded");

    // The `.pyi` stub must mirror the flat bindings: resource-less methods land on the aggregate
    // `ExampleClient` with all path params, and there is no phantom scoped class.
    let pyi = std::fs::read_to_string(python_dir.join("example_client.pyi")).expect("pyi");
    assert!(
        pyi.contains(
            "def fetch_tag_assignment(\n\
             \n            self,\n\
             \x20           entity_type: str,\n\
             \x20           entity_name: str,\n\
             \x20           tag_key: str\n\
             \x20       ) -> TagAssignment:"
        ),
        "pyi: fetch_tag_assignment must expose all composite path params -> TagAssignment:\n{pyi}"
    );
    assert!(
        pyi.contains(
            "def touch_tag_assignment(\n\
             \n            self,\n\
             \x20           entity_type: str,\n\
             \x20           entity_name: str,\n\
             \x20           tag_key: str\n\
             \x20       ) -> None:"
        ),
        "pyi: touch_tag_assignment must take all path params and return None:\n{pyi}"
    );
    assert!(
        !pyi.contains("class TagAssignmentsServiceClient")
            && !pyi.contains("class TagAssignmentsClient")
            && !pyi.contains("class TagsClient"),
        "pyi: resource-less service must not get a phantom scoped class:\n{pyi}"
    );

    let py = std::fs::read_to_string(python_dir.join("mod.rs")).expect("python mod.rs");
    // Composite-key getter exposes ALL path params on the root client (not a scoped client).
    // The Get RPC carries a gnostic `operation_id`, so the binding method is named
    // `fetch_tag_assignment` (annotation-driven naming), not `get_tag_assignment`.
    assert!(
        py.contains("pub fn fetch_tag_assignment(")
            && py.contains("entity_type: String")
            && py.contains("entity_name: String")
            && py.contains("tag_key: String"),
        "python: fetch_tag_assignment must take all composite path params:\n{py:.4000}"
    );
    // Empty-returning custom RPC lowers to `<()>` (regression for the missing type arg).
    assert!(
        py.contains("pub fn touch_tag_assignment(") && py.contains("PyResult<()>"),
        "python: touch_tag_assignment must return PyResult<()>:\n{py:.4000}"
    );
    // Resource-less service has no scoped per-service module emitted.
    assert!(
        !python_dir.join("tags.rs").exists(),
        "python: resource-less service must not get a scoped module"
    );

    let ts = std::fs::read_to_string(node_ts_dir.join("client.ts")).expect("ts client.ts");
    assert!(
        ts.contains(
            "async fetchTagAssignment(entityType: string, entityName: string, tagKey: string)"
        ),
        "ts: fetchTagAssignment must take all composite path params:\n{ts:.4000}"
    );
    assert!(
        ts.contains("async touchTagAssignment(") && ts.contains("tagKey: string): Promise<void>"),
        "ts: touchTagAssignment must return Promise<void>:\n{ts:.4000}"
    );
}

/// The generated Rust aggregate root client (`client.rs`) must expose flat builder constructors for
/// resource-less services, matching the surface the language bindings call. Regression guard for the
/// aggregate generator.
#[test]
fn test_aggregate_client_emits_flat_builders_for_resource_less_service() {
    let descriptor = load_descriptor();
    let metadata = parse_file_descriptor_set(&descriptor).expect("parse succeeded");
    let tmp = TempDir::new().expect("tempdir");
    let common_dir = tmp.path().join("common");
    let node_ts_dir = tmp.path().join("node_ts");
    let python_dir = tmp.path().join("python");
    let node_dir = tmp.path().join("node");
    let client_dir = tmp.path().join("client");
    for dir in &[
        &common_dir,
        &node_ts_dir,
        &python_dir,
        &node_dir,
        &client_dir,
    ] {
        std::fs::create_dir_all(dir).expect("create dir");
    }
    let mut config = make_test_config(
        common_dir.clone(),
        node_ts_dir.clone(),
        python_dir.clone(),
        node_dir.clone(),
    );
    config.output.client = Some(client_dir.clone());
    generate_code(&metadata, &config).expect("generate_code succeeded");

    let client = std::fs::read_to_string(client_dir.join("client.rs")).expect("client.rs");

    // The aggregate struct uses the configured name.
    assert!(
        client.contains("pub struct ExampleClient"),
        "client.rs must define the configured aggregate struct:\n{client:.4000}"
    );
    // Resource-less list method takes the composite path params (entity_type, entity_name) and
    // returns the builder.
    assert!(
        client.contains("pub fn list_tag_assignments(")
            && client.contains("entity_type: impl Into<String>")
            && client.contains("entity_name: impl Into<String>")
            && client.contains("-> ListTagAssignmentsBuilder"),
        "client.rs: list_tag_assignments must take composite path params and return its builder:\n{client:.4000}"
    );
    // Custom POST RPC (Empty return) emits a flat builder constructor under its operation name.
    assert!(
        client.contains("pub fn touch_tag_assignment(")
            && client.contains("tag_key: impl Into<String>")
            && client.contains("-> TouchTagAssignmentBuilder"),
        "client.rs: touch_tag_assignment must take all path params and return its builder:\n{client:.4000}"
    );
    // The top-level client module must re-export the aggregate.
    let client_mod = std::fs::read_to_string(client_dir.join("mod.rs")).expect("client mod.rs");
    assert!(
        client_mod.contains("pub mod client") && client_mod.contains("pub use client::*"),
        "client mod.rs must export the aggregate module:\n{client_mod}"
    );
}

/// The generated Python output — the PyO3 client bindings (`python/*.rs`) and the
/// model wrapper `#[pyclass]` types (`models/_gen/pyo3_impls.rs`) — must be valid
/// Rust. `syn::parse_file` is a syntax-only gate (it does not resolve `pyo3` or the
/// model crate), but it catches structural breakage in the wrapper/binding
/// emitters without a full PyO3 toolchain. Run for both runtimes, since the wrapper
/// bodies differ (buffa `EnumValue`/`MessageField` vs prost `i32`/`Option<Box<T>>`).
#[test]
fn generated_python_output_is_valid_rust() {
    for runtime in [olai_codegen::Runtime::Prost, olai_codegen::Runtime::Buffa] {
        let descriptor = load_descriptor();
        let metadata = parse_file_descriptor_set(&descriptor).expect("parse succeeded");

        let tmp = TempDir::new().expect("tempdir");
        // Models + extractors are co-located: the common (extractor) dir is the
        // models `_gen` subdir.
        let models_dir = tmp.path().join("models");
        let common_dir = models_dir.join("_gen");
        let python_dir = tmp.path().join("python");
        let node_ts_dir = tmp.path().join("node_ts");
        let node_dir = tmp.path().join("node");
        for dir in &[
            &common_dir,
            &models_dir,
            &python_dir,
            &node_ts_dir,
            &node_dir,
        ] {
            std::fs::create_dir_all(dir).expect("create dir");
        }

        let mut config = make_test_config(common_dir, node_ts_dir, python_dir.clone(), node_dir);
        config.runtime = runtime;
        // Enable models output so the wrapper `pyo3_impls.rs` is emitted alongside
        // the bindings.
        config.output.models = Some(models_dir.clone());

        generate_code(&metadata, &config).expect("generate_code succeeded");

        let mut checked = 0usize;
        for path in walkdir(tmp.path()) {
            if path.extension().and_then(|e| e.to_str()) != Some("rs") {
                continue;
            }
            let src = std::fs::read_to_string(&path).expect("read generated file");
            syn::parse_file(&src).unwrap_or_else(|e| {
                panic!(
                    "generated file is not valid Rust ({runtime:?}): {}\n{e}",
                    path.display()
                )
            });
            checked += 1;
        }
        assert!(
            checked > 0,
            "expected to parse-check at least one generated .rs file ({runtime:?})"
        );
    }
}

/// `BindingsConfig::python_api` selects which client flavors the PyO3 output carries: the
/// blocking `FooClient` classes, the awaitable `AsyncFooClient` classes, or both. Sync-only
/// output must not reference `pyo3_async_runtimes` (so consumers don't need the dependency), and
/// the `.pyi` must mirror the emitted classes (`async def` + `AsyncIterator` pagers).
#[test]
fn python_api_selects_client_flavors() {
    use olai_codegen::PythonApi;

    for api in [PythonApi::Sync, PythonApi::Async, PythonApi::Both] {
        let descriptor = load_descriptor();
        let metadata = parse_file_descriptor_set(&descriptor).expect("parse succeeded");

        let tmp = TempDir::new().expect("tempdir");
        let dirs = ["common", "python", "node_ts", "node"].map(|d| tmp.path().join(d));
        for dir in &dirs {
            std::fs::create_dir_all(dir).expect("create dir");
        }
        let [common_dir, python_dir, node_ts_dir, node_dir] = dirs;
        let mut config = make_test_config(common_dir, node_ts_dir, python_dir.clone(), node_dir);
        config.bindings.as_mut().expect("bindings").python_api = api;
        generate_code(&metadata, &config).expect("generate_code succeeded");

        let read = |name: &str| {
            std::fs::read_to_string(python_dir.join(name))
                .unwrap_or_else(|e| panic!("read {name} ({api:?}): {e}"))
        };
        let module = read("mod.rs");
        let runtime = read("runtime.rs");
        let typings = read("example_client.pyi");
        for (name, src) in [("mod.rs", &module), ("runtime.rs", &runtime)] {
            syn::parse_file(src)
                .unwrap_or_else(|e| panic!("{name} is not valid Rust ({api:?}): {e}"));
        }

        let has_sync = module.contains("#[pyclass(name = \"ExampleClient\")]");
        let has_async = module.contains("#[pyclass(name = \"AsyncExampleClient\")]");
        assert_eq!(has_sync, api.has_sync(), "sync root client ({api:?})");
        assert_eq!(has_async, api.has_async(), "async root client ({api:?})");
        assert!(
            module.contains("pub mod runtime;") && module.contains("pub fn register_clients("),
            "mod.rs must declare the runtime and the registration helper ({api:?})"
        );

        let async_refs = module.contains("pyo3_async_runtimes")
            || runtime.contains("pyo3_async_runtimes")
            || runtime.contains("AsyncListIterator");
        assert_eq!(
            async_refs,
            api.has_async(),
            "pyo3-async-runtimes must be referenced iff async clients are emitted ({api:?})"
        );

        assert_eq!(
            typings.contains("class ExampleClient()"),
            api.has_sync(),
            "sync .pyi class ({api:?})"
        );
        assert_eq!(
            typings.contains("class AsyncExampleClient()"),
            api.has_async(),
            "async .pyi class ({api:?})"
        );
        if api.has_sync() {
            assert!(
                typings.contains("def list_catalogs(self, max_results: int) -> Iterator[Catalog]:"),
                "sync list stub returns a lazy Iterator ({api:?}):\n{typings}"
            );
        }
        if api.has_async() {
            assert!(
                typings.contains(
                    "def list_catalogs(self, max_results: int) -> AsyncIterator[Catalog]:"
                ) && !typings.contains("async def list_catalogs"),
                "async list stub returns its AsyncIterator directly ({api:?}):\n{typings}"
            );
            assert!(
                typings.contains("async def get(self) -> Catalog:"),
                "async scoped methods are coroutines ({api:?}):\n{typings}"
            );
        }
    }
}