Safe Haskell	Safe-Inferred
Language	Haskell2010

Hasura.GraphQL.Transport.WebSocket.Server

Synopsis

data WSId
mkUnsafeWSId :: UUID -> WSId
data MessageDetails = MessageDetails !SerializableBlob !Int64
data WSEvent = EMessageSent !MessageDetails
data WSEventInfo = WSEventInfo {
- _wseiEventType :: !(Maybe ServerMsgType)
- _wseiOperationId :: !(Maybe OperationId)
- _wseiOperationName :: !(Maybe OperationName)
- _wseiQueryExecutionTime :: !(Maybe Double)
- _wseiResponseSize :: !(Maybe Int64)
- _wseiParameterizedQueryHash :: !(Maybe ParameterizedQueryHash)
}
data WSLog = WSLog !WSId !WSEvent !(Maybe WSEventInfo)
class Monad m => MonadWSLog m where
- logWSLog :: Logger Hasura -> WSLog -> m ()
data WSQueueResponse = WSQueueResponse ByteString (Maybe WSEventInfo) (IO DiffTime)
data WSConn a
getRawWebSocketConnection :: WSConn a -> Connection
getData :: WSConn a -> a
getWSId :: WSConn a -> WSId
closeConn :: WSConn a -> ByteString -> IO ()
sendMsgAndCloseConn :: WSConn a -> Word16 -> ByteString -> ServerMsg -> IO ()
sendMsg :: WSConn a -> WSQueueResponse -> IO ()
data WSServer a = WSServer {
- _wssLogger :: Logger Hasura
- _wssSecuritySensitiveUserConfig :: TVar SecuritySensitiveUserConfig
- _wssStatus :: TVar (ServerStatus a)
}
createWSServer :: AuthMode -> AllowListStatus -> InlinedAllowlist -> CorsPolicy -> SQLGenCtx -> HashSet ExperimentalFeature -> NamingCase -> Logger Hasura -> STM (WSServer a)
closeAllConnectionsWithReason :: WSServer a -> String -> ByteString -> (SecuritySensitiveUserConfig -> SecuritySensitiveUserConfig) -> IO ()
data AcceptWith a = AcceptWith !a !AcceptRequest !(WSConn a -> IO ()) !(WSConn a -> IO ())
type WSKeepAliveMessageAction a = WSConn a -> IO ()
type WSOnErrorMessageAction a = WSConn a -> ConnErrMsg -> WSErrorMessage -> IO ()
data WSActions a = WSActions {
- _wsaPostExecErrMessageAction :: !(WSPostExecErrMessageAction a)
- _wsaOnErrorMessageAction :: !(WSOnErrorMessageAction a)
- _wsaConnectionCloseAction :: !(WSCloseConnAction a)
- _wsaKeepAliveAction :: !(WSKeepAliveMessageAction a)
- _wsaGetDataMessageType :: !(DataMsg -> ServerMsg)
- _wsaAcceptRequest :: !AcceptRequest
- _wsaErrorMsgFormat :: !([Encoding] -> Encoding)
}
data WSErrorMessage
- = ClientMessageParseFailed
- | ConnInitFailed
mkWSServerErrorCode :: WSSubProtocol -> WSErrorMessage -> ConnErrMsg -> ServerErrorCode
type OnConnH m a = WSId -> RequestHead -> IpAddress -> WSActions a -> m (Either RejectRequest (AcceptWith a))
type HasuraServerApp m = IpAddress -> PendingConnection -> m ()
data WSHandlers m a = WSHandlers (WSId -> RequestHead -> IpAddress -> WSSubProtocol -> m (Either RejectRequest (AcceptWith a))) (WSConn a -> ByteString -> WSSubProtocol -> m ()) (OnCloseH m a)
websocketConnectionReaper :: IO (AuthMode, AllowListStatus, CorsPolicy, SQLGenCtx, HashSet ExperimentalFeature, NamingCase) -> IO SchemaCache -> WSServer a -> IO Void
createServerApp :: (MonadIO m, MonadBaseControl IO m, Forall (Pure m), MonadWSLog m) => IO MetricsConfig -> WSConnectionInitTimeout -> WSServer a -> PrometheusMetrics -> WSHandlers m a -> HasuraServerApp m
shutdown :: WSServer a -> IO ()

Documentation

data WSId Source #

Instances

Instances details

ToJSON WSId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods toJSON :: WSId -> Value Source # toEncoding :: WSId -> Encoding Source # toJSONList :: [WSId] -> Value Source # toEncodingList :: [WSId] -> Encoding Source #
Show WSId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods showsPrec :: Int -> WSId -> ShowS # show :: WSId -> String # showList :: [WSId] -> ShowS #
Eq WSId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods (==) :: WSId -> WSId -> Bool # (/=) :: WSId -> WSId -> Bool #
Hashable WSId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods hashWithSalt :: Int -> WSId -> Int Source # hash :: WSId -> Int Source #

mkUnsafeWSId :: UUID -> WSId Source #

data MessageDetails Source #

Websocket message and other details

Constructors

MessageDetails !SerializableBlob !Int64

Instances

Instances details

ToJSON MessageDetails Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods toJSON :: MessageDetails -> Value Source # toEncoding :: MessageDetails -> Encoding Source # toJSONList :: [MessageDetails] -> Value Source # toEncodingList :: [MessageDetails] -> Encoding Source #
Show MessageDetails Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods showsPrec :: Int -> MessageDetails -> ShowS # show :: MessageDetails -> String # showList :: [MessageDetails] -> ShowS #

data WSEvent Source #

Constructors

EMessageSent !MessageDetails

Instances

Instances details

ToJSON WSEvent Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods toJSON :: WSEvent -> Value Source # toEncoding :: WSEvent -> Encoding Source # toJSONList :: [WSEvent] -> Value Source # toEncodingList :: [WSEvent] -> Encoding Source #
Show WSEvent Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods showsPrec :: Int -> WSEvent -> ShowS # show :: WSEvent -> String # showList :: [WSEvent] -> ShowS #

data WSEventInfo Source #

Constructors

WSEventInfo
Fields _wseiEventType :: !(Maybe ServerMsgType) _wseiOperationId :: !(Maybe OperationId) _wseiOperationName :: !(Maybe OperationName) _wseiQueryExecutionTime :: !(Maybe Double) _wseiResponseSize :: !(Maybe Int64) _wseiParameterizedQueryHash :: !(Maybe ParameterizedQueryHash)

Instances

Instances details

ToJSON WSEventInfo Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods toJSON :: WSEventInfo -> Value Source # toEncoding :: WSEventInfo -> Encoding Source # toJSONList :: [WSEventInfo] -> Value Source # toEncodingList :: [WSEventInfo] -> Encoding Source #
Show WSEventInfo Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods showsPrec :: Int -> WSEventInfo -> ShowS # show :: WSEventInfo -> String # showList :: [WSEventInfo] -> ShowS #
Eq WSEventInfo Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods (==) :: WSEventInfo -> WSEventInfo -> Bool # (/=) :: WSEventInfo -> WSEventInfo -> Bool #

data WSLog Source #

Constructors

WSLog !WSId !WSEvent !(Maybe WSEventInfo)

Instances

Instances details

ToJSON WSLog Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods toJSON :: WSLog -> Value Source # toEncoding :: WSLog -> Encoding Source # toJSONList :: [WSLog] -> Value Source # toEncodingList :: [WSLog] -> Encoding Source #
Show WSLog Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods showsPrec :: Int -> WSLog -> ShowS # show :: WSLog -> String # showList :: [WSLog] -> ShowS #
ToEngineLog WSLog Hasura Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods toEngineLog :: WSLog -> (LogLevel, EngineLogType Hasura, Value) Source #

class Monad m => MonadWSLog m where Source #

Methods

logWSLog :: Logger Hasura -> WSLog -> m () Source #

Takes WS server log data and logs it logWSServer

Instances

Instances details

MonadWSLog AppM Source #
Instance details Defined in Hasura.App Methods logWSLog :: Logger Hasura -> WSLog -> AppM () Source #
MonadWSLog m => MonadWSLog (ExceptT e m) Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods logWSLog :: Logger Hasura -> WSLog -> ExceptT e m () Source #
MonadWSLog m => MonadWSLog (ReaderT r m) Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Server Methods logWSLog :: Logger Hasura -> WSLog -> ReaderT r m () Source #

data WSQueueResponse Source #

Constructors

WSQueueResponse ByteString (Maybe WSEventInfo) (IO DiffTime)

data WSConn a Source #

getRawWebSocketConnection :: WSConn a -> Connection Source #

getData :: WSConn a -> a Source #

getWSId :: WSConn a -> WSId Source #

closeConn :: WSConn a -> ByteString -> IO () Source #

sendMsgAndCloseConn :: WSConn a -> Word16 -> ByteString -> ServerMsg -> IO () Source #

sendMsg :: WSConn a -> WSQueueResponse -> IO () Source #

data WSServer a Source #

Constructors

WSServer
Fields _wssLogger :: Logger Hasura _wssSecuritySensitiveUserConfig :: TVar SecuritySensitiveUserConfig Keep track of the security sensitive user configuration to perform maintenance actions _wssStatus :: TVar (ServerStatus a) See e.g. createServerApp.onAccept for how we use STM to preserve consistency

createWSServer :: AuthMode -> AllowListStatus -> InlinedAllowlist -> CorsPolicy -> SQLGenCtx -> HashSet ExperimentalFeature -> NamingCase -> Logger Hasura -> STM (WSServer a) Source #

closeAllConnectionsWithReason :: WSServer a -> String -> ByteString -> (SecuritySensitiveUserConfig -> SecuritySensitiveUserConfig) -> IO () Source #

data AcceptWith a Source #

Constructors

AcceptWith !a !AcceptRequest !(WSConn a -> IO ()) !(WSConn a -> IO ())

type WSKeepAliveMessageAction a = WSConn a -> IO () Source #

These set of functions or message handlers is used by the server while communicating with the client. They are particularly useful for the case when the messages being sent to the client are different for each of the sub-protocol(s) supported by the server.

type WSOnErrorMessageAction a = WSConn a -> ConnErrMsg -> WSErrorMessage -> IO () Source #

data WSActions a Source #

Used for specific actions within the onConn and onMessage handlers

Constructors

WSActions

Fields

_wsaPostExecErrMessageAction :: !(WSPostExecErrMessageAction a)
_wsaOnErrorMessageAction :: !(WSOnErrorMessageAction a)
_wsaConnectionCloseAction :: !(WSCloseConnAction a)
_wsaKeepAliveAction :: !(WSKeepAliveMessageAction a)
NOTE: keep alive action was made redundant because we need to send this message after the connection has been successfully established after connection_init
_wsaGetDataMessageType :: !(DataMsg -> ServerMsg)
_wsaAcceptRequest :: !AcceptRequest
_wsaErrorMsgFormat :: !([Encoding] -> Encoding)

data WSErrorMessage Source #

Constructors

ClientMessageParseFailed
ConnInitFailed

mkWSServerErrorCode :: WSSubProtocol -> WSErrorMessage -> ConnErrMsg -> ServerErrorCode Source #

type OnConnH m a = WSId -> RequestHead -> IpAddress -> WSActions a -> m (Either RejectRequest (AcceptWith a)) Source #

type HasuraServerApp m = IpAddress -> PendingConnection -> m () Source #

aka generalized ServerApp over m, which takes an IPAddress

data WSHandlers m a Source #

NOTE: The types of _hOnConn and _hOnMessage were updated from OnConnH and OnMessageH because we needed to pass the subprotcol here to these methods to eventually get to OnConnH and OnMessageH. Please see createServerApp to get a better understanding of how these handlers are used.

Constructors

WSHandlers (WSId -> RequestHead -> IpAddress -> WSSubProtocol -> m (Either RejectRequest (AcceptWith a))) (WSConn a -> ByteString -> WSSubProtocol -> m ()) (OnCloseH m a)

websocketConnectionReaper :: IO (AuthMode, AllowListStatus, CorsPolicy, SQLGenCtx, HashSet ExperimentalFeature, NamingCase) -> IO SchemaCache -> WSServer a -> IO Void Source #

The background thread responsible for closing all websocket connections when security sensitive user configuration changes. It checks for changes in the auth mode, allowlist, cors config, stringify num, dangerous boolean collapse, stringify big query numeric, experimental features and invalidates/closes all connections if there are any changes.

createServerApp Source #

Arguments

:: (MonadIO m, MonadBaseControl IO m, Forall (Pure m), MonadWSLog m)
=> IO MetricsConfig
-> WSConnectionInitTimeout
-> WSServer a
-> PrometheusMetrics
-> WSHandlers m a	user provided handlers
-> HasuraServerApp m	aka WS.ServerApp

shutdown :: WSServer a -> IO () Source #