Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Federation.BackendNotifications

Contents

Internal machinery

Synopsis

data BackendNotification = BackendNotification {
- ownDomain :: Domain
- targetComponent :: Component
- path :: Text
- body :: RawJson
- bodyVersions :: Maybe VersionRange
- requestId :: Maybe RequestId
}
fedNotifToBackendNotif :: forall {k} (tag :: k). (HasFedPath tag, HasVersionRange tag, KnownComponent (NotificationComponent k), ToJSON (Payload tag)) => RequestId -> Domain -> Payload tag -> BackendNotification
newtype PayloadBundle (c :: Component) = PayloadBundle {
- notifications :: NonEmpty BackendNotification
}
toBundle :: forall {k} (tag :: k). (HasFedPath tag, HasVersionRange tag, KnownComponent (NotificationComponent k), ToJSON (Payload tag)) => RequestId -> Domain -> Payload tag -> PayloadBundle (NotificationComponent k)
makeBundle :: forall {k} (tag :: k) c. (HasFedPath tag, HasVersionRange tag, KnownComponent (NotificationComponent k), ToJSON (Payload tag), c ~ NotificationComponent k) => Payload tag -> FedQueueClient c (PayloadBundle c)
type BackendNotificationAPI = Capture "name" Text :> (ReqBody '[JSON] RawJson :> Post '[JSON] EmptyResponse)
sendNotification :: FederatorClientVersionedEnv -> Component -> Text -> RawJson -> IO (Either FederatorClientError ())
enqueue :: Channel -> RequestId -> Domain -> Domain -> DeliveryMode -> FedQueueClient c a -> IO a
routingKey :: Text -> Text
type DefederationDomain = Domain
ensureQueue :: Channel -> Text -> IO ()
newtype FedQueueClient c a = FedQueueClient (ReaderT FedQueueEnv IO a)
data FedQueueEnv = FedQueueEnv {
- channel :: Channel
- originDomain :: Domain
- targetDomain :: Domain
- deliveryMode :: DeliveryMode
- requestId :: RequestId
}
data EnqueueError = EnqueueError String

Documentation

data BackendNotification Source #

NOTE: Stored in RabbitMQ, any changes to serialization of this object could cause notifications to get lost.

Constructors

BackendNotification

Fields

ownDomain :: Domain
targetComponent :: Component
path :: Text
body :: RawJson
Using RawJson here allows the backend notification pusher to not parse this body, which could be very large and completely useless to the pusher. This also makes development less clunky as we don't have to create a sum type here for all types of notifications that could exist.
bodyVersions :: Maybe VersionRange
The federation API versions that the $sel:body:BackendNotification corresponds to. The field is optional so that messages already in the queue are not lost.
requestId :: Maybe RequestId

Instances

Instances details

FromJSON BackendNotification Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods parseJSON :: Value -> Parser BackendNotification Source # parseJSONList :: Value -> Parser [BackendNotification] Source #
ToJSON BackendNotification Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods toJSON :: BackendNotification -> Value Source # toEncoding :: BackendNotification -> Encoding Source # toJSONList :: [BackendNotification] -> Value Source # toEncodingList :: [BackendNotification] -> Encoding Source #
Show BackendNotification Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods showsPrec :: Int -> BackendNotification -> ShowS # show :: BackendNotification -> String # showList :: [BackendNotification] -> ShowS #
Eq BackendNotification Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods (==) :: BackendNotification -> BackendNotification -> Bool # (/=) :: BackendNotification -> BackendNotification -> Bool #
ToSchema BackendNotification Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods schema :: ValueSchema NamedSwaggerDoc BackendNotification Source #

fedNotifToBackendNotif :: forall {k} (tag :: k). (HasFedPath tag, HasVersionRange tag, KnownComponent (NotificationComponent k), ToJSON (Payload tag)) => RequestId -> Domain -> Payload tag -> BackendNotification Source #

Convert a federation endpoint to a backend notification to be enqueued to a RabbitMQ queue.

newtype PayloadBundle (c :: Component) Source #

Constructors

PayloadBundle
Fields notifications :: NonEmpty BackendNotification

Instances

Instances details

FromJSON (PayloadBundle c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods parseJSON :: Value -> Parser (PayloadBundle c) Source # parseJSONList :: Value -> Parser [PayloadBundle c] Source #
ToJSON (PayloadBundle c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods toJSON :: PayloadBundle c -> Value Source # toEncoding :: PayloadBundle c -> Encoding Source # toJSONList :: [PayloadBundle c] -> Value Source # toEncodingList :: [PayloadBundle c] -> Encoding Source #
Semigroup (PayloadBundle c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods (<>) :: PayloadBundle c -> PayloadBundle c -> PayloadBundle c # sconcat :: NonEmpty (PayloadBundle c) -> PayloadBundle c # stimes :: Integral b => b -> PayloadBundle c -> PayloadBundle c #
ToSchema (PayloadBundle c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods schema :: ValueSchema NamedSwaggerDoc (PayloadBundle c) Source #

toBundle Source #

Arguments

:: forall {k} (tag :: k). (HasFedPath tag, HasVersionRange tag, KnownComponent (NotificationComponent k), ToJSON (Payload tag))
=> RequestId
-> Domain	The origin domain
-> Payload tag
-> PayloadBundle (NotificationComponent k)

makeBundle :: forall {k} (tag :: k) c. (HasFedPath tag, HasVersionRange tag, KnownComponent (NotificationComponent k), ToJSON (Payload tag), c ~ NotificationComponent k) => Payload tag -> FedQueueClient c (PayloadBundle c) Source #

type BackendNotificationAPI = Capture "name" Text :> (ReqBody '[JSON] RawJson :> Post '[JSON] EmptyResponse) Source #

sendNotification :: FederatorClientVersionedEnv -> Component -> Text -> RawJson -> IO (Either FederatorClientError ()) Source #

enqueue :: Channel -> RequestId -> Domain -> Domain -> DeliveryMode -> FedQueueClient c a -> IO a Source #

routingKey :: Text -> Text Source #

type DefederationDomain = Domain Source #

ensureQueue :: Channel -> Text -> IO () Source #

If you ever change this function and modify queue parameters, know that it will start failing in the next release! So be prepared to write migrations.

Internal machinery

newtype FedQueueClient c a Source #

Reads a servant request and puts the information in relevant RabbitMQ queue. Perhaps none of this should be servant code anymore. But it is here to allow smooth transition to RabbitMQ based notification pushing.

Use fedQueueClient to create an action and pass it to enqueue

Constructors

FedQueueClient (ReaderT FedQueueEnv IO a)

Instances

Instances details

MonadReader FedQueueEnv (FedQueueClient c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods ask :: FedQueueClient c FedQueueEnv # local :: (FedQueueEnv -> FedQueueEnv) -> FedQueueClient c a -> FedQueueClient c a # reader :: (FedQueueEnv -> a) -> FedQueueClient c a #
MonadIO (FedQueueClient c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods liftIO :: IO a -> FedQueueClient c a #
Applicative (FedQueueClient c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods pure :: a -> FedQueueClient c a # (<>) :: FedQueueClient c (a -> b) -> FedQueueClient c a -> FedQueueClient c b # liftA2 :: (a -> b -> c0) -> FedQueueClient c a -> FedQueueClient c b -> FedQueueClient c c0 # (>) :: FedQueueClient c a -> FedQueueClient c b -> FedQueueClient c b # (<*) :: FedQueueClient c a -> FedQueueClient c b -> FedQueueClient c a #
Functor (FedQueueClient c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods fmap :: (a -> b) -> FedQueueClient c a -> FedQueueClient c b # (<$) :: a -> FedQueueClient c b -> FedQueueClient c a #
Monad (FedQueueClient c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods (>>=) :: FedQueueClient c a -> (a -> FedQueueClient c b) -> FedQueueClient c b # (>>) :: FedQueueClient c a -> FedQueueClient c b -> FedQueueClient c b # return :: a -> FedQueueClient c a #

data FedQueueEnv Source #

Constructors

FedQueueEnv
Fields channel :: Channel originDomain :: Domain targetDomain :: Domain deliveryMode :: DeliveryMode requestId :: RequestId

Instances

Instances details

MonadReader FedQueueEnv (FedQueueClient c) Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods ask :: FedQueueClient c FedQueueEnv # local :: (FedQueueEnv -> FedQueueEnv) -> FedQueueClient c a -> FedQueueClient c a # reader :: (FedQueueEnv -> a) -> FedQueueClient c a #

data EnqueueError Source #

Constructors

EnqueueError String

Instances

Instances details

Exception EnqueueError Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods toException :: EnqueueError -> SomeException # fromException :: SomeException -> Maybe EnqueueError # displayException :: EnqueueError -> String #
Show EnqueueError Source #
Instance details Defined in Wire.API.Federation.BackendNotifications Methods showsPrec :: Int -> EnqueueError -> ShowS # show :: EnqueueError -> String # showList :: [EnqueueError] -> ShowS #