7e385fc126
Some checks failed
SonarQube / SonarQube (push) Failing after 5m28s
E2e test on main branch push / server and client test (map[name:admin port:8080]) (push) Failing after 3m33s
Server and lib tests / Library test (js) (push) Failing after 1m36s
Server and lib tests / Library test (vue) (push) Successful in 2m24s
Server and lib tests / Web client test (admin) (push) Successful in 2m52s
Server and lib tests / Web client test (compose) (push) Successful in 3m23s
Server and lib tests / Web client test (discovery) (push) Successful in 2m49s
Server and lib tests / Web client test (one) (push) Successful in 2m52s
Server and lib tests / Web client test (privacy) (push) Successful in 2m44s
Server and lib tests / Web client test (reporter) (push) Successful in 2m56s
Server and lib tests / Web client test (workflow) (push) Successful in 3m0s
Server and lib tests / Server tests (push) Failing after 4m55s
E2e test on main branch push / notify-failure (push) Failing after 9s
Server and lib tests / Send matrix testing notification (push) Successful in 2s
Mark stale issues and pull requests / stale (push) Successful in 40s
65 lines
1.8 KiB
Plaintext
65 lines
1.8 KiB
Plaintext
# pkg/eventbus
|
|
|
|
Package handles event dispatching and handler registration
|
|
|
|
## Event
|
|
|
|
Event (in context of eventbus package) contains of resource type, event type and a matcher.
|
|
|
|
### Resource type
|
|
|
|
Resource types are identifiers of internal resources, like user, role, request, ...
|
|
|
|
### Event type
|
|
|
|
Type describes direct or indirect user action or some other event in the system.
|
|
|
|
#### Deferred events
|
|
|
|
Deferred events (onTimestamp and onInterval) are executed by scheduler package service.
|
|
|
|
#### Manual events
|
|
|
|
Manual events (onManual) are a special case.
|
|
These events are not (nor should be) dispatched directly or through event-bus.
|
|
|
|
We use it to route requests and pack attributes from the API to the Corredor service
|
|
|
|
### Event matcher
|
|
|
|
Matcher is a function on event that helps filtering fired events.
|
|
It decides (returns true or false) if fired event is a match for any of a registered handlers
|
|
|
|
Bus has basic internal filtering for resource & event type.
|
|
Other constraints are passed to event's matcher function.
|
|
|
|
.Matcher will receive 2+ string parameters:
|
|
- name
|
|
- operator
|
|
- zero or more values
|
|
|
|
It's matcher responsibility to handle contents of name, operator and values parameters.
|
|
|
|
Constraint checker procedure will call matcher for each constraint.
|
|
All constraints must match.
|
|
First non-match will break constraint checking procedure.
|
|
|
|
|
|
## Handler
|
|
|
|
Handler is combination of (event matching) rules/constraints and handler callback function.
|
|
Function is called when a event compatible with registered rules & constraints is fired.
|
|
|
|
Handler can respond to multiple resource/event combinations.
|
|
|
|
### Constraints
|
|
|
|
Matcher function is called multiple times, once per each handler constraint.
|
|
If any of the calls result in a non-match, check
|
|
|
|
Handler without any constraints is considered a match.
|
|
|
|
### Weight
|
|
|
|
Weight controls order of execution.
|