f2bf0ee685
While fail-fast and best-effort make for good categories at the extreme ends of error handling, we keep finding outselves wanting to operate in a middle ground. This change introduces a new error handling category: FailAfterRecovery. This option tells corso to complete as much of its process as it can, even if it recovers from errors. But at the end of processing, if it recovered from any errors, an error is returned for the operation. This behavior is the new failure handling default, instead of failFast. --- #### Does this PR need a docs update or release note? - [x] ⛔ No #### Type of change - [x] 🌻 Feature #### Test Plan - [x] 💪 Manual - [x] ⚡ Unit test
91 lines
2.4 KiB
Go
91 lines
2.4 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/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 = iota // Status Unknown
|
|
InProgress // In Progress
|
|
Completed // Completed
|
|
Failed // Failed
|
|
NoData // 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"`
|
|
Options control.Options `json:"options"`
|
|
Status opStatus `json:"status"`
|
|
|
|
bus events.Eventer
|
|
kopia *kopia.Wrapper
|
|
store *store.Wrapper
|
|
}
|
|
|
|
func newOperation(
|
|
opts control.Options,
|
|
bus events.Eventer,
|
|
kw *kopia.Wrapper,
|
|
sw *store.Wrapper,
|
|
) operation {
|
|
return operation{
|
|
CreatedAt: time.Now(),
|
|
Errors: fault.New(opts.FailureHandling == control.FailFast),
|
|
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
|
|
}
|