| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Hasura.GraphQL.Execute.Common
Synopsis
- class Monad m => MonadGQLExecutionCheck m where
- checkGQLExecution :: UserInfo -> ([Header], IpAddress) -> AllowListStatus -> SchemaCache -> GQLReqUnparsed -> RequestId -> m (Either QErr GQLReqParsed)
- executeIntrospection :: UserInfo -> Value -> SetGraphqlIntrospectionOptions -> m (Either QErr ExecutionStep)
- checkGQLBatchedReqs :: UserInfo -> RequestId -> [GQLReq GQLQueryText] -> SchemaCache -> m (Either QErr ())
Documentation
class Monad m => MonadGQLExecutionCheck m where Source #
Typeclass representing safety checks (if any) that need to be performed before a GraphQL query should be allowed to be executed. In OSS, the safety check is to check in the query is in the allow list.
the executeIntrospection function has different implementations in OSS and
Pro. In Pro, the GraphQL schema introspection can be disabled for specified
roles and in OSS there is no restrictions.
| TODO (from master): Limitation: This parses the query, which is not ideal if we already have the query cached. The parsing happens unnecessary. But getting this to either return a plan or parse was tricky and complicated.
Methods
Arguments
| :: UserInfo | |
| -> ([Header], IpAddress) | |
| -> AllowListStatus | allow list enabled? |
| -> SchemaCache | needs allow list |
| -> GQLReqUnparsed | the unparsed GraphQL query string (and related values) |
| -> RequestId | |
| -> m (Either QErr GQLReqParsed) |
executeIntrospection :: UserInfo -> Value -> SetGraphqlIntrospectionOptions -> m (Either QErr ExecutionStep) Source #
checkGQLBatchedReqs :: UserInfo -> RequestId -> [GQLReq GQLQueryText] -> SchemaCache -> m (Either QErr ()) Source #