Merge pull request #251 from ydb-platform/interval

Interval <-> time.Duration fix

Author: asmyasnikov

CHANGELOG.md

@@ -1,3 +1,7 @@
+* Fixed bug with convert ydb value to `time.Duration` in `result.Scan[WithDefaults,Named]()`
+* Fixed bug with make ydb value from `time.Duration` in `types.IntervalValueFromDuration(d)`
+* Marked `table/types.{IntervalValue,NullableIntervalValue}` as deprecated 
+
 ## v3.26.8
 * Removed the processing of trailer metadata on stream calls 
 

internal/table/scanner/scan_raw.go

@@ -173,7 +173,7 @@ func (s *rawConverter) Timestamp() (v time.Time) {
 
 func (s *rawConverter) Interval() (v time.Duration) {
 	s.unwrap()
-	return timeutil.UnmarshalInterval(s.int64())
+	return timeutil.MicrosecondsToDuration(s.int64())
 }
 
 func (s *rawConverter) TzDate() (v time.Time) {

internal/table/scanner/scanner.go

@@ -378,7 +378,7 @@ func (s *scanner) any() interface{} {
 	case value.TypeInt64:
 		return s.int64()
 	case value.TypeInterval:
-		return timeutil.UnmarshalInterval(s.int64())
+		return timeutil.MicrosecondsToDuration(s.int64())
 	case value.TypeTzDate:
 		src, err := timeutil.UnmarshalTzDate(s.text())
 		if err != nil {
@@ -750,7 +750,7 @@ func (s *scanner) scanRequired(value interface{}) {
 	case *time.Time:
 		s.setTime(v)
 	case *time.Duration:
-		*v = timeutil.UnmarshalInterval(s.int64())
+		*v = timeutil.MicrosecondsToDuration(s.int64())
 	case *string:
 		s.setString(v)
 	case *[]byte:
@@ -910,7 +910,7 @@ func (s *scanner) scanOptional(value interface{}, defaultValueForOptional bool)
 		if s.isNull() {
 			*v = nil
 		} else {
-			src := timeutil.UnmarshalInterval(s.int64())
+			src := timeutil.MicrosecondsToDuration(s.int64())
 			*v = &src
 		}
 	case **string:

internal/table/scanner/scanner_test.go

@@ -250,7 +250,7 @@ func valueFromPrimitiveTypeID(c *column, r xrand.Rand) (*Ydb.Value, interface{})
 				Int64Value: v,
 			},
 		}
-		src := timeutil.UnmarshalInterval(v)
+		src := timeutil.MicrosecondsToDuration(v)
 		if c.optional && !c.testDefault {
 			vp := &src
 			return ydbval, &vp

internal/timeutil/time.go

@@ -17,13 +17,14 @@ const (
 
 var unix = time.Unix(0, 0)
 
-// UnmarshalInterval up to ±292 years.
-func UnmarshalInterval(n int64) time.Duration {
-	return time.Duration(n)
+// MicrosecondsToDuration returns time.Duration from given microseconds
+func MicrosecondsToDuration(n int64) time.Duration {
+	return time.Duration(n) * time.Microsecond
 }
 
-func MarshalInterval(d time.Duration) int64 {
-	return int64(d)
+// DurationToMicroseconds returns microseconds from given time.Duration
+func DurationToMicroseconds(d time.Duration) int64 {
+	return int64(d / time.Microsecond)
 }
 
 // UnmarshalDate up to 11761191-01-20 00:00:00 +0000 UTC.

internal/value/value.go

@@ -339,6 +339,7 @@ func TimestampValue(v uint64) Value {
 	}
 }
 
+// IntervalValue makes Value from given microseconds value
 func IntervalValue(v int64) Value {
 	return Value{
 		t: TypeInterval,

table/table_regress_test.go

@@ -7,12 +7,13 @@ import (
 	"context"
 	"os"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/table"
-
 	"github.com/ydb-platform/ydb-go-sdk/v3"
+	"github.com/ydb-platform/ydb-go-sdk/v3/table"
+	"github.com/ydb-platform/ydb-go-sdk/v3/table/types"
 )
 
 type issue229Struct struct{}
@@ -49,3 +50,31 @@ func connect(t *testing.T) ydb.Connection {
 	require.NoError(t, err)
 	return db
 }
+
+func TestIssue259IntervalFromDuration(t *testing.T) {
+	// https://github.com/ydb-platform/ydb-go-sdk/issues/259
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	db := connect(t)
+	err := db.Table().DoTx(ctx, func(ctx context.Context, tx table.TransactionActor) error {
+		res, err := tx.Execute(ctx, `DECLARE $ts as Interval;
+			$ten_micro = CAST(10 as Interval);
+			SELECT $ts == $ten_micro, $ten_micro;`, table.NewQueryParameters(
+			table.ValueParam(`$ts`, types.IntervalValueFromDuration(10*time.Microsecond)),
+		))
+		require.NoError(t, err)
+		require.NoError(t, res.NextResultSetErr(ctx))
+		require.True(t, res.NextRow())
+
+		var (
+			val      bool
+			tenMicro time.Duration
+		)
+		require.NoError(t, res.Scan(&val, &tenMicro))
+		require.True(t, val)
+		require.Equal(t, 10*time.Microsecond, tenMicro)
+		return nil
+	}, table.WithTxSettings(table.TxSettings(table.WithSerializableReadWrite())))
+	require.NoError(t, err)
+}

table/types/value.go

@@ -42,56 +42,109 @@ func DatetimeValue(v uint32) Value { return value.DatetimeValue(v) }
 
 func TimestampValue(v uint64) Value { return value.TimestampValue(v) }
 
+// IntervalValueFromMicroseconds makes Value from given microseconds value
+func IntervalValueFromMicroseconds(v int64) Value { return value.IntervalValue(v) }
+
+// IntervalValue makes Value from given microseconds value
+//
+// Deprecated: use IntervalValueFromMicroseconds instead
 func IntervalValue(v int64) Value { return value.IntervalValue(v) }
 
+// TzDateValue makes TzDate value from string
 func TzDateValue(v string) Value { return value.TzDateValue(v) }
 
+// TzDatetimeValue makes TzDatetime value from string
 func TzDatetimeValue(v string) Value { return value.TzDatetimeValue(v) }
 
+// TzTimestampValue makes TzTimestamp value from string
 func TzTimestampValue(v string) Value { return value.TzTimestampValue(v) }
 
+// DateValueFromTime makes Date value from time.Time
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func DateValueFromTime(v time.Time) Value { return value.DateValue(timeutil.MarshalDate(v)) }
 
+// DatetimeValueFromTime makes Datetime value from time.Time
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func DatetimeValueFromTime(v time.Time) Value {
 	return value.DatetimeValue(timeutil.MarshalDatetime(v))
 }
 
+// TimestampValueFromTime makes Timestamp value from time.Time
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func TimestampValueFromTime(v time.Time) Value {
 	return value.TimestampValue(timeutil.MarshalTimestamp(v))
 }
 
+// IntervalValueFromDuration makes Interval value from time.Duration
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func IntervalValueFromDuration(v time.Duration) Value {
-	return value.IntervalValue(timeutil.MarshalInterval(v))
+	return value.IntervalValue(timeutil.DurationToMicroseconds(v))
 }
 
+// TzDateValueFromTime makes TzDate value from time.Time
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func TzDateValueFromTime(v time.Time) Value { return value.TzDateValue(timeutil.MarshalTzDate(v)) }
 
+// TzDatetimeValueFromTime makes TzDatetime value from time.Time
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func TzDatetimeValueFromTime(v time.Time) Value {
 	return value.TzDatetimeValue(timeutil.MarshalTzDatetime(v))
 }
 
+// TzTimestampValueFromTime makes TzTimestamp value from time.Time
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func TzTimestampValueFromTime(v time.Time) Value {
 	return value.TzTimestampValue(timeutil.MarshalTzTimestamp(v))
 }
 
 func StringValue(v []byte) Value { return value.StringValue(v) }
 
+// StringValueFromString makes String value from string
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func StringValueFromString(v string) Value { return value.StringValue([]byte(v)) }
 
 func UTF8Value(v string) Value { return value.UTF8Value(v) }
 
 func YSONValue(v string) Value { return value.YSONValue(v) }
 
+// YSONValueFromBytes makes YSON value from bytes
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func YSONValueFromBytes(v []byte) Value { return value.YSONValue(string(v)) }
 
 func JSONValue(v string) Value { return value.JSONValue(v) }
 
+// JSONValueFromBytes makes JSON value from bytes
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func JSONValueFromBytes(v []byte) Value { return value.JSONValue(string(v)) }
 
 func UUIDValue(v [16]byte) Value { return value.UUIDValue(v) }
 
 func JSONDocumentValue(v string) Value { return value.JSONDocumentValue(v) }
 
+// JSONDocumentValueFromBytes makes JSONDocument value from bytes
+//
+// Warning: all *From* helpers will be removed at next major release
+// (functional will be implements with go1.18 type lists)
 func JSONDocumentValueFromBytes(v []byte) Value { return value.JSONDocumentValue(string(v)) }
 
 func DyNumberValue(v string) Value { return value.DyNumberValue(v) }
@@ -344,13 +397,23 @@ func NullableTzTimestampValueFromTime(v *time.Time) Value {
 	return OptionalValue(TzTimestampValueFromTime(*v))
 }
 
+// NullableIntervalValue makes Value which maybe nil or valued
+//
+// Deprecated: use NullableIntervalValueFromMicroseconds instead
 func NullableIntervalValue(v *int64) Value {
 	if v == nil {
 		return NullValue(TypeInterval)
 	}
 	return OptionalValue(IntervalValue(*v))
 }
 
+func NullableIntervalValueFromMicroseconds(v *int64) Value {
+	if v == nil {
+		return NullValue(TypeInterval)
+	}
+	return OptionalValue(IntervalValueFromMicroseconds(*v))
+}
+
 func NullableIntervalValueFromDuration(v *time.Duration) Value {
 	if v == nil {
 		return NullValue(TypeInterval)
@@ -492,7 +555,7 @@ func Nullable(t Type, v interface{}) Value {
 	case TypeInterval:
 		switch tt := v.(type) {
 		case *int64:
-			return NullableIntervalValue(tt)
+			return NullableIntervalValueFromMicroseconds(tt)
 		case *time.Duration:
 			return NullableIntervalValueFromDuration(tt)
 		default:

table/types/value_test.go

@@ -217,10 +217,10 @@ func TestNullable(t *testing.T) {
 			exp:  NullValue(TypeTzDate),
 		},
 		{
-			name: "interval from int32",
+			name: "interval from int64",
 			t:    TypeInterval,
 			v:    func(v int64) *int64 { return &v }(123),
-			exp:  OptionalValue(IntervalValue(123)),
+			exp:  OptionalValue(IntervalValueFromMicroseconds(123)),
 		},
 		{
 			name: "interval from time.Time",