golem-rust-macro 2.0.0-rc1

Golem Rust tooling library that facilitates writing Golem backends in Rust
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
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
// Copyright 2024-2026 Golem Cloud
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::recursion::is_recursive;
use proc_macro::TokenStream;
use proc_macro2::{Ident, Span};
use quote::quote;
use syn::{Data, DeriveInput, Fields, Lit, LitStr, Variant};

pub fn derive_into_value(ast: &DeriveInput, golem_rust_crate_ident: &Ident) -> TokenStream {
    let is_recursive = is_recursive(ast);

    if is_recursive {
        return syn::Error::new_spanned(&ast.ident, "Cannot derive IntoValue for recursive types")
            .to_compile_error()
            .into();
    }

    let ident = &ast.ident;
    let flatten_value = ast
        .attrs
        .iter()
        .any(|attr| attr.path().is_ident("flatten_value"));
    let ident_lit = LitStr::new(&ident.to_string(), Span::call_site());

    let (add_to_builder, add_to_type_builder) = match &ast.data {
        Data::Struct(data) => {
            let newtype_result = if data.fields.len() == 1 {
                let field = data.fields.iter().next().unwrap().clone();
                if field.ident.is_none() || flatten_value {
                    // single field without an identifier, we consider this a newtype
                    let field_type = field.ty;

                    let add_to_builder = match field.ident {
                        None => quote! {
                            self.0.add_to_builder(builder)
                        },
                        Some(field_name) => quote! {
                            self.#field_name.add_to_builder(builder)
                        },
                    };
                    let add_to_type_builder = quote! {
                        <#field_type as #golem_rust_crate_ident::value_and_type::IntoValue>::add_to_type_builder(builder)
                    };

                    Some((add_to_builder, add_to_type_builder))
                } else {
                    None
                }
            } else {
                None
            };

            match newtype_result {
                Some(newtype_result) => newtype_result,
                None => record_or_tuple(&ident_lit, &data.fields, golem_rust_crate_ident),
            }
        }
        Data::Enum(data) => {
            let is_simple_enum = data
                .variants
                .iter()
                .all(|variant| variant.fields.is_empty());

            if is_simple_enum {
                let case_branches = data
                    .variants
                    .iter()
                    .enumerate()
                    .map(|(idx, variant)| {
                        let case_ident = &variant.ident;
                        let idx = idx as u32;
                        quote! {
                            #ident::#case_ident => builder.enum_value(#idx)
                        }
                    })
                    .collect::<Vec<_>>();
                let case_labels = data
                    .variants
                    .iter()
                    .map(|variant| variant.ident.to_string())
                    .collect::<Vec<_>>();

                let add_to_builder = quote! {
                    match self {
                        #(#case_branches),*
                    }
                };

                let add_to_type_builder = quote! {
                    builder.r#enum(
                        Some(#ident_lit.to_string()),
                        None,
                        &[#(#case_labels),*]
                    )
                };

                (add_to_builder, add_to_type_builder)
            } else {
                let case_branches = data
                    .variants
                    .iter()
                    .enumerate()
                    .map(|(idx, variant)| {
                        let case_ident = &variant.ident;
                        let idx = idx as u32;

                        if variant.fields.is_empty() {
                            quote! {
                                #ident::#case_ident => {
                                    builder.variant_unit(#idx)
                                }
                            }
                        } else if has_single_anonymous_field(&variant.fields) {
                            // separate inner type
                            if is_unit_case(variant) {
                                quote! {
                                    #ident::#case_ident(inner) => {
                                       builder.variant_unit(#idx)
                                    }
                                }
                            } else {
                                quote! {
                                    #ident::#case_ident(inner) => {
                                        let builder = builder.variant(#idx);
                                        inner.add_to_builder(builder).finish()
                                    }
                                }
                            }
                        } else if has_only_named_fields(&variant.fields) {
                            // record case
                            let field_names = variant
                                .fields
                                .iter()
                                .map(|field| {
                                    let field = field.ident.as_ref().unwrap();
                                    quote! { #field }
                                })
                                .collect::<Vec<_>>();

                            let field_values = variant.fields.iter().map(|field| {
                                let field = field.ident.as_ref().unwrap();
                                quote! {
                                    let builder = #field.add_to_builder(builder.item());
                                }
                            });

                            if is_unit_case(variant) {
                                quote! {
                                    #ident::#case_ident { #(#field_names),* } => {
                                       builder.variant_unit(#idx)
                                    }
                                }
                            } else {
                                quote! {
                                    #ident::#case_ident { #(#field_names),* } => {
                                        let builder = builder.variant(#idx);
                                        let builder = builder.record();
                                        #(#field_values)*
                                        builder.finish().finish()
                                    }
                                }
                            }
                        } else {
                            // tuple case
                            let field_names = variant
                                .fields
                                .iter()
                                .enumerate()
                                .map(|(idx, _field)| {
                                    Ident::new(&format!("f{idx}"), Span::call_site())
                                })
                                .collect::<Vec<_>>();

                            let field_values = field_names.iter().map(|field| {
                                quote! {
                                    let builder = #field.add_to_builder(builder.item());
                                }
                            });

                            if is_unit_case(variant) {
                                quote! {
                                    #ident::#case_ident(#(#field_names),*) => {
                                        builder.variant_unit(#idx)
                                    }
                                }
                            } else {
                                quote! {
                                    #ident::#case_ident(#(#field_names),*) => {
                                        let builder = builder.variant(#idx);
                                        let builder = builder.tuple();
                                        #(#field_values)*
                                        builder.finish().finish()
                                    }
                                }
                            }
                        }
                    })
                    .collect::<Vec<_>>();

                let case_defs = data.variants.iter()
                    .map(|variant| {
                        let case_name = variant.ident.to_string();
                        if is_unit_case(variant) {
                            quote! {
                                builder = builder.unit_case(#case_name);
                            }
                        } else if has_single_anonymous_field(&variant.fields) {
                            let single_field = variant.fields.iter().next().unwrap();
                            let typ = &single_field.ty;

                            quote! {
                                builder = <#typ as #golem_rust_crate_ident::value_and_type::IntoValue>::add_to_type_builder(builder.case(#case_name));
                            }
                        } else {
                            let case_name_lit = LitStr::new(&case_name, Span::call_site());
                            let (_, inner_add_to_type_builder) = record_or_tuple(
                                &case_name_lit,
                                &variant.fields,
                                golem_rust_crate_ident,
                            );

                            quote! {
                                builder = {
                                    let builder = builder.case(#case_name);
                                    #inner_add_to_type_builder
                                };
                            }
                        }
                    })
                    .collect::<Vec<_>>();

                let into_value = quote! {
                    match self {
                        #(#case_branches),*
                    }
                };
                let get_type = quote! {
                    let mut builder = builder.variant(Some(#ident_lit.to_string()), None);
                    #(#case_defs)*
                    builder.finish()
                };

                (into_value, get_type)
            }
        }
        Data::Union(_data) => {
            panic!("Cannot derive IntoValue for unions")
        }
    };

    let result = quote! {
        impl #golem_rust_crate_ident::value_and_type::IntoValue for #ident {
            fn add_to_builder<B: #golem_rust_crate_ident::value_and_type::NodeBuilder>(self, builder: B) -> B::Result {
                use #golem_rust_crate_ident::value_and_type::NodeBuilder;

                #add_to_builder
            }

            fn add_to_type_builder<B: #golem_rust_crate_ident::value_and_type::TypeNodeBuilder>(builder: B) -> B::Result {
                use #golem_rust_crate_ident::value_and_type::TypeNodeBuilder;

                #add_to_type_builder
            }
        }
    };

    result.into()
}

fn record_or_tuple(
    ident_lit: &LitStr,
    fields: &Fields,
    golem_rust_crate_ident: &Ident,
) -> (proc_macro2::TokenStream, proc_macro2::TokenStream) {
    let all_fields_has_names = fields.iter().all(|field| field.ident.is_some());

    if all_fields_has_names {
        let field_values = fields
            .iter()
            .map(|field| {
                let field_name = field.ident.as_ref().unwrap();
                quote! {
                    let builder = self.#field_name.add_to_builder(builder.item());
                }
            })
            .collect::<Vec<_>>();

        let field_defs = fields
            .iter()
            .map(|field| {
                let field_name = field.ident.as_ref().unwrap().to_string();
                let field_type = &field.ty;
                quote! {
                    let builder = <#field_type as #golem_rust_crate_ident::value_and_type::IntoValue>::add_to_type_builder(builder.field(#field_name));
                }
            })
            .collect::<Vec<_>>();

        let add_to_builder = quote! {
            let builder = builder.record();
            #(#field_values)*
            let builder = builder.finish();
            builder
        };
        let add_to_type_builder = quote! {
            let builder = builder.record(Some(#ident_lit.to_string()), None);
            #(#field_defs)*
            let builder = builder.finish();
            builder
        };

        (add_to_builder, add_to_type_builder)
    } else {
        let tuple_field_values = fields
            .iter()
            .enumerate()
            .map(|(idx, _field)| {
                let index = syn::Index::from(idx);
                quote! {
                    let builder = self.#index.add_to_builder(builder.item());
                }
            })
            .collect::<Vec<_>>();

        let tuple_field_types = fields
            .iter()
            .map(|field| {
                let field_type = &field.ty;
                quote! {
                    let builder = <#field_type as #golem_rust_crate_ident::value_and_type::IntoValue>::add_to_type_builder(builder.item());
                }
            })
            .collect::<Vec<_>>();

        let add_to_builder = quote! {
            let builder = builder.tuple();
            #(#tuple_field_values)*
            let builder = builder.finish();
            builder
        };
        let add_to_type_builder = quote! {
            let builder = builder.tuple(Some(#ident_lit.to_string()), None);
            #(#tuple_field_types)*
            let builder = builder.finish();
            builder
        };

        (add_to_builder, add_to_type_builder)
    }
}

fn has_single_anonymous_field(fields: &Fields) -> bool {
    fields.len() == 1 && fields.iter().next().unwrap().ident.is_none()
}

fn has_only_named_fields(fields: &Fields) -> bool {
    fields.iter().all(|field| field.ident.is_some())
}

fn is_unit_case(variant: &Variant) -> bool {
    variant.fields.is_empty()
        || variant
            .attrs
            .iter()
            .any(|attr| attr.path().is_ident("unit_case"))
}

pub fn derive_from_value_and_type(
    ast: &DeriveInput,
    golem_rust_crate_ident: &Ident,
) -> TokenStream {
    let is_recursive = is_recursive(ast);

    if is_recursive {
        return syn::Error::new_spanned(
            &ast.ident,
            "Cannot derive FromValueAndType for recursive types",
        )
        .to_compile_error()
        .into();
    }

    let ident = &ast.ident;
    let flatten_value = ast
        .attrs
        .iter()
        .any(|attr| attr.path().is_ident("flatten_value"));

    let extractor = match &ast.data {
        Data::Struct(data) => {
            let newtype_result = if data.fields.len() == 1 {
                let field = data.fields.iter().next().unwrap().clone();
                if field.ident.is_none() || flatten_value {
                    // single field without an identifier, we consider this a newtype
                    let field_type = field.ty;

                    let extractor = match field.ident {
                        None => quote! {
                            let inner = <#field_type as #golem_rust_crate_ident::value_and_type::FromValueAndType>::from_extractor(
                                extractor
                            )?;
                            Ok(Self(inner))
                        },
                        Some(field_name) => quote! {
                            let #field_name = <#field_type as #golem_rust_crate_ident::value_and_type::FromValueAndType>::from_extractor(
                                extractor
                            )?;
                            Ok(Self { #field_name })
                        },
                    };

                    Some(extractor)
                } else {
                    None
                }
            } else {
                None
            };

            match newtype_result {
                Some(newtype_result) => newtype_result,
                None => record_or_tuple_extractor(&data.fields, golem_rust_crate_ident),
            }
        }
        Data::Enum(data) => {
            let is_simple_enum = data
                .variants
                .iter()
                .all(|variant| variant.fields.is_empty());

            if is_simple_enum {
                let case_branches = data
                    .variants
                    .iter()
                    .enumerate()
                    .map(|(idx, variant)| {
                        let case_ident = &variant.ident;
                        let idx = idx as u32;
                        quote! {
                            Some(#idx) => Ok(#ident::#case_ident)
                        }
                    })
                    .collect::<Vec<_>>();

                let invalid_case_error = Lit::Str(LitStr::new(
                    &format!("Invalid {}", ast.ident),
                    Span::call_site(),
                ));

                quote! {
                    match extractor.enum_value() {
                        #(#case_branches),*,
                        _ => Err(#invalid_case_error.to_string())
                    }
                }
            } else {
                let cases = data
                    .variants
                    .iter()
                    .enumerate()
                    .map(|(idx, variant)| {
                        let case_ident = &variant.ident;
                        let idx = idx as u32;

                        if variant.fields.is_empty() {
                            quote! {
                                #idx => {
                                    Ok(#ident::#case_ident)
                                }
                            }
                        } else if has_single_anonymous_field(&variant.fields) {
                            // separate inner type
                            if is_unit_case(variant) {
                                quote! {
                                    #idx => {
                                        Ok(#ident::#case_ident)
                                    }
                                }
                            } else {
                                let single_field = variant.fields.iter().next().unwrap();
                                let typ = &single_field.ty;
                                let missing_body_error = Lit::Str(LitStr::new(
                                    &format!("Missing {case_ident} body"),
                                    Span::call_site()
                                ));

                                quote! {
                                    #idx => {
                                        Ok(#ident::#case_ident(
                                            <#typ as #golem_rust_crate_ident::value_and_type::FromValueAndType>::from_extractor(
                                                &inner.ok_or_else(|| #missing_body_error.to_string())?
                                            )?
                                        ))
                                    }
                                }
                            }
                        } else if has_only_named_fields(&variant.fields) {
                            // record case
                            if is_unit_case(variant) {
                                quote! {
                                    #idx => {
                                        Ok(#ident::#case_ident)
                                    }
                                }
                            } else {
                                let missing_case_error = Lit::Str(LitStr::new(
                                    &format!("Missing {case_ident} fields"),
                                    Span::call_site(),
                                ));
                                let field_extractors = variant.fields.iter()
                                    .enumerate()
                                    .map(|(idx, field)| {
                                        let field_name = field.ident.as_ref().unwrap();
                                        let field_ty = &field.ty;
                                        let missing_field_error = Lit::Str(LitStr::new(&format!("Missing {field_name} field"), Span::call_site()));

                                        quote! {
                                            #field_name: <#field_ty as #golem_rust_crate_ident::value_and_type::FromValueAndType>::from_extractor(
                                                &<#golem_rust_crate_ident::golem_wasm::WitNodePointer as #golem_rust_crate_ident::value_and_type::WitValueExtractor>::field(&inner, #idx).ok_or_else(|| #missing_field_error.to_string())?
                                            )?
                                        }
                                    })
                                    .collect::<Vec<_>>();

                                quote! {
                                   #idx => {
                                        let inner = &inner.ok_or_else(|| #missing_case_error.to_string())?;

                                        Ok(#ident::#case_ident {
                                            #(#field_extractors),*
                                        })
                                    }
                                }
                            }
                        } else if is_unit_case(variant) {
                                quote! {
                                    #idx => {
                                        Ok(#ident::#case_ident)
                                    }
                                }
                            } else {
                                let tuple_type = {
                                    let tys = variant.fields.iter().map(|f| &f.ty);
                                    quote! { ( #(#tys),* ) }
                                };

                                let tuple_bindings = {
                                    let names = variant
                                        .fields
                                        .iter()
                                        .enumerate()
                                        .map(|(i, _)| syn::Ident::new(&format!("field_{i}"), Span::call_site()));
                                    quote! { ( #(#names),* ) }
                                };

                                let constructor_args = {
                                    let names = variant
                                        .fields
                                        .iter()
                                        .enumerate()
                                        .map(|(i, _)| syn::Ident::new(&format!("field_{i}"), Span::call_site()));
                                    quote! { #(#names),* }
                                };

                                let missing_err = "Missing tuple element #0".to_string();

                                quote! {
                                      #idx => {
                                        let #tuple_bindings = <#tuple_type as #golem_rust_crate_ident::value_and_type::FromValueAndType>::from_extractor(
                                            &inner.ok_or_else(|| #missing_err.to_string())?
                                        )?;

                                        Ok(#ident::#case_ident(
                                            #constructor_args
                                        ))
                                    }
                                }
                        }
                    })
                    .collect::<Vec<_>>();

                let should_be_variant_error = Lit::Str(LitStr::new(
                    &format!("{} should be variant", ast.ident),
                    Span::call_site(),
                ));

                let invalid_case_format = Lit::Str(LitStr::new(
                    &format!("Invalid {} variant: {{idx}}", ast.ident),
                    Span::call_site(),
                ));

                quote! {
                    let (idx, inner) = extractor
                        .variant()
                        .ok_or_else(|| #should_be_variant_error.to_string())?;
                    match idx {
                        #(#cases),*,
                        _ => Err(format!(#invalid_case_format)),
                    }
                }
            }
        }
        Data::Union(_) => {
            panic!("Cannot derive FromValueAndType for unions")
        }
    };

    let result = quote! {
        impl #golem_rust_crate_ident::value_and_type::FromValueAndType for #ident {
            fn from_extractor<'a, 'b>(
                extractor: &'a impl #golem_rust_crate_ident::value_and_type::WitValueExtractor<'a, 'b>,
            ) -> Result<Self, String> {
                #extractor
            }
        }
    };

    result.into()
}

fn record_or_tuple_extractor(
    fields: &Fields,
    golem_rust_crate_ident: &Ident,
) -> proc_macro2::TokenStream {
    let all_fields_has_names = fields.iter().all(|field| field.ident.is_some());

    if all_fields_has_names {
        let field_extractors = fields.iter()
            .enumerate()
            .map(|(idx, field)| {
                let field_name = field.ident.as_ref().unwrap();
                let field_ty = &field.ty;
                let missing_field_error = Lit::Str(LitStr::new(&format!("Missing {field_name} field"), Span::call_site()));
                quote! {
                    #field_name: <#field_ty as #golem_rust_crate_ident::value_and_type::FromValueAndType>::from_extractor(
                        &extractor.field(#idx).ok_or_else(|| #missing_field_error.to_string())?
                    )?
                }
            })
            .collect::<Vec<_>>();

        quote! {
            Ok(Self {
                #(#field_extractors),*
            })
        }
    } else {
        let field_extractors = fields.iter()
            .enumerate()
            .map(|(idx, field)| {
                let elem_ty = &field.ty;
                let missing_tuple_element_error = Lit::Str(LitStr::new(&format!("Missing tuple element #{idx}"), Span::call_site()));
                quote! {
                    <#elem_ty as #golem_rust_crate_ident::value_and_type::FromValueAndType>::from_extractor(
                        &extractor.tuple_element(#idx).ok_or_else(|| #missing_tuple_element_error.to_string())?
                    )?
                }
            })
            .collect::<Vec<_>>();

        quote! {
            Ok((
                #(#field_extractors),*
            ))
        }
    }
}