9abd9d4f96
I've needed to catch gotchas that arise from contributors adding a value in the middle of an iota list, not to mention have dealt with prior bugs that happened the same way, now too many times to feel safe about its usage. This PR removes the use of iota from all const declarations. The intent is to not allow the use of iota within the codebase. --- #### Does this PR need a docs update or release note? - [x] ⛔ No #### Type of change - [x] 🧹 Tech Debt/Cleanup #### Issue(s) * #3993 #### Test Plan - [x] ⚡ Unit test - [x] 💚 E2E
95 lines
2.5 KiB
Go
95 lines
2.5 KiB
Go
package operations
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/alcionai/clues"
|
|
|
|
"github.com/alcionai/corso/src/internal/events"
|
|
"github.com/alcionai/corso/src/internal/kopia"
|
|
"github.com/alcionai/corso/src/pkg/control"
|
|
"github.com/alcionai/corso/src/pkg/count"
|
|
"github.com/alcionai/corso/src/pkg/fault"
|
|
"github.com/alcionai/corso/src/pkg/store"
|
|
)
|
|
|
|
// OpStatus describes the current status of an operation.
|
|
// InProgress - the standard value for any process that has not
|
|
// arrived at an end state. The end states are Failed, Completed,
|
|
// or NoData.
|
|
//
|
|
// Failed - the operation was unable to begin processing data at all.
|
|
// No items have been written by the consumer.
|
|
//
|
|
// Completed - the operation was able to process one or more of the
|
|
// items in the request. Both partial success (0 < N < len(items)
|
|
// errored) and total success (0 errors) are set as Completed.
|
|
//
|
|
// NoData - only occurs when no data was involved in an operation.
|
|
// For example, if a backup is requested for a specific user's
|
|
// mail, but that account contains zero mail messages, the backup
|
|
// contains No Data.
|
|
type OpStatus int
|
|
|
|
//go:generate stringer -type=OpStatus -linecomment
|
|
const (
|
|
Unknown OpStatus = 0 // Status Unknown
|
|
InProgress OpStatus = 1 // In Progress
|
|
Completed OpStatus = 2 // Completed
|
|
Failed OpStatus = 3 // Failed
|
|
NoData OpStatus = 4 // No Data
|
|
)
|
|
|
|
// --------------------------------------------------------------------------------
|
|
// Operation Core
|
|
// --------------------------------------------------------------------------------
|
|
|
|
// An operation tracks the in-progress workload of some long-running process.
|
|
// Specific processes (eg: backups, restores, etc) are expected to wrap operation
|
|
// with process specific details.
|
|
type operation struct {
|
|
CreatedAt time.Time `json:"createdAt"`
|
|
|
|
Errors *fault.Bus `json:"errors"`
|
|
Counter *count.Bus
|
|
Options control.Options `json:"options"`
|
|
Status OpStatus `json:"status"`
|
|
|
|
bus events.Eventer
|
|
kopia *kopia.Wrapper
|
|
store store.BackupStorer
|
|
}
|
|
|
|
func newOperation(
|
|
opts control.Options,
|
|
bus events.Eventer,
|
|
ctr *count.Bus,
|
|
kw *kopia.Wrapper,
|
|
sw store.BackupStorer,
|
|
) operation {
|
|
return operation{
|
|
CreatedAt: time.Now(),
|
|
Errors: fault.New(opts.FailureHandling == control.FailFast),
|
|
Counter: ctr,
|
|
Options: opts,
|
|
|
|
bus: bus,
|
|
kopia: kw,
|
|
store: sw,
|
|
|
|
Status: InProgress,
|
|
}
|
|
}
|
|
|
|
func (op operation) validate() error {
|
|
if op.kopia == nil {
|
|
return clues.New("missing kopia connection")
|
|
}
|
|
|
|
if op.store == nil {
|
|
return clues.New("missing modelstore")
|
|
}
|
|
|
|
return nil
|
|
}
|