Fix partially expanded unions and interfaces

We need all variants to be able to deserialize the enum, but some of
them may be empty

Author: tomhoule

graphql_query_derive/src/interfaces.rs

@@ -1,16 +1,16 @@
-use constants::*;
 use failure;
 use objects::GqlObjectField;
 use proc_macro2::{Ident, Span, TokenStream};
 use query::QueryContext;
 use selection::{Selection, SelectionItem};
 use shared::*;
 use std::borrow::Cow;
+use std::collections::HashSet;
 use unions::union_variants;
 
 #[derive(Debug, PartialEq)]
 pub struct GqlInterface {
-    pub implemented_by: Vec<String>,
+    pub implemented_by: HashSet<String>,
     pub name: String,
     pub fields: Vec<GqlObjectField>,
 }
@@ -19,7 +19,7 @@ impl GqlInterface {
     pub fn new(name: Cow<str>) -> GqlInterface {
         GqlInterface {
             name: name.into_owned(),
-            implemented_by: Vec::new(),
+            implemented_by: HashSet::new(),
             fields: vec![],
         }
     }
@@ -60,9 +60,19 @@ impl GqlInterface {
 
         let object_children =
             field_impls_for_selection(&self.fields, query_context, &object_selection, prefix)?;
-        let (union_variants, union_children) =
+        let (mut union_variants, union_children, used_variants) =
             union_variants(&union_selection, query_context, prefix)?;
 
+        union_variants.extend(
+            self.implemented_by
+                .iter()
+                .filter(|obj| used_variants.iter().find(|v| v == obj).is_none())
+                .map(|v| {
+                    let v = Ident::new(v, Span::call_site());
+                    quote!(#v)
+                }),
+        );
+
         let attached_enum_name = Ident::new(&format!("{}On", name), Span::call_site());
         let (attached_enum, last_object_field) = if union_variants.len() > 0 {
             let attached_enum = quote! {

graphql_query_derive/src/schema.rs

@@ -191,6 +191,16 @@ impl Schema {
 
         })
     }
+
+    pub fn ingest_interface_implementations(&mut self, impls: BTreeMap<String, Vec<String>>) {
+        impls.into_iter().for_each(|(iface_name, implementors)| {
+            let iface = self
+                .interfaces
+                .get_mut(&iface_name)
+                .expect(&format!("interface not found: {}", iface_name));
+            iface.implemented_by = implementors.into_iter().collect();
+        });
+    }
 }
 
 impl ::std::convert::From<graphql_parser::schema::Document> for Schema {
@@ -259,6 +269,8 @@ impl ::std::convert::From<graphql_parser::schema::Document> for Schema {
             }
         }
 
+        schema.ingest_interface_implementations(interface_implementations);
+
         schema
     }
 }
@@ -356,6 +368,8 @@ impl ::std::convert::From<::introspection_response::IntrospectionResponse> for S
             }
         }
 
+        schema.ingest_interface_implementations(interface_implementations);
+
         schema
     }
 }

graphql_query_derive/src/unions.rs

@@ -21,8 +21,9 @@ pub fn union_variants(
     selection: &Selection,
     query_context: &QueryContext,
     prefix: &str,
-) -> Result<(Vec<TokenStream>, Vec<TokenStream>), failure::Error> {
+) -> Result<(Vec<TokenStream>, Vec<TokenStream>, Vec<String>), failure::Error> {
     let mut children_definitions = Vec::new();
+    let mut used_variants = Vec::with_capacity(selection.0.len());
 
     let variants: Result<Vec<TokenStream>, failure::Error> = selection
             .0
@@ -41,6 +42,7 @@ pub fn union_variants(
                     SelectionItem::FragmentSpread(_) => Err(format_err!("fragment spread on union"))?,
                     SelectionItem::InlineFragment(frag) => {
                         let variant_name = Ident::new(&frag.on, Span::call_site());
+                        used_variants.push(frag.on.to_string());
 
                         let new_prefix = format!("{}On{}", prefix, frag.on);
 
@@ -83,7 +85,7 @@ pub fn union_variants(
 
     let variants = variants?;
 
-    Ok((variants, children_definitions))
+    Ok((variants, children_definitions, used_variants))
 }
 
 impl GqlUnion {
@@ -103,7 +105,18 @@ impl GqlUnion {
             })?;
         }
 
-        let (variants, children_definitions) = union_variants(selection, query_context, prefix)?;
+        let (mut variants, children_definitions, used_variants) =
+            union_variants(selection, query_context, prefix)?;
+
+        variants.extend(
+            self.0
+                .iter()
+                .filter(|v| used_variants.iter().find(|a| a == v).is_none())
+                .map(|v| {
+                    let v = Ident::new(v, Span::call_site());
+                    quote!(#v)
+                }),
+        );
 
         Ok(quote!{
             #(#children_definitions)*

tests/interfaces.rs

@@ -28,3 +28,29 @@ fn interface_deserialization() {
 
     assert_eq!(response_data.everything.map(|names| names.len()), Some(4));
 }
+
+#[derive(GraphQLQuery)]
+#[GraphQLQuery(
+    query_path = "tests/interfaces/interface_not_on_everything_query.graphql",
+    schema_path = "tests/interfaces/interface_schema.graphql"
+)]
+#[allow(dead_code)]
+struct InterfaceNotOnEverythingQuery;
+
+const RESPONSE_NOT_ON_EVERYTHING: &'static str =
+    include_str!("interfaces/interface_response_not_on_everything.json");
+
+#[test]
+fn interface_not_on_everything_deserialization() {
+    println!("{:?}", RESPONSE);
+    let response_data: interface_not_on_everything_query::ResponseData =
+        serde_json::from_str(RESPONSE_NOT_ON_EVERYTHING).unwrap();
+
+    println!("{:?}", response_data);
+
+    let expected = r##"ResponseData { everything: Some([RustMyQueryEverything { name: "Audrey Lorde", on: Person(RustMyQueryEverythingOnPerson { birthday: Some("1934-02-18") }) }, RustMyQueryEverything { name: "Laïka", on: Dog }, RustMyQueryEverything { name: "Mozilla", on: Organization(RustMyQueryEverythingOnOrganization { industry: OTHER }) }, RustMyQueryEverything { name: "Norbert", on: Dog }]) }"##;
+
+    assert_eq!(format!("{:?}", response_data), expected);
+
+    assert_eq!(response_data.everything.map(|names| names.len()), Some(4));
+}

tests/interfaces/interface_not_on_everything_query.graphql

@@ -0,0 +1,12 @@
+query MyQuery {
+  everything {
+    __typename
+    name
+    ... on Person {
+      birthday
+    }
+    ... on Organization {
+      industry
+    }
+  }
+}

tests/interfaces/interface_response_not_on_everything.json

@@ -0,0 +1,22 @@
+{
+    "everything": [
+        {
+            "__typename": "Person",
+            "name": "Audrey Lorde",
+            "birthday": "1934-02-18"
+        },
+        {
+            "__typename": "Dog",
+            "name": "Laïka"
+        },
+        {
+            "__typename": "Organization",
+            "name": "Mozilla",
+            "industry": "OTHER"
+        },
+        {
+            "__typename": "Dog",
+            "name": "Norbert"
+        }
+    ]
+}