refactor: storage.InternalError should retain the inner error

This is so we can do proper error handling, at the same time
we want to maintain backward compatibility
This commit is contained in:
Abu Kashem 2024-09-26 09:44:09 -04:00
parent daf76e6ead
commit f24ec7e00d
No known key found for this signature in database
GPG Key ID: E5ECC1124B5F9C68
3 changed files with 18 additions and 16 deletions

View File

@ -172,24 +172,26 @@ func NewInvalidError(errors field.ErrorList) InvalidError {
// not from the underlying storage backend (e.g., etcd). // not from the underlying storage backend (e.g., etcd).
type InternalError struct { type InternalError struct {
Reason string Reason string
// retain the inner error to maintain the error tree, so as to enable us
// to do proper error checking, but we also need to be backward compatible.
err error
} }
func (e InternalError) Error() string { func (e InternalError) Error() string {
return e.Reason return e.Reason
} }
func (e InternalError) Unwrap() error { return e.err }
// IsInternalError returns true if and only if err is an InternalError. // IsInternalError returns true if and only if err is an InternalError.
func IsInternalError(err error) bool { func IsInternalError(err error) bool {
_, ok := err.(InternalError) _, ok := err.(InternalError)
return ok return ok
} }
func NewInternalError(reason string) InternalError { func NewInternalError(err error) InternalError {
return InternalError{reason} return InternalError{Reason: err.Error(), err: err}
}
func NewInternalErrorf(format string, a ...interface{}) InternalError {
return InternalError{fmt.Sprintf(format, a...)}
} }
var tooLargeResourceVersionCauseMsg = "Too large resource version" var tooLargeResourceVersionCauseMsg = "Too large resource version"

View File

@ -179,7 +179,7 @@ func (s *store) Get(ctx context.Context, key string, opts storage.GetOptions, ou
data, _, err := s.transformer.TransformFromStorage(ctx, kv.Value, authenticatedDataString(preparedKey)) data, _, err := s.transformer.TransformFromStorage(ctx, kv.Value, authenticatedDataString(preparedKey))
if err != nil { if err != nil {
return storage.NewInternalError(err.Error()) return storage.NewInternalError(err)
} }
err = decode(s.codec, s.versioner, data, out, kv.ModRevision) err = decode(s.codec, s.versioner, data, out, kv.ModRevision)
@ -225,7 +225,7 @@ func (s *store) Create(ctx context.Context, key string, obj, out runtime.Object,
newData, err := s.transformer.TransformToStorage(ctx, data, authenticatedDataString(preparedKey)) newData, err := s.transformer.TransformToStorage(ctx, data, authenticatedDataString(preparedKey))
if err != nil { if err != nil {
span.AddEvent("TransformToStorage failed", attribute.String("err", err.Error())) span.AddEvent("TransformToStorage failed", attribute.String("err", err.Error()))
return storage.NewInternalError(err.Error()) return storage.NewInternalError(err)
} }
span.AddEvent("TransformToStorage succeeded") span.AddEvent("TransformToStorage succeeded")
@ -508,7 +508,7 @@ func (s *store) GuaranteedUpdate(
newData, err := s.transformer.TransformToStorage(ctx, data, transformContext) newData, err := s.transformer.TransformToStorage(ctx, data, transformContext)
if err != nil { if err != nil {
span.AddEvent("TransformToStorage failed", attribute.String("err", err.Error())) span.AddEvent("TransformToStorage failed", attribute.String("err", err.Error()))
return storage.NewInternalError(err.Error()) return storage.NewInternalError(err)
} }
span.AddEvent("TransformToStorage succeeded") span.AddEvent("TransformToStorage succeeded")
@ -768,7 +768,7 @@ func (s *store) GetList(ctx context.Context, key string, opts storage.ListOption
data, _, err := s.transformer.TransformFromStorage(ctx, kv.Value, authenticatedDataString(kv.Key)) data, _, err := s.transformer.TransformFromStorage(ctx, kv.Value, authenticatedDataString(kv.Key))
if err != nil { if err != nil {
return storage.NewInternalErrorf("unable to transform key %q: %v", kv.Key, err) return storage.NewInternalError(fmt.Errorf("unable to transform key %q: %w", kv.Key, err))
} }
// Check if the request has already timed out before decode object // Check if the request has already timed out before decode object
@ -933,7 +933,7 @@ func (s *store) getState(ctx context.Context, getResp *clientv3.GetResponse, key
data, stale, err := s.transformer.TransformFromStorage(ctx, getResp.Kvs[0].Value, authenticatedDataString(key)) data, stale, err := s.transformer.TransformFromStorage(ctx, getResp.Kvs[0].Value, authenticatedDataString(key))
if err != nil { if err != nil {
return nil, storage.NewInternalError(err.Error()) return nil, storage.NewInternalError(err)
} }
state.data = data state.data = data

View File

@ -139,11 +139,11 @@ func (p *Preconditions) Check(key string, obj runtime.Object) error {
} }
objMeta, err := meta.Accessor(obj) objMeta, err := meta.Accessor(obj)
if err != nil { if err != nil {
return NewInternalErrorf( return NewInternalError(
"can't enforce preconditions %v on un-introspectable object %v, got error: %v", fmt.Errorf("can't enforce preconditions %v on un-introspectable object %v, got error: %w",
*p, *p,
obj, obj,
err) err))
} }
if p.UID != nil && *p.UID != objMeta.GetUID() { if p.UID != nil && *p.UID != objMeta.GetUID() {
err := fmt.Sprintf( err := fmt.Sprintf(