Class BrokerProxy

A wrapper around rascal broker to be used by Mosaic services.

Hierarchy

  • BrokerProxy

Constructors

constructor

Properties

attachBrokerHandlers broker eventSigning? getPublication getSubscription isConnectedToBroker logger onBrokerBlocked onBrokerBusy onBrokerError onBrokerReady onBrokerUnblocked onBrokerVhostInitialized publications subscriptions instance

Methods

addMessageHandler bounce connect isConnected nuke publish publishCommand publishEvent purge shutdown subscribe unsubscribeAll create

Constructors

Private constructor

Properties

Private attachBrokerHandlers

attachBrokerHandlers: any

Private broker

broker: any

Private Optional eventSigning

eventSigning?: any

Private getPublication

getPublication: any

Private getSubscription

getSubscription: any

Private isConnectedToBroker

isConnectedToBroker: any

Private logger

logger: any

Private onBrokerBlocked

onBrokerBlocked: any

Private onBrokerBusy

onBrokerBusy: any

Private onBrokerError

onBrokerError: any

Private onBrokerReady

onBrokerReady: any

Private onBrokerUnblocked

onBrokerUnblocked: any

Private onBrokerVhostInitialized

onBrokerVhostInitialized: any

Private publications

publications: any

Private subscriptions

subscriptions: any

Private Static instance

instance: any

Methods

addMessageHandler

  • Attaches a MessageHandler to a subscriptions "On Message" event.

    Type Parameters

    • TContent

    Parameters

    • handler: MessageHandler<TContent>

      The message handler class to handle a specific message type

    • Optional middleware: OnMessageMiddleware<unknown>[]

      Apply middleware on receiving a message

    Returns Promise<SubscriberSessionAsPromised>

bounce

  • Disconnects and re-initializes the broker.

    Returns Promise<void>

connect

  • Allows to programmatically establish a connection to a vhost.

    Parameters

    • key: string

      vhost name

    Returns Promise<Connection>

isConnected

  • Returns a boolean indicating if the service is connected to the Broker.

    Returns boolean

nuke

  • Total teardown of vhost, subscriptions and queues. Can be used in unit tests in an "After All" function

    Returns Promise<void>

publish

  • Type Parameters

    • T

    Parameters

    • aggregateId: string

      The (database) ID of the aggregate type or use the const UNKNOWN_AGGREGATE_ID or MULTIPLE_AGGREGATE_IDS values.

    • type: {
          aggregateType: string;
          messageType: string;
      }

      The aggregate type and message type e.g. channel and ChannelPublishedEvent

      • aggregateType: string
      • messageType: string
    • payload: T

      message payload

    • Optional envelopeOverrides: MessageEnvelopeOverrides

      explicitly defined message envelope values, e.g. auth token or message context

    • Optional options: PublicationConfig

      explicitly defined message options, e.g. if additional header values should be passed

    Returns Promise<PublicationSession>

    Deprecated

    please use publishCommand or publishEvent instead.

    Publish a message with a defined routing key.

publishCommand

  • Publish a command message with a defined routing key.

    Type Parameters

    • T

    Parameters

    • aggregateId: string

      The (database) ID of the aggregate type or use the const UNKNOWN_AGGREGATE_ID or MULTIPLE_AGGREGATE_IDS values.

    • type: {
          aggregateType: string;
          messageType: string;
      }

      The aggregate type and message type e.g. image and EnsureImageExists

      • aggregateType: string
      • messageType: string
    • payload: T

      message payload

    • Optional envelopeOverrides: MessageEnvelopeOverrides

      explicitly defined message envelope values, e.g. auth token or message context

    • Optional commandConfig: PublicationConfig

      explicitly defined command configuration, e.g. if additional header values should be passed

    Returns Promise<PublicationSession>

publishEvent

  • Publish an event message with a defined routing key.

    Type Parameters

    • T

    Parameters

    • aggregateId: string

      The (database) ID of the aggregate type or use the const UNKNOWN_AGGREGATE_ID or MULTIPLE_AGGREGATE_IDS values.

    • type: {
          aggregateType: string;
          messageType: string;
      }

      The aggregate type and message type e.g. channel and ChannelPublishedEvent

      • aggregateType: string
      • messageType: string
    • payload: T

      message payload

    • Optional envelopeOverrides: MessageEnvelopeOverrides

      explicitly defined message envelope values, e.g. auth token or message context

    • Optional eventConfig: PublicationConfig

      explicitly defined event configuration, e.g. if additional header values should be passed

    Returns Promise<PublicationSession>

purge

  • Purges all messages from all queues of all vhosts. Can be used together with unsubscribeAll in unit tests in an "After Each" function

    Returns Promise<void>

shutdown

  • Shutdowns the broker, which cancels all subscriptions and waits for a sort amount of time for inflight messages to be acknowledged, before closing channels and disconnecting.

    Returns Promise<void>

subscribe

  • Wrapper for a default rascal subscribe method, allowing explicit subscription to a queue using a dedicated routing key. Consider using addMessageHandler to initialize a subscription and directly attach a message handled to be executed on message received event.

    Parameters

    • key: string
    • Optional overrides: SubscriptionConfig

    Returns Promise<SubscriberSessionAsPromised>

unsubscribeAll

  • Cancels all established subscription sessions. Can be used together with purge in unit tests in an "After Each" function

    Returns Promise<void>

Static create

  • Initializes a rascal broker instance using a rascal config and components

    Parameters

    • config: BrokerConfig
    • logger: Logger
    • Optional components: Record<string, unknown>
    • Optional signing: Required<Pick<ValueObject<{
          rmqChannelMax: (() => number);
          rmqDevMiddleware: (() => boolean);
          rmqEventSigningKeyVersion: (() => number);
          rmqEventSigningPrivateKey: (() => string);
          rmqEventSigningPublicKey: (() => string);
          rmqHost: (() => string);
          rmqMgmtHost: (() => undefined | string);
          rmqMgmtPort: (() => undefined | number);
          rmqMgmtProtocol: (() => undefined | string);
          rmqPassword: (() => string);
          rmqPort: (() => number);
          rmqProtocol: (() => string);
          rmqUser: (() => string);
          rmqVHost: (() => string);
          rmqVHostAssert: (() => boolean);
      }>, "rmqEventSigningPrivateKey" | "rmqEventSigningKeyVersion">>

    Returns Promise<BrokerProxy>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc