OperationCompleted -> OperationStatus + fix integration tests

Author: asmyasnikov

CHANGELOG.md

@@ -9,6 +9,8 @@
 * Added `With[Custom]UserAgent()` `Option` and `CustomOption` constructors
 * Refactored `log.Logger` interface and internal implementation
 * Added `retry.RetryableError()` for returns user-defined error which must be retryed 
+* Renamed internal type `internal.errors.OperationCompleted` to `internal.errors.OperationStatus`
+* Added `String()` method to `table.KeyRange` and `table.Value` types
 
 ## 3.6.2
 * Refactored table retry helpers

internal/errors/operation.go

@@ -103,20 +103,20 @@ func IsOpError(err error, code StatusCode) bool {
 	return op.Reason == code
 }
 
-func (e StatusCode) OperationCompleted() OperationCompleted {
+func (e StatusCode) OperationStatus() OperationStatus {
 	switch e {
 	case
 		StatusAborted,
 		StatusUnavailable,
 		StatusOverloaded,
 		StatusBadSession,
 		StatusSessionBusy:
-		return OperationCompletedFalse
+		return OperationNotFinished
 	case
 		StatusUndetermined:
-		return OperationCompletedUndefined
+		return OperationStatusUndefined
 	default:
-		return OperationCompletedTrue
+		return OperationFinished
 	}
 }
 

internal/errors/retry.go

@@ -5,23 +5,23 @@ import "fmt"
 // RetryType reports which operations need to retry
 type RetryType uint8
 
-// OperationCompleted reports which status of operation: completed or none
-type OperationCompleted uint8
+// OperationStatus reports which status of operation: completed or none
+type OperationStatus uint8
 
-// Binary flags that used as OperationCompleted
+// Binary flags that used as OperationStatus
 const (
-	OperationCompletedTrue      = OperationCompleted(1 << iota >> 1)
-	OperationCompletedUndefined // may be true or may be false
-	OperationCompletedFalse
+	OperationFinished        = OperationStatus(1 << iota >> 1)
+	OperationStatusUndefined // may be true or may be false
+	OperationNotFinished
 )
 
-func (t OperationCompleted) String() string {
+func (t OperationStatus) String() string {
 	switch t {
-	case OperationCompletedTrue:
+	case OperationFinished:
 		return "operation was completed, no need retries"
-	case OperationCompletedFalse:
+	case OperationNotFinished:
 		return "operation was not completed, need retries"
-	case OperationCompletedUndefined:
+	case OperationStatusUndefined:
 		return "operation completed status undefined, no need retries"
 	default:
 		return fmt.Sprintf("unknown operation completed code: %d", t)

internal/errors/retryable.go

@@ -1,11 +1,11 @@
 package errors
 
 type RetryableError struct {
-	Msg               string
+	Err               error
 	BackoffType       BackoffType
 	MustDeleteSession bool
 }
 
 func (e *RetryableError) Error() string {
-	return e.Msg
+	return e.Err.Error()
 }

internal/errors/transport.go

@@ -206,19 +206,19 @@ func (t TransportErrorCode) String() string {
 	return transportErrorString(t)
 }
 
-func (t TransportErrorCode) OperationCompleted() OperationCompleted {
+func (t TransportErrorCode) OperationStatus() OperationStatus {
 	switch t {
 	case
 		TransportErrorAborted,
 		TransportErrorResourceExhausted:
-		return OperationCompletedFalse
+		return OperationNotFinished
 	case
 		TransportErrorInternal,
 		TransportErrorCanceled,
 		TransportErrorUnavailable:
-		return OperationCompletedUndefined
+		return OperationStatusUndefined
 	default:
-		return OperationCompletedTrue
+		return OperationFinished
 	}
 }
 

internal/value/value.go

@@ -11,6 +11,7 @@ import (
 
 type V interface {
 	ToYDB() *Ydb.TypedValue
+	String() string
 	toString(*bytes.Buffer)
 }
 

retry/retry.go

@@ -51,9 +51,9 @@ func WithDeleteSession() retryableErrorOption {
 	}
 }
 
-func RetryableError(msg string, opts ...retryableErrorOption) error {
+func RetryableError(err error, opts ...retryableErrorOption) error {
 	re := &errors.RetryableError{
-		Msg: msg,
+		Err: err,
 	}
 	for _, o := range opts {
 		o(re)
@@ -66,6 +66,7 @@ func RetryableError(msg string, opts ...retryableErrorOption) error {
 // - deadline was canceled or deadlined
 // - retry operation returned nil as error
 // Warning: if deadline without deadline or cancellation func Retry will be worked infinite
+// If you need to retry your op func on some logic errors - you must returns from op func RetryableError()
 func Retry(ctx context.Context, isIdempotentOperation bool, op retryOperation) (err error) {
 	var (
 		i        int
@@ -113,31 +114,31 @@ func Check(err error) (m retryMode) {
 	switch {
 	case errors.As(err, &te):
 		return retryMode{
-			statusCode:         int32(te.Reason),
-			operationCompleted: te.Reason.OperationCompleted(),
-			backoff:            te.Reason.BackoffType(),
-			deleteSession:      te.Reason.MustDeleteSession(),
+			statusCode:      int32(te.Reason),
+			operationStatus: te.Reason.OperationStatus(),
+			backoff:         te.Reason.BackoffType(),
+			deleteSession:   te.Reason.MustDeleteSession(),
 		}
 	case errors.As(err, &oe):
 		return retryMode{
-			statusCode:         int32(oe.Reason),
-			operationCompleted: oe.Reason.OperationCompleted(),
-			backoff:            oe.Reason.BackoffType(),
-			deleteSession:      oe.Reason.MustDeleteSession(),
+			statusCode:      int32(oe.Reason),
+			operationStatus: oe.Reason.OperationStatus(),
+			backoff:         oe.Reason.BackoffType(),
+			deleteSession:   oe.Reason.MustDeleteSession(),
 		}
 	case errors.As(err, &re):
 		return retryMode{
-			statusCode:         -1,
-			operationCompleted: errors.OperationCompletedFalse,
-			backoff:            re.BackoffType,
-			deleteSession:      re.MustDeleteSession,
+			statusCode:      -1,
+			operationStatus: errors.OperationNotFinished,
+			backoff:         re.BackoffType,
+			deleteSession:   re.MustDeleteSession,
 		}
 	default:
 		return retryMode{
-			statusCode:         -1,
-			operationCompleted: errors.OperationCompletedTrue, // it's finish, not need any retry attempts
-			backoff:            errors.BackoffTypeNoBackoff,
-			deleteSession:      false,
+			statusCode:      -1,
+			operationStatus: errors.OperationFinished, // it's finish, not need any retry attempts
+			backoff:         errors.BackoffTypeNoBackoff,
+			deleteSession:   false,
 		}
 	}
 }
@@ -212,17 +213,17 @@ func max(a, b uint) uint {
 
 // retryMode reports whether operation is able retried and with which properties.
 type retryMode struct {
-	statusCode         int32
-	operationCompleted errors.OperationCompleted
-	backoff            errors.BackoffType
-	deleteSession      bool
+	statusCode      int32
+	operationStatus errors.OperationStatus
+	backoff         errors.BackoffType
+	deleteSession   bool
 }
 
 func (m retryMode) MustRetry(isOperationIdempotent bool) bool {
-	switch m.operationCompleted {
-	case errors.OperationCompletedTrue:
+	switch m.operationStatus {
+	case errors.OperationFinished:
 		return false
-	case errors.OperationCompletedUndefined:
+	case errors.OperationStatusUndefined:
 		return isOperationIdempotent
 	default:
 		return true

retry/retry_test.go

@@ -119,13 +119,13 @@ func TestRetryModes(t *testing.T) {
 	}
 	type Case struct {
 		err           error              // given error
-		backoff       errors.BackoffType // no backoff (=== no operationCompleted), fast backoff, slow backoff
+		backoff       errors.BackoffType // no backoff (=== no operationStatus), fast backoff, slow backoff
 		deleteSession bool               // close session and delete from pool
 		canRetry      CanRetry
 	}
 	errs := []Case{
 		{
-			// retryer given unknown error - we will not operationCompleted and will close session
+			// retryer given unknown error - we will not operationStatus and will close session
 			err:           fmt.Errorf("unknown error"),
 			backoff:       errors.BackoffTypeNoBackoff,
 			deleteSession: false,

table/options/models.go

@@ -1,6 +1,7 @@
 package options
 
 import (
+	"bytes"
 	"time"
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/feature"
@@ -415,6 +416,24 @@ type KeyRange struct {
 	To   types.Value
 }
 
+func (kr KeyRange) String() string {
+	var buf bytes.Buffer
+	buf.WriteString("[")
+	if kr.From == nil {
+		buf.WriteString("NULL")
+	} else {
+		buf.WriteString(kr.From.String())
+	}
+	buf.WriteString(",")
+	if kr.To == nil {
+		buf.WriteString("NULL")
+	} else {
+		buf.WriteString(kr.To.String())
+	}
+	buf.WriteString("]")
+	return buf.String()
+}
+
 // Deprecated: use TimeToLiveSettings instead.
 // Will be removed after Jan 2022.
 type TTLSettings struct {

test/scripting_test.go

@@ -19,7 +19,7 @@ import (
 	"github.com/ydb-platform/ydb-go-sdk/v3/trace"
 )
 
-func TestScriptingService(t *testing.T) {
+func TestScripting(t *testing.T) {
 	ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
 	defer cancel()
 	var (
@@ -72,13 +72,13 @@ func TestScriptingService(t *testing.T) {
 			}()
 			if !res.NextResultSet(ctx) {
 				return retry.RetryableError(
-					"no result sets",
+					fmt.Errorf("no result sets"),
 					retry.WithBackoff(retry.BackoffTypeNoBackoff),
 				)
 			}
 			if !res.NextRow() {
 				return retry.RetryableError(
-					"no rows",
+					fmt.Errorf("no rows"),
 					retry.WithBackoff(retry.BackoffTypeSlowBackoff),
 				)
 			}
@@ -109,14 +109,14 @@ func TestScriptingService(t *testing.T) {
 			}()
 			if !res.NextResultSet(ctx) {
 				return retry.RetryableError(
-					"no result sets",
+					fmt.Errorf("no result sets"),
 					retry.WithBackoff(retry.BackoffTypeNoBackoff),
 					retry.WithDeleteSession(),
 				)
 			}
 			if !res.NextRow() {
 				return retry.RetryableError(
-					"no rows",
+					fmt.Errorf("no rows"),
 					retry.WithBackoff(retry.BackoffTypeFastBackoff),
 				)
 			}