refactor: clean up scalar (#2515)

Co-authored-by: Tushar Mathur <[email protected]>
tailcallhq · Jul 25, 2024 · e129a78 · e129a78 · github-actions · Jul 25, 2024
1 parent 05c7cad
commit e129a78
Show file tree

Hide file tree

Showing 37 changed files with 745 additions and 1,126 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -167,6 +167,7 @@ num = "0.4.3"
 indenter = "0.3.3"
 derive_more = { workspace = true }
 enum_dispatch = "0.3.13"
+strum = "0.26.2"
 
 [dev-dependencies]
 tailcall-prettier = { path = "tailcall-prettier" }

diff --git a/generated/.tailcallrc.graphql b/generated/.tailcallrc.graphql
@@ -430,20 +430,17 @@ directive @upstream(
 ) on SCHEMA
 
 """
-Represents list of bytes
+Field whose value is a sequence of bytes.
 """
 scalar Bytes
 
 """
-A date string, such as 2007-12-03, is compliant with the full-date format outlined 
-in section 5.6 of the RFC 3339 (https://datatracker.ietf.org/doc/html/rfc3339) profile 
-of the ISO 8601 standard for the representation of dates and times using the Gregorian 
-calendar.
+Field whose value conforms to the standard date format as specified in RFC 3339 (https://datatracker.ietf.org/doc/html/rfc3339).
 """
 scalar Date
 
 """
-field whose value conforms to the standard internet email address format as specified 
+Field whose value conforms to the standard internet email address format as specified 
 in HTML Spec: https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address.
 """
 scalar Email
@@ -454,70 +451,68 @@ Empty scalar type represents an empty value.
 scalar Empty
 
 """
-Represents signed integer type 128 bit size as string
+Field whose value is a 128-bit signed integer.
 """
 scalar Int128
 
 """
-Represents signed integer type 16bit size
+Field whose value is a 16-bit signed integer.
 """
 scalar Int16
 
 """
-Represents signed integer type 32bit size
+Field whose value is a 32-bit signed integer.
 """
 scalar Int32
 
 """
-Represents signed integer type 64bit size as string
+Field whose value is a 64-bit signed integer.
 """
 scalar Int64
 
 """
-Represents signed integer type 8bit size
+Field whose value is an 8-bit signed integer.
 """
 scalar Int8
 
 """
-The JSON scalar type represents JSON values as specified by [ECMA-404](www.ecma-international.org/publications/files/ECMA-ST/ 
-ECMA-404.pdf).
+Field whose value conforms to the standard JSON format as specified in RFC 8259 (https://datatracker.ietf.org/doc/html/rfc8259).
 """
 scalar JSON
 
 """
-A field whose value conforms to the standard E.164 format as specified in E.164 specification 
+Field whose value conforms to the standard E.164 format as specified in E.164 specification 
 (https://en.wikipedia.org/wiki/E.164).
 """
 scalar PhoneNumber
 
 """
-Represents unsigned integer type 128bit size as string
+Field whose value is a 128-bit unsigned integer.
 """
 scalar UInt128
 
 """
-Represents unsigned integer type 16bit size
+Field whose value is a 16-bit unsigned integer.
 """
 scalar UInt16
 
 """
-Represents unsigned integer type 32bit size
+Field whose value is a 32-bit unsigned integer.
 """
 scalar UInt32
 
 """
-Represents unsigned integer type 64bit size as string
+Field whose value is a 64-bit unsigned integer.
 """
 scalar UInt64
 
 """
-Represents unsigned integer type 8bit size
+Field whose value is an 8-bit unsigned integer.
 """
 scalar UInt8
 
 """
-A field whose value conforms to the standard URL format as specified in RFC3986 (https://www.ietf.org/rfc/rfc3986.txt), 
-and it uses real JavaScript URL objects.
+Field whose value conforms to the standard URL format as specified in RFC 3986 (https://datatracker.ietf.org/doc/html/rfc3986).
 """
 scalar Url
 

diff --git a/generated/.tailcallrc.schema.json b/generated/.tailcallrc.schema.json
@@ -210,8 +210,7 @@
     },
     "Bytes": {
       "title": "Bytes",
-      "description": "Represents list of bytes",
-      "type": "string"
+      "description": "Field whose value is a sequence of bytes."
     },
     "Cache": {
       "description": "The @cache operator enables caching for the query, field or type it is applied to.",
@@ -316,43 +315,15 @@
     },
     "Date": {
       "title": "Date",
-      "description": "A date string, such as 2007-12-03, is compliant with the full-date format outlined in section 5.6 of the RFC 3339 (https://datatracker.ietf.org/doc/html/rfc3339) profile of the ISO 8601 standard for the representation of dates and times using the Gregorian calendar.",
-      "type": "object",
-      "required": [
-        "Date"
-      ],
-      "properties": {
-        "Date": {
-          "type": "string"
-        }
-      }
+      "description": "Field whose value conforms to the standard date format as specified in RFC 3339 (https://datatracker.ietf.org/doc/html/rfc3339)."
     },
     "Email": {
       "title": "Email",
-      "description": "field whose value conforms to the standard internet email address format as specified in HTML Spec: https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address.",
-      "type": "object",
-      "required": [
-        "Email"
-      ],
-      "properties": {
-        "Email": {
-          "type": "string",
-          "pattern": "/^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/"
-        }
-      }
+      "description": "Field whose value conforms to the standard internet email address format as specified in HTML Spec: https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address."
     },
     "Empty": {
       "title": "Empty",
-      "description": "Empty scalar type represents an empty value.",
-      "type": "object",
-      "required": [
-        "Empty"
-      ],
-      "properties": {
-        "Empty": {
-          "type": "null"
-        }
-      }
+      "description": "Empty scalar type represents an empty value."
     },
     "Encoding": {
       "type": "string",
@@ -775,33 +746,23 @@
     },
     "Int128": {
       "title": "Int128",
-      "description": "Represents signed integer type 128 bit size as string",
-      "type": "integer",
-      "format": "int128"
+      "description": "Field whose value is a 128-bit signed integer."
     },
     "Int16": {
       "title": "Int16",
-      "description": "Represents signed integer type 16bit size",
-      "type": "integer",
-      "format": "int16"
+      "description": "Field whose value is a 16-bit signed integer."
     },
     "Int32": {
       "title": "Int32",
-      "description": "Represents signed integer type 32bit size",
-      "type": "integer",
-      "format": "int32"
+      "description": "Field whose value is a 32-bit signed integer."
     },
     "Int64": {
       "title": "Int64",
-      "description": "Represents signed integer type 64bit size as string",
-      "type": "integer",
-      "format": "int64"
+      "description": "Field whose value is a 64-bit signed integer."
     },
     "Int8": {
       "title": "Int8",
-      "description": "Represents signed integer type 8bit size",
-      "type": "integer",
-      "format": "int8"
+      "description": "Field whose value is an 8-bit signed integer."
     },
     "JS": {
       "type": "object",
@@ -816,16 +777,7 @@
     },
     "JSON": {
       "title": "JSON",
-      "description": "The JSON scalar type represents JSON values as specified by [ECMA-404](www.ecma-international.org/publications/files/ECMA-ST/ ECMA-404.pdf).",
-      "type": "object",
-      "required": [
-        "JSON"
-      ],
-      "properties": {
-        "JSON": {
-          "type": "string"
-        }
-      }
+      "description": "Field whose value conforms to the standard JSON format as specified in RFC 8259 (https://datatracker.ietf.org/doc/html/rfc8259)."
     },
     "KeyValue": {
       "type": "object",
@@ -939,16 +891,7 @@
     },
     "PhoneNumber": {
       "title": "PhoneNumber",
-      "description": "A field whose value conforms to the standard E.164 format as specified in E.164 specification (https://en.wikipedia.org/wiki/E.164).",
-      "type": "object",
-      "required": [
-        "PhoneNumber"
-      ],
-      "properties": {
-        "PhoneNumber": {
-          "type": "string"
-        }
-      }
+      "description": "Field whose value conforms to the standard E.164 format as specified in E.164 specification (https://en.wikipedia.org/wiki/E.164)."
     },
     "PrometheusExporter": {
       "description": "Output the telemetry metrics data to prometheus server",
@@ -1362,38 +1305,23 @@
     },
     "UInt128": {
       "title": "UInt128",
-      "description": "Represents unsigned integer type 128bit size as string",
-      "type": "integer",
-      "format": "uint128",
-      "minimum": 0.0
+      "description": "Field whose value is a 128-bit unsigned integer."
     },
     "UInt16": {
       "title": "UInt16",
-      "description": "Represents unsigned integer type 16bit size",
-      "type": "integer",
-      "format": "uint16",
-      "minimum": 0.0
+      "description": "Field whose value is a 16-bit unsigned integer."
     },
     "UInt32": {
       "title": "UInt32",
-      "description": "Represents unsigned integer type 32bit size",
-      "type": "integer",
-      "format": "uint32",
-      "minimum": 0.0
+      "description": "Field whose value is a 32-bit unsigned integer."
     },
     "UInt64": {
       "title": "UInt64",
-      "description": "Represents unsigned integer type 64bit size as string",
-      "type": "integer",
-      "format": "uint64",
-      "minimum": 0.0
+      "description": "Field whose value is a 64-bit unsigned integer."
     },
     "UInt8": {
       "title": "UInt8",
-      "description": "Represents unsigned integer type 8bit size",
-      "type": "integer",
-      "format": "uint8",
-      "minimum": 0.0
+      "description": "Field whose value is an 8-bit unsigned integer."
     },
     "Union": {
       "type": "object",
@@ -1565,16 +1493,7 @@
     },
     "Url": {
       "title": "Url",
-      "description": "A field whose value conforms to the standard URL format as specified in RFC3986 (https://www.ietf.org/rfc/rfc3986.txt), and it uses real JavaScript URL objects.",
-      "type": "object",
-      "required": [
-        "Url"
-      ],
-      "properties": {
-        "Url": {
-          "type": "string"
-        }
-      }
+      "description": "Field whose value conforms to the standard URL format as specified in RFC 3986 (https://datatracker.ietf.org/doc/html/rfc3986)."
     },
     "Variant": {
       "description": "Definition of GraphQL value",

diff --git a/src/core/blueprint/blueprint.rs b/src/core/blueprint/blueprint.rs
@@ -191,7 +191,7 @@ pub struct ScalarTypeDefinition {
     pub name: String,
     pub directive: Vec<Directive>,
     pub description: Option<String>,
-    pub validator: scalar::ScalarType,
+    pub scalar: scalar::Scalar,
 }
 
 #[derive(Clone, Debug)]

diff --git a/src/core/blueprint/definitions.rs b/src/core/blueprint/definitions.rs
@@ -18,7 +18,9 @@ pub fn to_scalar_type_definition(name: &str) -> Valid<Definition, String> {
         name: name.to_string(),
         directive: Vec::new(),
         description: None,
-        validator: scalar::get_scalar(name),
+        scalar: scalar::Scalar::find(name)
+            .unwrap_or(&scalar::Scalar::Empty)
+            .clone(),
     }))
 }
 
@@ -127,7 +129,7 @@ fn process_field_within_type(context: ProcessFieldWithinTypeContext) -> Valid<Ty
         }
 
         let next_is_required = is_required && next_field.required;
-        if scalar::is_predefined_scalar(&next_field.type_of) {
+        if scalar::Scalar::is_predefined(&next_field.type_of) {
             return process_path(ProcessPathContext {
                 type_info,
                 config_module,
@@ -358,7 +360,7 @@ pub fn update_cache_resolvers<'a>(
 
 fn validate_field_type_exist(config: &Config, field: &Field) -> Valid<(), String> {
     let field_type = &field.type_of;
-    if !scalar::is_predefined_scalar(field_type) && !config.contains(field_type) {
+    if !scalar::Scalar::is_predefined(field_type) && !config.contains(field_type) {
         Valid::fail(format!("Undeclared type '{field_type}' was found"))
     } else {
         Valid::succeed(())

diff --git a/src/core/blueprint/index.rs b/src/core/blueprint/index.rs
@@ -3,7 +3,7 @@ use indexmap::IndexMap;
 use crate::core::blueprint::{
     Blueprint, Definition, FieldDefinition, InputFieldDefinition, SchemaDefinition,
 };
-use crate::core::scalar::is_predefined_scalar;
+use crate::core::scalar;
 
 ///
 /// A read optimized index of all the types in the Blueprint. Provide O(1)
@@ -33,7 +33,7 @@ impl Index {
     pub fn type_is_scalar(&self, type_name: &str) -> bool {
         let def = self.map.get(type_name).map(|(def, _)| def);
 
-        matches!(def, Some(Definition::Scalar(_))) || is_predefined_scalar(type_name)
+        matches!(def, Some(Definition::Scalar(_))) || scalar::Scalar::is_predefined(type_name)
     }
 
     pub fn get_field(&self, type_name: &str, field_name: &str) -> Option<&QueryField> {
Thread Stats	Avg	Stdev	Max	+/- Stdev
Latency	7.35ms	3.31ms	86.48ms	71.84%
Req/Sec	3.44k	127.52	3.97k	82.50%