Merge pull request #104 from 1Password/blitz/push-muqkuztzrytk

Add semantic nullability capability to async-graphql

Author: abliskovsky-agilebits

Cargo.toml

@@ -38,6 +38,7 @@ graphiql = ["dep:askama"]
 raw_value = ["async-graphql-value/raw_value"]
 boxed-trait = ["async-graphql-derive/boxed-trait"]
 custom-error-conversion = []
+nullable-result = []
 
 [[bench]]
 harness = false

derive/src/args.rs

@@ -237,6 +237,8 @@ pub struct SimpleObjectField {
     pub complexity: Option<Expr>,
     #[darling(default, multiple)]
     pub requires_scopes: Vec<String>,
+    #[darling(default)]
+    pub semantic_non_null: Option<bool>,
 }
 
 #[derive(FromDeriveInput)]
@@ -292,6 +294,8 @@ pub struct SimpleObject {
     pub requires_scopes: Vec<String>,
     #[darling(rename = "crate")]
     pub crate_path: Option<Path>,
+    #[darling(default)]
+    pub semantic_non_null: bool,
 }
 
 #[derive(FromMeta, Default)]
@@ -345,6 +349,8 @@ pub struct Object {
     pub requires_scopes: Vec<String>,
     #[darling(rename = "crate")]
     pub crate_path: Option<Path>,
+    #[darling(default)]
+    pub semantic_non_null: bool,
 }
 
 #[derive(FromMeta, Default)]
@@ -373,6 +379,7 @@ pub struct ObjectField {
     pub directives: Vec<Expr>,
     #[darling(default, multiple)]
     pub requires_scopes: Vec<String>,
+    pub semantic_non_null: Option<bool>,
 }
 
 #[derive(FromMeta, Default, Clone)]
@@ -681,6 +688,8 @@ pub struct InterfaceField {
     pub directives: Vec<Expr>,
     #[darling(default, multiple)]
     pub requires_scopes: Vec<String>,
+    #[darling(default)]
+    pub semantic_non_null: Option<bool>,
 }
 
 #[derive(FromVariant)]
@@ -719,6 +728,8 @@ pub struct Interface {
     pub tags: Vec<String>,
     #[darling(default, multiple, rename = "directive")]
     pub directives: Vec<Expr>,
+    #[darling(default)]
+    pub semantic_non_null: bool,
     // for OneofObject
     #[darling(default)]
     pub input_name: Option<String>,
@@ -765,6 +776,7 @@ pub struct Subscription {
     pub directives: Vec<Expr>,
     #[darling(rename = "crate")]
     pub crate_path: Option<Path>,
+    pub semantic_non_null: bool,
 }
 
 #[derive(FromMeta, Default)]
@@ -793,6 +805,7 @@ pub struct SubscriptionField {
     pub complexity: Option<Expr>,
     #[darling(default, multiple, rename = "directive")]
     pub directives: Vec<Expr>,
+    pub semantic_non_null: Option<bool>,
 }
 
 #[derive(FromField)]
@@ -997,6 +1010,7 @@ pub struct ComplexObject {
     pub guard: Option<Expr>,
     #[darling(rename = "crate")]
     pub crate_path: Option<Path>,
+    pub semantic_non_null: bool,
 }
 
 #[derive(FromMeta, Default)]
@@ -1024,6 +1038,7 @@ pub struct ComplexObjectField {
     pub directives: Vec<Expr>,
     #[darling(default, multiple)]
     pub requires_scopes: Vec<String>,
+    pub semantic_non_null: Option<bool>,
 }
 
 #[derive(FromMeta, Default)]

derive/src/complex_object.rs

@@ -130,7 +130,7 @@ pub fn generate(
                         .into());
                     }
                 };
-                let ty = ty.value_type();
+                let ty = ty.value_type(object_args.internal);
                 let ident = &method.sig.ident;
 
                 schema_fields.push(quote! {
@@ -330,7 +330,7 @@ pub fn generate(
                     .into());
                 }
             };
-            let schema_ty = ty.value_type();
+            let schema_ty = ty.value_type(object_args.internal);
             let visible = visible_fn(&method_args.visible);
 
             let complexity = if let Some(complexity) = &method_args.complexity {
@@ -375,6 +375,14 @@ pub fn generate(
             } else {
                 quote! { ::std::option::Option::None }
             };
+            let semantic_nullability = if method_args
+                .semantic_non_null
+                .unwrap_or(object_args.semantic_non_null)
+            {
+                quote! { <#schema_ty as #crate_name::OutputType>::semantic_nullability() }
+            } else {
+                quote! { #crate_name::registry::SemanticNullability::None }
+            };
 
             schema_fields.push(quote! {
                 #(#cfg_attrs)*
@@ -400,6 +408,7 @@ pub fn generate(
                     compute_complexity: #complexity,
                     directive_invocations: ::std::vec![ #(#directives),* ],
                     requires_scopes: ::std::vec![ #(#requires_scopes),* ],
+                    semantic_nullability: #semantic_nullability,
                 }));
             });
 

derive/src/interface.rs

@@ -170,6 +170,7 @@ pub fn generate(interface_args: &args::Interface) -> GeneratorResult<TokenStream
         override_from,
         directives,
         requires_scopes,
+        semantic_non_null,
     } in &interface_args.fields
     {
         let (name, method_name) = if let Some(method) = method {
@@ -304,7 +305,7 @@ pub fn generate(interface_args: &args::Interface) -> GeneratorResult<TokenStream
             OutputType::Value(ty) => ty,
             OutputType::Result(ty) => ty,
         };
-        let schema_ty = oty.value_type();
+        let schema_ty = oty.value_type(interface_args.internal);
 
         methods.push(quote! {
             #[allow(missing_docs)]
@@ -331,6 +332,12 @@ pub fn generate(interface_args: &args::Interface) -> GeneratorResult<TokenStream
             directives,
             TypeDirectiveLocation::FieldDefinition,
         );
+        let semantic_nullability = if semantic_non_null.unwrap_or(interface_args.semantic_non_null)
+        {
+            quote! { <#schema_ty as #crate_name::OutputType>::semantic_nullability() }
+        } else {
+            quote! { #crate_name::registry::SemanticNullability::None }
+        };
 
         schema_fields.push(quote! {
             fields.insert(::std::string::ToString::to_string(#name), #crate_name::registry::MetaField {
@@ -355,6 +362,7 @@ pub fn generate(interface_args: &args::Interface) -> GeneratorResult<TokenStream
                 compute_complexity: ::std::option::Option::None,
                 directive_invocations: ::std::vec![ #(#directives),* ],
                 requires_scopes: ::std::vec![ #(#requires_scopes),* ],
+                semantic_nullability: #semantic_nullability,
             });
         });
 

derive/src/object.rs

@@ -180,7 +180,7 @@ pub fn generate(
                     }
                 };
 
-                let entity_type = ty.value_type();
+                let entity_type = ty.value_type(object_args.internal);
                 let mut key_pat = Vec::new();
                 let mut key_getter = Vec::new();
                 let mut use_keys = Vec::new();
@@ -300,7 +300,7 @@ pub fn generate(
                             .into());
                         }
                     };
-                    let ty = ty.value_type();
+                    let ty = ty.value_type(object_args.internal);
                     let ident = &method.sig.ident;
 
                     schema_fields.push(quote! {
@@ -479,7 +479,7 @@ pub fn generate(
                         .into());
                     }
                 };
-                let schema_ty = ty.value_type();
+                let schema_ty = ty.value_type(object_args.internal);
                 let visible = visible_fn(&method_args.visible);
 
                 let complexity = if let Some(complexity) = &method_args.complexity {
@@ -524,6 +524,14 @@ pub fn generate(
                 } else {
                     quote! { ::std::option::Option::None }
                 };
+                let semantic_nullability = if method_args
+                    .semantic_non_null
+                    .unwrap_or(object_args.semantic_non_null)
+                {
+                    quote! { <#schema_ty as #crate_name::OutputType>::semantic_nullability() }
+                } else {
+                    quote! { #crate_name::registry::SemanticNullability::None }
+                };
 
                 schema_fields.push(quote! {
                     #(#cfg_attrs)*
@@ -549,6 +557,7 @@ pub fn generate(
                         compute_complexity: #complexity,
                         directive_invocations: ::std::vec![ #(#directives),* ],
                         requires_scopes: ::std::vec![ #(#requires_scopes),* ],
+                        semantic_nullability: #semantic_nullability,
                     });
                 });
 

derive/src/output_type.rs

@@ -2,6 +2,8 @@ use proc_macro2::{Ident, Span};
 use quote::quote;
 use syn::{Error, GenericArgument, PathArguments, Result, Type};
 
+use crate::utils::get_crate_path;
+
 pub enum OutputType<'a> {
     Value(&'a Type),
     Result(&'a Type),
@@ -42,10 +44,11 @@ impl<'a> OutputType<'a> {
         Ok(ty)
     }
 
-    pub fn value_type(&self) -> Type {
+    pub fn value_type(&self, internal: bool) -> Type {
+        let crate_name = get_crate_path(&None, internal);
         let tokens = match self {
             OutputType::Value(ty) => quote! {#ty},
-            OutputType::Result(ty) => quote! {#ty},
+            OutputType::Result(ty) => quote! {#crate_name::Result<#ty>},
         };
         let mut ty = syn::parse2::<syn::Type>(tokens).unwrap();
         Self::remove_lifecycle(&mut ty);

derive/src/simple_object.rs

@@ -227,6 +227,14 @@ pub fn generate(object_args: &args::SimpleObject) -> GeneratorResult<TokenStream
         } else {
             quote! { ::std::option::Option::None }
         };
+        let semantic_nullability = if field
+            .semantic_non_null
+            .unwrap_or(object_args.semantic_non_null)
+        {
+            quote! { <#ty as #crate_name::OutputType>::semantic_nullability() }
+        } else {
+            quote! { #crate_name::registry::SemanticNullability::None }
+        };
 
         if !field.flatten {
             schema_fields.push(quote! {
@@ -248,6 +256,7 @@ pub fn generate(object_args: &args::SimpleObject) -> GeneratorResult<TokenStream
                     compute_complexity: #complexity,
                     directive_invocations: ::std::vec![ #(#directives),* ],
                     requires_scopes: ::std::vec![ #(#requires_scopes),* ],
+                    semantic_nullability: #semantic_nullability,
                 });
             });
         } else {

derive/src/subscription.rs

@@ -184,7 +184,10 @@ pub fn generate(
                     .into());
                 }
             };
-            let res_ty = ty.value_type();
+            let res_ty = match ty {
+                OutputType::Value(ty) => ty,
+                OutputType::Result(ty) => ty,
+            };
             let stream_ty = if let Type::ImplTrait(TypeImplTrait { bounds, .. }) = &res_ty {
                 let mut r = None;
                 for b in bounds {
@@ -196,6 +199,14 @@ pub fn generate(
             } else {
                 quote! { #res_ty }
             };
+            let output_ty = match ty {
+                OutputType::Value(_) => {
+                    quote! { <#stream_ty as #crate_name::futures_util::stream::Stream>::Item }
+                }
+                OutputType::Result(_) => {
+                    quote! { #crate_name::Result<<#stream_ty as #crate_name::futures_util::stream::Stream>::Item> }
+                }
+            };
 
             if let OutputType::Value(inner_ty) = &ty {
                 let block = &method.block;
@@ -261,6 +272,15 @@ pub fn generate(
                 TypeDirectiveLocation::FieldDefinition,
             );
 
+            let semantic_nullability = if field
+                .semantic_non_null
+                .unwrap_or(subscription_args.semantic_non_null)
+            {
+                quote! { <#output_ty as #crate_name::OutputType>::semantic_nullability() }
+            } else {
+                quote! { #crate_name::registry::SemanticNullability::None }
+            };
+
             schema_fields.push(quote! {
                 #(#cfg_attrs)*
                 fields.insert(::std::borrow::ToOwned::to_owned(#field_name), #crate_name::registry::MetaField {
@@ -271,7 +291,7 @@ pub fn generate(
                         #(#schema_args)*
                         args
                     },
-                    ty: <<#stream_ty as #crate_name::futures_util::stream::Stream>::Item as #crate_name::OutputType>::create_type_info(registry),
+                    ty: <#output_ty as #crate_name::OutputType>::create_type_info(registry),
                     deprecation: #field_deprecation,
                     cache_control: ::std::default::Default::default(),
                     external: false,
@@ -285,6 +305,7 @@ pub fn generate(
                     compute_complexity: #complexity,
                     directive_invocations: ::std::vec![ #(#directives),* ],
                     requires_scopes: ::std::vec![],
+                    semantic_nullability: #semantic_nullability,
                 });
             });
 
@@ -348,7 +369,7 @@ pub fn generate(
                                     let ri = #crate_name::extensions::ResolveInfo {
                                         path_node: ctx_selection_set.path_node.as_ref().unwrap(),
                                         parent_type: &parent_type,
-                                        return_type: &<<#stream_ty as #crate_name::futures_util::stream::Stream>::Item as #crate_name::OutputType>::qualified_type_name(),
+                                        return_type: &<#output_ty as #crate_name::OutputType>::qualified_type_name(),
                                         name: field.node.name.node.as_str(),
                                         alias: field.node.alias.as_ref().map(|alias| alias.node.as_str()),
                                         is_for_introspection: false,