6123fa40e8
* Checkpoint before the weekend * Update location for SetupPostgresDB * Include first functioning tests for processing head * Fix gitignore * Test CaptureHead | Add Metrics | Handle Test Race Conditions This Commit allows us to: * Test the `CaptureHead` function. * Test parsing a single Head message. * Test a Reorg condition. * Add Metrics. This is primarily used for testing but can have future use cases. * Rearrange the test due to race conditions introduced by reusing a variable. `BeforeEach` can't be used to update `BC`. * Update and finalize testing at this stage * Update code and CI/CD * Fix lint errors * Update CICD and fail when file not found. * Update test to have failed as expected.
72 lines
1.7 KiB
Go
72 lines
1.7 KiB
Go
package gracefulshutdown
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
"os/signal"
|
|
"sync"
|
|
"syscall"
|
|
"time"
|
|
|
|
log "github.com/sirupsen/logrus"
|
|
"github.com/vulcanize/ipld-ethcl-indexer/pkg/loghelper"
|
|
)
|
|
|
|
// operation is a clean up function on shutting down
|
|
type Operation func(ctx context.Context) error
|
|
|
|
var (
|
|
TimeoutErr = func(timeout string) error {
|
|
return fmt.Errorf("The Timeout %s, has been elapsed, the application will forcefully exit", timeout)
|
|
}
|
|
)
|
|
|
|
// gracefulShutdown waits for termination syscalls and doing clean up operations after received it
|
|
func Shutdown(ctx context.Context, notifierCh chan os.Signal, timeout time.Duration, ops map[string]Operation) (<-chan struct{}, <-chan error) {
|
|
waitCh := make(chan struct{})
|
|
errCh := make(chan error)
|
|
go func() {
|
|
|
|
// add any other syscalls that you want to be notified with
|
|
signal.Notify(notifierCh, syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP)
|
|
<-notifierCh
|
|
|
|
log.Info("Shutting Down your application")
|
|
|
|
// set timeout for the ops to be done to prevent system hang
|
|
timeoutFunc := time.AfterFunc(timeout, func() {
|
|
log.Warnf(TimeoutErr(timeout.String()).Error())
|
|
errCh <- TimeoutErr(timeout.String())
|
|
})
|
|
|
|
defer timeoutFunc.Stop()
|
|
|
|
var wg sync.WaitGroup
|
|
|
|
// Do the operations asynchronously to save time
|
|
for key, op := range ops {
|
|
wg.Add(1)
|
|
innerOp := op
|
|
innerKey := key
|
|
go func() {
|
|
defer wg.Done()
|
|
|
|
log.Infof("cleaning up: %s", innerKey)
|
|
if err := innerOp(ctx); err != nil {
|
|
loghelper.LogError(err).Errorf("%s: clean up failed: %s", innerKey, err.Error())
|
|
return
|
|
}
|
|
|
|
log.Infof("%s was shutdown gracefully", innerKey)
|
|
}()
|
|
}
|
|
|
|
wg.Wait()
|
|
|
|
close(waitCh)
|
|
}()
|
|
|
|
return waitCh, errCh
|
|
}
|