improve(selection): emit Option when using @include or @Skip

Author: KonstantinSimeonov

examples/github/examples/github.rs

@@ -45,6 +45,7 @@ fn main() -> Result<(), anyhow::Error> {
     let variables = repo_view::Variables {
         owner: owner.to_string(),
         name: name.to_string(),
+        with_issues: true
     };
 
     let client = Client::builder()
@@ -81,6 +82,7 @@ fn main() -> Result<(), anyhow::Error> {
         .repository
         .expect("missing repository")
         .issues
+        .unwrap()
         .nodes
         .expect("issue nodes is null")
         .iter()

examples/github/examples/query_1.graphql

@@ -1,10 +1,10 @@
-query RepoView($owner: String!, $name: String!) {
+query RepoView($owner: String!, $name: String!, $withIssues: Boolean!) {
   repository(owner: $owner, name: $name) {
     homepageUrl
     stargazers {
       totalCount
     }
-    issues(first: 20, states: OPEN) {
+    issues(first: 20, states: OPEN) @include(if: $withIssues) {
       nodes {
         title
         comments {

graphql_client_codegen/src/codegen.rs

@@ -199,10 +199,10 @@ fn render_variable_field_type(
     let safe_name = shared::keyword_replace(normalized_name.clone());
     let full_name = Ident::new(safe_name.as_ref(), Span::call_site());
 
-    decorate_type(&full_name, &variable.r#type.qualifiers)
+    decorate_type(&full_name, &variable.r#type.qualifiers, false)
 }
 
-fn decorate_type(ident: &Ident, qualifiers: &[GraphqlTypeQualifier]) -> TokenStream {
+fn decorate_type(ident: &Ident, qualifiers: &[GraphqlTypeQualifier], skip_or_include: bool) -> TokenStream {
     let mut qualified = quote!(#ident);
 
     let mut non_null = false;
@@ -233,7 +233,8 @@ fn decorate_type(ident: &Ident, qualifiers: &[GraphqlTypeQualifier]) -> TokenStr
 
     // If we are in nullable context at the end of the iteration, we wrap the whole
     // type with an Option.
-    if !non_null {
+    // This can also happen if the field has a @skip or @include directive
+    if !non_null || skip_or_include {
         qualified = quote!(Option<#qualified>);
     }
 

graphql_client_codegen/src/codegen/inputs.rs

@@ -74,7 +74,7 @@ fn generate_struct(
                 None
             };
         let type_name = Ident::new(normalized_field_type_name.as_ref(), Span::call_site());
-        let field_type_tokens = super::decorate_type(&type_name, &field_type.qualifiers);
+        let field_type_tokens = super::decorate_type(&type_name, &field_type.qualifiers, false);
         let field_type = if field_type
             .id
             .as_input_id()
@@ -127,7 +127,7 @@ fn generate_enum(
         let mut qualifiers = vec![GraphqlTypeQualifier::Required];
         qualifiers.extend(field_type.qualifiers.iter().cloned());
 
-        let field_type_tokens = super::decorate_type(&type_name, &qualifiers);
+        let field_type_tokens = super::decorate_type(&type_name, &qualifiers, false);
         let field_type = if field_type
             .id
             .as_input_id()

graphql_client_codegen/src/codegen/selection.rs

@@ -82,6 +82,7 @@ fn calculate_custom_response_type_selection<'a>(
         flatten: false,
         boxed: false,
         deprecation: field.deprecation(),
+        skip_or_include: false
     });
 
     let struct_id = context.push_type(ExpandedType {
@@ -285,6 +286,8 @@ fn calculate_selection<'a>(
                                     struct_id,
                                     deprecation: None,
                                     boxed: fragment_is_recursive(*fragment_id, context.query.query),
+                                    // TODO
+                                    skip_or_include: false
                                 }),
                         }
                     }
@@ -331,6 +334,7 @@ fn calculate_selection<'a>(
                             flatten: false,
                             deprecation: schema_field.deprecation(),
                             boxed: false,
+                            skip_or_include: field.skip_or_include
                         });
                     }
                     TypeId::Scalar(scalar) => {
@@ -348,6 +352,7 @@ fn calculate_selection<'a>(
                             flatten: false,
                             deprecation: schema_field.deprecation(),
                             boxed: false,
+                            skip_or_include: field.skip_or_include
                         });
                     }
                     TypeId::Object(_) | TypeId::Interface(_) | TypeId::Union(_) => {
@@ -362,6 +367,7 @@ fn calculate_selection<'a>(
                             flatten: false,
                             boxed: false,
                             deprecation: schema_field.deprecation(),
+                            skip_or_include: field.skip_or_include
                         });
 
                         let type_id = context.push_type(ExpandedType {
@@ -407,6 +413,7 @@ fn calculate_selection<'a>(
                     flatten: true,
                     deprecation: None,
                     boxed: fragment_is_recursive(*fragment_id, context.query.query),
+                    skip_or_include: false
                 });
 
                 // We stop here, because the structs for the fragments are generated separately, to
@@ -434,6 +441,7 @@ struct ExpandedField<'a> {
     flatten: bool,
     deprecation: Option<Option<&'a str>>,
     boxed: bool,
+    skip_or_include: bool
 }
 
 impl ExpandedField<'_> {
@@ -442,6 +450,7 @@ impl ExpandedField<'_> {
         let qualified_type = decorate_type(
             &Ident::new(&self.field_type, Span::call_site()),
             self.field_type_qualifiers,
+            self.skip_or_include
         );
 
         let qualified_type = if self.boxed {

graphql_client_codegen/src/query.rs

@@ -318,11 +318,17 @@ where
                         ))
                     })?;
 
+                let has_skip_or_include = field
+                    .directives
+                    .iter()
+                    .any(|directive| ["skip", "include"].contains(&directive.name.as_ref()));
+
                 let id = query.push_selection(
                     Selection::Field(SelectedField {
                         alias: field.alias.as_ref().map(|alias| alias.as_ref().into()),
                         field_id,
                         selection_set: Vec::with_capacity(selection_set.items.len()),
+                        skip_or_include: has_skip_or_include
                     }),
                     parent,
                 );

graphql_client_codegen/src/query/selection.rs

@@ -257,6 +257,7 @@ pub(crate) struct SelectedField {
     pub(crate) alias: Option<String>,
     pub(crate) field_id: StoredFieldId,
     pub(crate) selection_set: Vec<SelectionId>,
+    pub(crate) skip_or_include: bool
 }
 
 impl SelectedField {

graphql_client_codegen/src/schema/graphql_parser_conversion.rs

@@ -184,7 +184,7 @@ fn ingest_object<'doc, T>(
             name: field.name.as_ref().into(),
             r#type: resolve_field_type(schema, &field.field_type),
             parent: super::StoredFieldParent::Object(object_id),
-            deprecation: find_deprecation(&field.directives),
+            deprecation: find_deprecation(&field.directives)
         };
 
         field_ids.push(schema.push_field(field));
@@ -221,7 +221,7 @@ fn ingest_object_type_extension<'doc, T>(
             name: field.name.as_ref().into(),
             r#type: resolve_field_type(schema, &field.field_type),
             parent: super::StoredFieldParent::Object(object_id),
-            deprecation: find_deprecation(&field.directives),
+            deprecation: find_deprecation(&field.directives)
         };
 
         field_ids.push(schema.push_field(field));
@@ -290,7 +290,7 @@ fn ingest_interface<'doc, T>(
             name: field.name.as_ref().into(),
             r#type: resolve_field_type(schema, &field.field_type),
             parent: super::StoredFieldParent::Interface(interface_id),
-            deprecation: find_deprecation(&field.directives),
+            deprecation: find_deprecation(&field.directives)
         };
 
         field_ids.push(schema.push_field(field));

graphql_client_codegen/src/schema/json_conversion.rs

@@ -183,7 +183,7 @@ fn ingest_interface(schema: &mut Schema, iface: &mut FullType) {
                 Some(field.deprecation_reason.clone())
             } else {
                 None
-            },
+            }
         };
 
         field_ids.push(schema.push_field(field));
@@ -218,7 +218,7 @@ fn ingest_object(schema: &mut Schema, object: &mut FullType) {
                 Some(field.deprecation_reason.clone())
             } else {
                 None
-            },
+            }
         };
 
         field_ids.push(schema.push_field(field));