refactor: add plan module

* rename/add plan dirs
* add read plan func/data
* add call plan func/data
* add mutate plan func/data

src/PostgREST/App.hs

@@ -31,19 +31,18 @@ import qualified Hasql.Transaction.Sessions as SQL
 import qualified Network.Wai                as Wai
 import qualified Network.Wai.Handler.Warp   as Warp
 
-import qualified PostgREST.Admin                    as Admin
-import qualified PostgREST.AppState                 as AppState
-import qualified PostgREST.Auth                     as Auth
-import qualified PostgREST.Cors                     as Cors
-import qualified PostgREST.Error                    as Error
-import qualified PostgREST.Logger                   as Logger
-import qualified PostgREST.Middleware               as Middleware
-import qualified PostgREST.Query                    as Query
-import qualified PostgREST.Request.ApiRequest       as ApiRequest
-import qualified PostgREST.Request.DbRequestBuilder as ReqBuilder
-import qualified PostgREST.Request.MutateQuery      as MutateRequest
-import qualified PostgREST.Request.Types            as ApiRequestTypes
-import qualified PostgREST.Response                 as Response
+import qualified PostgREST.Admin              as Admin
+import qualified PostgREST.AppState           as AppState
+import qualified PostgREST.Auth               as Auth
+import qualified PostgREST.Cors               as Cors
+import qualified PostgREST.Error              as Error
+import qualified PostgREST.Logger             as Logger
+import qualified PostgREST.Middleware         as Middleware
+import qualified PostgREST.Plan               as Plan
+import qualified PostgREST.Query              as Query
+import qualified PostgREST.Request.ApiRequest as ApiRequest
+import qualified PostgREST.Request.Types      as ApiRequestTypes
+import qualified PostgREST.Response           as Response
 
 import PostgREST.AppState                (AppState)
 import PostgREST.Auth                    (AuthResult (..))
@@ -57,13 +56,14 @@ import PostgREST.DbStructure.Identifiers (FieldName,
 import PostgREST.DbStructure.Proc        (ProcDescription (..))
 import PostgREST.DbStructure.Table       (Table (..))
 import PostgREST.Error                   (Error)
+import PostgREST.Plan.MutatePlan         (MutatePlan)
+import PostgREST.Plan.ReadPlan           (ReadPlanTree)
 import PostgREST.Query                   (DbHandler)
 import PostgREST.Request.ApiRequest      (Action (..),
                                           ApiRequest (..),
                                           InvokeMethod (..),
                                           Mutation (..), Target (..))
 import PostgREST.Request.Preferences     (PreferRepresentation (..))
-import PostgREST.Request.ReadQuery       (ReadRequest)
 import PostgREST.Version                 (prettyVersion)
 import PostgREST.Workers                 (connectionWorker, listener)
 
@@ -223,7 +223,7 @@ handleRequest context@(RequestContext _ _ ApiRequest{..} _) =
 
 handleRead :: Bool -> QualifiedIdentifier -> RequestContext -> DbHandler Wai.Response
 handleRead headersOnly identifier context@RequestContext{..} = do
-  req <- liftEither $ readRequest identifier context
+  req <- liftEither $ readPlan identifier context
 
   (resultSet, total) <- Query.readQuery req ctxConfig ctxApiRequest
 
@@ -237,7 +237,7 @@ handleCreate identifier context@RequestContext{..} = do
       then maybe mempty tablePKCols $ HM.lookup identifier $ dbTables ctxDbStructure
       else mempty
 
-  (mutateReq, readReq) <- liftEither $ writeRequest MutationCreate identifier context pkCols
+  (mutateReq, readReq) <- liftEither $ mutatePlan MutationCreate identifier context pkCols
 
   resultSet <- Query.createQuery mutateReq readReq pkCols ctxApiRequest ctxConfig
 
@@ -245,20 +245,20 @@ handleCreate identifier context@RequestContext{..} = do
 
 handleUpdate :: QualifiedIdentifier -> RequestContext -> DbHandler Wai.Response
 handleUpdate identifier context@(RequestContext ctxConfig _ ctxApiRequest _) = do
-  (mutateReq, readReq) <- liftEither $ writeRequest MutationUpdate identifier context mempty
+  (mutateReq, readReq) <- liftEither $ mutatePlan MutationUpdate identifier context mempty
   resultSet <- Query.updateQuery mutateReq readReq ctxApiRequest ctxConfig
   pure $ Response.updateResponse ctxApiRequest resultSet
 
 handleSingleUpsert :: QualifiedIdentifier -> RequestContext-> DbHandler Wai.Response
 handleSingleUpsert identifier context@(RequestContext ctxConfig ctxDbStructure ctxApiRequest _) = do
   let pkCols = maybe mempty tablePKCols $ HM.lookup identifier $ dbTables ctxDbStructure
-  (mutateReq, readReq) <- liftEither $ writeRequest MutationSingleUpsert identifier context pkCols
+  (mutateReq, readReq) <- liftEither $ mutatePlan MutationSingleUpsert identifier context pkCols
   resultSet <- Query.singleUpsertQuery mutateReq readReq ctxApiRequest ctxConfig
   pure $ Response.singleUpsertResponse ctxApiRequest resultSet
 
 handleDelete :: QualifiedIdentifier -> RequestContext -> DbHandler Wai.Response
 handleDelete identifier context@(RequestContext ctxConfig _ ctxApiRequest _) = do
-  (mutateReq, readReq) <- liftEither $ writeRequest MutationDelete identifier context mempty
+  (mutateReq, readReq) <- liftEither $ mutatePlan MutationDelete identifier context mempty
   resultSet <- Query.deleteQuery mutateReq readReq ctxApiRequest ctxConfig
   pure $ Response.deleteResponse ctxApiRequest resultSet
 
@@ -270,8 +270,8 @@ handleInvoke invMethod proc context@RequestContext{..} = do
         (pdSchema proc)
         (fromMaybe (pdName proc) $ Proc.procTableName proc)
 
-  readReq <- liftEither $ readRequest identifier context
-  let callReq = ReqBuilder.callRequest proc ctxApiRequest readReq
+  readReq <- liftEither $ readPlan identifier context
+  let callReq = Plan.callPlan proc ctxApiRequest readReq
 
   resultSet <- Query.invokeQuery proc callReq readReq ctxApiRequest ctxConfig
 
@@ -282,14 +282,14 @@ handleOpenApi headersOnly tSchema (RequestContext conf dbStructure apiRequest pg
   oaiResult <- Query.openApiQuery dbStructure pgVer conf tSchema
   pure $ Response.openApiResponse headersOnly oaiResult conf dbStructure (iSchema apiRequest) (iNegotiatedByProfile apiRequest)
 
-writeRequest :: Mutation -> QualifiedIdentifier -> RequestContext -> [FieldName] -> Either Error (MutateRequest.MutateRequest, ReadRequest)
-writeRequest mutation identifier@QualifiedIdentifier{..} context@RequestContext{..} pkCols = do
-  readReq <- readRequest identifier context
-  mutateReq <- ReqBuilder.mutateRequest mutation qiSchema qiName ctxApiRequest pkCols readReq
+mutatePlan :: Mutation -> QualifiedIdentifier -> RequestContext -> [FieldName] -> Either Error (MutatePlan, ReadPlanTree)
+mutatePlan mutation identifier@QualifiedIdentifier{..} context@RequestContext{..} pkCols = do
+  readReq <- readPlan identifier context
+  mutateReq <- Plan.mutatePlan mutation qiSchema qiName ctxApiRequest pkCols readReq
   pure (mutateReq, readReq)
 
-readRequest :: QualifiedIdentifier -> RequestContext -> Either Error ReadRequest
-readRequest QualifiedIdentifier{..} (RequestContext AppConfig{..} dbStructure apiRequest _) =
-  ReqBuilder.readRequest qiSchema qiName configDbMaxRows
+readPlan :: QualifiedIdentifier -> RequestContext -> Either Error ReadPlanTree
+readPlan QualifiedIdentifier{..} (RequestContext AppConfig{..} dbStructure apiRequest _) =
+  Plan.readPlan qiSchema qiName configDbMaxRows
     (dbRelationships dbStructure)
     apiRequest