PURISTA API / @purista/base-http-bridge / HttpEventBridge
Class: HttpEventBridge<CustomConfig>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:66
The HTTP event bridge is a generic event bridge. In environments like Dapr or Knative, the communication is done via sidecar containers and via HTTP.
In these cases, it is expected, that the current instance is a HTTP server, which provides REST endpoints for commands and subscriptions. The communication from the current instance to the sidecar is also done via REST endpoints.
HTTP calls from the sidecar to the current instance might be done via CloudEvent schema, which wraps the payload into a defined structure. The HttpEventBridge can be configured to respect this, and to extract the information from CloudEvents.
To use the HttpEventBridge, you will need following peer-dependencies installed:
- hono
- trouter
Extends
EventBridgeBaseClass
<CustomConfig
>
Extended by
Type Parameters
CustomConfig
CustomConfig
extends HttpEventBridgeConfig
Implements
Constructors
Constructor
new HttpEventBridge<
CustomConfig
>(config
,client
):HttpEventBridge
<CustomConfig
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:77
Parameters
config
{ [K in string | number | symbol]: ({ defaultCommandTimeout?: number; instanceId?: string; logger?: Logger; logLevel?: LogLevelName; spanProcessor?: SpanProcessor } & CustomConfig)[K] }
client
Returns
HttpEventBridge
<CustomConfig
>
Overrides
EventBridgeBaseClass
.constructor
Properties
app
app:
Hono
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:71
client
client:
HttpEventBridgeClient
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:75
config
config:
Complete
<{ [K in string | number | symbol]: ({ defaultCommandTimeout?: number; instanceId?: string; logger?: Logger; logLevel?: LogLevelName; spanProcessor?: SpanProcessor } & CustomConfig)[K] }>
Defined in: core/dist/commonjs/core/EventBridge/EventBridgeBaseClass.impl.d.ts:17
Inherited from
defaultCommandTimeout
defaultCommandTimeout:
number
Defined in: core/dist/commonjs/core/EventBridge/EventBridgeBaseClass.impl.d.ts:20
The default time until when a command invocation automatically returns a time out error
Implementation of
EventBridge
.defaultCommandTimeout
Inherited from
EventBridgeBaseClass
.defaultCommandTimeout
instanceId
instanceId:
string
Defined in: core/dist/commonjs/core/EventBridge/EventBridgeBaseClass.impl.d.ts:19
Implementation of
Inherited from
EventBridgeBaseClass
.instanceId
isShuttingDown
isShuttingDown:
boolean
=false
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:72
isStarted
isStarted:
boolean
=false
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:73
logger
logger:
Logger
Defined in: core/dist/commonjs/core/EventBridge/EventBridgeBaseClass.impl.d.ts:15
Inherited from
name
name:
string
Defined in: core/dist/commonjs/core/EventBridge/EventBridgeBaseClass.impl.d.ts:18
Implementation of
Inherited from
server
server:
undefined
|Server
<typeofIncomingMessage
, typeofServerResponse
> |Http2Server
<typeofIncomingMessage
, typeofServerResponse
, typeofHttp2ServerRequest
, typeofHttp2ServerResponse
> |Http2SecureServer
<typeofIncomingMessage
, typeofServerResponse
, typeofHttp2ServerRequest
, typeofHttp2ServerResponse
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:70
traceProvider
traceProvider:
NodeTracerProvider
Defined in: core/dist/commonjs/core/EventBridge/EventBridgeBaseClass.impl.d.ts:16
Inherited from
EventBridgeBaseClass
.traceProvider
Methods
destroy()
destroy():
Promise
<void
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:356
Shut down event bridge as gracefully as possible
Returns
Promise
<void
>
Implementation of
Overrides
emit()
emit<
K
>(eventName
,parameter
?):void
Defined in: core/dist/commonjs/core/types/GenericEventEmitter.d.ts:13
Type Parameters
K
K
extends EventKey
<{ [key:
custom-${string}]
: unknown
; [key:
adapter-${string}]
: unknown
; eventbridge-connected
: never
; eventbridge-connection-error
: unknown
; eventbridge-disconnected
: never
; eventbridge-error
: unknown
; eventbridge-reconnecting
: never
; }>
Parameters
eventName
K
parameter?
object
[K
]
Returns
void
Inherited from
emitMessage()
emitMessage<
T
>(message
):Promise
<Readonly
<EBMessage
>>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:149
Emit a message to the eventbridge without awaiting a result
Type Parameters
T
T
extends EBMessage
Parameters
message
Omit
<EBMessage
, "id"
| "timestamp"
| "correlationId"
>
the message
Returns
Promise
<Readonly
<EBMessage
>>
Implementation of
getTracer()
getTracer():
Tracer
Defined in: core/dist/commonjs/core/EventBridge/EventBridgeBaseClass.impl.d.ts:27
Returns open telemetry tracer of this service
Returns
Tracer
Tracer
Inherited from
EventBridgeBaseClass
.getTracer
invoke()
invoke<
T
>(input
,ttl
?):Promise
<T
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:209
Call a command of a service and return the result of this command
Type Parameters
T
T
Parameters
input
Omit
<{ contentEncoding
: string
; contentType
: string
; correlationId
: string
; eventName
: string
; id
: string
; messageType
: Command
; otp
: string
; payload
: { parameter
: unknown
; payload
: unknown
; }; principalId
: string
; receiver
: EBMessageAddress
; sender
: { instanceId
: string
; serviceName
: string
; serviceTarget
: string
; serviceVersion
: string
; }; tenantId
: string
; timestamp
: number
; traceId
: string
; }, "id"
| "timestamp"
| "correlationId"
| "messageType"
>
a partial command message
ttl?
number
the time to live (timeout) of the invocation
Returns
Promise
<T
>
Implementation of
isHealthy()
isHealthy():
Promise
<boolean
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:346
Indicates if the eventbridge is running and works correctly
Returns
Promise
<boolean
>
Implementation of
isReady()
isReady():
Promise
<boolean
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:342
Indicates if the eventbridge has been started and is connected to underlaying message broker
Returns
Promise
<boolean
>
Implementation of
off()
off<
K
>(eventName
,fn
):void
Defined in: core/dist/commonjs/core/types/GenericEventEmitter.d.ts:12
Type Parameters
K
K
extends EventKey
<{ [key:
custom-${string}]
: unknown
; [key:
adapter-${string}]
: unknown
; eventbridge-connected
: never
; eventbridge-connection-error
: unknown
; eventbridge-disconnected
: never
; eventbridge-error
: unknown
; eventbridge-reconnecting
: never
; }>
Parameters
eventName
K
fn
EventReceiver
<object
[K
]>
Returns
void
Inherited from
on()
on<
K
>(eventName
,fn
):void
Defined in: core/dist/commonjs/core/types/GenericEventEmitter.d.ts:11
Type Parameters
K
K
extends EventKey
<{ [key:
custom-${string}]
: unknown
; [key:
adapter-${string}]
: unknown
; eventbridge-connected
: never
; eventbridge-connection-error
: unknown
; eventbridge-disconnected
: never
; eventbridge-error
: unknown
; eventbridge-reconnecting
: never
; }>
Parameters
eventName
K
fn
EventReceiver
<object
[K
]>
Returns
void
Inherited from
registerCommand()
registerCommand(
address
,cb
,metadata
,eventBridgeConfig
):Promise
<string
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:263
Parameters
address
the address of the service command (service name, version and command name)
cb
(message
) => Promise
<Readonly
<Omit
<{ contentEncoding
: string
; contentType
: string
; correlationId
: string
; eventName
: string
; id
: string
; messageType
: CommandSuccessResponse
; otp
: string
; payload
: unknown
; principalId
: string
; receiver
: { instanceId
: string
; serviceName
: string
; serviceTarget
: string
; serviceVersion
: string
; }; sender
: { instanceId
: string
; serviceName
: string
; serviceTarget
: string
; serviceVersion
: string
; }; tenantId
: string
; timestamp
: number
; traceId
: string
; }, "instanceId"
>> | Readonly
<Omit
<{ contentEncoding
: "utf-8"
; contentType
: "application/json"
; correlationId
: string
; eventName
: string
; id
: string
; isHandledError
: boolean
; messageType
: CommandErrorResponse
; otp
: string
; payload
: { data
: unknown
; message
: string
; status
: StatusCode
; }; principalId
: string
; receiver
: { instanceId
: string
; serviceName
: string
; serviceTarget
: string
; serviceVersion
: string
; }; sender
: { instanceId
: string
; serviceName
: string
; serviceTarget
: string
; serviceVersion
: string
; }; tenantId
: string
; timestamp
: number
; traceId
: string
; }, "instanceId"
>>>
the function to be called if a matching command arrives
metadata
expose
object
& object
eventBridgeConfig
Returns
Promise
<string
>
Implementation of
registerSubscription()
registerSubscription(
subscription
,cb
):Promise
<string
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:317
Register a new subscription
Parameters
subscription
the subscription definition
cb
(message
) => Promise
<undefined
| Omit
<{ contentEncoding
: string
; contentType
: string
; correlationId
: string
; eventName
: string
; id
: string
; messageType
: CustomMessage
; otp
: string
; payload
: unknown
; principalId
: string
; receiver
: EBMessageAddress
; sender
: { instanceId
: string
; serviceName
: string
; serviceTarget
: string
; serviceVersion
: string
; }; tenantId
: string
; timestamp
: number
; traceId
: string
; }, "id"
| "timestamp"
>>
the function to be called if a matching message arrives
Returns
Promise
<string
>
Implementation of
EventBridge
.registerSubscription
removeAllListeners()
removeAllListeners():
void
Defined in: core/dist/commonjs/core/types/GenericEventEmitter.d.ts:14
Returns
void
Inherited from
EventBridgeBaseClass
.removeAllListeners
start()
start():
Promise
<void
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:91
Start the eventbridge and connect to the underlaying message broker
Returns
Promise
<void
>
Implementation of
Overrides
startActiveSpan()
startActiveSpan<
F
>(name
,opts
,context
,fn
):Promise
<F
>
Defined in: core/dist/commonjs/core/EventBridge/EventBridgeBaseClass.impl.d.ts:36
Start a child span for opentelemetry tracking
Type Parameters
F
F
Parameters
name
string
name of span
opts
SpanOptions
span options
context
optional context
undefined
| Context
fn
(span
) => Promise
<F
>
function to be executed within the span
Returns
Promise
<F
>
return value of fn
Inherited from
EventBridgeBaseClass
.startActiveSpan
unregisterCommand()
unregisterCommand(
address
):Promise
<void
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:313
Unregister a service command
Parameters
address
The address (service name, version and command name) of the command to be de-registered
Returns
Promise
<void
>
Implementation of
unregisterSubscription()
unregisterSubscription(
address
):Promise
<void
>
Defined in: base-http-bridge/src/HttpEventBridge/HttpEventBridge.impl.ts:338
Parameters
address
Returns
Promise
<void
>
Implementation of
EventBridge
.unregisterSubscription
wrapInSpan()
wrapInSpan<
F
>(name
,opts
,fn
,context
?):Promise
<F
>
Defined in: core/dist/commonjs/core/EventBridge/EventBridgeBaseClass.impl.d.ts:52
Start span for opentelemetry tracking on same level. The created span will not become the "active" span within opentelemetry!
This means during logging and similar the spanId of parent span is logged.
Use wrapInSpan for marking points in flow of one bigger function, but not to trace the program flow itself
Type Parameters
F
F
Parameters
name
string
name of span
opts
SpanOptions
span options
fn
(span
) => Promise
<F
>
function te be executed in the span
context?
Context
span context
Returns
Promise
<F
>
return value of fn