core

Documentation

Index

• Constants
• Variables
• type Err
  • func As(err error) (*Err, bool)
  • func (e Err) Error() string

Constants

const (
	// add this label when we might need to further investigate the cause of the
	// error.  For example, in the graph api layer we try to categorize errors
	// by their specific identity, such as "the resource was locked out".  If
	// we're unsuccessful, we can still fall back to the more generic error code,
	// "403 forbidden".  But it tradeoff, we may end up catching (and gracefully
	// handling) 403s, but not identifying an underlying root issue.  This label
	// is here to say, "maybe you should look for the reason why this happened".
	LabelRootCauseUnknown = "root-cause-unknown"
)

Variables

var (
	// occurs when creation of an entity (usually by restful POST or PUT) errors
	// because some other entity already already exists with a conflicting identifier.
	// The identifier is not always the id.  For example: duplicate filenames
	// in the same directory will cause conflicts, even with different IDs.
	ErrAlreadyExists = &Err{msg: "conflict: already exists"}
	// currently we have no internal throttling controls.  We only try to match
	// external throttling requirements.  This sentinel assumes that an external
	// server has returned one or more throttling errors which has stopped
	// operation progress.
	ErrApplicationThrottled = &Err{msg: "application throttled"}
	// for use when a short-lived auth token (a jwt or something similar) expires.
	ErrAuthTokenExpired = &Err{msg: "auth token expired"}
	// about what it sounds like: we tried to look for a backup by ID, but the
	// storage layer couldn't find anything for that ID.
	ErrBackupNotFound = &Err{msg: "backup not found"}
	// basically "internal server error". But not internal issues. We only return this
	// when a downstream service (ex: graph api) responds with a 5xx style error.
	// Note: producers may not funnel all 5xx errors in this umbrella, because
	// different cases (ex: `StatusHTTPVersionNotSupported`) may need more specific
	// attention and handling than standard gateway outages or service issues.
	ErrDownstreamServerError = &Err{msg: "server error in downstream service"}
	// a catch-all for downstream api auth issues.  doesn't matter which api.
	ErrInsufficientAuthorization = &Err{msg: "insufficient authorization"}
	// happens when we look up something using an identifier other than a canonical ID
	// (ex: filtering, searching, etc). This error should only be returned if a unique
	// result is an expected constraint of the behavior.  If it's possible to
	// opportunistically select one of the many results, no error should get returned.
	ErrMultipleResultsMatchIdentifier = &Err{msg: "multiple results match the identifier"}
	// basically what it sounds like: we went looking for something by ID and
	// it wasn't found.  This might be because it was deleted in flight, or
	// was never created, or some other reason.
	ErrNotFound = &Err{msg: "not found"}
	// specifically for repository creation: if we tried to create a repo and
	// it already exists with those credentials, we return this error.
	ErrRepoAlreadyExists = &Err{msg: "repository already exists"}
	// use this when a resource (user, etc; whatever owner is used to own the
	// data in the given backup) is unable to be used for backup or restore.
	// some nuance here: this is not the same as a broad-scale auth issue.
	// it is also not the same as a "not found" issue.  it's specific to
	// cases where we can find the resource, and have authorization to access
	// it, but are told by the external system that the resource is somehow
	// unusable.
	ErrResourceNotAccessible = &Err{msg: "resource not accesible"}
	// a service is the set of application data within a given provider.  eg:
	// if m365 is the provider, then exchange is a service, so is oneDrive.
	// this sentinel is used to indicate that the service in question is not
	// accessible to the user.  this is not the same as an auth error.  more
	// often its a license issue.  as in: the tenant hasn't purchased the use
	// of this service (but may have purchased the use of other services in
	// the same provider).
	ErrServiceNotEnabled = &Err{msg: "service not enabled"}
)

Types

type Err

type Err struct {
	// contains filtered or unexported fields
}

func As

func As(err error) (*Err, bool)

As is a quality-of-life wrapper around errors.As, to retrieve the core.Err out of any arbitrary error.

func (Err) Error

func (e Err) Error() string