Merge pull request #1651 from ydb-platform/stack-scan

* Added stacktrace call to row scan errors for detect broken client code

Author: asmyasnikov

CHANGELOG.md

@@ -1,3 +1,4 @@
+* Added stacktrace call to row scan errors for detect broken client code
 * Fixed DescribeConsumer ignoring PartitionConsumerStats
 * Added virtualtimestamps field to cdc description
 

internal/query/row.go

@@ -4,15 +4,22 @@ import (
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb"
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/query/scanner"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
 	"github.com/ydb-platform/ydb-go-sdk/v3/query"
 )
 
 var _ query.Row = (*Row)(nil)
 
 type Row struct {
-	indexedScanner scanner.IndexedScanner
-	namedScanner   scanner.NamedScanner
-	structScanner  scanner.StructScanner
+	indexedScanner interface {
+		Scan(dst ...interface{}) error
+	}
+	namedScanner interface {
+		ScanNamed(dst ...scanner.NamedDestination) error
+	}
+	structScanner interface {
+		ScanStruct(dst interface{}, opts ...scanner.ScanStructOption) error
+	}
 }
 
 func NewRow(columns []*Ydb.Column, v *Ydb.Value) *Row {
@@ -25,14 +32,38 @@ func NewRow(columns []*Ydb.Column, v *Ydb.Value) *Row {
 	}
 }
 
-func (r Row) Scan(dst ...interface{}) (err error) {
-	return r.indexedScanner.Scan(dst...)
+func (r Row) Scan(dst ...interface{}) error {
+	err := r.indexedScanner.Scan(dst...)
+	if err != nil {
+		return xerrors.WithStackTrace(
+			xerrors.WithStackTrace(err),
+			xerrors.WithSkipDepth(1),
+		)
+	}
+
+	return nil
 }
 
-func (r Row) ScanNamed(dst ...scanner.NamedDestination) (err error) {
-	return r.namedScanner.ScanNamed(dst...)
+func (r Row) ScanNamed(dst ...scanner.NamedDestination) error {
+	err := r.namedScanner.ScanNamed(dst...)
+	if err != nil {
+		return xerrors.WithStackTrace(
+			xerrors.WithStackTrace(err),
+			xerrors.WithSkipDepth(1),
+		)
+	}
+
+	return nil
 }
 
-func (r Row) ScanStruct(dst interface{}, opts ...scanner.ScanStructOption) (err error) {
-	return r.structScanner.ScanStruct(dst, opts...)
+func (r Row) ScanStruct(dst interface{}, opts ...scanner.ScanStructOption) error {
+	err := r.structScanner.ScanStruct(dst, opts...)
+	if err != nil {
+		return xerrors.WithStackTrace(
+			xerrors.WithStackTrace(err),
+			xerrors.WithSkipDepth(1),
+		)
+	}
+
+	return nil
 }

internal/query/row_test.go

@@ -0,0 +1,69 @@
+package query
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/query/scanner"
+)
+
+type testScanner struct {
+	err error
+}
+
+func (s testScanner) Scan(dst ...interface{}) error {
+	return s.err
+}
+
+func (s testScanner) ScanNamed(dst ...scanner.NamedDestination) error {
+	return s.err
+}
+
+func (s testScanner) ScanStruct(dst interface{}, opts ...scanner.ScanStructOption) error {
+	return s.err
+}
+
+func TestRowScan(t *testing.T) {
+	expErr := errors.New("test error")
+	row := Row{
+		indexedScanner: testScanner{err: expErr},
+		namedScanner:   testScanner{err: expErr},
+		structScanner:  testScanner{err: expErr},
+	}
+	for _, tt := range []struct {
+		name      string
+		scan      func() error
+		expErrStr string
+	}{
+		{
+			name: "indexed scan",
+			scan: func() error {
+				return row.Scan()
+			},
+			expErrStr: "test error at `github.com/ydb-platform/ydb-go-sdk/v3/internal/query.Row.Scan(row.go:39)` at `github.com/ydb-platform/ydb-go-sdk/v3/internal/query.TestRowScan.func1(row_test.go:43)`", //nolint:lll
+		},
+		{
+			name: "named scan",
+			scan: func() error {
+				return row.ScanNamed()
+			},
+			expErrStr: "test error at `github.com/ydb-platform/ydb-go-sdk/v3/internal/query.Row.ScanNamed(row.go:51)` at `github.com/ydb-platform/ydb-go-sdk/v3/internal/query.TestRowScan.func2(row_test.go:50)`", //nolint:lll
+		},
+		{
+			name: "struct scan",
+			scan: func() error {
+				return row.ScanStruct(nil)
+			},
+			expErrStr: "test error at `github.com/ydb-platform/ydb-go-sdk/v3/internal/query.Row.ScanStruct(row.go:63)` at `github.com/ydb-platform/ydb-go-sdk/v3/internal/query.TestRowScan.func3(row_test.go:57)`", //nolint:lll
+		},
+	} {
+		t.Run(tt.name, func(t *testing.T) {
+			err := tt.scan()
+			require.Error(t, err)
+			require.ErrorIs(t, err, expErr)
+			require.Equal(t, tt.expErrStr, err.Error())
+		})
+	}
+}