golem-schema-derive 1.6.0-dev.2

Derive macros for the Golem schema model
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
// Copyright 2024-2026 Golem Cloud
//
// Licensed under the Golem Source License v1.1 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://license.golem.cloud/LICENSE
//
// 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::codegen::helpers::{
    add_trait_bounds, body_expr_for_field, default_name_for, display_name_expr, from_value_expr,
    metadata_expr_for_item, metadata_expr_for_type, private, to_value_expr, type_id_expr,
};
use crate::parse::{ItemAttrs, TypeAttrs, parse_item_attrs};
use proc_macro2::TokenStream;
use quote::quote;
use syn::spanned::Spanned;
use syn::{DataStruct, DeriveInput, Field, Fields, Ident, LitStr};

pub fn expand_struct_into_schema(
    input: &DeriveInput,
    type_attrs: &TypeAttrs,
    data: &DataStruct,
) -> syn::Result<TokenStream> {
    let ident = &input.ident;

    if type_attrs.transparent {
        return expand_transparent_into_schema(input, type_attrs, data);
    }

    let with_bounds = add_trait_bounds(&input.generics, false, true);
    let (impl_generics, _, where_clause) = with_bounds.split_for_impl();
    let (_, ty_generics, _) = input.generics.split_for_impl();
    let private = private();
    let type_id = type_id_expr(type_attrs, &input.generics);
    let display = display_name_expr(type_attrs, ident);
    let metadata = metadata_expr_for_type(type_attrs);

    let body_expr = struct_body_expr(&data.fields, type_attrs)?;
    let to_value_body = struct_to_value(&data.fields, type_attrs)?;

    Ok(quote! {
        #[automatically_derived]
        impl #impl_generics #private::IntoSchema for #ident #ty_generics #where_clause {
            fn type_id() -> #private::TypeId {
                #type_id
            }

            fn register_in(builder: &mut #private::SchemaBuilder) -> #private::SchemaType {
                let id = <Self as #private::IntoSchema>::type_id();
                if builder.is_registered(&id) {
                    return #private::SchemaType::ref_to(id);
                }
                builder.reserve(id.clone());
                let body: #private::SchemaType = #body_expr;
                builder.commit(id.clone(), #display, #metadata, body);
                #private::SchemaType::ref_to(id)
            }

            fn to_value(&self) -> #private::SchemaValue {
                #to_value_body
            }
        }
    })
}

pub fn expand_struct_from_schema(
    input: &DeriveInput,
    type_attrs: &TypeAttrs,
    data: &DataStruct,
) -> syn::Result<TokenStream> {
    let ident = &input.ident;

    if type_attrs.transparent {
        return expand_transparent_from_schema(input, type_attrs, data);
    }

    let with_bounds = add_trait_bounds(&input.generics, true, false);
    let (impl_generics, _, where_clause) = with_bounds.split_for_impl();
    let (_, ty_generics, _) = input.generics.split_for_impl();
    let private = private();

    let decoder = struct_decoder(ident, &data.fields, type_attrs)?;

    Ok(quote! {
        #[automatically_derived]
        impl #impl_generics #private::FromSchema for #ident #ty_generics #where_clause {
            fn from_value(
                value: &#private::SchemaValue,
            ) -> ::core::result::Result<Self, #private::FromSchemaError> {
                #decoder
            }
        }
    })
}

// ----------------------------------------------------------------------
// IntoSchema body (schema construction)
// ----------------------------------------------------------------------

fn struct_body_expr(fields: &Fields, type_attrs: &TypeAttrs) -> syn::Result<TokenStream> {
    let private = private();
    match fields {
        Fields::Named(named) => {
            let mut field_tokens: Vec<TokenStream> = Vec::new();
            for f in &named.named {
                let attrs = parse_item_attrs(&f.attrs)?;
                if attrs.skip || attrs.default_with.is_some() {
                    continue;
                }
                field_tokens.push(named_field_token(f, type_attrs, &attrs)?);
            }
            Ok(quote! {
                #private::SchemaType::record(::std::vec![ #( #field_tokens ),* ])
            })
        }
        Fields::Unnamed(unnamed) => {
            let element_tokens: Vec<TokenStream> = unnamed
                .unnamed
                .iter()
                .map(unnamed_element_body)
                .collect::<syn::Result<_>>()?;
            Ok(quote! {
                #private::SchemaType::tuple(::std::vec![ #( #element_tokens ),* ])
            })
        }
        Fields::Unit => Ok(quote! {
            #private::SchemaType::record(::std::vec::Vec::new())
        }),
    }
}

fn named_field_token(
    field: &Field,
    type_attrs: &TypeAttrs,
    item_attrs: &ItemAttrs,
) -> syn::Result<TokenStream> {
    let private = private();
    let ident = field
        .ident
        .as_ref()
        .expect("named field must have an ident");
    let name = item_attrs
        .rename
        .clone()
        .unwrap_or_else(|| default_name_for(ident, type_attrs.rename_all));
    let name_lit = LitStr::new(&name, ident.span());
    let body = body_expr_for_field(item_attrs, &field.ty)?;
    let metadata = metadata_expr_for_item(item_attrs);
    Ok(quote! {
        #private::NamedFieldType {
            name: ::std::string::String::from(#name_lit),
            body: #body,
            metadata: #metadata,
        }
    })
}

fn unnamed_element_body(field: &Field) -> syn::Result<TokenStream> {
    let item_attrs = parse_item_attrs(&field.attrs)?;
    body_expr_for_field(&item_attrs, &field.ty)
}

// ----------------------------------------------------------------------
// to_value
// ----------------------------------------------------------------------

fn struct_to_value(fields: &Fields, _type_attrs: &TypeAttrs) -> syn::Result<TokenStream> {
    let private = private();
    match fields {
        Fields::Named(named) => {
            let mut element_tokens: Vec<TokenStream> = Vec::new();
            for f in &named.named {
                let attrs = parse_item_attrs(&f.attrs)?;
                if attrs.skip || attrs.default_with.is_some() {
                    continue;
                }
                let ident = f.ident.as_ref().unwrap();
                let value_expr = quote! { self.#ident };
                element_tokens.push(to_value_expr(&attrs, &f.ty, value_expr));
            }
            Ok(quote! {
                #private::SchemaValue::Record {
                    fields: ::std::vec![ #( #element_tokens ),* ],
                }
            })
        }
        Fields::Unnamed(unnamed) => {
            let mut element_tokens: Vec<TokenStream> = Vec::new();
            for (i, f) in unnamed.unnamed.iter().enumerate() {
                let attrs = parse_item_attrs(&f.attrs)?;
                let idx = syn::Index::from(i);
                let value_expr = quote! { self.#idx };
                element_tokens.push(to_value_expr(&attrs, &f.ty, value_expr));
            }
            Ok(quote! {
                #private::SchemaValue::Tuple {
                    elements: ::std::vec![ #( #element_tokens ),* ],
                }
            })
        }
        Fields::Unit => Ok(quote! {
            #private::SchemaValue::Record { fields: ::std::vec::Vec::new() }
        }),
    }
}

// ----------------------------------------------------------------------
// FromSchema decoder
// ----------------------------------------------------------------------

fn struct_decoder(
    ident: &Ident,
    fields: &Fields,
    _type_attrs: &TypeAttrs,
) -> syn::Result<TokenStream> {
    let private = private();
    match fields {
        Fields::Named(named) => {
            // Determine the order of "encoded" fields (non-skipped/non-default)
            // because they correspond positionally to entries in the SchemaValue.
            let mut encoded_indices: Vec<usize> = Vec::new();
            let mut field_attrs: Vec<(usize, ItemAttrs)> = Vec::new();
            for (idx, f) in named.named.iter().enumerate() {
                let attrs = parse_item_attrs(&f.attrs)?;
                if !attrs.skip && attrs.default_with.is_none() {
                    encoded_indices.push(idx);
                }
                field_attrs.push((idx, attrs));
            }

            let mut bindings: Vec<TokenStream> = Vec::new();
            for (pos, &orig_idx) in encoded_indices.iter().enumerate() {
                let field = &named.named[orig_idx];
                let field_ident = field.ident.as_ref().unwrap();
                let ty = &field.ty;
                let pos_idx = syn::Index::from(pos);
                let attrs = &field_attrs[orig_idx].1;
                let read_value = quote! {
                    field_values.get(#pos_idx).ok_or_else(|| {
                        #private::FromSchemaError::custom(::std::format!(
                            "record field index {} out of bounds",
                            #pos_idx
                        ))
                    })?
                };
                let decoded = from_value_expr(attrs, ty, quote! { (#read_value) });
                bindings.push(quote! {
                    let #field_ident: #ty = #decoded;
                });
            }
            // Skipped / default fields get default values.
            for (orig_idx, attrs) in field_attrs.iter() {
                if !attrs.skip && attrs.default_with.is_none() {
                    continue;
                }
                let field = &named.named[*orig_idx];
                let field_ident = field.ident.as_ref().unwrap();
                let ty = &field.ty;
                let init = if let Some(path) = attrs.default_with.as_ref() {
                    let path_tokens: TokenStream =
                        path.parse().map_err(|e: proc_macro2::LexError| {
                            syn::Error::new(field.span(), format!("invalid default path: {e}"))
                        })?;
                    quote! { #path_tokens() }
                } else {
                    quote! { <#ty as ::core::default::Default>::default() }
                };
                bindings.push(quote! {
                    let #field_ident: #ty = #init;
                });
            }
            let inits = named.named.iter().map(|f| {
                let id = f.ident.as_ref().unwrap();
                quote! { #id }
            });
            Ok(quote! {
                let field_values: &::std::vec::Vec<#private::SchemaValue> = match value {
                    #private::SchemaValue::Record { fields } => fields,
                    other => {
                        return ::core::result::Result::Err(
                            #private::FromSchemaError::shape_mismatch(
                                "record",
                                #private::value_kind(other),
                                ::std::stringify!(#ident),
                            ),
                        );
                    }
                };
                #( #bindings )*
                ::core::result::Result::Ok(#ident { #( #inits ),* })
            })
        }
        Fields::Unnamed(unnamed) => {
            let len = unnamed.unnamed.len();
            let mut bindings: Vec<TokenStream> = Vec::new();
            for (idx, field) in unnamed.unnamed.iter().enumerate() {
                let attrs = parse_item_attrs(&field.attrs)?;
                let ty = &field.ty;
                let bind = quote::format_ident!("__field_{idx}");
                let idx_lit = syn::Index::from(idx);
                let read_value = quote! {
                    element_values.get(#idx_lit).ok_or_else(|| {
                        #private::FromSchemaError::custom(::std::format!(
                            "tuple element index {} out of bounds",
                            #idx_lit
                        ))
                    })?
                };
                let decoded = from_value_expr(&attrs, ty, quote! { (#read_value) });
                bindings.push(quote! {
                    let #bind: #ty = #decoded;
                });
            }
            let init_idents = (0..len).map(|i| quote::format_ident!("__field_{i}"));
            Ok(quote! {
                let element_values: &::std::vec::Vec<#private::SchemaValue> = match value {
                    #private::SchemaValue::Tuple { elements } => elements,
                    other => {
                        return ::core::result::Result::Err(
                            #private::FromSchemaError::shape_mismatch(
                                "tuple",
                                #private::value_kind(other),
                                ::std::stringify!(#ident),
                            ),
                        );
                    }
                };
                if element_values.len() != #len {
                    return ::core::result::Result::Err(
                        #private::FromSchemaError::custom(::std::format!(
                            "tuple struct length mismatch: expected {}, got {}",
                            #len,
                            element_values.len(),
                        ))
                    );
                }
                #( #bindings )*
                ::core::result::Result::Ok(#ident( #( #init_idents ),* ))
            })
        }
        Fields::Unit => Ok(quote! {
            match value {
                #private::SchemaValue::Record { fields } if fields.is_empty() => {
                    ::core::result::Result::Ok(#ident)
                }
                other => ::core::result::Result::Err(
                    #private::FromSchemaError::shape_mismatch(
                        "empty record",
                        #private::value_kind(other),
                        ::std::stringify!(#ident),
                    ),
                ),
            }
        }),
    }
}

// ----------------------------------------------------------------------
// Transparent newtypes
// ----------------------------------------------------------------------

fn expand_transparent_into_schema(
    input: &DeriveInput,
    _type_attrs: &TypeAttrs,
    data: &DataStruct,
) -> syn::Result<TokenStream> {
    let ident = &input.ident;
    let with_bounds = add_trait_bounds(&input.generics, false, true);
    let (impl_generics, _, where_clause) = with_bounds.split_for_impl();
    let (_, ty_generics, _) = input.generics.split_for_impl();
    let private = private();
    let inner_ty = sole_inner_type(input, data)?;

    Ok(quote! {
        #[automatically_derived]
        impl #impl_generics #private::IntoSchema for #ident #ty_generics #where_clause {
            fn type_id() -> #private::TypeId {
                <#inner_ty as #private::IntoSchema>::type_id()
            }
            fn register_in(builder: &mut #private::SchemaBuilder) -> #private::SchemaType {
                <#inner_ty as #private::IntoSchema>::register_in(builder)
            }
            fn to_value(&self) -> #private::SchemaValue {
                <#inner_ty as #private::IntoSchema>::to_value(&self.0)
            }
        }
    })
}

fn expand_transparent_from_schema(
    input: &DeriveInput,
    _type_attrs: &TypeAttrs,
    data: &DataStruct,
) -> syn::Result<TokenStream> {
    let ident = &input.ident;
    let with_bounds = add_trait_bounds(&input.generics, true, false);
    let (impl_generics, _, where_clause) = with_bounds.split_for_impl();
    let (_, ty_generics, _) = input.generics.split_for_impl();
    let private = private();
    let inner_ty = sole_inner_type(input, data)?;

    Ok(quote! {
        #[automatically_derived]
        impl #impl_generics #private::FromSchema for #ident #ty_generics #where_clause {
            fn from_value(
                value: &#private::SchemaValue,
            ) -> ::core::result::Result<Self, #private::FromSchemaError> {
                let inner = <#inner_ty as #private::FromSchema>::from_value(value)?;
                ::core::result::Result::Ok(#ident(inner))
            }
        }
    })
}

fn sole_inner_type(input: &DeriveInput, data: &DataStruct) -> syn::Result<syn::Type> {
    match &data.fields {
        Fields::Unnamed(u) if u.unnamed.len() == 1 => Ok(u.unnamed.first().unwrap().ty.clone()),
        _ => Err(syn::Error::new_spanned(
            &input.ident,
            "`#[schema(transparent)]` requires a tuple struct with exactly one field",
        )),
    }
}