chore(portforward): improve loop reliability
- handle settings update within run function - signal back start result to update call - update loop settings only when service is started
This commit is contained in:
@@ -27,8 +27,9 @@ type Loop struct {
|
|||||||
// when performing an update
|
// when performing an update
|
||||||
runCtx context.Context //nolint:containedctx
|
runCtx context.Context //nolint:containedctx
|
||||||
runCancel context.CancelFunc
|
runCancel context.CancelFunc
|
||||||
updatedSignal chan<- struct{}
|
|
||||||
runDone <-chan struct{}
|
runDone <-chan struct{}
|
||||||
|
updateTrigger chan<- service.Settings
|
||||||
|
updatedResult <-chan error
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewLoop(settings settings.PortForwarding, routing Routing,
|
func NewLoop(settings settings.PortForwarding, routing Routing,
|
||||||
@@ -52,26 +53,39 @@ func (l *Loop) Start(_ context.Context) (runError <-chan error, _ error) {
|
|||||||
runDone := make(chan struct{})
|
runDone := make(chan struct{})
|
||||||
l.runDone = runDone
|
l.runDone = runDone
|
||||||
|
|
||||||
updatedSignal := make(chan struct{})
|
updateTrigger := make(chan service.Settings)
|
||||||
l.updatedSignal = updatedSignal
|
l.updateTrigger = updateTrigger
|
||||||
|
updateResult := make(chan error)
|
||||||
|
l.updatedResult = updateResult
|
||||||
runErrorCh := make(chan error)
|
runErrorCh := make(chan error)
|
||||||
|
|
||||||
go l.run(l.runCtx, runDone, runErrorCh, updatedSignal)
|
go l.run(l.runCtx, runDone, runErrorCh,
|
||||||
|
l.settings, updateTrigger, updateResult)
|
||||||
|
|
||||||
return runErrorCh, nil
|
return runErrorCh, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *Loop) run(runCtx context.Context, runDone chan<- struct{},
|
func (l *Loop) run(runCtx context.Context, runDone chan<- struct{},
|
||||||
runErrorCh chan<- error, updatedSignal <-chan struct{}) {
|
runErrorCh chan<- error, initialSettings service.Settings,
|
||||||
|
updateTrigger <-chan service.Settings, updateResult chan<- error) {
|
||||||
defer close(runDone)
|
defer close(runDone)
|
||||||
|
|
||||||
|
settings := initialSettings
|
||||||
var serviceRunError <-chan error
|
var serviceRunError <-chan error
|
||||||
for {
|
for {
|
||||||
|
updateReceived := false
|
||||||
select {
|
select {
|
||||||
case <-runCtx.Done():
|
case <-runCtx.Done():
|
||||||
// Stop call takes care of stopping the service
|
// Stop call takes care of stopping the service
|
||||||
return
|
return
|
||||||
case <-updatedSignal: // first and subsequent start trigger
|
case partialUpdate := <-updateTrigger:
|
||||||
|
updatedSettings, err := settings.UpdateWith(partialUpdate)
|
||||||
|
if err != nil {
|
||||||
|
updateResult <- err
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
settings = updatedSettings
|
||||||
|
updateReceived = true
|
||||||
case err := <-serviceRunError:
|
case err := <-serviceRunError:
|
||||||
l.logger.Error(err.Error())
|
l.logger.Error(err.Error())
|
||||||
}
|
}
|
||||||
@@ -85,37 +99,40 @@ func (l *Loop) run(runCtx context.Context, runDone chan<- struct{},
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
l.settingsMutex.RLock()
|
l.service = service.New(settings, l.routing, l.client,
|
||||||
l.service = service.New(l.settings, l.routing, l.client,
|
|
||||||
l.portAllower, l.logger, l.uid, l.gid)
|
l.portAllower, l.logger, l.uid, l.gid)
|
||||||
l.settingsMutex.RUnlock()
|
|
||||||
|
|
||||||
var err error
|
var err error
|
||||||
serviceRunError, err = l.service.Start(runCtx)
|
serviceRunError, err = l.service.Start(runCtx)
|
||||||
|
if updateReceived {
|
||||||
|
// Signal to the Update call that the service has started
|
||||||
|
// and if it failed to start.
|
||||||
|
updateResult <- err
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if runCtx.Err() == nil { // crashed but NOT stopped
|
if runCtx.Err() == nil { // crashed but NOT stopped
|
||||||
runErrorCh <- fmt.Errorf("starting new service: %w", err)
|
runErrorCh <- fmt.Errorf("starting new service: %w", err)
|
||||||
}
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Service is created and started successfully, so update
|
||||||
|
// the settings for external calls such as GetSettings.
|
||||||
|
l.settingsMutex.Lock()
|
||||||
|
l.settings = settings
|
||||||
|
l.settingsMutex.Unlock()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *Loop) UpdateWith(partialUpdate service.Settings) (err error) {
|
func (l *Loop) UpdateWith(partialUpdate service.Settings) (err error) {
|
||||||
l.settingsMutex.Lock()
|
|
||||||
l.settings, err = l.settings.UpdateWith(partialUpdate)
|
|
||||||
l.settingsMutex.Unlock()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
select {
|
||||||
case l.updatedSignal <- struct{}{}:
|
case l.updateTrigger <- partialUpdate:
|
||||||
// Settings are validated and if the service fails to start
|
select {
|
||||||
// or crashes at runtime, the loop will stop and signal its
|
case err = <-l.updatedResult:
|
||||||
// parent goroutine. Settings validation should be the only
|
return err
|
||||||
// error feedback for the caller of `Update`.
|
case <-l.runCtx.Done():
|
||||||
return nil
|
return l.runCtx.Err()
|
||||||
|
}
|
||||||
case <-l.runCtx.Done():
|
case <-l.runCtx.Done():
|
||||||
// loop has been stopped, no update can be done
|
// loop has been stopped, no update can be done
|
||||||
return l.runCtx.Err()
|
return l.runCtx.Err()
|
||||||
|
|||||||
Reference in New Issue
Block a user