cronus_generator 0.7.0

The generators for cronus API spec.
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
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
use anyhow::bail;
use convert_case::{Case, Casing};
use cronus_spec::{
    GolangGinGeneratorOption, PythonFastApiGeneratorOption, RawSchema, RawUsecaseMethod,
    RawUsecaseMethodRestOption,
};
use std::{any::type_name, cell::RefCell, collections::HashSet, fmt::format, path::PathBuf};

use crate::{
    utils::{
        self, get_path_from_optional_parent, get_request_name, get_response_name,
        get_schema_by_name, get_usecase_name, spec_ty_to_golang_builtin_ty,
        spec_ty_to_py_builtin_ty, spec_ty_to_rust_builtin_ty,
    },
    Ctxt, Generator,
};
use anyhow::{Ok, Result};
use tracing::{self, debug, span, Level};

pub struct GolangGinGenerator {}

impl GolangGinGenerator {
    pub fn new() -> Self {
        Self {}
    }
}

impl Generator for GolangGinGenerator {
    fn name(&self) -> &'static str {
        "golang_gin"
    }

    fn before_all(&self, ctx: &Ctxt) -> Result<()> {
        let gen_opt = self.get_gen_option(ctx);

        let pkg_name = gen_opt
            .and_then(|opt| opt.package.as_ref())
            .ok_or_else(|| anyhow::anyhow!("golang_gin domain_package option is not set"))?;

        ctx.append_file(
            self.name(),
            &self.dst(ctx),
            &format!("package {}\n\n", pkg_name),
        );

        let domain_import = gen_opt
            .and_then(|opt| opt.domain_import.as_ref())
            .ok_or_else(|| anyhow::anyhow!("golang_gin domain_import option is not set"))?;
        let imports = vec![domain_import, "net/http", "github.com/gin-gonic/gin"];
        let mut imports_str = imports
            .iter()
            .map(|import| format!("import \"{}\"", import))
            .collect::<Vec<String>>()
            .join("\n");
        imports_str += "\n\n";
        ctx.append_file(self.name(), &self.dst(ctx), &imports_str);

        Ok(())
    }

    /// Generate the Golang Gin router for the given usecase.
    fn generate_usecase(
        &self,
        ctx: &Ctxt,
        name: &str,
        usecase: &cronus_spec::RawUsecase,
    ) -> Result<()> {
        let span = span!(Level::TRACE, "generate_usecase", "usecase" = name);
        // Enter the span, returning a guard object.
        let _enter = span.enter();

        let has_rest_methods = usecase.methods.iter().any(|(_, method)| {
            method
                .option
                .as_ref()
                .and_then(|option| option.rest.as_ref())
                .is_some()
        });

        if !has_rest_methods {
            return Ok(());
        }

        let full_usecase_name = get_usecase_name(ctx, name);
        let domain_package = self
            .get_gen_option(ctx)
            .and_then(|gen_opt| gen_opt.domain_package.as_ref())
            .ok_or_else(|| anyhow::anyhow!("golang_gin domain_package option is not set"))?;

        let mut result = String::new();

        let path_prefix = usecase
            .option
            .as_ref()
            .and_then(|usecase_opt| usecase_opt.rest.as_ref())
            .and_then(|rest| rest.path.as_ref())
            .cloned()
            .unwrap_or_default();
        let service_var = "s";
        let setup_fn_name = format!(
            "func Setup{}Routes(r *gin.Engine, {} {}.{}) {{\n",
            full_usecase_name, service_var, domain_package, full_usecase_name
        );

        result += &setup_fn_name;
        let rg_var = "rg";
        result += &format!("  {} := r.Group(\"{}\")\n", rg_var, path_prefix);

        for (method_name, method) in &usecase.methods {
            let rest = match method.option {
                Some(ref option) => {
                    if let Some(rest) = &option.rest {
                        rest
                    } else {
                        continue;
                    }
                }
                None => continue,
            };

            let rest_path = match &rest.path {
                Some(path) => path,
                None => &"".to_string(),
            };

            // register the route with the lambda function
            result += &format!(
                "  {}.{}(\"{}\", {})\n",
                rg_var,
                rest.method.to_ascii_uppercase(),
                rest_path,
                self.gen_usecase_method(ctx, service_var, domain_package, &method_name, method)?
            );

            //     // prepare body if http method is not get

            //     if let Some(req) = &method.req {
            //         let request_ty = get_request_name(ctx, method_name);

            //         if rest.method != "get" {
            //             let mut cloned_req = req.clone();

            //             // remove path parameters from request struct

            //             if let Some(path_params) = path_params.as_ref() {
            //                 for param in path_params {
            //                     cloned_req.properties.as_mut().unwrap().remove(param);
            //                 }
            //             }

            //             let mut need_generate_body = false;

            //             for (prop_name, prop_schema) in cloned_req.properties.as_ref().unwrap() {
            //                 if prop_schema.option.as_ref()
            //                     .and_then(|o| o.python_fastapi.as_ref().and_then(| opt| opt.exclude))
            //                     .unwrap_or(false) {
            //                     // skip properties if exclude is set
            //                     continue;
            //                 }
            //                 need_generate_body = true;
            //                 break
            //             }

            //             if need_generate_body {

            //                 let body_ty = format!("{}Body", method_name.to_case(Case::UpperCamel));
            //                 if cloned_req.properties.as_ref().unwrap().len() != 0 {
            //                     self.generate_struct(ctx, &cloned_req, Some(body_ty.clone()), None);
            //                     arg_strs.push(format!("body: {}", body_ty));

            //                 }
            //             }
            //         } else {
            //             req.properties.as_ref().unwrap().into_iter().for_each(|(prop_name, prop_schema)| {
            //                 if prop_schema.option.as_ref()
            //                 .and_then(|o| o.python_fastapi.as_ref().and_then(| opt| opt.exclude))
            //                 .unwrap_or(false) {
            //             // skip properties if exclude is set
            //             return;
            //                 }

            //                 if let Some(path_params) = path_params.as_ref() {
            //                     if path_params.contains(prop_name) {
            //                         return;
            //                     }

            //                 }

            //                 let ty = self.generate_struct(ctx, prop_schema, None, None);
            //                 if prop_schema.required.unwrap_or(false) {
            //                     arg_strs.push(format!("{}: {}", prop_name.to_case(Case::Snake), ty));

            //                 } else {
            //                     default_arg_strs.push(format!("{}: Optional[{}] = None", prop_name.to_case(Case::Snake), ty));

            //                 }
            //             });
            //         }
            //     }

            //     // handle path parameters
            //     match get_method_path_names_and_tys(method)? {
            //         Some((props, tys)) => {
            //             for (i, prop) in props.iter().enumerate() {
            //                 arg_strs.push(format!("{}: {}", prop.to_case(Case::Snake), tys[i]));
            //             }
            //         }
            //         None => {}
            //     }

            //     let arg_str = arg_strs.join(", ");
            //     if !arg_str.is_empty() {
            //         result += &arg_str;
            //     }

            //     result += ")";

            //     let mut result_type: String = "None".to_string();

            //     let mut has_res = false;
            //     // generate response
            //     if let Some(res) = &method.res {
            //         has_res = true;
            //         let response_ty = get_response_name(ctx, method_name);
            //         self.generate_struct(ctx, &res, Some(response_ty.clone()), None);
            //         result_type = response_ty;

            //     }

            //     result += &format!(" -> {}", result_type);

            //     result += ":\n";

            //     // let mut has_request = false;
            //     let mut request_fields:Vec<String> = Vec::new();

            //     // collect extra fields, which should not be assigned from body or path/query variable
            //     let mut extra_props:HashSet<String> = HashSet::new();

            //     // handle extra request fields (global level)
            //     match self.get_gen_option(ctx) {
            //         Some(gen_opt) => {
            //             if let Some(extra_request_fields) = &gen_opt.extra_request_fields {
            //                 for field in extra_request_fields {
            //                     request_fields.push(field.to_string());
            //                     let mut parts = field.split("=");
            //                     if let Some(part) = parts.next() {
            //                         extra_props.insert(part.trim().to_string());
            //                     }
            //                 }
            //             }
            //         },
            //         None => {}
            //     }

            //     // request object creation
            //     if let Some(req) = &method.req {

            //         for (prop_name, prop_schema) in req.properties.as_ref().unwrap() {
            //             if extra_props.contains(prop_name) {
            //                 // skip extra props
            //                 continue;
            //             }
            //             let mut field = String::new();
            //             field += &prop_name.to_case(Case::Snake);
            //             field += "=";

            //             // if property is in body, use body.xxx
            //             // otherwise, use xxx directly
            //             let mut in_path = false;
            //             if let Some(path_params) = path_params.as_ref() {
            //                 if path_params.contains(prop_name)  {
            //                     field += &prop_name.to_case(Case::Snake);
            //                     in_path = true;
            //                 }
            //             }

            //             if !in_path {
            //                 if rest.method == "get" {
            //                     field += &prop_name.to_case(Case::Snake);
            //                 }
            //                 else {
            //                     field += "body.";
            //                     field += &prop_name.to_case(Case::Snake);
            //                 }
            //             }

            //             request_fields.push(field);

            //         }
            //     }

            //     if request_fields.len() != 0 {
            //         result += "  request = ";
            //         result += &get_request_name(ctx, method_name);
            //         result += "(";
            //         result += &request_fields.join(",\n    ");
            //         result += ")\n";
            //     }

            //     if has_res {
            //         result += "  return"
            //     }

            //     let call_usecase = format!("ctx.{}.{}({})", trait_name, method_name.to_case(Case::Snake), if request_fields.len() != 0 {
            //         "request"
            //     } else {
            //         ""
            //     });
            //     let usecase_ty = get_usecase_name(ctx, &trait_name);
            //     result += &call_usecase;
            //     result += "\n";
        }

        result += "}\n";
        ctx.append_file(self.name(), &self.dst(ctx), &result);

        Ok(())
    }
}

fn get_method_path_names_and_tys(
    method: &RawUsecaseMethod,
) -> Result<Option<(Vec<String>, Vec<String>)>> {
    let path_params = utils::get_path_params(method);
    let mut struct_fields: Vec<String> = Vec::new();
    let mut struct_tys: Vec<String> = Vec::new();
    match path_params {
        Some(path_params) => {
            for prop in &path_params {
                let prop_schema = method
                    .req
                    .as_ref()
                    .unwrap()
                    .properties
                    .as_ref()
                    .unwrap()
                    .get(prop)
                    .unwrap();

                let ty: String;

                if prop_schema.items.is_some() {
                    bail!("array property cannot be used as path variable")
                }

                if let Some(t) = utils::spec_ty_to_py_builtin_ty(prop_schema.ty.as_ref().unwrap()) {
                    ty = t;
                } else {
                    ty = prop_schema.ty.as_ref().unwrap().clone();
                }

                struct_fields.push(prop.clone());
                struct_tys.push(ty);
            }

            Ok(Some((struct_fields, struct_tys)))
        }
        None => Ok(None),
    }
}

impl GolangGinGenerator {
    fn gen_anonymous_struct(
        &self,
        ctx: &Ctxt,
        schema: &RawSchema,
        name: Option<String>,
        form_tag_props: Option<HashSet<String>>,
        uri_tag_props: Option<HashSet<String>>,
        json_tag_props: Option<HashSet<String>>,
    ) -> Result<String> {
        let mut result = String::new();
        result += "struct {\n";
        for (prop_name, prop_schema) in schema.properties.as_ref().unwrap() {
            if prop_schema
                .option
                .as_ref()
                .and_then(|o| o.golang_gin.as_ref().and_then(|opt| opt.exclude))
                .unwrap_or(false)
            {
                // skip properties if exclude is set
                continue;
            }
            let ty = if prop_schema.items.is_some() {
                // if items is set, it is an array type
                let item_ty = prop_schema
                    .items
                    .as_ref()
                    .and_then(|items| items.ty.as_ref())
                    .ok_or_else(|| anyhow::anyhow!("items type is not set for {}", prop_name))?;
                let ty = spec_ty_to_golang_builtin_ty(item_ty)
                    .unwrap_or_else(|| item_ty.clone());
                format!("[]{}", ty)
                
            } else {
                spec_ty_to_golang_builtin_ty(prop_schema.ty.as_ref().unwrap())
                .unwrap_or_else(|| prop_schema.ty.as_ref().unwrap().clone())
            };
            
           
            let actual_ty = if prop_schema.required.unwrap_or(false) {
                // if required, use the type directly
                ty
            } else {
                // if not required, use pointer type
                format!("*{}", ty)
            };
            let camel_prop_name = prop_name.to_case(Case::Camel);
            let upper_camel_prop_name = camel_prop_name.to_case(Case::UpperCamel);
            let mut tags: Vec<String> = Vec::new();
            if let Some(json_props) = json_tag_props.as_ref() {
                if json_props.contains(&camel_prop_name) {
                    tags.push(format!("json:\"{}\"", camel_prop_name));
                }
            }

            if let Some(form_props) = form_tag_props.as_ref() {
                if form_props.contains(&camel_prop_name) {
                    tags.push(format!("form:\"{}\"", camel_prop_name));
                }
            }

            if let Some(uri_props) = uri_tag_props.as_ref() {
                if uri_props.contains(&camel_prop_name) {
                    tags.push(format!("uri:\"{}\"", camel_prop_name));
                }
            }
            let tags_str = if tags.is_empty() {
                "".to_string()
            } else {
                format!("`{}`", tags.join(" "))
            };
            result += &format!("  {} {} {}\n", upper_camel_prop_name, actual_ty, tags_str);
        }
        result += "}";
        Ok(result)
    }

    fn gen_usecase_method(
        &self,
        ctx: &Ctxt,
        usecase_var: &str,
        domain_pkg: &str,
        method_name: &str,
        method: &RawUsecaseMethod,
    ) -> Result<String> {
        let mut result = String::new();
        let domain_package = self
            .get_gen_option(ctx)
            .and_then(|gen_opt| gen_opt.domain_package.as_ref())
            .ok_or_else(|| anyhow::anyhow!("golang_gin domain_package option is not set"))?;
        let rest = method
            .option
            .as_ref()
            .and_then(|option| option.rest.as_ref())
            .ok_or_else(|| anyhow::anyhow!("No rest option for method {}", method_name))?;
        result += "func (ctx *gin.Context) {\n";

        let (path_params, query_params, body_params) = utils::get_pqb(method, |prop| {
            prop.option.as_ref()
                .and_then(|o| o.golang_gin.as_ref())
                .and_then(|g| g.exclude)
                .unwrap_or(false)
        });
        let is_multipart = method
            .option
            .as_ref()
            .and_then(|opt| opt.rest.as_ref())
            .and_then(|rest_opt| rest_opt.content_type.as_ref())
            .and_then(|ct| Some(ct == "multipart/form-data"))
            .unwrap_or(false);

        let form_tag_props: Option<HashSet<String>> = if is_multipart {
            // query_params + body_params
            let mut combined: Option<HashSet<String>> = query_params.clone();
            if combined.is_none() {
                combined = body_params.clone();
            } else { 
                if let Some(body_params) = &body_params{
                    combined.as_mut().unwrap().extend(body_params.iter().cloned());
                }
            }
            combined
        } else {
            // only query params for non-multipart
            query_params.clone()
        };

        // request variable creation
        if let Some(req) = &method.req {
            let request_ty = get_request_name(ctx, method_name);
            result += &format!(
                "  var request {}\n",
                self.gen_anonymous_struct(
                    ctx,
                    req,
                    Some(request_ty.clone()),
                    form_tag_props,
                    path_params.clone(),
                    if is_multipart {None} else {body_params }
                )?
            );
        }

        
        // path variable extraction
        if path_params.is_some() {
            result += " if err := ctx.ShouldBindUri(&request); err != nil {\n";
            result += "    ctx.JSON(http.StatusBadRequest, gin.H{\"error\": err.Error()})\n";
            result += "    return\n";
            result += "  }\n";
        }

        let mut extra_fields: Vec<String> = Vec::new();

        // handle extra request fields (generator level)
        if let Some(extra_request_fields) = self
            .get_gen_option(ctx)
            .as_ref()
            .and_then(|opt| opt.extra_request_fields.as_ref())
        {
            extra_fields.extend(extra_request_fields.iter().cloned());
        }

        // handle extra request fields (method level)
        if let Some(extra_request_fields) = method
            .option
            .as_ref()
            .and_then(|opt| opt.golang_gin.as_ref())
            .and_then(|py_opt| py_opt.extra_request_fields.as_ref())
        {
            extra_fields.extend(extra_request_fields.iter().cloned());
        }

        let all_fields: HashSet<String> = method
            .req
            .as_ref()
            .and_then(|req| req.properties.as_ref())
            .map_or_else(HashSet::new, |props| {
                props
                    .iter()
                    .map(|(k, _)| k.to_string().to_case(Case::UpperCamel))
                    .collect::<HashSet<String>>()
            });

        // remove extra fields from all fields if they are not present in the request
        extra_fields.retain(|field| {
            all_fields.contains(&field.split(':').next().unwrap().trim().to_string())
        });

        if method.req.is_some() {
            // if get, use query parameters
            if rest.method == "get" {
                result += "  if err := ctx.ShouldBindQuery(&request); err != nil {\n";
                result += "    ctx.JSON(http.StatusBadRequest, gin.H{\"error\": err.Error()})\n";
                result += "    return\n";
                result += "  }\n";
            } else {
                if is_multipart {
                    // multipart/form-data, use
                    result += "  if err := ctx.ShouldBind(&request); err != nil {\n";
                    result +=
                        "    ctx.JSON(http.StatusBadRequest, gin.H{\"error\": err.Error()})\n";
                    result += "    return\n";
                    result += "  }\n";
                } else {
                    // default to ShouldBindJSON for other methods
                    // if post, delete, put, patch, use body parameters

                    result += "  if err := ctx.BindJSON(&request); err != nil {\n";
                    result +=
                        "    ctx.JSON(http.StatusBadRequest, gin.H{\"error\": err.Error()})\n";
                    result += "    return\n";
                    result += "  }\n";
                }
            }
        }

        if method.req.is_some() || !extra_fields.is_empty() {
            let request_ty = get_request_name(ctx, method_name);
            result += &format!(" domain_request := {}.{}{{\n", domain_package, request_ty);

            // handle extra request fields
            if !extra_fields.is_empty() {
                for field in extra_fields {
                    result += &field;
                    result += ",\n";
                }
            }

            if let Some(req) = &method.req {
                for (prop_name, prop_schema) in req.properties.as_ref().unwrap() {
                    if prop_schema
                        .option
                        .as_ref()
                        .and_then(|o| o.golang_gin.as_ref().and_then(|opt| opt.exclude))
                        .unwrap_or(false)
                    {
                        // skip properties if exclude is set
                        continue;
                    }
                    let upper_camel_prop_name = prop_name.to_case(Case::UpperCamel);
                    // let passed_by = if prop_schema.required.unwrap_or(false) {
                    //     ""
                    // } else {
                    //     "&"
                    // };
                    result += &format!(
                        "  {}: request.{},\n",
                        upper_camel_prop_name, upper_camel_prop_name
                    );
                }
            }

            result += "  }\n";
        }

        let has_res = method.res.is_some();
        let res_var = if has_res { "response, " } else { "" };
        result += &format!(
            "  {} err := {}.{}(ctx, &domain_request)\n",
            res_var,
            usecase_var,
            method_name.to_case(Case::UpperCamel)
        );
        result += "  if err != nil {\n";
        result += "    ctx.JSON(http.StatusInternalServerError, gin.H{\"error\": err.Error()})\n";
        result += "    return\n";
        result += "  }\n";
        if has_res {
            result += "  ctx.JSON(http.StatusOK, response)\n";
        } else {
            result += "  ctx.Status(http.StatusNoContent)\n";
        }

        result += "}";
        Ok(result)
    }
    fn get_gen_option<'a>(&self, ctx: &'a Ctxt) -> Option<&'a GolangGinGeneratorOption> {
        ctx.spec.option.as_ref().and_then(|go| {
            go.generator
                .as_ref()
                .and_then(|gen| gen.golang_gin.as_ref())
        })
    }

    fn dst(&self, ctx: &Ctxt) -> String {
        let default_file = "generated.go";

        self.get_gen_option(ctx)
            .and_then(|gen| {
                Some(get_path_from_optional_parent(
                    gen.def_loc.file.parent(),
                    gen.file.as_ref(),
                    default_file,
                ))
            })
            .unwrap_or_else(|| default_file.into())
    }
}