Merge pull request #582 from supabase/fix-581

fix #581 - missing description in schema

Author: imor

src/builder.rs

@@ -1945,6 +1945,7 @@ pub struct __DirectiveBuilder {
 #[allow(dead_code)]
 #[serde(untagged)]
 pub enum __SchemaField {
+    Description,
     Types(Vec<__TypeBuilder>),
     QueryType(__TypeBuilder),
     MutationType(Option<__TypeBuilder>),
@@ -1961,6 +1962,7 @@ pub struct __SchemaSelection {
 
 #[derive(Clone)]
 pub struct __SchemaBuilder {
+    pub description: String,
     pub selections: Vec<__SchemaSelection>,
 }
 
@@ -2516,6 +2518,7 @@ impl __Schema {
                             builder_fields.push(__SchemaSelection {
                                 alias: alias_or_name(&selection_field),
                                 selection: match f.name().as_str() {
+                                    "description" => __SchemaField::Description,
                                     "types" => {
                                         let builders = self
                                             .types()
@@ -2601,6 +2604,7 @@ impl __Schema {
                 }
 
                 Ok(__SchemaBuilder {
+                    description: "Represents the GraphQL schema of the database".to_string(),
                     selections: builder_fields,
                 })
             }

src/transpile.rs

@@ -1660,6 +1660,9 @@ impl Serialize for __SchemaBuilder {
 
         for selection in &self.selections {
             match &selection.selection {
+                __SchemaField::Description => {
+                    map.serialize_entry(&selection.alias, &self.description)?;
+                }
                 __SchemaField::Types(type_builders) => {
                     map.serialize_entry(&selection.alias, &type_builders)?;
                 }

test/expected/issue_581_missing_desc_on_schema.out

@@ -0,0 +1,102 @@
+begin;
+
+select graphql.resolve($$
+query IntrospectionQuery {
+  __schema {
+    description
+    queryType { name }
+    mutationType { name }
+    subscriptionType { name }
+    types {
+      ...FullType
+    }
+    directives {
+      name
+      description
+
+      locations
+      args(includeDeprecated: true) {
+        ...InputValue
+      }
+    }
+  }
+}
+
+fragment FullType on __Type {
+  kind
+  name
+  description
+
+  fields(includeDeprecated: true) {
+    name
+    description
+    args(includeDeprecated: true) {
+      ...InputValue
+    }
+    type {
+      ...TypeRef
+    }
+    isDeprecated
+    deprecationReason
+  }
+  inputFields(includeDeprecated: true) {
+    ...InputValue
+  }
+  interfaces {
+    ...TypeRef
+  }
+  enumValues(includeDeprecated: true) {
+    name
+    description
+    isDeprecated
+    deprecationReason
+  }
+  possibleTypes {
+    ...TypeRef
+  }
+}
+
+fragment InputValue on __InputValue {
+  name
+  description
+  type { ...TypeRef }
+  defaultValue
+  isDeprecated
+  deprecationReason
+}
+
+fragment TypeRef on __Type {
+  kind
+  name
+  ofType {
+    kind
+    name
+    ofType {
+      kind
+      name
+      ofType {
+        kind
+        name
+        ofType {
+          kind
+          name
+          ofType {
+            kind
+            name
+            ofType {
+              kind
+              name
+              ofType {
+                kind
+                name
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+$$, NULL, 'IntrospectionQuery');
+
+rollback;