helper: Add function to format `Canceled` errors

Add a function to format gRPC errors with an error code of `Canceled`.

2 files changed, 11 insertions, 0 deletions

diff --git a/internal/helper/error.go b/internal/helper/error.go
index e649e5231..517fb1d70 100644
--- a/internal/helper/error.go
+++ b/internal/helper/error.go
@@ -60,6 +60,12 @@ func wrapError(code codes.Code, err error) error {
 	return err
 }
 
+// ErrCanceledf wraps a formatted error with codes.Canceled, unless the formatted error is a
+// wrapped gRPC error.
+func ErrCanceledf(format string, a ...interface{}) error {
+	return formatError(codes.Canceled, format, a...)
+}
+
 // ErrInternalf wraps a formatted error with codes.Internal, unless the formatted error is a
 // wrapped gRPC error.
 func ErrInternalf(format string, a ...interface{}) error {
diff --git a/internal/helper/error_test.go b/internal/helper/error_test.go
index 047aa6853..3de56385d 100644
--- a/internal/helper/error_test.go
+++ b/internal/helper/error_test.go
@@ -99,6 +99,11 @@ func TestErrorf(t *testing.T) {
 		expectedCode codes.Code
 	}{
 		{
+			desc:         "Canceledf",
+			errorf:       ErrCanceledf,
+			expectedCode: codes.Canceled,
+		},
+		{
 			desc:         "Internalf",
 			errorf:       ErrInternalf,
 			expectedCode: codes.Internal,