mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-17 20:41:49 +03:00
80161e4208
https://github.com/hasura/graphql-engine-mono/pull/1179 Co-authored-by: Abby Sassel <3883855+sassela@users.noreply.github.com> Co-authored-by: Tirumarai Selvan <8663570+tirumaraiselvan@users.noreply.github.com> GitOrigin-RevId: b565de269e215ae8172bddd895f3d057ddcc8695
93 lines
4.5 KiB
Haskell
93 lines
4.5 KiB
Haskell
{- | BackendAPI
|
|
|
|
This module defines the 'BackendAPI' class, alongside a few helpers. Its goal is to delegate to
|
|
backends the responsibility of creating the parsers for the metadata API. Each backend is expected
|
|
to provide a list of 'CommandParser', which in turn is a simple function from command name and
|
|
command arguments to a corresponding parser. Command parsers can easily be created using the
|
|
'commandParser' function.
|
|
|
|
Furthermore, for each set of related features, such as table tracking commands, or permission
|
|
commands, a helper function is provided, that allows a backend to write its instance by simply
|
|
listing the set of features it supports.
|
|
-}
|
|
|
|
module Hasura.Server.API.Backend where
|
|
|
|
import Hasura.Prelude
|
|
|
|
import qualified Data.Aeson.Types as J
|
|
|
|
import Data.Aeson ((<?>))
|
|
|
|
import Hasura.RQL.Types.Backend
|
|
import Hasura.SQL.AnyBackend
|
|
import Hasura.SQL.Backend
|
|
import {-# SOURCE #-} Hasura.Server.API.Metadata
|
|
|
|
|
|
-- API class
|
|
|
|
type CommandParser = Text -> J.Value -> J.Parser (Maybe RQLMetadataV1)
|
|
|
|
class BackendAPI (b :: BackendType) where
|
|
metadataV1CommandParsers :: [CommandParser]
|
|
|
|
|
|
-- helpers
|
|
|
|
commandParser
|
|
:: J.FromJSON a
|
|
=> Text -- ^ expected command name
|
|
-> (a -> RQLMetadataV1) -- ^ corresponding parser
|
|
-> CommandParser
|
|
commandParser expected constructor provided arguments =
|
|
-- We return a Maybe parser here if the command name doesn't match, as Aeson's alternative
|
|
-- instance backtracks: if we used 'fail', we would not be able to distinguish between "this is
|
|
-- the correct branch, the name matches, but the argument fails to parse, we must fail" and "this
|
|
-- is not the command we were expecting here, it is fine to continue with another".
|
|
whenMaybe (expected == provided) $ constructor <$> (J.parseJSON arguments <?> J.Key "args")
|
|
|
|
sourceCommands, tableCommands, tablePermissionsCommands, functionCommands, functionPermissionsCommands, relationshipCommands, remoteRelationshipCommands
|
|
:: forall (b :: BackendType). Backend b
|
|
=> [CommandParser]
|
|
sourceCommands =
|
|
[ commandParser "add_source" $ RMAddSource . mkAnyBackend @b
|
|
, commandParser "drop_source" $ RMDropSource
|
|
, commandParser "set_table_customization" $ RMSetTableCustomization . mkAnyBackend @b
|
|
]
|
|
tableCommands =
|
|
[ commandParser "track_table" $ RMTrackTable . mkAnyBackend @b
|
|
, commandParser "untrack_table" $ RMUntrackTable . mkAnyBackend @b
|
|
]
|
|
tablePermissionsCommands =
|
|
[ commandParser "create_insert_permission" $ RMCreateInsertPermission . mkAnyBackend @b
|
|
, commandParser "create_select_permission" $ RMCreateSelectPermission . mkAnyBackend @b
|
|
, commandParser "create_update_permission" $ RMCreateUpdatePermission . mkAnyBackend @b
|
|
, commandParser "create_delete_permission" $ RMCreateDeletePermission . mkAnyBackend @b
|
|
, commandParser "drop_insert_permission" $ RMDropInsertPermission . mkAnyBackend @b
|
|
, commandParser "drop_select_permission" $ RMDropSelectPermission . mkAnyBackend @b
|
|
, commandParser "drop_update_permission" $ RMDropUpdatePermission . mkAnyBackend @b
|
|
, commandParser "drop_delete_permission" $ RMDropDeletePermission . mkAnyBackend @b
|
|
, commandParser "set_permission_comment" $ RMSetPermissionComment . mkAnyBackend @b
|
|
]
|
|
functionCommands =
|
|
[ commandParser "track_function" $ RMTrackFunction . mkAnyBackend @b
|
|
, commandParser "untrack_function" $ RMUntrackFunction . mkAnyBackend @b
|
|
]
|
|
functionPermissionsCommands =
|
|
[ commandParser "create_function_permission" $ RMCreateFunctionPermission . mkAnyBackend @b
|
|
, commandParser "drop_function_permission" $ RMDropFunctionPermission . mkAnyBackend @b
|
|
]
|
|
relationshipCommands =
|
|
[ commandParser "create_object_relationship" $ RMCreateObjectRelationship . mkAnyBackend @b
|
|
, commandParser "create_array_relationship" $ RMCreateArrayRelationship . mkAnyBackend @b
|
|
, commandParser "set_relationship_comment" $ RMSetRelationshipComment . mkAnyBackend @b
|
|
, commandParser "rename_relationship" $ RMRenameRelationship . mkAnyBackend @b
|
|
, commandParser "drop_relationship" $ RMDropRelationship . mkAnyBackend @b
|
|
]
|
|
remoteRelationshipCommands =
|
|
[ commandParser "create_remote_relationship" $ RMCreateRemoteRelationship . mkAnyBackend @b
|
|
, commandParser "update_remote_relationship" $ RMUpdateRemoteRelationship . mkAnyBackend @b
|
|
, commandParser "delete_remote_relationship" $ RMDeleteRemoteRelationship
|
|
]
|