go-waku/waku/v2/service/common_service.go

package service

import (
	"context"
	"errors"
	"sync"
	"sync/atomic"
)

// this is common layout for all the services that require mutex protection and a guarantee that all running goroutines will be finished before stop finishes execution. This guarantee comes from waitGroup all one has to use CommonService.WaitGroup() in the goroutines that should finish by the end of stop function.
type CommonService struct {
	sync.RWMutex
	cancel  context.CancelFunc
	ctx     context.Context
	wg      sync.WaitGroup
	started atomic.Bool
}

func NewCommonService() *CommonService {
	return &CommonService{
		wg:      sync.WaitGroup{},
		RWMutex: sync.RWMutex{},
	}
}

// mutex protected start function
// creates internal context over provided context and runs fn safely
// fn is excerpt to be executed to start the protocol
func (sp *CommonService) Start(ctx context.Context, fn func() error) error {
	sp.Lock()
	defer sp.Unlock()
	if sp.started.Load() {
		return ErrAlreadyStarted
	}
	sp.started.Store(true)
	sp.ctx, sp.cancel = context.WithCancel(ctx)
	if err := fn(); err != nil {
		sp.started.Store(false)
		sp.cancel()
		return err
	}
	return nil
}

var ErrAlreadyStarted = errors.New("already started")
var ErrNotStarted = errors.New("not started")

// mutex protected stop function
func (sp *CommonService) Stop(fn func()) {
	sp.Lock()
	defer sp.Unlock()
	if !sp.started.Load() {
		return
	}
	sp.cancel()
	fn()
	sp.wg.Wait()
	sp.started.Store(false)
}

// This is not a mutex protected function, it is up to the caller to use it in a mutex protected context
func (sp *CommonService) ErrOnNotRunning() error {
	if !sp.started.Load() {
		return ErrNotStarted
	}
	return nil
}

func (sp *CommonService) Context() context.Context {
	return sp.ctx
}
func (sp *CommonService) WaitGroup() *sync.WaitGroup {
	return &sp.wg
}