Cosmos DB: Adds Patch Support

src/Cli/ConfigGenerator.cs

@@ -364,7 +364,7 @@ public static bool TryAddNewEntity(AddOptions options, RuntimeConfig initialRunt
             // Try to get the source object as string or DatabaseObjectSource for new Entity
             if (!TryCreateSourceObjectForNewEntity(
                 options,
-                initialRuntimeConfig.DataSource.DatabaseType == DatabaseType.CosmosDB_NoSQL,
+                initialRuntimeConfig.DataSource.DatabaseType is DatabaseType.CosmosDB_NoSQL,
                 out EntitySource? source))
             {
                 _logger.LogError("Unable to create the source object.");
@@ -374,7 +374,11 @@ public static bool TryAddNewEntity(AddOptions options, RuntimeConfig initialRunt
             EntityActionPolicy? policy = GetPolicyForOperation(options.PolicyRequest, options.PolicyDatabase);
             EntityActionFields? field = GetFieldsForOperation(options.FieldsToInclude, options.FieldsToExclude);
 
-            EntityPermission[]? permissionSettings = ParsePermission(options.Permissions, policy, field, source.Type);
+            EntityPermission[]? permissionSettings = ParsePermission(
+                options.Permissions,
+                policy,
+                field,
+                source.Type);
             if (permissionSettings is null)
             {
                 _logger.LogError("Please add permission in the following format. --permissions \"<<role>>:<<actions>>\"");
@@ -424,7 +428,7 @@ public static bool TryAddNewEntity(AddOptions options, RuntimeConfig initialRunt
                 }
             }
 
-            EntityRestOptions restOptions = ConstructRestOptions(options.RestRoute, SupportedRestMethods, initialRuntimeConfig.DataSource.DatabaseType == DatabaseType.CosmosDB_NoSQL);
+            EntityRestOptions restOptions = ConstructRestOptions(options.RestRoute, SupportedRestMethods, initialRuntimeConfig.DataSource.DatabaseType is DatabaseType.CosmosDB_NoSQL);
             EntityGraphQLOptions graphqlOptions = ConstructGraphQLTypeDetails(options.GraphQLType, graphQLOperationsForStoredProcedures);
 
             // Create new entity.
@@ -630,7 +634,7 @@ public static bool TryUpdateExistingEntity(UpdateOptions options, RuntimeConfig
                 }
             }
 
-            EntityRestOptions updatedRestDetails = ConstructUpdatedRestDetails(entity, options, initialConfig.DataSource.DatabaseType == DatabaseType.CosmosDB_NoSQL);
+            EntityRestOptions updatedRestDetails = ConstructUpdatedRestDetails(entity, options, initialConfig.DataSource.DatabaseType is DatabaseType.CosmosDB_NoSQL);
             EntityGraphQLOptions updatedGraphQLDetails = ConstructUpdatedGraphQLDetails(entity, options);
             EntityPermission[]? updatedPermissions = entity!.Permissions;
             Dictionary<string, EntityRelationship>? updatedRelationships = entity.Relationships;
@@ -648,7 +652,13 @@ public static bool TryUpdateExistingEntity(UpdateOptions options, RuntimeConfig
             if (options.Permissions is not null && options.Permissions.Any())
             {
                 // Get the Updated Permission Settings
-                updatedPermissions = GetUpdatedPermissionSettings(entity, options.Permissions, updatedPolicy, updatedFields, updatedSourceType);
+                updatedPermissions = GetUpdatedPermissionSettings(
+                    entity,
+                    options.Permissions,
+                    updatedPolicy,
+                    updatedFields,
+                    updatedSourceType,
+                    initialConfig.DataSource.DatabaseType);
 
                 if (updatedPermissions is null)
                 {
@@ -739,7 +749,8 @@ public static bool TryUpdateExistingEntity(UpdateOptions options, RuntimeConfig
                                                                         IEnumerable<string> permissions,
                                                                         EntityActionPolicy? policy,
                                                                         EntityActionFields? fields,
-                                                                        EntitySourceType? sourceType)
+                                                                        EntitySourceType? sourceType,
+                                                                        DatabaseType databaseType)
         {
 
             // Parse role and operations from the permissions string
@@ -781,7 +792,9 @@ public static bool TryUpdateExistingEntity(UpdateOptions options, RuntimeConfig
                     else
                     {
                         // User didn't use WILDCARD, and wants to update some of the operations.
-                        IDictionary<EntityActionOperation, EntityAction> existingOperations = ConvertOperationArrayToIEnumerable(permission.Actions, entityToUpdate.Source.Type);
+                        IDictionary<EntityActionOperation, EntityAction> existingOperations
+                            = ConvertOperationArrayToIEnumerable(
+                                permission.Actions, entityToUpdate.Source.Type, databaseType);
 
                         // Merge existing operations with new operations
                         EntityAction[] updatedOperationArray = GetUpdatedOperationArray(newOperationArray, policy, fields, existingOperations);

src/Cli/Utils.cs

@@ -87,7 +87,7 @@ public static EntityAction[] CreateOperations(string operations, EntityActionPol
         /// </summary>
         /// <param name="operations">Array of operations which is of type JsonElement.</param>
         /// <returns>Dictionary of operations</returns>
-        public static IDictionary<EntityActionOperation, EntityAction> ConvertOperationArrayToIEnumerable(EntityAction[] operations, EntitySourceType? sourceType)
+        public static IDictionary<EntityActionOperation, EntityAction> ConvertOperationArrayToIEnumerable(EntityAction[] operations, EntitySourceType? sourceType, DatabaseType databaseType)
         {
             Dictionary<EntityActionOperation, EntityAction> result = new();
             foreach (EntityAction operation in operations)
@@ -96,8 +96,13 @@ public static EntityAction[] CreateOperations(string operations, EntityActionPol
                 if (op is EntityActionOperation.All)
                 {
                     HashSet<EntityActionOperation> resolvedOperations = sourceType is EntitySourceType.StoredProcedure ?
-                        EntityAction.ValidStoredProcedurePermissionOperations :
-                        EntityAction.ValidPermissionOperations;
+                        EntityAction.ValidStoredProcedurePermissionOperations : EntityAction.ValidPermissionOperations;
+
+                    if (databaseType is DatabaseType.CosmosDB_NoSQL && resolvedOperations.Contains(EntityActionOperation.Update))
+                    {
+                        resolvedOperations.Add(EntityActionOperation.Patch);
+                    }
+
                     // Expand wildcard to all valid operations (except execute)
                     foreach (EntityActionOperation validOp in resolvedOperations)
                     {

src/Config/ObjectModel/EntityActionOperation.cs

@@ -19,7 +19,7 @@ public enum EntityActionOperation
     Delete, Read,
 
     // cosmosdb_nosql operations
-    Upsert, Create,
+    Upsert, Create, Patch,
 
     // Sql operations
     Insert, Update, UpdateGraphQL,

src/Config/ObjectModel/RuntimeEntities.cs

@@ -5,6 +5,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Text.Json.Serialization;
 using Azure.DataApiBuilder.Config.Converters;
+using Azure.DataApiBuilder.Service.Exceptions;
 using Humanizer;
 
 namespace Azure.DataApiBuilder.Config.ObjectModel;
@@ -67,7 +68,9 @@ public bool ContainsKey(string key)
             }
             else
             {
-                throw new ApplicationException($"The entity '{key}' was not found in the dab-config json");
+                throw new DataApiBuilderException(message: $"The entity '{key}' was not found in the dab-config json",
+                    statusCode: System.Net.HttpStatusCode.ServiceUnavailable,
+                    subStatusCode: DataApiBuilderException.SubStatusCodes.ConfigValidationError);
             }
         }
     }

src/Core/Authorization/AuthorizationResolver.cs

@@ -333,7 +333,7 @@ public void SetEntityPermissionMap(RuntimeConfig runtimeConfig)
                     // so that it doesn't need to be evaluated per request.
                     PopulateAllowedExposedColumns(operationToColumn.AllowedExposedColumns, entityName, allowedColumns, metadataProvider);
 
-                    IEnumerable<EntityActionOperation> operations = GetAllOperationsForObjectType(operation, entity.Source.Type);
+                    IEnumerable<EntityActionOperation> operations = GetAllOperationsForObjectType(runtimeConfig.DataSource.DatabaseType, operation, entity.Source.Type);
                     foreach (EntityActionOperation crudOperation in operations)
                     {
                         // Try to add the opElement to the map if not present.
@@ -345,7 +345,7 @@ public void SetEntityPermissionMap(RuntimeConfig runtimeConfig)
 
                         foreach (string allowedColumn in allowedColumns)
                         {
-                            entityToRoleMap.FieldToRolesMap.TryAdd(key: allowedColumn, CreateOperationToRoleMap(entity.Source.Type));
+                            entityToRoleMap.FieldToRolesMap.TryAdd(key: allowedColumn, CreateOperationToRoleMap(runtimeConfig.DataSource.DatabaseType, entity.Source.Type));
                             entityToRoleMap.FieldToRolesMap[allowedColumn][crudOperation].Add(role);
                         }
 
@@ -419,17 +419,31 @@ public void SetEntityPermissionMap(RuntimeConfig runtimeConfig)
     /// Stored procedures only support Operation.Execute.
     /// In case the operation is Operation.All (wildcard), it gets resolved to a set of CRUD operations.
     /// </summary>
+    /// <param name="databaseType">database Type i.e Cosmos_NoSQL etc.</param>
     /// <param name="operation">operation type.</param>
     /// <param name="sourceType">Type of database object: Table, View, or Stored Procedure.</param>
     /// <returns>IEnumerable of all available operations.</returns>
-    public static IEnumerable<EntityActionOperation> GetAllOperationsForObjectType(EntityActionOperation operation, EntitySourceType? sourceType)
+    public static IEnumerable<EntityActionOperation> GetAllOperationsForObjectType(DatabaseType databaseType, EntityActionOperation operation, EntitySourceType? sourceType)
     {
         if (sourceType is EntitySourceType.StoredProcedure)
         {
             return new List<EntityActionOperation> { EntityActionOperation.Execute };
         }
 
-        return operation is EntityActionOperation.All ? EntityAction.ValidPermissionOperations : new List<EntityActionOperation> { operation };
+        IEnumerable<EntityActionOperation> validOperations =
+            operation is EntityActionOperation.All ? EntityAction.ValidPermissionOperations : new List<EntityActionOperation> { operation };
+
+        //For CosmosDB, add Patch operation to the list of valid operations if Update operation is present.
+        if (databaseType is DatabaseType.CosmosDB_NoSQL &&
+                    validOperations.Contains(EntityActionOperation.Update))
+        {
+            List<EntityActionOperation> tempOperationList = validOperations.ToList<EntityActionOperation>();
+            tempOperationList.Add(EntityActionOperation.Patch);
+
+            validOperations = tempOperationList;
+        };
+
+        return validOperations;
     }
 
     /// <summary>
@@ -803,10 +817,10 @@ private static IEnumerable<string> ResolveEntityDefinitionColumns(string entityN
     /// Creates new key value map of
     /// Key: operationType
     /// Value: Collection of role names.
-    /// There are only five possible operations
+    /// There are only six possible operations
     /// </summary>
     /// <returns>Dictionary: Key - Operation | Value - List of roles.</returns>
-    private static Dictionary<EntityActionOperation, List<string>> CreateOperationToRoleMap(EntitySourceType? sourceType)
+    private static Dictionary<EntityActionOperation, List<string>> CreateOperationToRoleMap(DatabaseType databaseType, EntitySourceType? sourceType)
     {
         if (sourceType is EntitySourceType.StoredProcedure)
         {
@@ -816,13 +830,21 @@ private static IEnumerable<string> ResolveEntityDefinitionColumns(string entityN
             };
         }
 
-        return new Dictionary<EntityActionOperation, List<string>>()
+        Dictionary<EntityActionOperation, List<string>> operationMap = new()
         {
             { EntityActionOperation.Create, new List<string>()},
             { EntityActionOperation.Read, new List<string>()},
             { EntityActionOperation.Update, new List<string>()},
             { EntityActionOperation.Delete, new List<string>()}
         };
+
+        // Patch operation is supported only for NOSQL databases i.e. CosmosDB
+        if (databaseType is DatabaseType.CosmosDB_NoSQL)
+        {
+            operationMap.Add(EntityActionOperation.Patch, new List<string>());
+        }
+
+        return operationMap;
     }
 
     #endregion

src/Core/Configurations/RuntimeConfigValidator.cs

@@ -91,7 +91,7 @@ public void ValidateConfigProperties()
 
             if (runtimeConfig.IsGraphQLEnabled)
             {
-                ValidateEntitiesDoNotGenerateDuplicateQueriesOrMutation(runtimeConfig.Entities);
+                ValidateEntitiesDoNotGenerateDuplicateQueriesOrMutation(runtimeConfig.DataSource.DatabaseType, runtimeConfig.Entities);
             }
         }
     }
@@ -318,10 +318,11 @@ private void LogConfigValidationExceptions()
     /// create mutation name: createBook
     /// update mutation name: updateBook
     /// delete mutation name: deleteBook
+    /// patch mutation name: patchBook
     /// </summary>
     /// <param name="entityCollection">Entity definitions</param>
     /// <exception cref="DataApiBuilderException"></exception>
-    public void ValidateEntitiesDoNotGenerateDuplicateQueriesOrMutation(RuntimeEntities entityCollection)
+    public void ValidateEntitiesDoNotGenerateDuplicateQueriesOrMutation(DatabaseType databaseType, RuntimeEntities entityCollection)
     {
         HashSet<string> graphQLOperationNames = new();
 
@@ -345,7 +346,8 @@ public void ValidateEntitiesDoNotGenerateDuplicateQueriesOrMutation(RuntimeEntit
             }
             else
             {
-                // For entities (table/view) that have graphQL exposed, two queries and three mutations would be generated.
+                // For entities (table/view) that have graphQL exposed, two queries, three mutations for Relational databases (e.g. MYSQL, MSSQL etc.)
+                // and four mutations for CosmosDb_NoSQL would be generated.
                 // Primary Key Query: For fetching an item using its primary key.
                 // List Query: To fetch a paginated list of items.
                 // Query names for both these queries are determined.
@@ -356,12 +358,14 @@ public void ValidateEntitiesDoNotGenerateDuplicateQueriesOrMutation(RuntimeEntit
                 string createMutationName = $"create{GraphQLNaming.GetDefinedSingularName(entityName, entity)}";
                 string updateMutationName = $"update{GraphQLNaming.GetDefinedSingularName(entityName, entity)}";
                 string deleteMutationName = $"delete{GraphQLNaming.GetDefinedSingularName(entityName, entity)}";
+                string patchMutationName = $"patch{GraphQLNaming.GetDefinedSingularName(entityName, entity)}";
 
                 if (!graphQLOperationNames.Add(pkQueryName)
                     || !graphQLOperationNames.Add(listQueryName)
                     || !graphQLOperationNames.Add(createMutationName)
                     || !graphQLOperationNames.Add(updateMutationName)
-                    || !graphQLOperationNames.Add(deleteMutationName))
+                    || !graphQLOperationNames.Add(deleteMutationName)
+                    || ((databaseType is DatabaseType.CosmosDB_NoSQL) && !graphQLOperationNames.Add(patchMutationName)))
                 {
                     containsDuplicateOperationNames = true;
                 }