Merge pull request #68 from ydb-platform/race-result

draft v3.5.2

Author: asmyasnikov

.github/workflows/gosec.yml

@@ -126,24 +126,69 @@ linters-settings:
 linters:
   disable-all: true
   enable:
+#    - cyclop
     - deadcode
     - depguard
+    - dogsled
+#    - dupl
     - errcheck
+    - errorlint
+#    - exhaustive
+#    - exhaustivestruct
+#    - forbidigo
+#    - funlen
+#    - gci
+#    - gocognit
     - goconst
+    - gocritic
+    - gocyclo
+#    - godot
+    - godox
     - gofmt # On why gofmt when goimports is enabled - https://github.com/golang/go/issues/21476
+    - gofumpt
+    - goheader
     - goimports
+#    - gomnd
+#    - gomoddirectives
+#    - gomodguard
+    - gosec
     - revive
     - gosimple
     - govet
+    - depguard
+#    - ifshort
+#    - ireturn
+    - lll
+    - makezero
+    - maligned
+    - misspell
     - ineffassign
     - misspell
+    - nakedret
+    - nestif
+#    - nilnil
+#    - nlreturn
+    - nolintlint
+    - prealloc
+    - predeclared
+    - rowserrcheck
+    - revive
     - staticcheck
+    - stylecheck
     - structcheck
+#    - tagliatelle
+#    - testpackage
+#    - thelper
+#    - tenv
     - typecheck
     - unconvert
     - unparam
     - unused
+#    - varnamelen
     - varcheck
+    - whitespace
+#    - wrapcheck
+#    - wsl
 
 issues:
   # List of regexps of issue texts to exclude, empty list by default.

.golangci.yml

@@ -1,3 +1,10 @@
+## 3.5.2
+* Fixed data race on closing table result
+* Added custom dns-resolver to grpc options for use dns-balancing with round_robin balancing policy
+* Wrapped with `recover()` system panic on getting system certificates pool
+* Added linters and fixed issues from them
+* Changed API of `sugar` package
+
 ## 3.5.1
 * Added system certificates for `darwin` system
 * Fixed `table.StreamResult` finishing

CHANGELOG.md

@@ -60,8 +60,8 @@ The straightforward example of querying data may look similar to this:
 ```go
    ctx := context.Background()
 
-   // connect package helps to connect to database, returns connection object which
-   // provide necessary clients such as table.Client, scheme.Client, etc.
+   // ydb.New() returns connection object which provide necessary clients for different ydb services
+   // such as table.Client, scheme.Client, coordination.Client, etc.
    db, err := ydb.New(
       ctx,
       ydb.WithConnectionString(os.Getenv("YDB_CONNECTION_STRING")),

README.md

@@ -32,6 +32,4 @@ type BalancerConfig struct {
 	PreferLocal bool
 }
 
-var (
-	DefaultBalancer = BalancerConfig{Algorithm: DefaultBalancingAlgorithm, PreferLocal: true}
-)
+var DefaultBalancer = BalancerConfig{Algorithm: DefaultBalancingAlgorithm, PreferLocal: true}

config/balancer.go

@@ -91,22 +91,22 @@ type Config interface {
 
 // Config contains driver configuration options.
 type config struct {
-	endpoint             string
-	database             string
-	secure               bool
-	credentials          credentials.Credentials
 	trace                trace.Driver
 	requestTimeout       time.Duration
 	streamTimeout        time.Duration
 	operationTimeout     time.Duration
 	operationCancelAfter time.Duration
 	discoveryInterval    time.Duration
+	dialTimeout          time.Duration
 	balancingConfig      BalancerConfig
-	requestsType         string
+	secure               bool
 	fastDial             bool
-	dialTimeout          time.Duration
-	tlsConfig            *tls.Config
+	endpoint             string
+	database             string
+	requestsType         string
 	grpcOptions          []grpc.DialOption
+	credentials          credentials.Credentials
+	tlsConfig            *tls.Config
 }
 
 func (c *config) GrpcDialOptions() []grpc.DialOption {
@@ -282,21 +282,28 @@ func New(opts ...Option) Config {
 	return c
 }
 
-func defaults() (c *config) {
-	var (
-		certPool *x509.CertPool
-		err      error
-	)
+func certPool() (certPool *x509.CertPool) {
+	defer func() {
+		// on darwin system panic raced on getting system security checks
+		if e := recover(); e != nil {
+			certPool = x509.NewCertPool()
+		}
+	}()
+	var err error
 	certPool, err = x509.SystemCertPool()
 	if err != nil {
 		certPool = x509.NewCertPool()
 	}
+	return
+}
+
+func defaults() (c *config) {
 	return &config{
 		discoveryInterval: DefaultDiscoveryInterval,
 		balancingConfig:   DefaultBalancer,
 		tlsConfig: &tls.Config{
 			MinVersion: tls.VersionTLS12,
-			RootCAs:    certPool,
+			RootCAs:    certPool(),
 		},
 	}
 }

config/config.go

@@ -18,31 +18,35 @@ func TestParseConnectionString(t *testing.T) {
 		error            error
 	}{
 		{
-			"grpc://ydb-ru.yandex.net:2135/?database=/ru/home/gvit/mydb&token=123",
+			"grpc://ydb-ru.yandex.net:2135/?" +
+				"database=/ru/home/gvit/mydb&token=123",
 			"grpc",
 			"ydb-ru.yandex.net:2135",
 			"/ru/home/gvit/mydb",
 			"123",
 			nil,
 		},
 		{
-			"grpcs://ydb.serverless.yandexcloud.net:2135/?database=/ru-central1/b1g8skpblkos03malf3s/etn02qso4v3isjb00te1&token=123",
+			"grpcs://ydb.serverless.yandexcloud.net:2135/?" +
+				"database=/ru-central1/b1g8skpblkos03malf3s/etn02qso4v3isjb00te1&token=123",
 			"grpcs",
 			"ydb.serverless.yandexcloud.net:2135",
 			"/ru-central1/b1g8skpblkos03malf3s/etn02qso4v3isjb00te1",
 			"123",
 			nil,
 		},
 		{
-			"grpcs://lb.etn03r9df42nb631unbv.ydb.mdb.yandexcloud.net:2135/?database=/ru-central1/b1g8skpblkos03malf3s/etn03r9df42nb631unbv&token=123",
+			"grpcs://lb.etn03r9df42nb631unbv.ydb.mdb.yandexcloud.net:2135/?" +
+				"database=/ru-central1/b1g8skpblkos03malf3s/etn03r9df42nb631unbv&token=123",
 			"grpcs",
 			"lb.etn03r9df42nb631unbv.ydb.mdb.yandexcloud.net:2135",
 			"/ru-central1/b1g8skpblkos03malf3s/etn03r9df42nb631unbv",
 			"123",
 			nil,
 		},
 		{
-			"abcd://ydb-ru.yandex.net:2135/?database=/ru/home/gvit/mydb",
+			"abcd://ydb-ru.yandex.net:2135/?" +
+				"database=/ru/home/gvit/mydb",
 			"",
 			"",
 			"",

connect_params_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/coordination"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/dial"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/discovery"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/errors"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/logger"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/ratelimiter"
 	"github.com/ydb-platform/ydb-go-sdk/v3/log"
@@ -93,19 +94,43 @@ func (db *db) Secure() bool {
 	return db.config.Secure()
 }
 
-func (db *db) Invoke(ctx context.Context, method string, args interface{}, reply interface{}, opts ...grpc.CallOption) error {
+func (db *db) Invoke(
+	ctx context.Context,
+	method string,
+	args interface{},
+	reply interface{},
+	opts ...grpc.CallOption,
+) error {
 	return db.cluster.Invoke(ctx, method, args, reply, opts...)
 }
 
-func (db *db) NewStream(ctx context.Context, desc *grpc.StreamDesc, method string, opts ...grpc.CallOption) (grpc.ClientStream, error) {
+func (db *db) NewStream(
+	ctx context.Context,
+	desc *grpc.StreamDesc,
+	method string,
+	opts ...grpc.CallOption,
+) (grpc.ClientStream, error) {
 	return db.cluster.NewStream(ctx, desc, method, opts...)
 }
 
 func (db *db) Close(ctx context.Context) error {
-	_ = db.Table().Close(ctx)
-	_ = db.Scheme().Close(ctx)
-	_ = db.Coordination().Close(ctx)
-	return db.cluster.Close(ctx)
+	issues := make([]error, 0, 4)
+	if err := db.cluster.Close(ctx); err != nil {
+		issues = append(issues, err)
+	}
+	if err := db.Table().Close(ctx); err != nil {
+		issues = append(issues, err)
+	}
+	if err := db.Scheme().Close(ctx); err != nil {
+		issues = append(issues, err)
+	}
+	if err := db.Coordination().Close(ctx); err != nil {
+		issues = append(issues, err)
+	}
+	if len(issues) > 0 {
+		return errors.NewWithIssues("close failed", issues...)
+	}
+	return nil
 }
 
 func (db *db) Table(opts ...Option) table.Client {

connection.go

@@ -30,7 +30,14 @@ func (c *lazyCoordination) DropNode(ctx context.Context, path string) (err error
 	return c.client.DropNode(ctx, path)
 }
 
-func (c *lazyCoordination) DescribeNode(ctx context.Context, path string) (_ *scheme.Entry, _ *coordination.Config, err error) {
+func (c *lazyCoordination) DescribeNode(
+	ctx context.Context,
+	path string,
+) (
+	_ *scheme.Entry,
+	_ *coordination.Config,
+	err error,
+) {
 	c.init()
 	return c.client.DescribeNode(ctx, path)
 }

coordiantion.go

@@ -7,15 +7,3 @@ require (
 	google.golang.org/grpc v1.38.0
 	google.golang.org/protobuf v1.26.0
 )
-
-retract v3.0.0
-
-retract v3.0.1
-
-retract v3.0.2
-
-retract v3.0.3
-
-retract v3.2.3
-
-retract v3.3.1