Restructure modules (#1572)
* Move portbase into monorepo * Add new simple module mgr * [WIP] Switch to new simple module mgr * Add StateMgr and more worker variants * [WIP] Switch more modules * [WIP] Switch more modules * [WIP] swtich more modules * [WIP] switch all SPN modules * [WIP] switch all service modules * [WIP] Convert all workers to the new module system * [WIP] add new task system to module manager * [WIP] Add second take for scheduling workers * [WIP] Add FIXME for bugs in new scheduler * [WIP] Add minor improvements to scheduler * [WIP] Add new worker scheduler * [WIP] Fix more bug related to new module system * [WIP] Fix start handing of the new module system * [WIP] Improve startup process * [WIP] Fix minor issues * [WIP] Fix missing subsystem in settings * [WIP] Initialize managers in constructor * [WIP] Move module event initialization to constrictors * [WIP] Fix setting for enabling and disabling the SPN module * [WIP] Move API registeration into module construction * [WIP] Update states mgr for all modules * [WIP] Add CmdLine operation support * Add state helper methods to module group and instance * Add notification and module status handling to status package * Fix starting issues * Remove pilot widget and update security lock to new status data * Remove debug logs * Improve http server shutdown * Add workaround for cleanly shutting down firewall+netquery * Improve logging * Add syncing states with notifications for new module system * Improve starting, stopping, shutdown; resolve FIXMEs/TODOs * [WIP] Fix most unit tests * Review new module system and fix minor issues * Push shutdown and restart events again via API * Set sleep mode via interface * Update example/template module * [WIP] Fix spn/cabin unit test * Remove deprecated UI elements * Make log output more similar for the logging transition phase * Switch spn hub and observer cmds to new module system * Fix log sources * Make worker mgr less error prone * Fix tests and minor issues * Fix observation hub * Improve shutdown and restart handling * Split up big connection.go source file * Move varint and dsd packages to structures repo * Improve expansion test * Fix linter warnings * Fix interception module on windows * Fix linter errors --------- Co-authored-by: Vladimir Stoilov <vladimir@safing.io>
This commit is contained in:
Daniel Hååvi
175
service/mgr/events.go
Normal file
175
service/mgr/events.go
Normal file
@@ -0,0 +1,175 @@
|
||||
//nolint:structcheck,golint // TODO: Seems broken for generics.
|
||||
package mgr
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"slices"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
)
|
||||
|
||||
// EventMgr is a simple event manager.
|
||||
type EventMgr[T any] struct {
|
||||
name string
|
||||
mgr *Manager
|
||||
lock sync.Mutex
|
||||
|
||||
subs []*EventSubscription[T]
|
||||
callbacks []*EventCallback[T]
|
||||
}
|
||||
|
||||
// EventSubscription is a subscription to an event.
|
||||
type EventSubscription[T any] struct {
|
||||
name string
|
||||
events chan T
|
||||
canceled atomic.Bool
|
||||
}
|
||||
|
||||
// EventCallback is a registered callback to an event.
|
||||
type EventCallback[T any] struct {
|
||||
name string
|
||||
callback EventCallbackFunc[T]
|
||||
canceled atomic.Bool
|
||||
}
|
||||
|
||||
// EventCallbackFunc defines the event callback function.
|
||||
type EventCallbackFunc[T any] func(*WorkerCtx, T) (cancel bool, err error)
|
||||
|
||||
// NewEventMgr returns a new event manager.
|
||||
// It is easiest used as a public field on a struct,
|
||||
// so that others can simply Subscribe() oder AddCallback().
|
||||
func NewEventMgr[T any](eventName string, mgr *Manager) *EventMgr[T] {
|
||||
return &EventMgr[T]{
|
||||
name: eventName,
|
||||
mgr: mgr,
|
||||
}
|
||||
}
|
||||
|
||||
// Subscribe subscribes to events.
|
||||
// The received events are shared among all subscribers and callbacks.
|
||||
// Be sure to apply proper concurrency safeguards, if applicable.
|
||||
func (em *EventMgr[T]) Subscribe(subscriberName string, chanSize int) *EventSubscription[T] {
|
||||
em.lock.Lock()
|
||||
defer em.lock.Unlock()
|
||||
|
||||
es := &EventSubscription[T]{
|
||||
name: subscriberName,
|
||||
events: make(chan T, chanSize),
|
||||
}
|
||||
|
||||
em.subs = append(em.subs, es)
|
||||
return es
|
||||
}
|
||||
|
||||
// AddCallback adds a callback to executed on events.
|
||||
// The received events are shared among all subscribers and callbacks.
|
||||
// Be sure to apply proper concurrency safeguards, if applicable.
|
||||
func (em *EventMgr[T]) AddCallback(callbackName string, callback EventCallbackFunc[T]) {
|
||||
em.lock.Lock()
|
||||
defer em.lock.Unlock()
|
||||
|
||||
ec := &EventCallback[T]{
|
||||
name: callbackName,
|
||||
callback: callback,
|
||||
}
|
||||
|
||||
em.callbacks = append(em.callbacks, ec)
|
||||
}
|
||||
|
||||
// Submit submits a new event.
|
||||
func (em *EventMgr[T]) Submit(event T) {
|
||||
em.lock.Lock()
|
||||
defer em.lock.Unlock()
|
||||
|
||||
var anyCanceled bool
|
||||
|
||||
// Send to subscriptions.
|
||||
for _, sub := range em.subs {
|
||||
// Check if subscription was canceled.
|
||||
if sub.canceled.Load() {
|
||||
anyCanceled = true
|
||||
continue
|
||||
}
|
||||
|
||||
// Submit via channel.
|
||||
select {
|
||||
case sub.events <- event:
|
||||
default:
|
||||
if em.mgr != nil {
|
||||
em.mgr.Warn(
|
||||
"event subscription channel overflow",
|
||||
"event", em.name,
|
||||
"subscriber", sub.name,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Run callbacks.
|
||||
for _, ec := range em.callbacks {
|
||||
// Execute callback.
|
||||
var (
|
||||
cancel bool
|
||||
err error
|
||||
)
|
||||
if em.mgr != nil {
|
||||
// Prefer executing in worker.
|
||||
wkrErr := em.mgr.Do("execute event callback", func(w *WorkerCtx) error {
|
||||
cancel, err = ec.callback(w, event) //nolint:scopelint // Execution is within scope.
|
||||
return nil
|
||||
})
|
||||
if wkrErr != nil {
|
||||
err = fmt.Errorf("callback execution failed: %w", wkrErr)
|
||||
}
|
||||
} else {
|
||||
cancel, err = ec.callback(nil, event)
|
||||
}
|
||||
|
||||
// Handle error and cancelation.
|
||||
if err != nil && em.mgr != nil {
|
||||
em.mgr.Warn(
|
||||
"event callback failed",
|
||||
"event", em.name,
|
||||
"callback", ec.name,
|
||||
"err", err,
|
||||
)
|
||||
}
|
||||
if cancel {
|
||||
ec.canceled.Store(true)
|
||||
anyCanceled = true
|
||||
}
|
||||
}
|
||||
|
||||
// If any canceled subscription/callback was seen, clean the slices.
|
||||
if anyCanceled {
|
||||
em.clean()
|
||||
}
|
||||
}
|
||||
|
||||
// clean removes all canceled subscriptions and callbacks.
|
||||
func (em *EventMgr[T]) clean() {
|
||||
em.subs = slices.DeleteFunc[[]*EventSubscription[T], *EventSubscription[T]](em.subs, func(es *EventSubscription[T]) bool {
|
||||
return es.canceled.Load()
|
||||
})
|
||||
em.callbacks = slices.DeleteFunc[[]*EventCallback[T], *EventCallback[T]](em.callbacks, func(ec *EventCallback[T]) bool {
|
||||
return ec.canceled.Load()
|
||||
})
|
||||
}
|
||||
|
||||
// Events returns a read channel for the events.
|
||||
// The received events are shared among all subscribers and callbacks.
|
||||
// Be sure to apply proper concurrency safeguards, if applicable.
|
||||
func (es *EventSubscription[T]) Events() <-chan T {
|
||||
return es.events
|
||||
}
|
||||
|
||||
// Cancel cancels the subscription.
|
||||
// The events channel is not closed, but will not receive new events.
|
||||
func (es *EventSubscription[T]) Cancel() {
|
||||
es.canceled.Store(true)
|
||||
}
|
||||
|
||||
// Done returns whether the event subscription has been canceled.
|
||||
func (es *EventSubscription[T]) Done() bool {
|
||||
return es.canceled.Load()
|
||||
}
|
||||
Reference in New Issue
Block a user