[CherryPick]: Fix for guid filter in GraphQL (0.8) (#1659)

- Cherry picks PR #1644 to 0.8 release as a bug fix patch.

---------

Co-authored-by: Ayush Agarwal <[email protected]>

Author: Aniruddh25

src/Core/Services/ResolverMiddleware.cs

@@ -261,6 +261,8 @@ protected static bool IsInnerObject(IMiddlewareContext context)
                 SINGLE_TYPE => ((FloatValueNode)value).ToSingle(),
                 FLOAT_TYPE => ((FloatValueNode)value).ToDouble(),
                 DECIMAL_TYPE => ((FloatValueNode)value).ToDecimal(),
+                // If we reach here, we can be sure that the value will not be null.
+                UUID_TYPE => Guid.TryParse(value.Value!.ToString(), out Guid guidValue) ? guidValue : value.Value,
                 _ => value.Value
             };
         }

src/Service.GraphQLBuilder/GraphQLTypes/SupportedTypes.cs

@@ -4,10 +4,13 @@
 namespace Azure.DataApiBuilder.Service.GraphQLBuilder.GraphQLTypes
 {
     /// <summary>
-    /// Only used to group the supported type names under a class with a relevant name
+    /// Only used to group the supported type names under a class with a relevant name.
+    /// The type names mentioned here are Hotchocolate scalar built in types.
+    /// The corresponding SQL type name may be different for e.g. UUID maps to Guid as the SQL type.
     /// </summary>
     public static class SupportedTypes
     {
+        public const string UUID_TYPE = "UUID";
         public const string BYTE_TYPE = "Byte";
         public const string SHORT_TYPE = "Short";
         public const string INT_TYPE = "Int";
@@ -20,6 +23,5 @@ public static class SupportedTypes
         public const string DATETIME_TYPE = "DateTime";
         public const string DATETIME_NONUTC_TYPE = "DateTimeNonUTC";
         public const string BYTEARRAY_TYPE = "ByteArray";
-        public const string GUID_TYPE = "Guid";
     }
 }

src/Service.GraphQLBuilder/GraphQLUtils.cs

@@ -42,6 +42,7 @@ public static bool IsBuiltInType(ITypeNode typeNode)
             HashSet<string> inBuiltTypes = new()
             {
                 "ID",
+                UUID_TYPE,
                 BYTE_TYPE,
                 SHORT_TYPE,
                 INT_TYPE,

src/Service.GraphQLBuilder/Queries/StandardQueryInputs.cs

@@ -169,7 +169,7 @@ public static InputObjectTypeDefinitionNode StringInputType() =>
                     new InputValueDefinitionNode(null, new NameNode("endsWith"), new StringValueNode("Ends With"), new StringType().ToTypeNode(), null, new List<DirectiveNode>()),
                     new InputValueDefinitionNode(null, new NameNode("neq"), new StringValueNode("Not Equals"), new StringType().ToTypeNode(), null, new List<DirectiveNode>()),
                     new InputValueDefinitionNode(null, new NameNode("caseInsensitive"), new StringValueNode("Case Insensitive"), new BooleanType().ToTypeNode(), new BooleanValueNode(false), new List<DirectiveNode>()),
-                    new InputValueDefinitionNode(null, new NameNode("isNull"), new StringValueNode("Not null test"), new BooleanType().ToTypeNode(), null, new List<DirectiveNode>())
+                    new InputValueDefinitionNode(null, new NameNode("isNull"), new StringValueNode("Is null test"), new BooleanType().ToTypeNode(), null, new List<DirectiveNode>())
                 }
             );
 
@@ -197,13 +197,32 @@ public static InputObjectTypeDefinitionNode ByteArrayInputType() =>
                 new StringValueNode("Input type for adding ByteArray filters"),
                 new List<DirectiveNode>(),
                 new List<InputValueDefinitionNode> {
-                    new InputValueDefinitionNode(null, new NameNode("isNull"), new StringValueNode("Not null test"), new BooleanType().ToTypeNode(), null, new List<DirectiveNode>())
+                    new InputValueDefinitionNode(null, new NameNode("isNull"), new StringValueNode("Is null test"), new BooleanType().ToTypeNode(), null, new List<DirectiveNode>())
+                }
+            );
+
+        public static InputObjectTypeDefinitionNode UuidInputType() =>
+            new(
+                location: null,
+                new NameNode("UuidFilterInput"),
+                new StringValueNode("Input type for adding Uuid filters"),
+                new List<DirectiveNode>(),
+                new List<InputValueDefinitionNode> {
+                    new InputValueDefinitionNode(null, new NameNode("eq"), new StringValueNode("Equals"), new UuidType().ToTypeNode(), null, new List<DirectiveNode>()),
+                    new InputValueDefinitionNode(null, new NameNode("contains"), new StringValueNode("Contains"), new UuidType().ToTypeNode(), null, new List<DirectiveNode>()),
+                    new InputValueDefinitionNode(null, new NameNode("notContains"), new StringValueNode("Not Contains"), new UuidType().ToTypeNode(), null, new List<DirectiveNode>()),
+                    new InputValueDefinitionNode(null, new NameNode("startsWith"), new StringValueNode("Starts With"), new UuidType().ToTypeNode(), null, new List<DirectiveNode>()),
+                    new InputValueDefinitionNode(null, new NameNode("endsWith"), new StringValueNode("Ends With"), new UuidType().ToTypeNode(), null, new List<DirectiveNode>()),
+                    new InputValueDefinitionNode(null, new NameNode("neq"), new StringValueNode("Not Equals"), new UuidType().ToTypeNode(), null, new List<DirectiveNode>()),
+                    new InputValueDefinitionNode(null, new NameNode("caseInsensitive"), new StringValueNode("Case Insensitive"), new BooleanType().ToTypeNode(), new BooleanValueNode(false), new List<DirectiveNode>()),
+                    new InputValueDefinitionNode(null, new NameNode("isNull"), new StringValueNode("Is null test"), new BooleanType().ToTypeNode(), null, new List<DirectiveNode>())
                 }
             );
 
         public static Dictionary<string, InputObjectTypeDefinitionNode> InputTypes = new()
         {
             { "ID", IdInputType() },
+            { UUID_TYPE, UuidInputType() },
             { BYTE_TYPE, ByteInputType() },
             { SHORT_TYPE, ShortInputType() },
             { INT_TYPE, IntInputType() },

src/Service.GraphQLBuilder/Sql/SchemaConverter.cs

@@ -219,7 +219,7 @@ public static string GetGraphQLTypeFromSystemType(Type type)
             return type.Name switch
             {
                 "String" => STRING_TYPE,
-                "Guid" => STRING_TYPE,
+                "Guid" => UUID_TYPE,
                 "Byte" => BYTE_TYPE,
                 "Int16" => SHORT_TYPE,
                 "Int32" => INT_TYPE,
@@ -255,7 +255,7 @@ public static IValueNode CreateValueNodeFromDbObjectMetadata(object metadataValu
                 short value => new ObjectValueNode(new ObjectFieldNode(SHORT_TYPE, new IntValueNode(value))),
                 int value => new ObjectValueNode(new ObjectFieldNode(INT_TYPE, value)),
                 long value => new ObjectValueNode(new ObjectFieldNode(LONG_TYPE, new IntValueNode(value))),
-                Guid value => new ObjectValueNode(new ObjectFieldNode(GUID_TYPE, value.ToString())),
+                Guid value => new ObjectValueNode(new ObjectFieldNode(UUID_TYPE, new UuidType().ParseValue(value))),
                 string value => new ObjectValueNode(new ObjectFieldNode(STRING_TYPE, value)),
                 bool value => new ObjectValueNode(new ObjectFieldNode(BOOLEAN_TYPE, value)),
                 float value => new ObjectValueNode(new ObjectFieldNode(SINGLE_TYPE, new SingleType().ParseValue(value))),

src/Service.Tests/DatabaseSchema-MsSql.sql

@@ -163,7 +163,7 @@ CREATE TABLE type_table(
     datetimeoffset_types datetimeoffset,
     smalldatetime_types smalldatetime,
     bytearray_types varbinary(max),
-    guid_types uniqueidentifier DEFAULT newid()
+    uuid_types uniqueidentifier DEFAULT newid()
 );
 
 CREATE TABLE trees (
@@ -414,6 +414,7 @@ VALUES
     '9998-12-31', '9998-12-31 23:59:59', '9998-12-31 23:59:59.9999999', '9998-12-31 23:59:59.9999999+00:00', '2079-06-06',
     0xFFFFFFFF),
     (5, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);
+INSERT INTO type_table(id, uuid_types) values(10, 'D1D021A8-47B4-4AE4-B718-98E89C41A161');
 SET IDENTITY_INSERT type_table OFF
 
 SET IDENTITY_INSERT sales ON

src/Service.Tests/DatabaseSchema-PostgreSql.sql

@@ -143,7 +143,7 @@ CREATE TABLE type_table(
     boolean_types boolean,
     datetime_types timestamp,
     bytearray_types bytea,
-    guid_types uuid DEFAULT gen_random_uuid ()
+    uuid_types uuid DEFAULT gen_random_uuid ()
 );
 
 CREATE TABLE trees (
@@ -328,6 +328,7 @@ INSERT INTO type_table(id, short_types, int_types, long_types, string_types, sin
     (3, -32768, -2147483648, -9223372036854775808, '', -3.4E38, -1.7E308, 2.929292E-19, true, '1753-01-01 00:00:00.000', '\x00000000'),
     (4, 32767, 2147483647, 9223372036854775807, 'null', 3.4E38, 1.7E308, 2.929292E-14, true, '9998-12-31 23:59:59.997', '\xFFFFFFFF'),
     (5, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);
+INSERT INTO type_table(id, uuid_types) values(10, 'D1D021A8-47B4-4AE4-B718-98E89C41A161');
 INSERT INTO trees("treeId", species, region, height) VALUES (1, 'Tsuga terophylla', 'Pacific Northwest', '30m'), (2, 'Pseudotsuga menziesii', 'Pacific Northwest', '40m');
 INSERT INTO fungi(speciesid, region) VALUES (1, 'northeast'), (2, 'southwest');
 INSERT INTO notebooks(id, noteBookName, color, ownerName) VALUES (1, 'Notebook1', 'red', 'Sean'), (2, 'Notebook2', 'green', 'Ani'), (3, 'Notebook3', 'blue', 'Jarupat'), (4, 'Notebook4', 'yellow', 'Aaron');

src/Service.Tests/GraphQLBuilder/Sql/SchemaConverterTests.cs

@@ -229,7 +229,7 @@ public void MultipleColumnsAllMapped()
         [DataRow(typeof(DateTime), DATETIME_TYPE)]
         [DataRow(typeof(DateTimeOffset), DATETIME_TYPE)]
         [DataRow(typeof(byte[]), BYTEARRAY_TYPE)]
-        [DataRow(typeof(Guid), STRING_TYPE)]
+        [DataRow(typeof(Guid), UUID_TYPE)]
         public void SystemTypeMapsToCorrectGraphQLType(Type systemType, string graphQLType)
         {
             SourceDefinition table = new();

src/Service.Tests/SqlTests/GraphQLSupportedTypesTests/GraphQLSupportedTypesTestsBase.cs

@@ -64,10 +64,10 @@ public abstract class GraphQLSupportedTypesTestBase : SqlTestBase
         [DataRow(BYTEARRAY_TYPE, 2)]
         [DataRow(BYTEARRAY_TYPE, 3)]
         [DataRow(BYTEARRAY_TYPE, 4)]
-        [DataRow(GUID_TYPE, 1)]
-        [DataRow(GUID_TYPE, 2)]
-        [DataRow(GUID_TYPE, 3)]
-        [DataRow(GUID_TYPE, 4)]
+        [DataRow(UUID_TYPE, 1)]
+        [DataRow(UUID_TYPE, 2)]
+        [DataRow(UUID_TYPE, 3)]
+        [DataRow(UUID_TYPE, 4)]
         public async Task QueryTypeColumn(string type, int id)
         {
             if (!IsSupportedType(type))
@@ -134,6 +134,8 @@ public async Task QueryTypeColumn(string type, int id)
         [DataRow(DECIMAL_TYPE, "eq", "-9.292929", "-9.292929", "=")]
         [DataRow(BOOLEAN_TYPE, "neq", "\'false\'", "false", "!=")]
         [DataRow(BOOLEAN_TYPE, "eq", "\'false\'", "false", "=")]
+        [DataRow(UUID_TYPE, "eq", "'D1D021A8-47B4-4AE4-B718-98E89C41A161'", "\"D1D021A8-47B4-4AE4-B718-98E89C41A161\"", "=")]
+        [DataRow(UUID_TYPE, "neq", "'D1D021A8-47B4-4AE4-B718-98E89C41A161'", "\"D1D021A8-47B4-4AE4-B718-98E89C41A161\"", "!=")]
         public async Task QueryTypeColumnFilterAndOrderBy(string type, string filterOperator, string sqlValue, string gqlValue, string queryOperator)
         {
             if (!IsSupportedType(type))
@@ -340,8 +342,8 @@ public async Task InsertIntoTypeColumnWithArgument(string type, object value)
         [DataRow(BYTEARRAY_TYPE, "\"U3RyaW5neQ==\"")]
         [DataRow(BYTEARRAY_TYPE, "\"V2hhdGNodSBkb2luZyBkZWNvZGluZyBvdXIgdGVzdCBiYXNlNjQgc3RyaW5ncz8=\"")]
         [DataRow(BYTEARRAY_TYPE, "null")]
-        [DataRow(GUID_TYPE, "\"3a1483a5-9ac2-4998-bcf3-78a28078c6ac\"")]
-        [DataRow(GUID_TYPE, "null")]
+        [DataRow(UUID_TYPE, "\"3a1483a5-9ac2-4998-bcf3-78a28078c6ac\"")]
+        [DataRow(UUID_TYPE, "null")]
         public async Task UpdateTypeColumn(string type, string value)
         {
             if (!IsSupportedType(type))
@@ -382,8 +384,8 @@ public async Task UpdateTypeColumn(string type, string value)
         [DataRow(DATETIME_TYPE, "1999-01-08 10:23:54")]
         [DataRow(DATETIME_NONUTC_TYPE, "1999-01-08 10:23:54+8:00")]
         [DataRow(BYTEARRAY_TYPE, "V2hhdGNodSBkb2luZyBkZWNvZGluZyBvdXIgdGVzdCBiYXNlNjQgc3RyaW5ncz8=")]
-        [DataRow(GUID_TYPE, "3a1483a5-9ac2-4998-bcf3-78a28078c6ac")]
-        [DataRow(GUID_TYPE, null)]
+        [DataRow(UUID_TYPE, "3a1483a5-9ac2-4998-bcf3-78a28078c6ac")]
+        [DataRow(UUID_TYPE, null)]
         public async Task UpdateTypeColumnWithArgument(string type, object value)
         {
             if (!IsSupportedType(type))
@@ -400,7 +402,7 @@ public async Task UpdateTypeColumnWithArgument(string type, object value)
 
             string field = $"{type.ToLowerInvariant()}_types";
             string graphQLQueryName = "updateSupportedType";
-            string gqlQuery = "mutation($param: " + TypeNameToGraphQLType(type) + "){ updateSupportedType (typeid: 1, item: {" + field + ": $param }){ " + field + " } }";
+            string gqlQuery = "mutation($param: " + type + "){ updateSupportedType (typeid: 1, item: {" + field + ": $param }){ " + field + " } }";
 
             string dbQuery = MakeQueryOnTypeTable(new List<string> { field }, id: 1);
 
@@ -428,12 +430,45 @@ private static void PerformTestEqualsForExtendedTypes(string type, string expect
             {
                 CompareDateTimeResults(actual.ToString(), expected);
             }
+            else if (type == UUID_TYPE)
+            {
+                CompareUuidResults(actual.ToString(), expected);
+            }
             else
             {
                 SqlTestHelper.PerformTestEqualJsonStrings(expected, actual.ToString());
             }
         }
 
+        private static void CompareUuidResults(string actual, string expected)
+        {
+            string fieldName = "uuid_types";
+
+            using JsonDocument actualJsonDoc = JsonDocument.Parse(actual);
+            using JsonDocument expectedJsonDoc = JsonDocument.Parse(expected);
+
+            if (actualJsonDoc.RootElement.ValueKind is JsonValueKind.Array)
+            {
+                ValidateArrayResults(actualJsonDoc, expectedJsonDoc, fieldName);
+                return;
+            }
+
+            string actualUuidString = actualJsonDoc.RootElement.GetProperty(fieldName).ToString();
+            string expectedUuidString = expectedJsonDoc.RootElement.GetProperty(fieldName).ToString();
+
+            // handles cases when one of the values is null
+            if (string.IsNullOrEmpty(actualUuidString) || string.IsNullOrEmpty(expectedUuidString))
+            {
+                Assert.AreEqual(expectedUuidString, actualUuidString);
+            }
+            else
+            {
+                Guid actualGuidValue = Guid.Parse(actualUuidString);
+                Guid expectedGuidValue = Guid.Parse(expectedUuidString);
+                Assert.AreEqual(actualGuidValue, expectedGuidValue);
+            }
+        }
+
         /// <summary>
         /// HotChocolate will parse large floats to exponential notation
         /// while the db will return the number fully printed out. Because
@@ -530,6 +565,12 @@ private static void ValidateArrayResults(JsonDocument actualJsonDoc, JsonDocumen
                     DateTime expectedDateTime = DateTime.Parse(expectedValue.ToString(), CultureInfo.InvariantCulture, DateTimeStyles.None);
                     Assert.AreEqual(expectedDateTime, actualDateTime);
                 }
+                else if (fieldName.StartsWith(UUID_TYPE.ToLower()))
+                {
+                    Guid actualGuidValue = Guid.Parse(actualValue.ToString());
+                    Guid expectedGuidValue = Guid.Parse(expectedValue.ToString());
+                    Assert.AreEqual(expectedGuidValue, actualGuidValue);
+                }
                 else if (fieldName.StartsWith(SINGLE_TYPE.ToLower()))
                 {
                     Assert.AreEqual(expectedValue.GetSingle(), actualValue.GetSingle());
@@ -541,20 +582,6 @@ private static void ValidateArrayResults(JsonDocument actualJsonDoc, JsonDocumen
             }
         }
 
-        /// <summary>
-        /// Needed to map the type name to a graphql type in argument tests
-        /// where the argument type need to be specified.
-        /// </summary>
-        private static string TypeNameToGraphQLType(string typeName)
-        {
-            if (typeName is GUID_TYPE)
-            {
-                return STRING_TYPE;
-            }
-
-            return typeName;
-        }
-
         protected abstract string MakeQueryOnTypeTable(
             List<string> queriedColumns,
             string filterValue = "1",

src/Service.Tests/SqlTests/GraphQLSupportedTypesTests/MySqlGQLSupportedTypesTests.cs

@@ -56,7 +56,7 @@ protected override bool IsSupportedType(string type)
         {
             return type switch
             {
-                GUID_TYPE => false,
+                UUID_TYPE => false,
                 _ => true
             };
         }

src/Service.Tests/SqlTests/RestApiTests/Insert/MsSqlInsertApiTests.cs

@@ -32,7 +32,7 @@ public class MsSqlInsertApiTests : InsertApiTestBase
                 "InsertOneInSupportedTypes",
                 $"SELECT [id] as [typeid], [byte_types], [short_types], [int_types], [long_types],string_types, [single_types], [float_types], " +
                 $"[decimal_types], [boolean_types], [date_types], [datetime_types], [datetime2_types], [datetimeoffset_types], [smalldatetime_types], " +
-                $"[bytearray_types], LOWER([guid_types]) as [guid_types] FROM { _integrationTypeTable } " +
+                $"[bytearray_types], LOWER([uuid_types]) as [uuid_types] FROM { _integrationTypeTable } " +
                 $"WHERE [id] = { STARTING_ID_FOR_TEST_INSERTS } AND [bytearray_types] is NULL " +
                 $"FOR JSON PATH, INCLUDE_NULL_VALUES, WITHOUT_ARRAY_WRAPPER"
             },

src/Service.Tests/SqlTests/RestApiTests/Insert/PostgreSqlInsertApiTests.cs

@@ -34,7 +34,7 @@ SELECT to_jsonb(subq) AS data
                     SELECT to_jsonb(subq) AS data
                     FROM (
                         SELECT id as typeid, short_types, int_types, long_types, string_types, single_types,
-                        float_types, decimal_types, boolean_types, datetime_types, bytearray_types, guid_types
+                        float_types, decimal_types, boolean_types, datetime_types, bytearray_types, uuid_types
                         FROM " + _integrationTypeTable + @"
                         WHERE id = " + STARTING_ID_FOR_TEST_INSERTS + @"
                     ) AS subq