apollo-errors-derive 0.4.0

Proc macro for deriving apollo-errors::Error trait
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
//! apollo_errors::Error trait implementation generation

use proc_macro2::TokenStream;
use quote::quote;

use crate::ir::{EnumDefinition, FieldDefinition, RegularVariantDefinition, VariantDefinition};

use super::helpers::{generate_regular_match_arms, generate_transparent_match_arms};
use crate::codegen::helpers::{DEFAULT_JSONRPC_CODE, generate_http_headers_body};

/// Generate code to serialize a field value.
/// Returns `Option<(&str, Value)>` - None if the field is Option and value is None.
fn generate_field_value(field: &FieldDefinition) -> TokenStream {
    let private = quote!(::apollo_errors::private);
    let serde_json_crate = quote!(#private::serde_json);

    let rust_name = &field.rust_name;
    let output_name = &field.output_name;

    if field.is_option {
        quote! {
            #rust_name.as_ref().map(|__apollo_inner| {
                (#output_name, #serde_json_crate::to_value(__apollo_inner).unwrap_or(#serde_json_crate::Value::Null))
            })
        }
    } else {
        quote! {
            ::std::option::Option::Some((#output_name, #serde_json_crate::to_value(#rust_name).unwrap_or(#serde_json_crate::Value::Null)))
        }
    }
}

/// Generate field values for extension fields in a variant
fn generate_extension_field_values(variant: &RegularVariantDefinition) -> Vec<TokenStream> {
    variant
        .fields
        .iter()
        .filter(|f| f.is_extension)
        .map(generate_field_value)
        .collect()
}

/// Generate the apollo_errors::Error trait implementation
pub fn generate_apollo_error_impl(ir: &EnumDefinition) -> TokenStream {
    // References to external crates
    let private = quote!(::apollo_errors::private);
    let serde_json_crate = quote!(#private::serde_json);

    let name = &ir.name;
    let (impl_generics, ty_generics, where_clause) = ir.generics.split_for_impl();

    let to_json_arms = generate_to_json_arms(&ir.variants);
    let to_debug_arms = generate_to_debug_arms(&ir.variants);
    let to_html_arms = generate_to_html_arms(&ir.variants);
    let to_graphql_arms = generate_to_graphql_arms(&ir.variants);
    let to_text_arms = generate_to_text_arms(&ir.variants);
    let to_jsonrpc_arms = generate_to_jsonrpc_arms(&ir.variants);

    // Generate http_status() method for regular variants
    let http_status_regular_arms =
        generate_regular_match_arms(&ir.variants, |variant, _pattern| {
            // Default to 500 if not specified
            let status = variant.http_status.unwrap_or(500);
            quote! { ::apollo_errors::http::StatusCode::from_u16(#status).unwrap() }
        });

    // Generate http_status() method for transparent variants (delegates to inner)
    let http_status_transparent_arms =
        generate_transparent_match_arms(&ir.variants, |_variant, _pattern| {
            quote! { ::apollo_errors::Error::http_status(inner) }
        });

    // Generate http_headers() method for regular variants
    let http_headers_regular_arms =
        generate_regular_match_arms(&ir.variants, |variant, _pattern| {
            generate_http_headers_body(&variant.fields, false)
        });

    // Generate http_headers() method for transparent variants (delegates to inner)
    let http_headers_transparent_arms =
        generate_transparent_match_arms(&ir.variants, |_variant, _pattern| {
            quote! { ::apollo_errors::Error::http_headers(inner) }
        });

    quote! {
        #[automatically_derived]
        impl #impl_generics ::apollo_errors::Error for #name #ty_generics #where_clause {
            fn to_json(&self) -> ::std::result::Result<#serde_json_crate::Value, #serde_json_crate::Error> {
                match self {
                    #(#to_json_arms)*
                }
            }

            fn to_debug(&self) -> ::std::string::String {
                match self {
                    #(#to_debug_arms)*
                }
            }

            fn to_html(&self) -> ::std::string::String {
                match self {
                    #(#to_html_arms)*
                }
            }

            fn to_graphql(&self) -> ::std::result::Result<#serde_json_crate::Value, #serde_json_crate::Error> {
                match self {
                    #(#to_graphql_arms)*
                }
            }

            fn to_text(&self) -> ::std::string::String {
                match self {
                    #(#to_text_arms)*
                }
            }

            fn to_jsonrpc(&self) -> ::std::result::Result<#serde_json_crate::Value, #serde_json_crate::Error> {
                let __apollo_message = ::std::string::ToString::to_string(self);
                let __apollo_diagnostic_code = ::apollo_errors::private::diagnostic_code(self);
                match self {
                    #(#to_jsonrpc_arms)*
                }
            }

            fn http_status(&self) -> ::apollo_errors::http::StatusCode {
                match self {
                    #(#http_status_regular_arms)*
                    #(#http_status_transparent_arms)*
                }
            }

            fn http_headers(&self) -> Vec<(::apollo_errors::http::HeaderName, ::apollo_errors::http::HeaderValue)> {
                match self {
                    #(#http_headers_regular_arms)*
                    #(#http_headers_transparent_arms)*
                }
            }
        }
    }
}

/// Generate match arms for to_json method (returns serde_json::Value)
fn generate_to_json_arms(variants: &[VariantDefinition]) -> Vec<TokenStream> {
    // References to external crates
    let private = quote!(::apollo_errors::private);
    let serde_json_crate = quote!(#private::serde_json);

    let regular_arms = generate_regular_match_arms(variants, |variant, _pattern| {
        let field_values = generate_extension_field_values(variant);

        if field_values.is_empty() {
            quote! {
                {
                    let __apollo_code = ::apollo_errors::private::diagnostic_code(self);
                    let __apollo_message = ::std::string::ToString::to_string(self);
                    ::std::result::Result::Ok(#serde_json_crate::json!({
                        "error": __apollo_code,
                        "message": __apollo_message
                    }))
                }
            }
        } else {
            quote! {
                {
                    let __apollo_code = ::apollo_errors::private::diagnostic_code(self);
                    let __apollo_message = ::std::string::ToString::to_string(self);
                    let mut __apollo_obj = #serde_json_crate::json!({
                        "error": __apollo_code,
                        "message": __apollo_message
                    });
                    if let #serde_json_crate::Value::Object(ref mut __apollo_map) = __apollo_obj {
                        #(
                            if let ::std::option::Option::Some((__apollo_key, __apollo_value)) = #field_values {
                                __apollo_map.insert(__apollo_key.to_string(), __apollo_value);
                            }
                        )*
                    }
                    ::std::result::Result::Ok(__apollo_obj)
                }
            }
        }
    });

    let transparent_arms = generate_transparent_match_arms(variants, |_variant, _pattern| {
        quote! { ::apollo_errors::Error::to_json(inner) }
    });

    regular_arms.into_iter().chain(transparent_arms).collect()
}

/// Generate match arms for to_debug method
fn generate_to_debug_arms(variants: &[VariantDefinition]) -> Vec<TokenStream> {
    let regular_arms = generate_regular_match_arms(variants, |variant, _pattern| {
        // Generate field debug strings
        let field_debug_items: Vec<_> = variant
            .fields
            .iter()
            .map(|field| {
                let rust_name = &field.rust_name;
                let field_name_str = rust_name.to_string();

                quote! {
                    format!("{}: {:?}", #field_name_str, #rust_name)
                }
            })
            .collect();

        let variant_name = &variant.name;
        if field_debug_items.is_empty() {
            quote! {
                format!("{}", stringify!(#variant_name))
            }
        } else {
            // Generate compile-time string concatenation instead of runtime Vec allocation
            quote! {
                format!("{} {{ {} }}", stringify!(#variant_name), [#(#field_debug_items),*].join(", "))
            }
        }
    });

    let transparent_arms = generate_transparent_match_arms(variants, |_variant, _pattern| {
        quote! { ::apollo_errors::Error::to_debug(inner) }
    });

    regular_arms.into_iter().chain(transparent_arms).collect()
}

/// Generate match arms for to_graphql method (returns serde_json::Value)
fn generate_to_graphql_arms(variants: &[VariantDefinition]) -> Vec<TokenStream> {
    // References to external crates
    let private = quote!(::apollo_errors::private);
    let serde_json_crate = quote!(#private::serde_json);

    let regular_arms = generate_regular_match_arms(variants, |variant, _pattern| {
        let extension_fields = generate_extension_field_values(variant);

        if extension_fields.is_empty() {
            quote! {
                {
                    let __apollo_code = ::apollo_errors::private::diagnostic_code(self);
                    let __apollo_message = ::std::string::ToString::to_string(self);
                    ::std::result::Result::Ok(#serde_json_crate::json!({
                        "message": __apollo_message,
                        "extensions": {
                            "code": __apollo_code
                        }
                    }))
                }
            }
        } else {
            quote! {
                {
                    let __apollo_code = ::apollo_errors::private::diagnostic_code(self);
                    let __apollo_message = ::std::string::ToString::to_string(self);
                    let mut __apollo_extensions = #serde_json_crate::json!({
                        "code": __apollo_code
                    });
                    if let #serde_json_crate::Value::Object(ref mut __apollo_map) = __apollo_extensions {
                        #(
                            if let ::std::option::Option::Some((__apollo_key, __apollo_value)) = #extension_fields {
                                __apollo_map.insert(__apollo_key.to_string(), __apollo_value);
                            }
                        )*
                    }
                    ::std::result::Result::Ok(#serde_json_crate::json!({
                        "message": __apollo_message,
                        "extensions": __apollo_extensions
                    }))
                }
            }
        }
    });

    let transparent_arms = generate_transparent_match_arms(variants, |_variant, _pattern| {
        quote! { ::apollo_errors::Error::to_graphql(inner) }
    });

    regular_arms.into_iter().chain(transparent_arms).collect()
}

/// Generate match arms for to_text method
fn generate_to_text_arms(variants: &[VariantDefinition]) -> Vec<TokenStream> {
    let regular_arms = generate_regular_match_arms(variants, |_variant, _pattern| {
        quote! {
            {
                let __apollo_code = ::apollo_errors::private::diagnostic_code(self);
                let __apollo_message = ::std::string::ToString::to_string(self);
                format!("[{__apollo_code}] {__apollo_message}")
            }
        }
    });

    let transparent_arms = generate_transparent_match_arms(variants, |_variant, _pattern| {
        quote! { ::apollo_errors::Error::to_text(inner) }
    });

    regular_arms.into_iter().chain(transparent_arms).collect()
}

/// Generate match arms for to_html method
fn generate_to_html_arms(variants: &[VariantDefinition]) -> Vec<TokenStream> {
    let regular_arms = generate_regular_match_arms(variants, |variant, _pattern| {
        // Generate extension fields for HTML
        let extension_fields = generate_extension_field_html(variant);

        quote! {
            {
                let __apollo_code = ::apollo_errors::private::diagnostic_code(self);
                let __apollo_message = ::std::string::ToString::to_string(self);
                let __apollo_help_html = ::apollo_errors::private::diagnostic_help(self)
                    .map(|h| format!("<p class=\"error-help\">{}</p>", ::apollo_errors::private::HtmlEscaped(h)))
                    .unwrap_or_default();
                let __apollo_extensions_html = #extension_fields;
                format!(
                    "<div class=\"error\">\n<h3 class=\"error-code\">{}</h3>\n<p class=\"error-message\">{}</p>\n{}{}\n</div>",
                    ::apollo_errors::private::HtmlEscaped(__apollo_code),
                    ::apollo_errors::private::HtmlEscaped(&__apollo_message),
                    __apollo_help_html,
                    __apollo_extensions_html
                )
            }
        }
    });

    let transparent_arms = generate_transparent_match_arms(variants, |_variant, _pattern| {
        quote! { ::apollo_errors::Error::to_html(inner) }
    });

    regular_arms.into_iter().chain(transparent_arms).collect()
}

fn generate_extension_field_html(variant: &RegularVariantDefinition) -> TokenStream {
    let field_items: Vec<_> = variant
        .fields
        .iter()
        .filter(|f| f.is_extension)
        .map(|field| {
            let rust_name = &field.rust_name;
            let output_name = &field.output_name;

            if field.is_option {
                quote! {
                    #rust_name.as_ref().map(|__apollo_inner| {
                        format!("<div class=\"error-field\"><span class=\"field-name\">{}:</span> <span class=\"field-value\">{}</span></div>",
                            #output_name,
                            ::apollo_errors::private::HtmlEscaped(__apollo_inner)
                        )
                    })
                }
            } else {
                quote! {
                    ::std::option::Option::Some(format!("<div class=\"error-field\"><span class=\"field-name\">{}:</span> <span class=\"field-value\">{}</span></div>",
                        #output_name,
                        ::apollo_errors::private::HtmlEscaped(#rust_name)
                    ))
                }
            }
        })
        .collect();

    if field_items.is_empty() {
        quote! { ::std::string::String::new() }
    } else {
        quote! {
            {
                let mut __apollo_fields: Vec<::std::string::String> = Vec::new();
                #(
                    if let ::std::option::Option::Some(__apollo_field_html) = #field_items {
                        __apollo_fields.push(__apollo_field_html);
                    }
                )*
                if __apollo_fields.is_empty() {
                    ::std::string::String::new()
                } else {
                    format!("\n<div class=\"error-extensions\">\n{}\n</div>", __apollo_fields.join("\n"))
                }
            }
        }
    }
}

/// Generate match arms for to_jsonrpc method (returns serde_json::Value)
fn generate_to_jsonrpc_arms(variants: &[VariantDefinition]) -> Vec<TokenStream> {
    // References to external crates
    let private = quote!(::apollo_errors::private);
    let serde_json_crate = quote!(#private::serde_json);

    let regular_arms = generate_regular_match_arms(variants, |variant, _pattern| {
        let extension_fields = generate_extension_field_values(variant);
        let jsonrpc_code = variant.jsonrpc_code.unwrap_or(DEFAULT_JSONRPC_CODE);

        quote! {
            {
                let mut __apollo_data = #serde_json_crate::json!({
                    "diagnostic_code": __apollo_diagnostic_code
                });
                if let #serde_json_crate::Value::Object(ref mut __apollo_map) = __apollo_data {
                    #(
                        if let ::std::option::Option::Some((__apollo_key, __apollo_value)) = #extension_fields {
                            __apollo_map.insert(__apollo_key.to_string(), __apollo_value);
                        }
                    )*
                }
                ::std::result::Result::Ok(#serde_json_crate::json!({
                    "code": #jsonrpc_code,
                    "message": __apollo_message,
                    "data": __apollo_data
                }))
            }
        }
    });

    let transparent_arms = generate_transparent_match_arms(variants, |_variant, _pattern| {
        quote! { ::apollo_errors::Error::to_jsonrpc(inner) }
    });

    regular_arms.into_iter().chain(transparent_arms).collect()
}