Safe Haskell	None
Language	Haskell2010

Hasura.GraphQL.Transport.WebSocket.Server

Synopsis

newtype WSId = WSId {
- unWSId :: UUID
}
mkUnsafeWSId :: UUID -> WSId
data MessageDetails = MessageDetails {
- _mdMessage :: !SerializableBlob
- _mdMessageSize :: !Int64
}
data WSEvent
- = EConnectionRequest
- | EAccepted
- | ERejected
- | EMessageReceived !MessageDetails
- | EMessageSent !MessageDetails
- | EJwtExpired
- | ECloseReceived
- | ECloseSent !SerializableBlob
- | EClosed
data WSEventInfo = WSEventInfo {
- _wseiEventType :: !(Maybe ServerMsgType)
- _wseiOperationId :: !(Maybe OperationId)
- _wseiOperationName :: !(Maybe OperationName)
- _wseiQueryExecutionTime :: !(Maybe Double)
- _wseiResponseSize :: !(Maybe Int64)
- _wseiParameterizedQueryHash :: !(Maybe ParameterizedQueryHash)
}
data WSLog = WSLog {
- _wslWebsocketId :: !WSId
- _wslEvent :: !WSEvent
- _wslMetadata :: !(Maybe WSEventInfo)
}
class Monad m => MonadWSLog m where
- logWSLog :: Logger Hasura -> WSLog -> m ()
data WSQueueResponse = WSQueueResponse {
- _wsqrMessage :: !ByteString
- _wsqrEventInfo :: !(Maybe WSEventInfo)
}
data WSConn a = WSConn {
- _wcConnId :: !WSId
- _wcLogger :: !(Logger Hasura)
- _wcConnRaw :: !Connection
- _wcSendQ :: !(TQueue WSQueueResponse)
- _wcExtraData :: !a
}
getRawWebSocketConnection :: WSConn a -> Connection
getData :: WSConn a -> a
getWSId :: WSConn a -> WSId
closeConn :: WSConn a -> ByteString -> IO ()
forceConnReconnect :: MonadIO m => WSConn a -> ByteString -> m ()
closeConnWithCode :: WSConn a -> Word16 -> ByteString -> IO ()
sendMsg :: WSConn a -> WSQueueResponse -> IO ()
type ConnMap a = Map WSId (WSConn a)
data ServerStatus a
- = AcceptingConns !(ConnMap a)
- | ShuttingDown
data WSServer a = WSServer {
- _wssLogger :: !(Logger Hasura)
- _wssStatus :: !(TVar (ServerStatus a))
}
createWSServer :: Logger Hasura -> STM (WSServer a)
closeAllWith :: (ByteString -> WSConn a -> IO ()) -> ByteString -> [(WSId, WSConn a)] -> IO ()
flushConnMap :: TVar (ServerStatus a) -> STM [(WSId, WSConn a)]
data AcceptWith a = AcceptWith {
- _awData :: !a
- _awReq :: !AcceptRequest
- _awKeepAlive :: !(WSConn a -> IO ())
- _awOnJwtExpiry :: !(WSConn a -> IO ())
}
type WSKeepAliveMessageAction a = WSConn a -> IO ()
type WSPostExecErrMessageAction a = WSConn a -> OperationId -> GQExecError -> IO ()
type WSOnErrorMessageAction a = WSConn a -> ConnErrMsg -> Maybe String -> IO ()
type WSCloseConnAction a = WSConn a -> OperationId -> String -> IO ()
data WSActions a = WSActions {
- _wsaPostExecErrMessageAction :: !(WSPostExecErrMessageAction a)
- _wsaOnErrorMessageAction :: !(WSOnErrorMessageAction a)
- _wsaConnectionCloseAction :: !(WSCloseConnAction a)
- _wsaKeepAliveAction :: !(WSKeepAliveMessageAction a)
- _wsaGetDataMessageType :: !(DataMsg -> ServerMsg)
- _wsaAcceptRequest :: !AcceptRequest
- _wsaErrorMsgFormat :: !([Value] -> Value)
}
onClientMessageParseErrorText :: Maybe String
onConnInitErrorText :: Maybe String
type OnConnH m a = WSId -> RequestHead -> IpAddress -> WSActions a -> m (Either RejectRequest (AcceptWith a))
type OnCloseH m a = WSConn a -> m ()
type HasuraServerApp m = IpAddress -> PendingConnection -> m ()
data WSHandlers m a = WSHandlers {
- _hOnConn :: WSId -> RequestHead -> IpAddress -> WSSubProtocol -> m (Either RejectRequest (AcceptWith a))
- _hOnMessage :: WSConn a -> ByteString -> WSSubProtocol -> m ()
- _hOnClose :: OnCloseH m a
}
createServerApp :: (MonadIO m, MonadBaseControl IO m, Forall (Pure m), MonadWSLog m) => WSConnectionInitTimeout -> WSServer a -> WSHandlers m a -> HasuraServerApp m
shutdown :: WSServer a -> IO ()

Documentation

newtype WSId Source #

Constructors

WSId
Fields unWSId :: UUID

Instances

Instances details

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

mkUnsafeWSId :: UUID -> WSId Source #

data MessageDetails Source #

Websocket message and other details

Constructors

MessageDetails
Fields _mdMessage :: !SerializableBlob _mdMessageSize :: !Int64

Instances

Instances details

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

data WSEvent Source #

Constructors

EConnectionRequest
EAccepted
ERejected
EMessageReceived !MessageDetails
EMessageSent !MessageDetails
EJwtExpired
ECloseReceived
ECloseSent !SerializableBlob
EClosed

Instances

Instances details

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

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

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

data WSLog Source #

Constructors

WSLog
Fields _wslWebsocketId :: !WSId _wslEvent :: !WSEvent _wslMetadata :: !(Maybe WSEventInfo)

Instances

Instances details

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

MonadIO m => MonadWSLog (PGMetadataStorageAppT m) Source #
Instance details Defined in Hasura.App Methods logWSLog :: Logger Hasura -> WSLog -> PGMetadataStorageAppT m () 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
Fields _wsqrMessage :: !ByteString _wsqrEventInfo :: !(Maybe WSEventInfo) extra metadata that we use for other actions, such as print log we don't want to inlcude them into websocket message payload

data WSConn a Source #

Constructors

WSConn
Fields _wcConnId :: !WSId _wcLogger :: !(Logger Hasura) _wcConnRaw :: !Connection _wcSendQ :: !(TQueue WSQueueResponse) _wcExtraData :: !a

getRawWebSocketConnection :: WSConn a -> Connection Source #

getData :: WSConn a -> a Source #

getWSId :: WSConn a -> WSId Source #

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

forceConnReconnect :: MonadIO m => WSConn a -> ByteString -> m () Source #

Closes a connection with code 1012, which means "Server is restarting" good clients will implement a retry logic with a backoff of a few seconds

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

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

type ConnMap a = Map WSId (WSConn a) Source #

data ServerStatus a Source #

Constructors

AcceptingConns !(ConnMap a)
ShuttingDown

data WSServer a Source #

Constructors

WSServer
Fields _wssLogger :: !(Logger Hasura) _wssStatus :: !(TVar (ServerStatus a)) See e.g. createServerApp.onAccept for how we use STM to preserve consistency

createWSServer :: Logger Hasura -> STM (WSServer a) Source #

closeAllWith :: (ByteString -> WSConn a -> IO ()) -> ByteString -> [(WSId, WSConn a)] -> IO () Source #

flushConnMap :: TVar (ServerStatus a) -> STM [(WSId, WSConn a)] Source #

Resets the current connections map to an empty one if the server is running and returns the list of connections that were in the map before flushing it.

data AcceptWith a Source #

Constructors

AcceptWith
Fields _awData :: !a _awReq :: !AcceptRequest _awKeepAlive :: !(WSConn a -> IO ()) _awOnJwtExpiry :: !(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 WSPostExecErrMessageAction a = WSConn a -> OperationId -> GQExecError -> IO () Source #

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

type WSCloseConnAction a = WSConn a -> OperationId -> String -> 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 :: !([Value] -> Value)

onClientMessageParseErrorText :: Maybe String Source #

to be used with WSOnErrorMessageAction

onConnInitErrorText :: Maybe String Source #

to be used with WSOnErrorMessageAction

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

type OnCloseH m a = WSConn a -> m () 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
Fields _hOnConn :: WSId -> RequestHead -> IpAddress -> WSSubProtocol -> m (Either RejectRequest (AcceptWith a)) _hOnMessage :: WSConn a -> ByteString -> WSSubProtocol -> m () _hOnClose :: OnCloseH m a

createServerApp Source #

Arguments

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

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