fix(config): representation for nested list (#2747)

Co-authored-by: Tushar Mathur <[email protected]>

core/blueprint/wrapping_type.rs

@@ -0,0 +1,175 @@
+use std::fmt::Formatter;
+use std::ops::Deref;
+
+use async_graphql::parser::types as async_graphql_types;
+use async_graphql::Name;
+use serde::{Deserialize, Serialize};
+
+use crate::core::is_default;
+
+/// Type to represent GraphQL type usage with modifiers
+/// [spec](https://spec.graphql.org/October2021/#sec-Wrapping-Types)
+#[derive(Clone, Serialize, Deserialize, PartialEq, Eq, schemars::JsonSchema)]
+#[serde(untagged)]
+pub enum Type {
+    Named {
+        /// Name of the type
+        name: String,
+        /// Flag to indicate the type is required.
+        #[serde(rename = "required", default, skip_serializing_if = "is_default")]
+        non_null: bool,
+    },
+    List {
+        /// Type is a list
+        #[serde(rename = "list")]
+        of_type: Box<Type>,
+        /// Flag to indicate the type is required.
+        #[serde(rename = "required", default, skip_serializing_if = "is_default")]
+        non_null: bool,
+    },
+}
+
+impl std::fmt::Debug for Type {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        match self {
+            Type::Named { name, non_null } => {
+                if *non_null {
+                    write!(f, "{}!", name)
+                } else {
+                    write!(f, "{}", name)
+                }
+            }
+            Type::List { of_type, non_null } => {
+                if *non_null {
+                    write!(f, "[{:?}]!", of_type)
+                } else {
+                    write!(f, "[{:?}]", of_type)
+                }
+            }
+        }
+    }
+}
+
+impl Default for Type {
+    fn default() -> Self {
+        Type::Named { name: "JSON".to_string(), non_null: false }
+    }
+}
+
+impl Type {
+    /// gets the name of the type
+    pub fn name(&self) -> &String {
+        match self {
+            Type::Named { name, .. } => name,
+            Type::List { of_type, .. } => of_type.name(),
+        }
+    }
+
+    /// checks if the type is nullable
+    pub fn is_nullable(&self) -> bool {
+        !match self {
+            Type::Named { non_null, .. } => *non_null,
+            Type::List { non_null, .. } => *non_null,
+        }
+    }
+    /// checks if the type is a list
+    pub fn is_list(&self) -> bool {
+        matches!(self, Type::List { .. })
+    }
+
+    /// convert this type into NonNull type
+    pub fn into_required(self) -> Self {
+        match self {
+            Type::Named { name, .. } => Self::Named { name, non_null: true },
+            Type::List { of_type, .. } => Self::List { of_type, non_null: true },
+        }
+    }
+
+    /// convert this into nullable type
+    pub fn into_nullable(self) -> Self {
+        match self {
+            Type::Named { name, .. } => Self::Named { name, non_null: false },
+            Type::List { of_type, .. } => Self::List { of_type, non_null: false },
+        }
+    }
+
+    /// create a nullable list type from this type
+    pub fn into_list(self) -> Self {
+        Type::List { of_type: Box::new(self), non_null: false }
+    }
+
+    /// convert this type from list to non-list for any level of nesting
+    pub fn into_single(self) -> Self {
+        match self {
+            Type::Named { .. } => self,
+            Type::List { of_type, .. } => of_type.into_single(),
+        }
+    }
+
+    /// replace the name of the underlying type
+    pub fn with_name(self, name: String) -> Self {
+        match self {
+            Type::Named { non_null, .. } => Type::Named { name, non_null },
+            Type::List { of_type, non_null } => {
+                Type::List { of_type: Box::new(of_type.with_name(name)), non_null }
+            }
+        }
+    }
+}
+
+impl From<&async_graphql_types::Type> for Type {
+    fn from(value: &async_graphql_types::Type) -> Self {
+        let non_null = !value.nullable;
+
+        match &value.base {
+            async_graphql_types::BaseType::Named(name) => {
+                Self::Named { name: name.to_string(), non_null }
+            }
+            async_graphql_types::BaseType::List(type_) => {
+                Self::List { of_type: Box::new(type_.as_ref().into()), non_null }
+            }
+        }
+    }
+}
+
+impl From<&Type> for async_graphql_types::Type {
+    fn from(value: &Type) -> Self {
+        let nullable = value.is_nullable();
+
+        let base = match value {
+            Type::Named { name, .. } => async_graphql_types::BaseType::Named(Name::new(name)),
+            Type::List { of_type, .. } => async_graphql_types::BaseType::List(Box::new(
+                async_graphql_types::Type::from(of_type.deref()),
+            )),
+        };
+
+        async_graphql_types::Type { base, nullable }
+    }
+}
+
+impl From<&Type> for async_graphql::dynamic::TypeRef {
+    fn from(value: &Type) -> Self {
+        let nullable = value.is_nullable();
+
+        let base = match value {
+            Type::Named { name, .. } => {
+                async_graphql::dynamic::TypeRef::Named(name.to_owned().into())
+            }
+            Type::List { of_type, .. } => async_graphql::dynamic::TypeRef::List(Box::new(
+                async_graphql::dynamic::TypeRef::from(of_type.deref()),
+            )),
+        };
+
+        if nullable {
+            base
+        } else {
+            async_graphql::dynamic::TypeRef::NonNull(Box::new(base))
+        }
+    }
+}
+
+impl From<String> for Type {
+    fn from(value: String) -> Self {
+        Self::Named { name: value, non_null: false }
+    }
+}

examples/jsonplaceholder.json

@@ -15,44 +15,61 @@
     "Post": {
       "fields": {
         "body": {
-          "type": "String",
-          "required": true
+          "type": {
+            "name": "String",
+            "required": true
+          }
         },
         "id": {
-          "type": "Int",
-          "required": true
+          "type": {
+            "name": "Int",
+            "required": true
+          }
         },
         "title": {
-          "type": "String",
-          "required": true
+          "type": {
+            "name": "String",
+            "required": true
+          }
         },
         "user": {
-          "type": "User",
+          "type": {
+            "name": "User"
+          },
           "http": {
             "path": "/users/{{value.userId}}"
           }
         },
         "userId": {
-          "type": "Int",
-          "required": true
+          "type": {
+            "name": "Int",
+            "required": true
+          }
         }
       }
     },
     "Query": {
       "fields": {
         "posts": {
-          "type": "Post",
-          "list": true,
+          "type": {
+            "list": {
+              "name": "Post"
+            }
+          },
           "http": {
             "path": "/posts"
           }
         },
         "user": {
-          "type": "User",
+          "type": {
+            "name": "User"
+          },
           "args": {
             "id": {
-              "type": "Int",
-              "required": true
+              "type": {
+                "name": "Int",
+                "required": true
+              }
             }
           },
           "http": {
@@ -64,26 +81,38 @@
     "User": {
       "fields": {
         "email": {
-          "type": "String",
-          "required": true
+          "type": {
+            "name": "String",
+            "required": true
+          }
         },
         "id": {
-          "type": "Int",
-          "required": true
+          "type": {
+            "name": "Int",
+            "required": true
+          }
         },
         "name": {
-          "type": "String",
-          "required": true
+          "type": {
+            "name": "String",
+            "required": true
+          }
         },
         "phone": {
-          "type": "String"
+          "type": {
+            "name": "String"
+          }
         },
         "username": {
-          "type": "String",
-          "required": true
+          "type": {
+            "name": "String",
+            "required": true
+          }
         },
         "website": {
-          "type": "String"
+          "type": {
+            "name": "String"
+          }
         }
       }
     }

examples/jsonplaceholder.yml

@@ -10,51 +10,65 @@ types:
   Post:
     fields:
       body:
-        type: String
-        required: true
+        type:
+          name: String
+          required: true
       id:
-        type: Int
-        required: true
+        type:
+          name: Int
+          required: true
       title:
-        type: String
-        required: true
+        type:
+          name: String
+          required: true
       user:
-        type: User
+        type:
+          name: User
         http:
           path: /users/{{value.userId}}
       userId:
-        type: Int
-        required: true
+        type:
+          name: Int
+          required: true
   Query:
     fields:
       posts:
-        type: Post
-        list: true
+        type:
+          list:
+            name: Post
         http:
           path: /posts
       user:
-        type: User
+        type:
+          name: User
         args:
           id:
-            type: Int
-            required: true
+            type:
+              name: Int
+              required: true
         http:
           path: /users/{{args.id}}
   User:
     fields:
       email:
-        type: String
-        required: true
+        type:
+          name: String
+          required: true
       id:
-        type: Int
-        required: true
+        type:
+          name: Int
+          required: true
       name:
-        type: String
-        required: true
+        type:
+          name: String
+          required: true
       phone:
-        type: String
+        type:
+          name: String
       username:
-        type: String
-        required: true
+        type:
+          name: String
+          required: true
       website:
-        type: String
+        type:
+          name: String