Stored Procedure support for new Execute operation - REST and GraphQL

ConfigGenerators/MsSqlCommands.txt

@@ -25,15 +25,15 @@ add Journal --config "dab-config.MsSql.json" --source "journals" --rest true --g
 add ArtOfWar --config "dab-config.MsSql.json" --source "aow" --rest true --permissions "anonymous:*"
 add series --config "dab-config.MsSql.json" --source "series" --permissions "anonymous:*"
 add Sales --config "dab-config.MsSql.json" --source "sales" --permissions "anonymous:*" --rest true --graphql true
-add GetBooks --config "dab-config.MsSql.json" --source "get_books" --source.type "stored-procedure" --permissions "anonymous:read" --rest true --graphql true
-add GetBook --config "dab-config.MsSql.json" --source "get_book_by_id" --source.type "stored-procedure" --permissions "anonymous:read" --rest true --graphql false
-add GetPublisher --config "dab-config.MsSql.json" --source "get_publisher_by_id" --source.type "stored-procedure" --source.params "id:1" --permissions "anonymous:read" --rest true --graphql true
-add InsertBook --config "dab-config.MsSql.json" --source "insert_book" --source.type "stored-procedure" --source.params "title:randomX,publisher_id:1234" --permissions "anonymous:create" --rest true --graphql true
-add CountBooks --config "dab-config.MsSql.json" --source "count_books" --source.type "stored-procedure" --permissions "anonymous:read" --rest true --graphql true
-add DeleteLastInsertedBook --config "dab-config.MsSql.json" --source "delete_last_inserted_book" --source.type "stored-procedure" --permissions "anonymous:delete" --rest true --graphql true
+add GetBooks --config "dab-config.MsSql.json" --source "get_books" --source.type "stored-procedure" --permissions "anonymous:execute" --rest true --graphql true
+add GetBook --config "dab-config.MsSql.json" --source "get_book_by_id" --source.type "stored-procedure" --permissions "anonymous:execute" --rest true --graphql false
+add GetPublisher --config "dab-config.MsSql.json" --source "get_publisher_by_id" --source.type "stored-procedure" --source.params "id:1" --permissions "anonymous:execute" --rest true --graphql true
+add InsertBook --config "dab-config.MsSql.json" --source "insert_book" --source.type "stored-procedure" --source.params "title:randomX,publisher_id:1234" --permissions "anonymous:execute" --rest true --graphql true
+add CountBooks --config "dab-config.MsSql.json" --source "count_books" --source.type "stored-procedure" --permissions "anonymous:execute" --rest true --graphql true
+add DeleteLastInsertedBook --config "dab-config.MsSql.json" --source "delete_last_inserted_book" --source.type "stored-procedure" --permissions "anonymous:execute" --rest true --graphql true
 add UpdateBookTitle --config "dab-config.MsSql.json" --source "update_book_title" --source.type "stored-procedure" --source.params "id:1,title:Testing Tonight" --permissions "anonymous:update" --rest true --graphql true
-add GetAuthorsHistoryByFirstName --config "dab-config.MsSql.json" --source "get_authors_history_by_first_name" --source.type "stored-procedure" --source.params "firstName:Aaron" --permissions "anonymous:read" --rest true --graphql SearchAuthorByFirstName
-add InsertAndDisplayAllBooksUnderGivenPublisher --config "dab-config.MsSql.json" --source "insert_and_display_all_books_for_given_publisher" --source.type "stored-procedure" --source.params "title:MyTitle,publisher_name:MyPublisher" --permissions "anonymous:create" --rest true --graphql true
+add GetAuthorsHistoryByFirstName --config "dab-config.MsSql.json" --source "get_authors_history_by_first_name" --source.type "stored-procedure" --source.params "firstName:Aaron" --permissions "anonymous:execute" --rest true --graphql SearchAuthorByFirstName
+add InsertAndDisplayAllBooksUnderGivenPublisher --config "dab-config.MsSql.json" --source "insert_and_display_all_books_for_given_publisher" --source.type "stored-procedure" --source.params "title:MyTitle,publisher_name:MyPublisher" --permissions "anonymous:execute" --rest true --graphql true
 update Publisher --config "dab-config.MsSql.json" --permissions "authenticated:create,read,update,delete" --rest true --graphql true --relationship books --target.entity Book --cardinality many
 update Publisher --config "dab-config.MsSql.json" --permissions "policy_tester_01:create,delete"
 update Publisher --config "dab-config.MsSql.json" --permissions "policy_tester_01:update" --fields.include "*"

ConfigGenerators/dab-config.sql.reference.json

@@ -915,15 +915,18 @@
         "object": "get_books"
       },
       "rest": true,
-      "graphql": true,
+      "graphql": {
+        "type": "GetBooks",
+        "operation": "query"
+      },
       "permissions": [
         {
           "role": "anonymous",
-          "actions": [ "read" ]
+          "actions": [ "execute" ]
         },
         {
           "role": "authenticated",
-          "actions": [ "read" ]
+          "actions": [ "execute" ]
         }
       ]
     },
@@ -932,16 +935,19 @@
         "type": "stored-procedure",
         "object": "get_book_by_id"
       },
-      "rest": true,
+      "rest": {
+        "path": "GetBook",
+        "method": [ "GET" ]
+      },
       "graphql": false,
       "permissions": [
         {
           "role": "anonymous",
-          "actions": [ "read" ]
+          "actions": [ "execute" ]
         },
         {
           "role": "authenticated",
-          "actions": [ "read" ]
+          "actions": [ "execute" ]
         }
       ]
     },
@@ -978,53 +984,68 @@
         },
         "key-fields": []
       },
-      "rest": true,
+      "rest": {
+        "path": "InsertBook",
+        "method": [ "POST" ]
+      },
       "permissions": [
         {
           "role": "anonymous",
           "actions": [
-            "create"
+            "execute"
           ]
         },
         {
           "role": "authenticated",
           "actions": [
-            "create"
+            "execute"
           ]
         }
       ],
-      "graphql": true
+      "graphql": {
+        "type": "InsertBook",
+        "operation": "mutation"
+      }
     },
     "CountBooks": {
       "source": {
         "type": "stored-procedure",
         "object": "count_books",
         "key-fields": []
       },
-      "rest": true,
+      "rest": {
+        "path": "CountBooks",
+        "method": [ "GET" ]
+      },
       "permissions": [
         {
           "role": "anonymous",
           "actions": [
-            "read"
+            "execute"
           ]
         },
         {
           "role": "authenticated",
           "actions": [
-            "read"
+            "execute"
           ]
         }
       ],
-      "graphql": true
+      "graphql": {
+        "type": "CountBooks",
+        "operation": "query"
+      }
     },
     "DeleteLastInsertedBook": {
       "source": {
         "type": "stored-procedure",
         "object": "delete_last_inserted_book",
         "key-fields": []
       },
-      "rest": true,
+      "rest": {
+        "path": "DeleteLastInsertedBook",
+        "method": [ "DELETE" ]
+      },
       "permissions": [
         {
           "role": "anonymous",
@@ -1039,7 +1060,10 @@
           ]
         }
       ],
-      "graphql": true
+      "graphql": {
+        "type": "DeleteLastInsertedBook",
+        "operation": "mutation"
+      }
     },
     "UpdateBookTitle": {
       "source": {
@@ -1051,22 +1075,28 @@
         },
         "key-fields": []
       },
-      "rest": true,
+      "rest": {
+        "path": "UpdateBookTitle",
+        "method": [ "PUT", "PATCH" ]
+      },
       "permissions": [
         {
           "role": "anonymous",
           "actions": [
-            "update"
+            "execute"
           ]
         },
         {
           "role": "authenticated",
           "actions": [
-            "update"
+            "execute"
           ]
         }
       ],
-      "graphql": true
+      "graphql": {
+        "type": "UpdateBookTitle",
+        "operation": "mutation"
+      }
     },
     "GetPublisher": {
       "source": {
@@ -1076,7 +1106,10 @@
           "id": 1
         }
       },
-      "rest": true,
+      "rest": {
+        "path": "GetPublisher",
+        "method": [ "GET" ]
+      },
       "permissions": [
         {
           "role": "anonymous",
@@ -1091,7 +1124,10 @@
           ]
         }
       ],
-      "graphql": true
+      "graphql": {
+        "type": "GetPublisher",
+        "operation": "query"
+      }
     }
   }
 }

src/Auth/AuthorizationMetadataHelpers.cs

@@ -34,6 +34,17 @@ public class EntityMetadata
         /// i.e. Read operation is permitted in {Role1, Role2, ..., RoleN}
         /// </summary>
         public Dictionary<Operation, List<string>> OperationToRolesMap { get; set; } = new();
+
+        /// <summary>
+        /// List of Http verbs enabled for Stored Procedure entities that have their REST endpoint enabled.
+        /// </summary>
+        public HashSet<string> StoredProcedureHttpVerbs { get; set; } = new();
+
+        /// <summary>
+        /// Defines the type of database object the entity represents.
+        /// Examples include Table, View, StoredProcedure
+        /// </summary>
+        public SourceType ObjectType { get; set; } = SourceType.Table;
     }
 
     /// <summary>

src/Auth/IAuthorizationResolver.cs

@@ -83,6 +83,15 @@ public interface IAuthorizationResolver
         /// <returns>Collection of role names allowed to perform operation on Entity's field.</returns>
         public IEnumerable<string> GetRolesForField(string entityName, string field, Operation operation);
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="entityName"></param>
+        /// <param name="roleName"></param>
+        /// <param name="httpVerb"></param>
+        /// <returns>True if the execution of the stored procedure is permitted.</returns>
+        public bool IsStoredProcedureExecutionPermitted(string entityName, string roleName, string httpVerb);
+
         /// <summary>
         /// Returns a list of roles which define permissions for the provided operation.
         /// i.e. list of roles which allow the operation 'Read' on entityName.

src/Config/Action.cs

@@ -20,7 +20,7 @@ public record PermissionOperation(
         Field? Fields)
     {
         // Set of allowed operations for a request.
-        public static readonly HashSet<Operation> ValidPermissionOperations = new() { Operation.Create, Operation.Read, Operation.Update, Operation.Delete };
+        public static readonly HashSet<Operation> ValidPermissionOperations = new() { Operation.Create, Operation.Read, Operation.Update, Operation.Delete, Operation.Execute };
     }
 
     /// <summary>
@@ -59,8 +59,10 @@ public override void Write(Utf8JsonWriter writer, Operation value, JsonSerialize
     public enum Operation
     {
         None,
+
         // *
         All,
+
         // Common Operations
         Delete, Read,
 
@@ -71,7 +73,10 @@ public enum Operation
         Insert, Update, UpdateGraphQL,
 
         // Additional
-        UpsertIncremental, UpdateIncremental
+        UpsertIncremental, UpdateIncremental,
+
+        // Stored Procedures / Functions
+        Execute
     }
 
     /// <summary>