async-graphql/derive/src/object.rs

527 lines
22 KiB
Rust
Raw Normal View History

2020-03-01 10:54:34 +00:00
use crate::args;
2020-03-06 15:58:43 +00:00
use crate::output_type::OutputType;
use crate::utils::{get_cfg_attrs, get_crate_name, get_param_getter_ident, get_rustdoc};
2020-03-09 12:00:57 +00:00
use inflector::Inflector;
2020-03-01 10:54:34 +00:00
use proc_macro::TokenStream;
use quote::quote;
use syn::ext::IdentExt;
2020-05-01 23:57:34 +00:00
use syn::{Block, Error, FnArg, ImplItem, ItemImpl, Pat, Result, ReturnType, Type, TypeReference};
2020-03-05 06:23:55 +00:00
pub fn generate(object_args: &args::Object, item_impl: &mut ItemImpl) -> Result<TokenStream> {
2020-03-02 00:24:49 +00:00
let crate_name = get_crate_name(object_args.internal);
2020-03-05 06:23:55 +00:00
let (self_ty, self_name) = match item_impl.self_ty.as_ref() {
Type::Path(path) => (
path,
path.path
.segments
.last()
.map(|s| s.ident.to_string())
.unwrap(),
),
_ => return Err(Error::new_spanned(&item_impl.self_ty, "Invalid type")),
2020-03-01 10:54:34 +00:00
};
2020-03-05 06:23:55 +00:00
let generics = &item_impl.generics;
let where_clause = &item_impl.generics.where_clause;
2020-04-09 14:03:09 +00:00
let extends = object_args.extends;
2020-03-01 10:54:34 +00:00
let gql_typename = object_args
.name
.clone()
2020-03-05 06:23:55 +00:00
.unwrap_or_else(|| self_name.clone());
2020-03-19 09:20:12 +00:00
2020-03-03 11:15:18 +00:00
let desc = object_args
.desc
.clone()
.or_else(|| get_rustdoc(&item_impl.attrs).ok().flatten())
.map(|s| quote! { Some(#s) })
2020-03-03 11:15:18 +00:00
.unwrap_or_else(|| quote! {None});
2020-03-05 06:23:55 +00:00
2020-03-01 10:54:34 +00:00
let mut resolvers = Vec::new();
2020-03-03 03:48:00 +00:00
let mut schema_fields = Vec::new();
2020-04-09 14:03:09 +00:00
let mut find_entities = Vec::new();
let mut add_keys = Vec::new();
let mut create_entity_types = Vec::new();
2020-03-01 10:54:34 +00:00
2020-03-05 06:23:55 +00:00
for item in &mut item_impl.items {
if let ImplItem::Method(method) = item {
2020-06-03 06:50:06 +00:00
if args::Entity::parse(&crate_name, &method.attrs)?.is_some() {
let cfg_attrs = get_cfg_attrs(&method.attrs);
2020-06-02 04:02:14 +00:00
if method.sig.asyncness.is_none() {
return Err(Error::new_spanned(&method, "Must be asynchronous"));
}
2020-04-27 04:57:52 +00:00
let ty = match &method.sig.output {
ReturnType::Type(_, ty) => OutputType::parse(ty)?,
ReturnType::Default => {
return Err(Error::new_spanned(&method.sig.output, "Missing type"))
}
};
2020-05-01 23:57:34 +00:00
let mut create_ctx = true;
2020-04-27 04:57:52 +00:00
let mut args = Vec::new();
for (idx, arg) in method.sig.inputs.iter_mut().enumerate() {
if let FnArg::Receiver(receiver) = arg {
if idx != 0 {
return Err(Error::new_spanned(
receiver,
"The self receiver must be the first parameter.",
));
}
} else if let FnArg::Typed(pat) = arg {
if idx == 0 {
return Err(Error::new_spanned(
pat,
"The self receiver must be the first parameter.",
));
}
match (&*pat.pat, &*pat.ty) {
(Pat::Ident(arg_ident), Type::Path(arg_ty)) => {
args.push((
2020-05-01 23:57:34 +00:00
arg_ident.clone(),
arg_ty.clone(),
2020-04-27 04:57:52 +00:00
args::Argument::parse(&crate_name, &pat.attrs)?,
));
pat.attrs.clear();
}
2020-05-01 23:57:34 +00:00
(arg, Type::Reference(TypeReference { elem, .. })) => {
2020-04-27 04:57:52 +00:00
if let Type::Path(path) = elem.as_ref() {
if idx != 1
|| path.path.segments.last().unwrap().ident != "Context"
{
return Err(Error::new_spanned(
arg,
"The Context must be the second argument.",
));
2020-05-01 23:57:34 +00:00
} else {
create_ctx = false;
2020-04-27 04:57:52 +00:00
}
}
}
_ => return Err(Error::new_spanned(arg, "Invalid argument type.")),
}
}
}
2020-05-01 23:57:34 +00:00
if create_ctx {
2020-05-05 05:02:24 +00:00
let arg =
syn::parse2::<FnArg>(quote! { _: &#crate_name::Context<'_> }).unwrap();
2020-05-01 23:57:34 +00:00
method.sig.inputs.insert(1, arg);
}
2020-04-27 04:57:52 +00:00
let entity_type = ty.value_type();
let mut key_pat = Vec::new();
let mut key_getter = Vec::new();
let mut use_keys = Vec::new();
let mut keys = Vec::new();
let mut keys_str = String::new();
let mut requires_getter = Vec::new();
2020-06-19 04:49:45 +00:00
let all_key = args.iter().all(|(_, _, arg)| !arg.key);
2020-04-27 04:57:52 +00:00
if args.is_empty() {
return Err(Error::new_spanned(
method,
"Entity need to have at least one key.",
));
}
for (ident, ty, args::Argument { name, key, .. }) in &args {
2020-06-19 04:49:45 +00:00
let is_key = all_key || *key;
2020-04-27 04:57:52 +00:00
let name = name
.clone()
.unwrap_or_else(|| ident.ident.unraw().to_string().to_camel_case());
2020-04-27 04:57:52 +00:00
if is_key {
if !keys_str.is_empty() {
keys_str.push(' ');
}
keys_str.push_str(&name);
2020-04-27 04:57:52 +00:00
key_pat.push(quote! {
Some(#ident)
});
key_getter.push(quote! {
params.get(#name).and_then(|value| {
let value: Option<#ty> = #crate_name::InputValueType::parse(Some(value.clone())).ok();
value
})
});
keys.push(name);
use_keys.push(ident);
} else {
// requires
requires_getter.push(quote! {
let #ident: #ty = #crate_name::InputValueType::parse(params.get(#name).cloned()).
2020-09-12 16:42:15 +00:00
map_err(|err| err.into_error(ctx.item.pos, <#ty as #crate_name::Type>::qualified_type_name()))?;
});
use_keys.push(ident);
}
2020-04-27 04:57:52 +00:00
}
2020-04-27 04:57:52 +00:00
add_keys.push(quote! { registry.add_keys(&<#entity_type as #crate_name::Type>::type_name(), #keys_str); });
create_entity_types.push(
quote! { <#entity_type as #crate_name::Type>::create_type_info(registry); },
);
let field_ident = &method.sig.ident;
2020-05-01 23:57:34 +00:00
if let OutputType::Value(inner_ty) = &ty {
let block = &method.block;
2020-05-03 23:59:30 +00:00
let new_block = quote!({
{
let value:#inner_ty = async move #block.await;
Ok(value)
}
});
method.block = syn::parse2::<Block>(new_block).expect("invalid block");
2020-05-01 23:57:34 +00:00
method.sig.output = syn::parse2::<ReturnType>(
quote! { -> #crate_name::FieldResult<#inner_ty> },
)
.expect("invalid result type");
}
2020-09-12 16:42:15 +00:00
let do_find = quote! { self.#field_ident(ctx, #(#use_keys),*).await.map_err(|err| err.into_error(ctx.item.pos))? };
2020-05-01 23:57:34 +00:00
2020-04-27 04:57:52 +00:00
find_entities.push((
args.len(),
quote! {
#(#cfg_attrs)*
2020-04-27 04:57:52 +00:00
if typename == &<#entity_type as #crate_name::Type>::type_name() {
if let (#(#key_pat),*) = (#(#key_getter),*) {
#(#requires_getter)*
2020-09-12 16:42:15 +00:00
let ctx_obj = ctx.with_selection_set(&ctx.item.node.selection_set);
2020-05-20 00:18:28 +00:00
return #crate_name::OutputValueType::resolve(&#do_find, &ctx_obj, ctx.item).await;
2020-04-27 04:57:52 +00:00
}
}
},
));
method.attrs.remove(
method
.attrs
.iter()
.enumerate()
.find(|(_, a)| a.path.is_ident("entity"))
.map(|(idx, _)| idx)
.unwrap(),
);
2020-05-01 23:57:34 +00:00
} else if let Some(field) = args::Field::parse(&crate_name, &method.attrs)? {
if method.sig.asyncness.is_none() {
2020-05-01 23:57:34 +00:00
return Err(Error::new_spanned(&method, "Must be asynchronous"));
}
2020-03-05 06:23:55 +00:00
let field_name = field
.name
.clone()
.unwrap_or_else(|| method.sig.ident.unraw().to_string().to_camel_case());
2020-03-05 06:23:55 +00:00
let field_desc = field
.desc
.as_ref()
.map(|s| quote! {Some(#s)})
.unwrap_or_else(|| quote! {None});
let field_deprecation = field
.deprecation
.as_ref()
.map(|s| quote! {Some(#s)})
.unwrap_or_else(|| quote! {None});
2020-04-09 14:03:09 +00:00
let external = field.external;
let requires = match &field.requires {
Some(requires) => quote! { Some(#requires) },
None => quote! { None },
};
let provides = match &field.provides {
Some(provides) => quote! { Some(#provides) },
None => quote! { None },
};
2020-03-05 06:23:55 +00:00
let ty = match &method.sig.output {
2020-03-06 15:58:43 +00:00
ReturnType::Type(_, ty) => OutputType::parse(ty)?,
2020-03-05 06:23:55 +00:00
ReturnType::Default => {
2020-03-06 15:58:43 +00:00
return Err(Error::new_spanned(&method.sig.output, "Missing type"))
2020-03-05 06:23:55 +00:00
}
};
2020-03-22 08:45:59 +00:00
let cache_control = {
let public = field.cache_control.public;
let max_age = field.cache_control.max_age;
quote! {
#crate_name::CacheControl {
public: #public,
max_age: #max_age,
}
}
};
let cfg_attrs = get_cfg_attrs(&method.attrs);
2020-03-05 06:23:55 +00:00
2020-05-01 23:57:34 +00:00
let mut create_ctx = true;
2020-03-05 06:23:55 +00:00
let mut args = Vec::new();
2020-03-02 11:25:21 +00:00
2020-03-05 06:23:55 +00:00
for (idx, arg) in method.sig.inputs.iter_mut().enumerate() {
if let FnArg::Receiver(receiver) = arg {
if idx != 0 {
return Err(Error::new_spanned(
receiver,
"The self receiver must be the first parameter.",
));
}
} else if let FnArg::Typed(pat) = arg {
if idx == 0 {
return Err(Error::new_spanned(
pat,
"The self receiver must be the first parameter.",
));
}
2020-03-04 02:38:07 +00:00
2020-03-05 06:23:55 +00:00
match (&*pat.pat, &*pat.ty) {
(Pat::Ident(arg_ident), Type::Path(arg_ty)) => {
2020-03-21 07:07:11 +00:00
args.push((
2020-05-01 23:57:34 +00:00
arg_ident.clone(),
arg_ty.clone(),
2020-03-21 07:07:11 +00:00
args::Argument::parse(&crate_name, &pat.attrs)?,
));
2020-03-05 06:23:55 +00:00
pat.attrs.clear();
}
2020-05-01 23:57:34 +00:00
(arg, Type::Reference(TypeReference { elem, .. })) => {
2020-03-05 06:23:55 +00:00
if let Type::Path(path) = elem.as_ref() {
if idx != 1
2020-03-21 01:32:13 +00:00
|| path.path.segments.last().unwrap().ident != "Context"
2020-03-05 06:23:55 +00:00
{
return Err(Error::new_spanned(
arg,
"The Context must be the second argument.",
));
}
2020-05-01 23:57:34 +00:00
create_ctx = false;
2020-03-05 06:23:55 +00:00
}
}
_ => return Err(Error::new_spanned(arg, "Invalid argument type.")),
}
}
2020-03-04 02:38:07 +00:00
}
2020-05-01 23:57:34 +00:00
if create_ctx {
2020-05-05 05:02:24 +00:00
let arg =
syn::parse2::<FnArg>(quote! { _: &#crate_name::Context<'_> }).unwrap();
2020-05-01 23:57:34 +00:00
method.sig.inputs.insert(1, arg);
}
2020-03-05 06:23:55 +00:00
let mut schema_args = Vec::new();
let mut use_params = Vec::new();
let mut get_params = Vec::new();
2020-03-04 02:38:07 +00:00
2020-03-05 06:23:55 +00:00
for (
ident,
ty,
args::Argument {
name,
desc,
default,
2020-03-22 01:34:32 +00:00
validator,
..
2020-03-05 06:23:55 +00:00
},
) in args
{
2020-03-09 12:00:57 +00:00
let name = name
.clone()
.unwrap_or_else(|| ident.ident.unraw().to_string().to_camel_case());
2020-03-05 06:23:55 +00:00
let desc = desc
.as_ref()
.map(|s| quote! {Some(#s)})
.unwrap_or_else(|| quote! {None});
let schema_default = default
.as_ref()
.map(|value| {
quote! {Some( <#ty as #crate_name::InputValueType>::to_value(&#value).to_string() )}
2020-03-05 06:23:55 +00:00
})
.unwrap_or_else(|| quote! {None});
schema_args.push(quote! {
args.insert(#name, #crate_name::registry::MetaInputValue {
2020-03-05 06:23:55 +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-05 06:23:55 +00:00
default_value: #schema_default,
2020-03-22 01:34:32 +00:00
validator: #validator,
2020-03-08 12:35:36 +00:00
});
2020-03-05 06:23:55 +00:00
});
2020-08-17 13:48:53 +00:00
let param_ident = &ident.ident;
use_params.push(quote! { #param_ident });
2020-03-05 06:23:55 +00:00
let default = match default {
Some(default) => quote! { Some(|| -> #ty { #default }) },
None => quote! { None },
2020-03-05 06:23:55 +00:00
};
2020-06-03 06:50:06 +00:00
let param_getter_name = get_param_getter_ident(&ident.ident.to_string());
2020-03-05 06:23:55 +00:00
get_params.push(quote! {
2020-06-03 06:50:06 +00:00
let #param_getter_name = || -> #crate_name::Result<#ty> { ctx.param_value(#name, #default) };
let #ident: #ty = #param_getter_name()?;
2020-03-05 06:23:55 +00:00
});
2020-03-03 03:48:00 +00:00
}
2020-03-01 10:54:34 +00:00
let schema_ty = ty.value_type();
2020-03-22 08:45:59 +00:00
2020-03-05 06:23:55 +00:00
schema_fields.push(quote! {
#(#cfg_attrs)*
fields.insert(#field_name.to_string(), #crate_name::registry::MetaField {
2020-03-19 09:20:12 +00:00
name: #field_name.to_string(),
2020-03-05 06:23:55 +00:00
description: #field_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-05 06:23:55 +00:00
deprecation: #field_deprecation,
2020-03-22 08:45:59 +00:00
cache_control: #cache_control,
2020-04-09 14:03:09 +00:00
external: #external,
provides: #provides,
requires: #requires,
2020-03-08 12:35:36 +00:00
});
2020-03-02 11:25:21 +00:00
});
2020-03-05 06:23:55 +00:00
let field_ident = &method.sig.ident;
2020-05-01 23:57:34 +00:00
if let OutputType::Value(inner_ty) = &ty {
let block = &method.block;
2020-05-03 23:59:30 +00:00
let new_block = quote!({
{
let value:#inner_ty = async move #block.await;
Ok(value)
}
});
method.block = syn::parse2::<Block>(new_block).expect("invalid block");
2020-05-01 23:57:34 +00:00
method.sig.output = syn::parse2::<ReturnType>(
quote! { -> #crate_name::FieldResult<#inner_ty> },
)
.expect("invalid result type");
}
2020-05-01 23:57:34 +00:00
let resolve_obj = quote! {
{
2020-05-05 05:02:24 +00:00
let res = self.#field_ident(ctx, #(#use_params),*).await;
2020-09-12 16:42:15 +00:00
res.map_err(|err| err.into_error_with_path(ctx.item.pos, ctx.path_node.as_ref()))?
2020-03-05 06:23:55 +00:00
}
};
2020-05-05 05:02:24 +00:00
let guard = field
.guard
.map(|guard| quote! {
#guard.check(ctx).await
2020-09-12 16:42:15 +00:00
.map_err(|err| err.into_error_with_path(ctx.item.pos, ctx.path_node.as_ref()))?;
2020-05-05 05:02:24 +00:00
});
2020-06-03 06:50:06 +00:00
let post_guard = field
.post_guard
.map(|guard| quote! {
#guard.check(ctx, &res).await
2020-09-12 16:42:15 +00:00
.map_err(|err| err.into_error_with_path(ctx.item.pos, ctx.path_node.as_ref()))?;
2020-06-03 06:50:06 +00:00
});
2020-05-05 05:02:24 +00:00
2020-03-05 06:23:55 +00:00
resolvers.push(quote! {
#(#cfg_attrs)*
2020-09-12 16:42:15 +00:00
if ctx.item.node.name.node == #field_name {
2020-03-05 06:23:55 +00:00
#(#get_params)*
#guard
2020-09-12 16:42:15 +00:00
let ctx_obj = ctx.with_selection_set(&ctx.item.node.selection_set);
2020-06-03 06:50:06 +00:00
let res = #resolve_obj;
#post_guard
return #crate_name::OutputValueType::resolve(&res, &ctx_obj, ctx.item).await;
2020-03-05 06:23:55 +00:00
}
2020-03-02 11:25:21 +00:00
});
2020-03-01 10:54:34 +00:00
2020-04-27 06:14:29 +00:00
if let Some((idx, _)) = method
.attrs
.iter()
.enumerate()
.find(|(_, a)| a.path.is_ident("field"))
{
method.attrs.remove(idx);
}
2020-04-28 07:01:19 +00:00
} else if let Some((idx, _)) = method
.attrs
.iter()
.enumerate()
.find(|(_, a)| a.path.is_ident("field"))
{
method.attrs.remove(idx);
2020-03-03 03:48:00 +00:00
}
2020-03-05 06:23:55 +00:00
}
2020-03-02 00:24:49 +00:00
}
2020-03-22 08:45:59 +00:00
let cache_control = {
let public = object_args.cache_control.public;
let max_age = object_args.cache_control.max_age;
quote! {
#crate_name::CacheControl {
public: #public,
max_age: #max_age,
}
}
};
2020-04-09 14:03:09 +00:00
find_entities.sort_by(|(a, _), (b, _)| b.cmp(a));
let find_entities_iter = find_entities.iter().map(|(_, code)| code);
2020-03-01 10:54:34 +00:00
let expanded = quote! {
2020-03-05 06:23:55 +00:00
#item_impl
2020-03-01 10:54:34 +00:00
#[allow(clippy::all, clippy::pedantic)]
impl #generics #crate_name::Type for #self_ty #where_clause {
fn type_name() -> ::std::borrow::Cow<'static, str> {
::std::borrow::Cow::Borrowed(#gql_typename)
2020-03-01 10:54:34 +00:00
}
2020-03-03 03:48:00 +00:00
2020-03-03 11:15:18 +00:00
fn create_type_info(registry: &mut #crate_name::registry::Registry) -> String {
let ty = registry.create_type::<Self, _>(|registry| #crate_name::registry::MetaType::Object {
2020-03-19 09:20:12 +00:00
name: #gql_typename.to_string(),
2020-03-03 11:15:18 +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-22 08:45:59 +00:00
cache_control: #cache_control,
2020-04-09 14:03:09 +00:00
extends: #extends,
keys: None,
});
#(#create_entity_types)*
#(#add_keys)*
ty
2020-03-03 03:48:00 +00:00
}
2020-03-01 10:54:34 +00:00
}
#[allow(clippy::all, clippy::pedantic, clippy::suspicious_else_formatting)]
2020-08-17 13:48:53 +00:00
#[allow(unused_braces, unused_variables, unused_parens, unused_mut)]
2020-03-02 00:24:49 +00:00
#[#crate_name::async_trait::async_trait]
2020-09-12 09:29:52 +00:00
impl#generics #crate_name::resolver_utils::ObjectType for #self_ty #where_clause {
async fn resolve_field(&self, ctx: &#crate_name::Context<'_>) -> #crate_name::Result<#crate_name::serde_json::Value> {
2020-03-06 15:58:43 +00:00
#(#resolvers)*
Err(#crate_name::QueryError::FieldNotFound {
2020-09-12 16:42:15 +00:00
field_name: ctx.item.node.name.to_string(),
2020-03-06 15:58:43 +00:00
object: #gql_typename.to_string(),
2020-09-12 16:42:15 +00:00
}.into_error(ctx.item.pos))
2020-03-01 10:54:34 +00:00
}
2020-04-09 14:03:09 +00:00
async fn find_entity(&self, ctx: &#crate_name::Context<'_>, params: &#crate_name::Value) -> #crate_name::Result<#crate_name::serde_json::Value> {
2020-04-09 14:03:09 +00:00
let params = match params {
#crate_name::Value::Object(params) => params,
2020-09-12 16:42:15 +00:00
_ => return Err(#crate_name::QueryError::EntityNotFound.into_error(ctx.item.pos)),
2020-04-09 14:03:09 +00:00
};
let typename = if let Some(#crate_name::Value::String(typename)) = params.get("__typename") {
typename
} else {
2020-09-12 16:42:15 +00:00
return Err(#crate_name::QueryError::TypeNameNotExists.into_error(ctx.item.pos));
2020-04-09 14:03:09 +00:00
};
#(#find_entities_iter)*
2020-09-12 16:42:15 +00:00
Err(#crate_name::QueryError::EntityNotFound.into_error(ctx.item.pos))
2020-04-09 14:03:09 +00:00
}
2020-03-01 10:54:34 +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::OutputValueType for #self_ty #where_clause {
2020-09-06 05:38:31 +00:00
async fn resolve(&self, ctx: &#crate_name::ContextSelectionSet<'_>, _field: &#crate_name::Positioned<#crate_name::parser::types::Field>) -> #crate_name::Result<#crate_name::serde_json::Value> {
2020-09-12 09:29:52 +00:00
#crate_name::resolver_utils::resolve_object(ctx, self).await
2020-03-19 09:20:12 +00:00
}
}
2020-03-01 10:54:34 +00:00
};
Ok(expanded.into())
}