async-graphql/derive/src/interface.rs

372 lines
14 KiB
Rust
Raw Normal View History

2020-09-28 09:44:00 +00:00
use darling::ast::{Data, Style};
2020-03-06 15:58:43 +00:00
use proc_macro::TokenStream;
use proc_macro2::{Ident, Span};
use quote::quote;
2020-05-11 03:03:13 +00:00
use std::collections::HashSet;
use syn::visit_mut::VisitMut;
use syn::{visit_mut, Error, Lifetime, Type};
2020-03-06 15:58:43 +00:00
2020-10-16 02:45:27 +00:00
use crate::args::{self, InterfaceField, InterfaceFieldArgument, RenameRuleExt, RenameTarget};
use crate::output_type::OutputType;
use crate::utils::{generate_default, get_crate_name, get_rustdoc, GeneratorResult};
2020-09-28 09:44:00 +00:00
pub fn generate(interface_args: &args::Interface) -> GeneratorResult<TokenStream> {
2020-03-06 15:58:43 +00:00
let crate_name = get_crate_name(interface_args.internal);
2020-09-28 09:44:00 +00:00
let ident = &interface_args.ident;
let generics = &interface_args.generics;
let s = match &interface_args.data {
2020-05-11 03:03:13 +00:00
Data::Enum(s) => s,
_ => {
2020-09-28 09:44:00 +00:00
return Err(
Error::new_spanned(ident, "Interface can only be applied to an enum.").into(),
)
2020-05-11 03:03:13 +00:00
}
2020-03-06 15:58:43 +00:00
};
2020-04-09 14:03:09 +00:00
let extends = interface_args.extends;
2020-03-06 15:58:43 +00:00
let mut enum_names = Vec::new();
2020-05-11 03:03:13 +00:00
let mut enum_items = HashSet::new();
2020-03-06 15:58:43 +00:00
let mut type_into_impls = Vec::new();
let gql_typename = interface_args
.name
.clone()
2020-10-14 09:08:57 +00:00
.unwrap_or_else(|| RenameTarget::Type.rename(ident.to_string()));
2020-09-28 09:44:00 +00:00
let desc = get_rustdoc(&interface_args.attrs)?
2020-10-16 10:37:59 +00:00
.map(|s| quote! { ::std::option::Option::Some(#s) })
.unwrap_or_else(|| quote! {::std::option::Option::None});
2020-03-06 15:58:43 +00:00
let mut registry_types = Vec::new();
let mut possible_types = Vec::new();
let mut get_introspection_typename = Vec::new();
2020-09-12 09:29:52 +00:00
let mut collect_all_fields = Vec::new();
2020-03-06 15:58:43 +00:00
2020-09-28 09:44:00 +00:00
for variant in s {
2020-05-11 03:03:13 +00:00
let enum_name = &variant.ident;
2020-09-28 09:44:00 +00:00
let ty = match variant.fields.style {
Style::Tuple if variant.fields.fields.len() == 1 => &variant.fields.fields[0],
Style::Tuple => {
2020-05-11 03:03:13 +00:00
return Err(Error::new_spanned(
2020-09-28 09:44:00 +00:00
enum_name,
2020-05-11 03:03:13 +00:00
"Only single value variants are supported",
2020-09-28 09:44:00 +00:00
)
.into())
2020-05-11 03:03:13 +00:00
}
2020-09-28 09:44:00 +00:00
Style::Unit => {
return Err(
Error::new_spanned(enum_name, "Empty variants are not supported").into(),
)
2020-05-11 03:03:13 +00:00
}
2020-09-28 09:44:00 +00:00
Style::Struct => {
2020-05-11 03:03:13 +00:00
return Err(Error::new_spanned(
2020-09-28 09:44:00 +00:00
enum_name,
2020-05-11 03:03:13 +00:00
"Variants with named fields are not supported",
2020-09-28 09:44:00 +00:00
)
.into())
2020-05-11 03:03:13 +00:00
}
};
2020-09-28 09:44:00 +00:00
if let Type::Path(p) = ty {
2020-05-11 03:03:13 +00:00
// This validates that the field type wasn't already used
if !enum_items.insert(p) {
2020-09-28 09:44:00 +00:00
return Err(
Error::new_spanned(ty, "This type already used in another variant").into(),
);
2020-05-11 03:03:13 +00:00
}
struct RemoveLifetime;
impl VisitMut for RemoveLifetime {
fn visit_lifetime_mut(&mut self, i: &mut Lifetime) {
i.ident = Ident::new("_", Span::call_site());
visit_mut::visit_lifetime_mut(self, i);
}
}
let mut assert_ty = p.clone();
RemoveLifetime.visit_type_path_mut(&mut assert_ty);
2020-05-11 03:03:13 +00:00
type_into_impls.push(quote! {
#crate_name::static_assertions::assert_impl_any!(#assert_ty: #crate_name::ObjectType, #crate_name::InterfaceType);
#[allow(clippy::all, clippy::pedantic)]
2020-09-17 05:43:08 +00:00
impl #generics ::std::convert::From<#p> for #ident #generics {
2020-05-11 03:03:13 +00:00
fn from(obj: #p) -> Self {
#ident::#enum_name(obj)
2020-03-06 15:58:43 +00:00
}
2020-05-11 03:03:13 +00:00
}
});
enum_names.push(enum_name);
2020-04-20 06:37:28 +00:00
2020-05-11 03:03:13 +00:00
registry_types.push(quote! {
<#p as #crate_name::Type>::create_type_info(registry);
registry.add_implements(&<#p as #crate_name::Type>::type_name(), #gql_typename);
});
2020-04-20 06:37:28 +00:00
2020-05-11 03:03:13 +00:00
possible_types.push(quote! {
2020-10-16 19:21:46 +00:00
possible_types.insert(<#p as #crate_name::Type>::type_name().into_owned());
2020-05-11 03:03:13 +00:00
});
2020-04-20 06:37:28 +00:00
2020-05-11 03:03:13 +00:00
get_introspection_typename.push(quote! {
#ident::#enum_name(obj) => <#p as #crate_name::Type>::type_name()
2020-09-12 09:29:52 +00:00
});
collect_all_fields.push(quote! {
#ident::#enum_name(obj) => obj.collect_all_fields(ctx, fields)
});
2020-05-11 03:03:13 +00:00
} else {
2020-09-28 09:44:00 +00:00
return Err(Error::new_spanned(ty, "Invalid type").into());
2020-03-06 15:58:43 +00:00
}
}
let mut methods = Vec::new();
let mut schema_fields = Vec::new();
let mut resolvers = Vec::new();
if interface_args.fields.is_empty() {
return Err(Error::new_spanned(
&ident,
2020-10-22 02:11:47 +00:00
"A GraphQL Interface type must define one or more fields.",
)
.into());
}
2020-03-06 15:58:43 +00:00
for InterfaceField {
name,
method,
2020-03-06 15:58:43 +00:00
desc,
ty,
args,
deprecation,
2020-04-09 14:03:09 +00:00
external,
provides,
requires,
2020-03-06 15:58:43 +00:00
} in &interface_args.fields
{
let (name, method_name) = if let Some(method) = method {
(name.to_string(), Ident::new(method, Span::call_site()))
} else {
let method_name = Ident::new(&name, Span::call_site());
2020-10-14 09:08:57 +00:00
(
interface_args
.rename_fields
.rename(name, RenameTarget::Field),
method_name,
)
};
2020-09-28 09:44:00 +00:00
let ty = match syn::parse_str::<syn::Type>(&ty.value()) {
Ok(ty) => ty,
Err(_) => return Err(Error::new_spanned(&ty, "Expect type").into()),
};
2020-03-06 15:58:43 +00:00
let mut calls = Vec::new();
let mut use_params = Vec::new();
let mut decl_params = Vec::new();
let mut get_params = Vec::new();
let mut schema_args = Vec::new();
2020-04-09 14:03:09 +00:00
let requires = match &requires {
2020-10-16 10:37:59 +00:00
Some(requires) => quote! { ::std::option::Option::Some(#requires) },
None => quote! { ::std::option::Option::None },
2020-04-09 14:03:09 +00:00
};
let provides = match &provides {
2020-10-16 10:37:59 +00:00
Some(provides) => quote! { ::std::option::Option::Some(#provides) },
None => quote! { ::std::option::Option::None },
2020-04-09 14:03:09 +00:00
};
2020-03-06 15:58:43 +00:00
2020-05-01 23:57:34 +00:00
decl_params.push(quote! { ctx: &'ctx #crate_name::Context<'ctx> });
use_params.push(quote! { ctx });
2020-03-07 03:21:56 +00:00
2020-03-06 15:58:43 +00:00
for InterfaceFieldArgument {
name,
desc,
ty,
default,
2020-09-28 09:44:00 +00:00
default_with,
2020-03-06 15:58:43 +00:00
} in args
{
let ident = Ident::new(name, Span::call_site());
2020-10-14 09:08:57 +00:00
let name = interface_args
.rename_args
.rename(name, RenameTarget::Argument);
2020-09-28 09:44:00 +00:00
let ty = match syn::parse_str::<syn::Type>(&ty.value()) {
Ok(ty) => ty,
Err(_) => return Err(Error::new_spanned(&ty, "Expect type").into()),
};
2020-03-06 15:58:43 +00:00
decl_params.push(quote! { #ident: #ty });
2020-03-07 03:21:56 +00:00
use_params.push(quote! { #ident });
2020-03-06 15:58:43 +00:00
2020-09-28 09:44:00 +00:00
let default = generate_default(&default, &default_with)?;
let get_default = match &default {
2020-10-16 10:37:59 +00:00
Some(default) => quote! { ::std::option::Option::Some(|| -> #ty { #default }) },
None => quote! { ::std::option::Option::None },
2020-03-06 15:58:43 +00:00
};
get_params.push(quote! {
let #ident: #ty = ctx.param_value(#name, #get_default)?;
2020-03-06 15:58:43 +00:00
});
let desc = desc
.as_ref()
2020-10-16 10:37:59 +00:00
.map(|s| quote! {::std::option::Option::Some(#s)})
.unwrap_or_else(|| quote! {::std::option::Option::None});
2020-03-06 15:58:43 +00:00
let schema_default = default
.as_ref()
.map(|value| {
2020-10-16 19:21:46 +00:00
quote! {
::std::option::Option::Some(::std::string::ToString::to_string(
&<#ty as #crate_name::InputType>::to_value(&#value)
2020-10-16 19:21:46 +00:00
))
}
2020-03-06 15:58:43 +00:00
})
2020-10-16 10:37:59 +00:00
.unwrap_or_else(|| quote! {::std::option::Option::None});
2020-03-06 15:58:43 +00:00
schema_args.push(quote! {
args.insert(#name, #crate_name::registry::MetaInputValue {
2020-03-06 15:58:43 +00:00
name: #name,
description: #desc,
2020-03-19 09:20:12 +00:00
ty: <#ty as #crate_name::Type>::create_type_info(registry),
2020-03-06 15:58:43 +00:00
default_value: #schema_default,
2020-10-16 10:37:59 +00:00
validator: ::std::option::Option::None,
2020-03-08 12:35:36 +00:00
});
2020-03-06 15:58:43 +00:00
});
}
for enum_name in &enum_names {
calls.push(quote! {
2020-10-31 00:58:54 +00:00
#ident::#enum_name(obj) => obj.#method_name(#(#use_params),*).await.map(::std::convert::Into::into)
2020-03-06 15:58:43 +00:00
});
}
let desc = desc
.as_ref()
2020-10-16 10:37:59 +00:00
.map(|s| quote! {::std::option::Option::Some(#s)})
.unwrap_or_else(|| quote! {::std::option::Option::None});
2020-03-06 15:58:43 +00:00
let deprecation = deprecation
.as_ref()
2020-10-16 10:37:59 +00:00
.map(|s| quote! {::std::option::Option::Some(#s)})
.unwrap_or_else(|| quote! {::std::option::Option::None});
2020-03-06 15:58:43 +00:00
2020-09-28 09:44:00 +00:00
let oty = OutputType::parse(&ty)?;
2020-05-01 23:57:34 +00:00
let ty = match oty {
OutputType::Value(ty) => ty,
OutputType::Result(_, ty) => ty,
};
let schema_ty = oty.value_type();
methods.push(quote! {
#[inline]
pub async fn #method_name<'ctx>(&self, #(#decl_params),*) -> #crate_name::Result<#ty> {
2020-05-01 23:57:34 +00:00
match self {
#(#calls,)*
}
}
});
2020-03-06 15:58:43 +00:00
schema_fields.push(quote! {
2020-10-16 19:21:46 +00:00
fields.insert(::std::string::ToString::to_string(#name), #crate_name::registry::MetaField {
name: ::std::string::ToString::to_string(#name),
2020-03-06 15:58:43 +00:00
description: #desc,
2020-03-08 12:35:36 +00:00
args: {
let mut args = #crate_name::indexmap::IndexMap::new();
2020-03-08 12:35:36 +00:00
#(#schema_args)*
args
},
2020-03-19 09:20:12 +00:00
ty: <#schema_ty as #crate_name::Type>::create_type_info(registry),
2020-03-06 15:58:43 +00:00
deprecation: #deprecation,
2020-10-16 10:37:59 +00:00
cache_control: ::std::default::Default::default(),
2020-04-09 14:03:09 +00:00
external: #external,
provides: #provides,
requires: #requires,
2020-03-08 12:35:36 +00:00
});
2020-03-06 15:58:43 +00:00
});
2020-05-01 23:57:34 +00:00
let resolve_obj = quote! {
2020-10-16 10:37:59 +00:00
self.#method_name(#(#use_params),*)
.await
.map_err(|err| err.into_server_error().at(ctx.item.pos))?
2020-03-06 15:58:43 +00:00
};
resolvers.push(quote! {
2020-09-12 16:42:15 +00:00
if ctx.item.node.name.node == #name {
2020-03-06 15:58:43 +00:00
#(#get_params)*
2020-09-12 16:42:15 +00:00
let ctx_obj = ctx.with_selection_set(&ctx.item.node.selection_set);
return #crate_name::OutputType::resolve(&#resolve_obj, &ctx_obj, ctx.item).await.map(::std::option::Option::Some);
2020-03-06 15:58:43 +00:00
}
});
}
2020-04-20 06:37:28 +00:00
let introspection_type_name = if get_introspection_typename.is_empty() {
2020-10-16 10:37:59 +00:00
quote! { ::std::unreachable!() }
2020-04-20 06:37:28 +00:00
} else {
quote! {
match self {
#(#get_introspection_typename),*
}
}
};
2020-03-06 15:58:43 +00:00
let expanded = quote! {
#(#type_into_impls)*
#[allow(clippy::all, clippy::pedantic)]
2020-03-06 15:58:43 +00:00
impl #generics #ident #generics {
#(#methods)*
}
#[allow(clippy::all, clippy::pedantic)]
2020-03-19 09:20:12 +00:00
impl #generics #crate_name::Type for #ident #generics {
2020-10-16 10:37:59 +00:00
fn type_name() -> ::std::borrow::Cow<'static, ::std::primitive::str> {
::std::borrow::Cow::Borrowed(#gql_typename)
2020-03-06 15:58:43 +00:00
}
2020-10-16 10:37:59 +00:00
fn introspection_type_name(&self) -> ::std::borrow::Cow<'static, ::std::primitive::str> {
2020-04-20 06:37:28 +00:00
#introspection_type_name
}
2020-10-16 10:37:59 +00:00
fn create_type_info(registry: &mut #crate_name::registry::Registry) -> ::std::string::String {
2020-03-06 15:58:43 +00:00
registry.create_type::<Self, _>(|registry| {
#(#registry_types)*
#crate_name::registry::MetaType::Interface {
2020-10-16 19:21:46 +00:00
name: ::std::string::ToString::to_string(#gql_typename),
2020-03-06 15:58:43 +00:00
description: #desc,
2020-03-08 12:35:36 +00:00
fields: {
let mut fields = #crate_name::indexmap::IndexMap::new();
2020-03-08 12:35:36 +00:00
#(#schema_fields)*
fields
},
2020-03-10 10:07:47 +00:00
possible_types: {
let mut possible_types = #crate_name::indexmap::IndexSet::new();
2020-03-10 10:07:47 +00:00
#(#possible_types)*
possible_types
},
2020-04-09 14:03:09 +00:00
extends: #extends,
2020-10-16 10:37:59 +00:00
keys: ::std::option::Option::None,
2020-03-06 15:58:43 +00:00
}
})
}
}
#[allow(clippy::all, clippy::pedantic)]
2020-03-06 15:58:43 +00:00
#[#crate_name::async_trait::async_trait]
2020-09-29 23:45:48 +00:00
impl #generics #crate_name::resolver_utils::ContainerType for #ident #generics {
2020-10-16 10:37:59 +00:00
async fn resolve_field(&self, ctx: &#crate_name::Context<'_>) -> #crate_name::ServerResult<::std::option::Option<#crate_name::Value>> {
2020-03-06 15:58:43 +00:00
#(#resolvers)*
2020-10-16 10:37:59 +00:00
::std::result::Result::Ok(::std::option::Option::None)
2020-03-06 15:58:43 +00:00
}
2020-03-07 02:39:55 +00:00
fn collect_all_fields<'__life>(&'__life self, ctx: &#crate_name::ContextSelectionSet<'__life>, fields: &mut #crate_name::resolver_utils::Fields<'__life>) -> #crate_name::ServerResult<()> {
2020-09-12 09:29:52 +00:00
match self {
#(#collect_all_fields),*
}
2020-03-07 02:39:55 +00:00
}
2020-03-06 15:58:43 +00:00
}
2020-03-19 09:20:12 +00:00
#[allow(clippy::all, clippy::pedantic)]
2020-03-19 09:20:12 +00:00
#[#crate_name::async_trait::async_trait]
impl #generics #crate_name::OutputType for #ident #generics {
2020-10-10 02:32:43 +00:00
async fn resolve(&self, ctx: &#crate_name::ContextSelectionSet<'_>, _field: &#crate_name::Positioned<#crate_name::parser::types::Field>) -> #crate_name::ServerResult<#crate_name::Value> {
2020-09-29 23:45:48 +00:00
#crate_name::resolver_utils::resolve_container(ctx, self).await
2020-03-19 09:20:12 +00:00
}
}
2020-09-29 23:45:48 +00:00
impl #generics #crate_name::InterfaceType for #ident #generics {}
2020-03-06 15:58:43 +00:00
};
Ok(expanded.into())
}