Refactor schema representation and code generation

CHANGELOG.md

@@ -258,7 +258,10 @@ There are a number of breaking changes due to the new features, read the `Added`
 
 ### Added
 
-- Copy documentation from the GraphQL schema to the generated types (including their fields) as normal Rust documentation. Documentation will show up in the generated docs as well as IDEs that support expanding derive macros (which does not include the RLS yet).
+- Copy documentation from the GraphQL schema to the generated types (including
+  their fields) as normal Rust documentation. Documentation will show up in the
+  generated docs as well as IDEs that support expanding derive macros (which
+  does not include the RLS yet).
 - Implement and test deserializing subscription responses. We also try to provide helpful error messages when a subscription query is not valid (i.e. when it has more than one top-level field).
 - Support the [new top-level errors shape from the June 2018 spec](https://github.com/facebook/graphql/blob/master/spec/Section%207%20--%20Response.md), except for the `extensions` field (see issue #64).
 

README.md

@@ -59,6 +59,7 @@ A typed GraphQL client library for Rust.
 
   ```rust
   use graphql_client::{GraphQLQuery, Response};
+  use std::error::Error;
 
   #[derive(GraphQLQuery)]
   #[graphql(
@@ -68,7 +69,7 @@ A typed GraphQL client library for Rust.
   )]
   pub struct UnionQuery;
 
-  fn perform_my_query(variables: union_query::Variables) -> Result<(), anyhow::Error> {
+  fn perform_my_query(variables: union_query::Variables) -> Result<(), Box<dyn Error>> {
 
       // this is the important line
       let request_body = UnionQuery::build_query(variables);

examples/github/Cargo.toml

@@ -5,7 +5,7 @@ authors = ["Tom Houlé <[email protected]>"]
 edition = "2018"
 
 [dev-dependencies]
-anyhow = "*"
+anyhow = "1.0"
 graphql_client = { path = "../../graphql_client" }
 serde = "^1.0"
 reqwest = "^0.9"

examples/hasura/Cargo.toml

@@ -5,7 +5,7 @@ authors = ["Mark Catley <[email protected]>"]
 edition = "2018"
 
 [dev-dependencies]
-anyhow = "*"
+anyhow = "1.0"
 graphql_client = { path = "../../graphql_client" }
 serde = "1.0"
 serde_derive = "1.0"

graphql-introspection-query/src/introspection_response.rs

@@ -78,7 +78,7 @@ impl<'de> Deserialize<'de> for __DirectiveLocation {
     }
 }
 
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq)]
 pub enum __TypeKind {
     SCALAR,
     OBJECT,
@@ -130,11 +130,11 @@ pub struct FullType {
     pub kind: Option<__TypeKind>,
     pub name: Option<String>,
     pub description: Option<String>,
-    pub fields: Option<Vec<Option<FullTypeFields>>>,
-    pub input_fields: Option<Vec<Option<FullTypeInputFields>>>,
-    pub interfaces: Option<Vec<Option<FullTypeInterfaces>>>,
-    pub enum_values: Option<Vec<Option<FullTypeEnumValues>>>,
-    pub possible_types: Option<Vec<Option<FullTypePossibleTypes>>>,
+    pub fields: Option<Vec<FullTypeFields>>,
+    pub input_fields: Option<Vec<FullTypeInputFields>>,
+    pub interfaces: Option<Vec<FullTypeInterfaces>>,
+    pub enum_values: Option<Vec<FullTypeEnumValues>>,
+    pub possible_types: Option<Vec<FullTypePossibleTypes>>,
 }
 
 #[derive(Clone, Debug, Deserialize)]
@@ -196,19 +196,14 @@ pub struct FullTypePossibleTypes {
 #[derive(Clone, Debug, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct InputValue {
-    pub name: Option<String>,
+    pub name: String,
     pub description: Option<String>,
     #[serde(rename = "type")]
-    pub type_: Option<InputValueType>,
+    pub type_: InputValueType,
     pub default_value: Option<String>,
 }
 
-#[derive(Clone, Debug, Deserialize)]
-#[serde(rename_all = "camelCase")]
-pub struct InputValueType {
-    #[serde(flatten)]
-    pub type_ref: TypeRef,
-}
+type InputValueType = TypeRef;
 
 #[derive(Clone, Debug, Deserialize)]
 #[serde(rename_all = "camelCase")]

graphql_client/src/lib.rs

@@ -31,6 +31,7 @@ doc_comment::doctest!("../../README.md");
 /// ```
 /// use graphql_client::*;
 /// use serde_json::json;
+/// use std::error::Error;
 ///
 /// #[derive(GraphQLQuery)]
 /// #[graphql(
@@ -39,7 +40,7 @@ doc_comment::doctest!("../../README.md");
 /// )]
 /// struct StarWarsQuery;
 ///
-/// fn main() -> Result<(), anyhow::Error> {
+/// fn main() -> Result<(), Box<dyn Error>> {
 ///     use graphql_client::GraphQLQuery;
 ///
 ///     let variables = star_wars_query::Variables {
@@ -124,13 +125,14 @@ impl Display for PathFragment {
 /// # use serde_json::json;
 /// # use serde::Deserialize;
 /// # use graphql_client::GraphQLQuery;
+/// # use std::error::Error;
 /// #
 /// # #[derive(Debug, Deserialize, PartialEq)]
 /// # struct ResponseData {
 /// #     something: i32
 /// # }
 /// #
-/// # fn main() -> Result<(), anyhow::Error> {
+/// # fn main() -> Result<(), Box<dyn Error>> {
 /// use graphql_client::*;
 ///
 /// let body: Response<ResponseData> = serde_json::from_value(json!({
@@ -230,6 +232,7 @@ impl Display for Error {
 /// # use serde_json::json;
 /// # use serde::Deserialize;
 /// # use graphql_client::GraphQLQuery;
+/// # use std::error::Error;
 /// #
 /// # #[derive(Debug, Deserialize, PartialEq)]
 /// # struct User {
@@ -247,7 +250,7 @@ impl Display for Error {
 /// #     dogs: Vec<Dog>,
 /// # }
 /// #
-/// # fn main() -> Result<(), anyhow::Error> {
+/// # fn main() -> Result<(), Box<dyn Error>> {
 /// use graphql_client::Response;
 ///
 /// let body: Response<ResponseData> = serde_json::from_value(json!({

graphql_client/tests/fragments.rs

@@ -24,13 +24,7 @@ fn fragment_reference() {
     let valid_fragment_reference =
         serde_json::from_value::<fragment_reference::ResponseData>(valid_response).unwrap();
 
-    assert_eq!(
-        valid_fragment_reference
-            .fragment_reference
-            .in_fragment
-            .unwrap(),
-        "value"
-    );
+    assert_eq!(valid_fragment_reference.in_fragment.unwrap(), "value");
 }
 
 #[test]
@@ -42,13 +36,7 @@ fn fragments_with_snake_case_name() {
     let valid_fragment_reference =
         serde_json::from_value::<snake_case_fragment::ResponseData>(valid_response).unwrap();
 
-    assert_eq!(
-        valid_fragment_reference
-            .snake_case_fragment
-            .in_fragment
-            .unwrap(),
-        "value"
-    );
+    assert_eq!(valid_fragment_reference.in_fragment.unwrap(), "value");
 }
 
 #[derive(GraphQLQuery)]
@@ -64,11 +52,9 @@ fn recursive_fragment() {
 
     let _ = RecursiveFragment {
         head: Some("ABCD".to_string()),
-        tail: Some(RecursiveFragmentTail {
-            recursive_fragment: Box::new(RecursiveFragment {
-                head: Some("EFGH".to_string()),
-                tail: None,
-            }),
-        }),
+        tail: Some(Box::new(RecursiveFragment {
+            head: Some("EFGH".to_string()),
+            tail: None,
+        })),
     };
 }

graphql_client/tests/input_object_variables.rs

@@ -39,12 +39,13 @@ fn input_object_variables_default() {
         msg: default_input_object_variables_query::Variables::default_msg(),
     };
 
-    let out = serde_json::to_string(&variables).unwrap();
+    let out = serde_json::to_value(&variables).unwrap();
 
-    assert_eq!(
-        out,
-        r#"{"msg":{"content":null,"to":{"category":null,"email":"[email protected]","name":null}}}"#,
-    );
+    let expected_default = serde_json::json!({
+        "msg":{"content":null,"to":{"category":null,"email":"[email protected]","name":null}}
+    });
+
+    assert_eq!(out, expected_default);
 }
 
 #[derive(GraphQLQuery)]

graphql_client/tests/interfaces/interface_with_type_refining_fragment_query.graphql

@@ -1,4 +1,4 @@
-fragment Birthday on Person {
+fragment BirthdayFragment on Person {
   birthday
 }
 
@@ -9,7 +9,7 @@ query QueryOnInterface {
     ... on Dog {
       isGoodDog
     }
-    ...Birthday
+    ...BirthdayFragment
     ... on Organization {
       industry
     }

graphql_client/tests/union_query.rs

@@ -1,6 +1,7 @@
 use graphql_client::*;
 
 const RESPONSE: &str = include_str!("unions/union_query_response.json");
+const FRAGMENT_AND_MORE_RESPONSE: &str = include_str!("unions/fragment_and_more_response.json");
 
 #[derive(GraphQLQuery)]
 #[graphql(
@@ -18,6 +19,14 @@ pub struct UnionQuery;
 )]
 pub struct FragmentOnUnion;
 
+#[derive(GraphQLQuery)]
+#[graphql(
+    query_path = "tests/unions/union_query.graphql",
+    schema_path = "tests/unions/union_schema.graphql",
+    response_derives = "PartialEq, Debug"
+)]
+pub struct FragmentAndMoreOnUnion;
+
 #[test]
 fn union_query_deserialization() {
     let response_data: union_query::ResponseData = serde_json::from_str(RESPONSE).unwrap();
@@ -53,26 +62,63 @@ fn fragment_on_union() {
 
     let expected = fragment_on_union::ResponseData {
         names: Some(vec![
-            fragment_on_union::FragmentOnUnionNames::Person(
-                fragment_on_union::FragmentOnUnionNamesOnPerson {
-                    first_name: "Audrey".to_string(),
-                },
-            ),
-            fragment_on_union::FragmentOnUnionNames::Dog(
-                fragment_on_union::FragmentOnUnionNamesOnDog {
-                    name: "Laïka".to_string(),
-                },
-            ),
-            fragment_on_union::FragmentOnUnionNames::Organization(
-                fragment_on_union::FragmentOnUnionNamesOnOrganization {
+            fragment_on_union::NamesFragment::Person(fragment_on_union::NamesFragmentOnPerson {
+                first_name: "Audrey".to_string(),
+            }),
+            fragment_on_union::NamesFragment::Dog(fragment_on_union::NamesFragmentOnDog {
+                name: "Laïka".to_string(),
+            }),
+            fragment_on_union::NamesFragment::Organization(
+                fragment_on_union::NamesFragmentOnOrganization {
                     title: "Mozilla".to_string(),
                 },
             ),
-            fragment_on_union::FragmentOnUnionNames::Dog(
-                fragment_on_union::FragmentOnUnionNamesOnDog {
-                    name: "Norbert".to_string(),
-                },
-            ),
+            fragment_on_union::NamesFragment::Dog(fragment_on_union::NamesFragmentOnDog {
+                name: "Norbert".to_string(),
+            }),
+        ]),
+    };
+
+    assert_eq!(response_data, expected);
+}
+
+#[test]
+fn fragment_and_more_on_union() {
+    use fragment_and_more_on_union::*;
+
+    let response_data: fragment_and_more_on_union::ResponseData =
+        serde_json::from_str(FRAGMENT_AND_MORE_RESPONSE).unwrap();
+
+    let expected = fragment_and_more_on_union::ResponseData {
+        names: Some(vec![
+            FragmentAndMoreOnUnionNames {
+                names_fragment: NamesFragment::Person(NamesFragmentOnPerson {
+                    first_name: "Larry".into(),
+                }),
+                on: FragmentAndMoreOnUnionNamesOn::Person,
+            },
+            FragmentAndMoreOnUnionNames {
+                names_fragment: NamesFragment::Dog(NamesFragmentOnDog {
+                    name: "Laïka".into(),
+                }),
+                on: FragmentAndMoreOnUnionNamesOn::Dog(FragmentAndMoreOnUnionNamesOnDog {
+                    is_good_dog: true,
+                }),
+            },
+            FragmentAndMoreOnUnionNames {
+                names_fragment: NamesFragment::Organization(NamesFragmentOnOrganization {
+                    title: "Mozilla".into(),
+                }),
+                on: FragmentAndMoreOnUnionNamesOn::Organization,
+            },
+            FragmentAndMoreOnUnionNames {
+                names_fragment: NamesFragment::Dog(NamesFragmentOnDog {
+                    name: "Norbert".into(),
+                }),
+                on: FragmentAndMoreOnUnionNamesOn::Dog(FragmentAndMoreOnUnionNamesOnDog {
+                    is_good_dog: true,
+                }),
+            },
         ]),
     };
 

graphql_client/tests/unions/fragment_and_more_response.json

@@ -0,0 +1,22 @@
+{
+  "names": [
+    {
+      "__typename": "Person",
+      "firstName": "Larry"
+    },
+    {
+      "__typename": "Dog",
+      "name": "Laïka",
+      "isGoodDog": true
+    },
+    {
+      "__typename": "Organization",
+      "title": "Mozilla"
+    },
+    {
+      "__typename": "Dog",
+      "name": "Norbert",
+      "isGoodDog": true
+    }
+  ]
+}

graphql_client/tests/unions/union_query.graphql

@@ -32,3 +32,12 @@ query FragmentOnUnion {
     ...NamesFragment
   }
 }
+
+query FragmentAndMoreOnUnion {
+  names {
+    ...NamesFragment
+    ... on Dog {
+      isGoodDog
+    }
+  }
+}

graphql_client_cli/Cargo.toml

@@ -14,7 +14,7 @@ path = "src/main.rs"
 [dependencies]
 anyhow = "1.0"
 reqwest = "^0.9"
-graphql_client = { version = "0.9.0", path = "../graphql_client" }
+graphql_client = { version = "0.9.0", path = "../graphql_client", features = [] }
 graphql_client_codegen = { path = "../graphql_client_codegen/", version = "0.9.0" }
 structopt = "0.3"
 serde = { version = "^1.0", features = ["derive"] }

graphql_client_cli/src/generate.rs

@@ -59,7 +59,7 @@ pub(crate) fn generate_code(params: CliCodegenParams) -> Result<()> {
         options.set_deprecation_strategy(deprecation_strategy);
     }
 
-    let gen = generate_module_token_stream(query_path.clone(), &schema_path, options).map_err(|fail| fail.compat())?;
+    let gen = generate_module_token_stream(query_path.clone(), &schema_path, options)?;
 
     let generated_code = gen.to_string();
     let generated_code = if cfg!(feature = "rustfmt") && !no_formatting {
@@ -103,5 +103,5 @@ fn format(codes: &str) -> String {
         return String::from_utf8(out).unwrap();
     }
     #[cfg(not(feature = "rustfmt"))]
-    unreachable!()
+    unreachable!("called format() without the rustfmt feature")
 }