55d5e1fd7d
Add checks to ensure that when somebody uses empty options, the deletion doesn't loop infinitely. Change-Id: I1738fb1e7e1f8efbbb954c491cb6489f7bcdc2db
93 lines
2.3 KiB
Go
93 lines
2.3 KiB
Go
// Copyright (C) 2019 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package dbcleanup
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/spacemonkeygo/monkit/v3"
|
|
"github.com/zeebo/errs"
|
|
"go.uber.org/zap"
|
|
|
|
"storj.io/common/sync2"
|
|
"storj.io/storj/satellite/orders"
|
|
)
|
|
|
|
var (
|
|
// Error the default dbcleanup errs class.
|
|
Error = errs.Class("dbcleanup error")
|
|
|
|
mon = monkit.Package()
|
|
)
|
|
|
|
// Config defines configuration struct for dbcleanup chore.
|
|
type Config struct {
|
|
SerialsInterval time.Duration `help:"how often to delete expired serial numbers" default:"4h"`
|
|
BatchSize int `help:"number of records to delete per delete execution. 0 indicates no limit. applicable to cockroach DB only." default:"1000"`
|
|
}
|
|
|
|
// Chore for deleting DB entries that are no longer needed.
|
|
//
|
|
// architecture: Chore
|
|
type Chore struct {
|
|
log *zap.Logger
|
|
orders orders.DB
|
|
|
|
Serials *sync2.Cycle
|
|
config Config
|
|
|
|
serialsDeleteOptions orders.SerialDeleteOptions
|
|
}
|
|
|
|
// NewChore creates new chore for deleting DB entries.
|
|
func NewChore(log *zap.Logger, ordersDB orders.DB, config Config) *Chore {
|
|
return &Chore{
|
|
log: log,
|
|
orders: ordersDB,
|
|
|
|
Serials: sync2.NewCycle(config.SerialsInterval),
|
|
config: config,
|
|
|
|
serialsDeleteOptions: orders.SerialDeleteOptions{
|
|
BatchSize: config.BatchSize,
|
|
},
|
|
}
|
|
}
|
|
|
|
// Run starts the db cleanup chore.
|
|
func (chore *Chore) Run(ctx context.Context) (err error) {
|
|
defer mon.Task()(&ctx)(&err)
|
|
return chore.Serials.Run(ctx, chore.deleteExpiredSerials)
|
|
}
|
|
|
|
func (chore *Chore) deleteExpiredSerials(ctx context.Context) (err error) {
|
|
defer mon.Task()(&ctx)(&err)
|
|
chore.log.Debug("deleting expired serial numbers")
|
|
|
|
now := time.Now()
|
|
|
|
deleted, err := chore.orders.DeleteExpiredSerials(ctx, now, chore.serialsDeleteOptions)
|
|
if err != nil {
|
|
chore.log.Error("deleting expired serial numbers", zap.Error(err))
|
|
} else {
|
|
chore.log.Debug("expired serials deleted", zap.Int("items deleted", deleted))
|
|
}
|
|
|
|
deleted, err = chore.orders.DeleteExpiredConsumedSerials(ctx, now)
|
|
if err != nil {
|
|
chore.log.Error("deleting expired serial numbers", zap.Error(err))
|
|
} else {
|
|
chore.log.Debug("expired serials deleted", zap.Int("items deleted", deleted))
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Close stops the dbcleanup chore.
|
|
func (chore *Chore) Close() error {
|
|
chore.Serials.Close()
|
|
return nil
|
|
}
|