feat: deprecate UnexpectedError

That reduces an API surface. Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@gmail.com>
siderolabs · May 14, 2021 · 3d83f61 · 3d83f61
1 parent b9dc1a9
commit 3d83f61
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/retry/constant_test.go b/retry/constant_test.go
@@ -78,7 +78,7 @@ func Test_constantRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return UnexpectedError(fmt.Errorf("unexpected"))
+					return fmt.Errorf("unexpected")
 				},
 			},
 			expectedCount: 1,
@@ -96,7 +96,7 @@ func Test_constantRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 					if count == 2 {
-						return UnexpectedError(fmt.Errorf("unexpected"))
+						return fmt.Errorf("unexpected")
 					}
 
 					return ExpectedError(fmt.Errorf("unexpected"))

diff --git a/retry/exponential_test.go b/retry/exponential_test.go
@@ -78,7 +78,7 @@ func Test_exponentialRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return UnexpectedError(fmt.Errorf("unexpected"))
+					return fmt.Errorf("unexpected")
 				},
 			},
 			expectedCount: 1,
@@ -96,7 +96,7 @@ func Test_exponentialRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 					if count == 2 {
-						return UnexpectedError(fmt.Errorf("unexpected"))
+						return fmt.Errorf("unexpected")
 					}
 
 					return ExpectedError(fmt.Errorf("unexpected"))

diff --git a/retry/linear_test.go b/retry/linear_test.go
@@ -78,7 +78,7 @@ func Test_linearRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return UnexpectedError(fmt.Errorf("unexpected"))
+					return fmt.Errorf("unexpected")
 				},
 			},
 			expectedCount: 1,
@@ -96,7 +96,7 @@ func Test_linearRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 					if count == 1 {
-						return UnexpectedError(fmt.Errorf("unexpected"))
+						return fmt.Errorf("unexpected")
 					}
 
 					return ExpectedError(fmt.Errorf("unexpected"))

diff --git a/retry/retry.go b/retry/retry.go
@@ -161,6 +161,8 @@ func ExpectedError(err error) error {
 
 // UnexpectedError error represents an error that is unexpected by the retrying
 // function. This error is fatal.
+//
+// Deprecated: all errors are unexpected by default, just return them.
 func UnexpectedError(err error) error {
 	if err == nil {
 		return nil

diff --git a/retry/retry_test.go b/retry/retry_test.go
@@ -47,7 +47,7 @@ func Test_retry(t *testing.T) {
 			name: "unexpected error string",
 			args: args{
 				c: context.Background(),
-				f: func(context.Context) error { return UnexpectedError(errors.New("test")) },
+				f: func(context.Context) error { return errors.New("test") },
 				d: 2 * time.Second,
 				t: NewConstantTicker(NewDefaultOptions()),
 				o: &Options{},