Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.Server.App

Synopsis

data HandlerCtx
data Handler m a
data APIResp
- = JSONResp !(HttpResponse EncJSON)
- | RawResp !(HttpResponse ByteString)
boolToText :: Bool -> Text
isAdminSecretSet :: AuthMode -> Text
mkGetHandler :: Handler m (HttpLogGraphQLInfo, APIResp) -> APIHandler m ()
onlyAdmin :: (MonadError QErr m, MonadReader HandlerCtx m) => m ()
class Monad m => MonadMetadataApiAuthorization m where
- authorizeV1QueryApi :: RQLQuery -> HandlerCtx -> m (Either QErr ())
- authorizeV1MetadataApi :: RQLMetadata -> HandlerCtx -> m (Either QErr ())
- authorizeV2QueryApi :: RQLQuery -> HandlerCtx -> m (Either QErr ())
class Monad m => MonadConfigApiHandler m where
- runConfigApiHandler :: AppStateRef impl -> SpockCtxT () m ()
mkSpockAction :: forall m a impl. (MonadIO m, MonadBaseControl IO m, HasAppEnv m, FromJSON a, UserAuthentication m, HttpLog m, HasResourceLimits m, MonadTrace m) => AppStateRef impl -> (Bool -> QErr -> Encoding) -> (QErr -> QErr) -> APIHandler m a -> ActionT m ()
class Monad m => ConsoleRenderer m where
- type ConsoleType m :: Type
- renderConsole :: Text -> AuthMode -> TelemetryStatus -> Maybe Text -> Maybe Text -> ConsoleType m -> m (Either String Text)
data CEConsoleType
- = OSSConsole
- | ProLiteConsole
ceConsoleTypeIdentifier :: CEConsoleType -> String
class Monad m => MonadVersionAPIWithExtraData m where
- getExtraDataForVersionAPI :: m [Pair]
renderHtmlTemplate :: Template -> Value -> Either String Text
configApiGetHandler :: forall m impl. (MonadIO m, MonadBaseControl IO m, HasAppEnv m, UserAuthentication m, HttpLog m, HasResourceLimits m, MonadTrace m) => AppStateRef impl -> SpockCtxT () m ()
data HasuraApp = HasuraApp !Application !AsyncActionSubscriptionState !(IO ())
mkWaiApp :: forall m impl. (MonadIO m, MonadFix m, MonadStateless IO m, Forall (Pure m), ConsoleRenderer m, MonadVersionAPIWithExtraData m, HttpLog m, HasAppEnv m, HasCacheStaticConfig m, HasFeatureFlagChecker m, UserAuthentication m, MonadMetadataApiAuthorization m, MonadGQLExecutionCheck m, MonadConfigApiHandler m, MonadQueryLog m, MonadExecutionLog m, MonadWSLog m, MonadTrace m, MonadExecuteQuery m, HasResourceLimits m, MonadMetadataStorage m, MonadResolveSource m, MonadQueryTags m, MonadEventLogCleanup m, ProvidesNetwork m, MonadGetPolicies m) => (AppStateRef impl -> SpockT m ()) -> AppStateRef impl -> ConsoleType m -> Store EmptyMetrics -> WSServerEnv impl -> m HasuraApp
onlyWhenApiEnabled :: MonadIO m => (AppContext -> Bool) -> AppStateRef impl -> ActionCtxT ctx m b -> ActionCtxT ctx m b

Documentation

data HandlerCtx Source #

Instances

Instances details

Monad m => MonadReader HandlerCtx (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods ask :: Handler m HandlerCtx # local :: (HandlerCtx -> HandlerCtx) -> Handler m a -> Handler m a # reader :: (HandlerCtx -> a) -> Handler m a #

data Handler m a Source #

Instances

Instances details

MonadTrans Handler Source #
Instance details Defined in Hasura.Server.App Methods lift :: Monad m => m a -> Handler m a #
MonadBaseControl b m => MonadBaseControl b (Handler m) Source #
Instance details Defined in Hasura.Server.App Associated Types type StM (Handler m) a Source # Methods liftBaseWith :: (RunInBase (Handler m) b -> b a) -> Handler m a Source # restoreM :: StM (Handler m) a -> Handler m a Source #
Monad m => MonadError QErr (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods throwError :: QErr -> Handler m a # catchError :: Handler m a -> (QErr -> Handler m a) -> Handler m a #
Monad m => MonadReader HandlerCtx (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods ask :: Handler m HandlerCtx # local :: (HandlerCtx -> HandlerCtx) -> Handler m a -> Handler m a # reader :: (HandlerCtx -> a) -> Handler m a #
MonadBase b m => MonadBase b (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods liftBase :: b α -> Handler m α Source #
MonadFix m => MonadFix (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods mfix :: (a -> Handler m a) -> Handler m a #
MonadIO m => MonadIO (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods liftIO :: IO a -> Handler m a #
Monad m => Applicative (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods pure :: a -> Handler m a # (<>) :: Handler m (a -> b) -> Handler m a -> Handler m b # liftA2 :: (a -> b -> c) -> Handler m a -> Handler m b -> Handler m c # (>) :: Handler m a -> Handler m b -> Handler m b # (<*) :: Handler m a -> Handler m b -> Handler m a #
Functor m => Functor (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods fmap :: (a -> b) -> Handler m a -> Handler m b # (<$) :: a -> Handler m b -> Handler m a #
Monad m => Monad (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods (>>=) :: Handler m a -> (a -> Handler m b) -> Handler m b # (>>) :: Handler m a -> Handler m b -> Handler m b # return :: a -> Handler m a #
HasAppEnv m => HasAppEnv (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods askAppEnv :: Handler m AppEnv Source #
MonadGQLExecutionCheck m => MonadGQLExecutionCheck (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods checkGQLExecution :: UserInfo -> ([Header], IpAddress) -> AllowListStatus -> SchemaCache -> GQLReqUnparsed -> RequestId -> Handler m (Either QErr GQLReqParsed) Source # executeIntrospection :: UserInfo -> Value -> SetGraphqlIntrospectionOptions -> Handler m (Either QErr ExecutionStep) Source # checkGQLBatchedReqs :: UserInfo -> RequestId -> [GQLReq GQLQueryText] -> SchemaCache -> Handler m (Either QErr ()) Source #
MonadExecutionLog m => MonadExecutionLog (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods logExecutionLog :: Logger Hasura -> ExecutionLog -> Handler m () Source #
MonadQueryLog m => MonadQueryLog (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods logQueryLog :: Logger Hasura -> QueryLog -> Handler m () Source #
MonadExecuteQuery m => MonadExecuteQuery (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods cacheLookup :: ExecutionPlan -> [QueryRootField UnpreparedValue] -> Maybe CachedDirective -> GQLReqParsed -> UserInfo -> [Header] -> Handler m (Either QErr (ResponseHeaders, CacheResult)) Source #
MonadMetadataStorage m => MonadMetadataStorage (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods fetchMetadataResourceVersion :: Handler m (Either QErr MetadataResourceVersion) Source # fetchMetadata :: Handler m (Either QErr MetadataWithResourceVersion) Source # fetchMetadataNotifications :: MetadataResourceVersion -> InstanceId -> Handler m (Either QErr [(MetadataResourceVersion, CacheInvalidations)]) Source # setMetadata :: MetadataResourceVersion -> Metadata -> Handler m (Either QErr MetadataResourceVersion) Source # notifySchemaCacheSync :: MetadataResourceVersion -> InstanceId -> CacheInvalidations -> Handler m (Either QErr ()) Source # getCatalogState :: Handler m (Either QErr CatalogState) Source # setCatalogState :: CatalogStateType -> Value -> Handler m (Either QErr ()) Source # fetchSourceIntrospection :: MetadataResourceVersion -> Handler m (Either QErr (Maybe StoredIntrospection)) Source # storeSourceIntrospection :: StoredIntrospection -> MetadataResourceVersion -> Handler m (Either QErr ()) Source # getMetadataDbUid :: Handler m (Either QErr MetadataDbId) Source # checkMetadataStorageHealth :: Handler m (Either QErr ()) Source # getDeprivedCronTriggerStats :: [TriggerName] -> Handler m (Either QErr [CronTriggerStats]) Source # getScheduledEventsForDelivery :: [TriggerName] -> Handler m (Either QErr ([CronEvent], [OneOffScheduledEvent])) Source # insertCronEvents :: [CronEventSeed] -> Handler m (Either QErr ()) Source # insertOneOffScheduledEvent :: OneOffEvent -> Handler m (Either QErr EventId) Source # insertScheduledEventInvocation :: Invocation 'ScheduledType -> ScheduledEventType -> Handler m (Either QErr ()) Source # setScheduledEventOp :: ScheduledEventId -> ScheduledEventOp -> ScheduledEventType -> Handler m (Either QErr ()) Source # unlockScheduledEvents :: ScheduledEventType -> [ScheduledEventId] -> Handler m (Either QErr Int) Source # unlockAllLockedScheduledEvents :: Handler m (Either QErr ()) Source # clearFutureCronEvents :: ClearCronEvents -> Handler m (Either QErr ()) Source # getOneOffScheduledEvents :: ScheduledEventPagination -> [ScheduledEventStatus] -> RowsCountOption -> Handler m (Either QErr (WithOptionalTotalCount [OneOffScheduledEvent])) Source # getCronEvents :: TriggerName -> ScheduledEventPagination -> [ScheduledEventStatus] -> RowsCountOption -> Handler m (Either QErr (WithOptionalTotalCount [CronEvent])) Source # getScheduledEventInvocations :: GetScheduledEventInvocations -> Handler m (Either QErr (WithOptionalTotalCount [ScheduledEventInvocation])) Source # deleteScheduledEvent :: ScheduledEventId -> ScheduledEventType -> Handler m (Either QErr ()) Source # insertAction :: ActionName -> SessionVariables -> [Header] -> Value -> Handler m (Either QErr ActionId) Source # fetchUndeliveredActionEvents :: Handler m (Either QErr [ActionLogItem]) Source # setActionStatus :: ActionId -> AsyncActionStatus -> Handler m (Either QErr ()) Source # fetchActionResponse :: ActionId -> Handler m (Either QErr ActionLogResponse) Source # clearActionData :: ActionName -> Handler m (Either QErr ()) Source # setProcessingActionLogsToPending :: LockedActionIdArray -> Handler m (Either QErr ()) Source #
MonadQueryTags m => MonadQueryTags (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods createQueryTags :: QueryTagsAttributes -> Maybe QueryTagsConfig -> Tagged (Handler m) QueryTagsComment Source #
MonadEventLogCleanup m => MonadEventLogCleanup (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods runLogCleaner :: SourceCache -> TriggerLogCleanupConfig -> Handler m (Either QErr EncJSON) Source # generateCleanupSchedules :: AnyBackend SourceInfo -> TriggerName -> AutoTriggerLogCleanupConfig -> Handler m (Either QErr ()) Source # updateTriggerCleanupSchedules :: Logger Hasura -> InsOrdHashMap SourceName BackendSourceMetadata -> InsOrdHashMap SourceName BackendSourceMetadata -> SchemaCache -> Handler m (Either QErr ()) Source #
HasCacheStaticConfig m => HasCacheStaticConfig (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods askCacheStaticConfig :: Handler m CacheStaticConfig Source #
Monad m => UserInfoM (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods askUserInfo :: Handler m UserInfo Source #
MonadResolveSource m => MonadResolveSource (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods getPGSourceResolver :: Handler m (SourceResolver ('Postgres 'Vanilla)) Source # getMSSQLSourceResolver :: Handler m (SourceResolver 'MSSQL) Source #
MonadMetadataApiAuthorization m => MonadMetadataApiAuthorization (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods authorizeV1QueryApi :: RQLQuery -> HandlerCtx -> Handler m (Either QErr ()) Source # authorizeV1MetadataApi :: RQLMetadata -> HandlerCtx -> Handler m (Either QErr ()) Source # authorizeV2QueryApi :: RQLQuery -> HandlerCtx -> Handler m (Either QErr ()) Source #
HasFeatureFlagChecker m => HasFeatureFlagChecker (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods checkFlag :: FeatureFlag -> Handler m Bool Source #
HasResourceLimits m => HasResourceLimits (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods askHTTPHandlerLimit :: Handler m ResourceLimits Source # askGraphqlOperationLimit :: RequestId -> UserInfo -> ApiLimit -> Handler m ResourceLimits Source #
MonadGetPolicies m => MonadGetPolicies (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods runGetApiTimeLimit :: Handler m (Maybe MaxTime) Source # runGetPrometheusMetricsGranularity :: Handler m (IO GranularPrometheusMetricsState) Source #
ProvidesNetwork m => ProvidesNetwork (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods askHTTPManager :: Handler m Manager Source #
MonadTrace m => MonadTrace (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods newTraceWith :: TraceContext -> SamplingPolicy -> Text -> Handler m a -> Handler m a Source # newSpanWith :: SpanId -> Text -> Handler m a -> Handler m a Source # currentContext :: Handler m (Maybe TraceContext) Source # attachMetadata :: TraceMetadata -> Handler m () Source #
type StM (Handler m) a Source #
Instance details Defined in Hasura.Server.App type StM (Handler m) a = StM (ReaderT HandlerCtx (ExceptT QErr m)) a

data APIResp Source #

Constructors

JSONResp !(HttpResponse EncJSON)
RawResp !(HttpResponse ByteString)

boolToText :: Bool -> Text Source #

isAdminSecretSet :: AuthMode -> Text Source #

mkGetHandler :: Handler m (HttpLogGraphQLInfo, APIResp) -> APIHandler m () Source #

onlyAdmin :: (MonadError QErr m, MonadReader HandlerCtx m) => m () Source #

class Monad m => MonadMetadataApiAuthorization m where Source #

Typeclass representing the metadata API authorization effect

Methods

authorizeV1QueryApi :: RQLQuery -> HandlerCtx -> m (Either QErr ()) Source #

authorizeV1MetadataApi :: RQLMetadata -> HandlerCtx -> m (Either QErr ()) Source #

authorizeV2QueryApi :: RQLQuery -> HandlerCtx -> m (Either QErr ()) Source #

Instances

Instances details

MonadMetadataApiAuthorization AppM Source #
Instance details Defined in Hasura.App Methods authorizeV1QueryApi :: RQLQuery -> HandlerCtx -> AppM (Either QErr ()) Source # authorizeV1MetadataApi :: RQLMetadata -> HandlerCtx -> AppM (Either QErr ()) Source # authorizeV2QueryApi :: RQLQuery -> HandlerCtx -> AppM (Either QErr ()) Source #
MonadMetadataApiAuthorization m => MonadMetadataApiAuthorization (Handler m) Source #
Instance details Defined in Hasura.Server.App Methods authorizeV1QueryApi :: RQLQuery -> HandlerCtx -> Handler m (Either QErr ()) Source # authorizeV1MetadataApi :: RQLMetadata -> HandlerCtx -> Handler m (Either QErr ()) Source # authorizeV2QueryApi :: RQLQuery -> HandlerCtx -> Handler m (Either QErr ()) Source #
MonadMetadataApiAuthorization m => MonadMetadataApiAuthorization (TraceT m) Source #
Instance details Defined in Hasura.Server.App Methods authorizeV1QueryApi :: RQLQuery -> HandlerCtx -> TraceT m (Either QErr ()) Source # authorizeV1MetadataApi :: RQLMetadata -> HandlerCtx -> TraceT m (Either QErr ()) Source # authorizeV2QueryApi :: RQLQuery -> HandlerCtx -> TraceT m (Either QErr ()) Source #
MonadMetadataApiAuthorization m => MonadMetadataApiAuthorization (ExceptT e m) Source #
Instance details Defined in Hasura.Server.App Methods authorizeV1QueryApi :: RQLQuery -> HandlerCtx -> ExceptT e m (Either QErr ()) Source # authorizeV1MetadataApi :: RQLMetadata -> HandlerCtx -> ExceptT e m (Either QErr ()) Source # authorizeV2QueryApi :: RQLQuery -> HandlerCtx -> ExceptT e m (Either QErr ()) Source #
MonadMetadataApiAuthorization m => MonadMetadataApiAuthorization (ReaderT r m) Source #
Instance details Defined in Hasura.Server.App Methods authorizeV1QueryApi :: RQLQuery -> HandlerCtx -> ReaderT r m (Either QErr ()) Source # authorizeV1MetadataApi :: RQLMetadata -> HandlerCtx -> ReaderT r m (Either QErr ()) Source # authorizeV2QueryApi :: RQLQuery -> HandlerCtx -> ReaderT r m (Either QErr ()) Source #

class Monad m => MonadConfigApiHandler m where Source #

The config API (v1alpha1config) handler

Methods

runConfigApiHandler :: AppStateRef impl -> SpockCtxT () m () Source #

Instances

Instances details

MonadConfigApiHandler AppM Source #
Instance details Defined in Hasura.App Methods runConfigApiHandler :: AppStateRef impl -> SpockCtxT () AppM () Source #

mkSpockAction Source #

Arguments

:: forall m a impl. (MonadIO m, MonadBaseControl IO m, HasAppEnv m, FromJSON a, UserAuthentication m, HttpLog m, HasResourceLimits m, MonadTrace m)
=> AppStateRef impl
-> (Bool -> QErr -> Encoding)	`QErr` JSON encoder function
-> (QErr -> QErr)	`QErr` modifier
-> APIHandler m a
-> ActionT m ()

class Monad m => ConsoleRenderer m where Source #

Associated Types

type ConsoleType m :: Type Source #

Methods

renderConsole :: Text -> AuthMode -> TelemetryStatus -> Maybe Text -> Maybe Text -> ConsoleType m -> m (Either String Text) Source #

Instances

Instances details

ConsoleRenderer AppM Source #
Instance details Defined in Hasura.App Associated Types type ConsoleType AppM Source # Methods renderConsole :: Text -> AuthMode -> TelemetryStatus -> Maybe Text -> Maybe Text -> ConsoleType AppM -> AppM (Either String Text) Source #
ConsoleRenderer m => ConsoleRenderer (TraceT m) Source #
Instance details Defined in Hasura.Server.App Associated Types type ConsoleType (TraceT m) Source # Methods renderConsole :: Text -> AuthMode -> TelemetryStatus -> Maybe Text -> Maybe Text -> ConsoleType (TraceT m) -> TraceT m (Either String Text) Source #

data CEConsoleType Source #

Constructors

OSSConsole
ProLiteConsole

ceConsoleTypeIdentifier :: CEConsoleType -> String Source #

class Monad m => MonadVersionAPIWithExtraData m where Source #

Methods

getExtraDataForVersionAPI :: m [Pair] Source #

Instances

Instances details

MonadVersionAPIWithExtraData AppM Source #
Instance details Defined in Hasura.App Methods getExtraDataForVersionAPI :: AppM [Pair] Source #

renderHtmlTemplate :: Template -> Value -> Either String Text Source #

configApiGetHandler :: forall m impl. (MonadIO m, MonadBaseControl IO m, HasAppEnv m, UserAuthentication m, HttpLog m, HasResourceLimits m, MonadTrace m) => AppStateRef impl -> SpockCtxT () m () Source #

Default implementation of the MonadConfigApiHandler

data HasuraApp Source #

Constructors

HasuraApp !Application !AsyncActionSubscriptionState !(IO ())

mkWaiApp :: forall m impl. (MonadIO m, MonadFix m, MonadStateless IO m, Forall (Pure m), ConsoleRenderer m, MonadVersionAPIWithExtraData m, HttpLog m, HasAppEnv m, HasCacheStaticConfig m, HasFeatureFlagChecker m, UserAuthentication m, MonadMetadataApiAuthorization m, MonadGQLExecutionCheck m, MonadConfigApiHandler m, MonadQueryLog m, MonadExecutionLog m, MonadWSLog m, MonadTrace m, MonadExecuteQuery m, HasResourceLimits m, MonadMetadataStorage m, MonadResolveSource m, MonadQueryTags m, MonadEventLogCleanup m, ProvidesNetwork m, MonadGetPolicies m) => (AppStateRef impl -> SpockT m ()) -> AppStateRef impl -> ConsoleType m -> Store EmptyMetrics -> WSServerEnv impl -> m HasuraApp Source #

onlyWhenApiEnabled :: MonadIO m => (AppContext -> Bool) -> AppStateRef impl -> ActionCtxT ctx m b -> ActionCtxT ctx m b Source #