With[Custom]UserAgent + refactoring of integration tests + table.types.Type.String()

Author: asmyasnikov

CHANGELOG.md

@@ -4,7 +4,9 @@
 * Removed experimental `balancer.PreferEndpoints[WithFallback][RegEx]` balancers
 * Supported connections `TTL` with `Option` `WithConnectionTTL`
 * Remove unnecessary `WithFastDial` option (lazy connections are always fast inserts into cluster)
-* Added `ScriptingYQL` service client
+* Added `Scripting` service client with API methods `Execute()`, `StreamExecute()` and `Explain()`
+* Added `String()` method to `table.types.Type` interface
+* Added `With[Custom]UserAgent()` `Option` and `CustomOption` constructors
 
 ## 3.6.2
 * Refactored table retry helpers

config/config.go

@@ -115,6 +115,7 @@ type config struct {
 	endpoint             string
 	database             string
 	requestsType         string
+	userAgent            string
 	grpcOptions          []grpc.DialOption
 	credentials          credentials.Credentials
 	tlsConfig            *tls.Config
@@ -247,6 +248,12 @@ func WithTrace(trace trace.Driver) Option {
 	}
 }
 
+func WithUserAgent(userAgent string) Option {
+	return func(c *config) {
+		c.userAgent = userAgent
+	}
+}
+
 func WithConnectionTTL(ttl time.Duration) Option {
 	return func(c *config) {
 		c.connectionTTL = ttl
@@ -324,7 +331,13 @@ func New(opts ...Option) Config {
 	if c.discoveryInterval == 0 {
 		c.balancer = balancer.SingleConn()
 	}
-	c.meta = meta.New(c.database, c.credentials, c.trace, c.requestsType)
+	c.meta = meta.New(
+		c.database,
+		c.credentials,
+		c.trace,
+		c.requestsType,
+		c.userAgent,
+	)
 	return c
 }
 

connection.go

@@ -188,19 +188,11 @@ func (c *connection) meta(opts ...CustomOption) meta.Meta {
 	if len(opts) == 0 {
 		return c.config.Meta()
 	}
-	options := customOptions{
-		database:    c.config.Database(),
-		credentials: c.config.Credentials(),
-	}
-	for _, o := range opts {
-		o(&options)
-	}
-	return meta.New(
-		options.database,
-		options.credentials,
-		c.config.Trace(),
-		c.config.RequestsType(),
-	)
+	options := &customOptions{meta: c.config.Meta()}
+	for _, opt := range opts {
+		opt(options)
+	}
+	return options.meta
 }
 
 // New connects to name and return name runtime holder

custom_options.go

@@ -4,26 +4,34 @@ import (
 	"fmt"
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/credentials"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/meta"
 )
 
 type customOptions struct {
-	database    string
-	credentials credentials.Credentials
+	meta meta.Meta
 }
 
 type CustomOption func(opts *customOptions)
 
 func WithCustomToken(accessToken string) CustomOption {
 	return func(opts *customOptions) {
-		opts.credentials = credentials.NewAccessTokenCredentials(
-			accessToken,
-			fmt.Sprintf(`WithCustomToken("%s")`, accessToken),
+		opts.meta = opts.meta.WithCredentials(
+			credentials.NewAccessTokenCredentials(
+				accessToken,
+				fmt.Sprintf(`WithCustomToken("%s")`, accessToken),
+			),
 		)
 	}
 }
 
+func WithCustomUserAgent(userAgent string) CustomOption {
+	return func(opts *customOptions) {
+		opts.meta = opts.meta.WithUserAgent(userAgent)
+	}
+}
+
 func WithCustomDatabase(database string) CustomOption {
 	return func(opts *customOptions) {
-		opts.database = database
+		opts.meta = opts.meta.WithDatabase(database)
 	}
 }

internal/lazy/scripting.go

@@ -17,31 +17,31 @@ type lazyScripting struct {
 	m      sync.Mutex
 }
 
-func (s *lazyScripting) ExecuteYql(
+func (s *lazyScripting) Execute(
 	ctx context.Context,
 	query string,
 	params *table.QueryParameters,
 ) (result.Result, error) {
 	s.init()
-	return s.client.ExecuteYql(ctx, query, params)
+	return s.client.Execute(ctx, query, params)
 }
 
-func (s *lazyScripting) ExplainYql(
+func (s *lazyScripting) Explain(
 	ctx context.Context,
 	query string,
 	mode scripting.ExplainMode,
 ) (table.ScriptingYQLExplanation, error) {
 	s.init()
-	return s.client.ExplainYql(ctx, query, mode)
+	return s.client.Explain(ctx, query, mode)
 }
 
-func (s *lazyScripting) StreamExecuteYql(
+func (s *lazyScripting) StreamExecute(
 	ctx context.Context,
 	query string,
 	params *table.QueryParameters,
 ) (result.StreamResult, error) {
 	s.init()
-	return s.client.StreamExecuteYql(ctx, query, params)
+	return s.client.StreamExecute(ctx, query, params)
 }
 
 func (s *lazyScripting) Close(ctx context.Context) error {

internal/meta/meta.go

@@ -21,19 +21,25 @@ const (
 
 type Meta interface {
 	Meta(ctx context.Context) (context.Context, error)
+
+	WithDatabase(database string) Meta
+	WithCredentials(creds credentials.Credentials) Meta
+	WithUserAgent(userAgent string) Meta
 }
 
 func New(
 	database string,
 	credentials credentials.Credentials,
 	trace trace.Driver,
 	requestsType string,
+	userAgent string,
 ) Meta {
 	return &meta{
 		trace:        trace,
 		credentials:  credentials,
 		database:     database,
 		requestsType: requestsType,
+		userAgent:    userAgent,
 	}
 }
 
@@ -42,6 +48,25 @@ type meta struct {
 	credentials  credentials.Credentials
 	database     string
 	requestsType string
+	userAgent    string
+}
+
+func (m *meta) WithDatabase(database string) Meta {
+	mm := *m
+	mm.database = database
+	return &mm
+}
+
+func (m *meta) WithCredentials(creds credentials.Credentials) Meta {
+	mm := *m
+	mm.credentials = creds
+	return &mm
+}
+
+func (m *meta) WithUserAgent(userAgent string) Meta {
+	mm := *m
+	mm.userAgent = userAgent
+	return &mm
 }
 
 func (m *meta) meta(ctx context.Context) (_ metadata.MD, err error) {
@@ -60,6 +85,11 @@ func (m *meta) meta(ctx context.Context) (_ metadata.MD, err error) {
 			md.Set(metaRequestType, m.requestsType)
 		}
 	}
+	if m.userAgent != "" {
+		if len(md.Get(metaUserAgent)) == 0 {
+			md.Set(metaUserAgent, m.userAgent)
+		}
+	}
 	if m.credentials == nil {
 		return md, nil
 	}

internal/proxy/scripting.go

@@ -14,7 +14,7 @@ type proxyScripting struct {
 	meta   meta.Meta
 }
 
-func (d *proxyScripting) ExecuteYql(
+func (d *proxyScripting) Execute(
 	ctx context.Context,
 	query string,
 	params *table.QueryParameters,
@@ -23,10 +23,10 @@ func (d *proxyScripting) ExecuteYql(
 	if err != nil {
 		return nil, err
 	}
-	return d.client.ExecuteYql(ctx, query, params)
+	return d.client.Execute(ctx, query, params)
 }
 
-func (d *proxyScripting) ExplainYql(
+func (d *proxyScripting) Explain(
 	ctx context.Context,
 	query string,
 	mode scripting.ExplainMode,
@@ -35,10 +35,10 @@ func (d *proxyScripting) ExplainYql(
 	if err != nil {
 		return e, err
 	}
-	return d.client.ExplainYql(ctx, query, mode)
+	return d.client.Explain(ctx, query, mode)
 }
 
-func (d *proxyScripting) StreamExecuteYql(
+func (d *proxyScripting) StreamExecute(
 	ctx context.Context,
 	query string,
 	params *table.QueryParameters,
@@ -47,7 +47,7 @@ func (d *proxyScripting) StreamExecuteYql(
 	if err != nil {
 		return nil, err
 	}
-	return d.client.StreamExecuteYql(ctx, query, params)
+	return d.client.StreamExecute(ctx, query, params)
 }
 
 func Scripting(client scripting.Client, meta meta.Meta) scripting.Client {

internal/scripting/scripting.go

@@ -12,16 +12,18 @@ import (
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/errors"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/table/scanner"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/value"
 	"github.com/ydb-platform/ydb-go-sdk/v3/scripting"
 	"github.com/ydb-platform/ydb-go-sdk/v3/table"
 	"github.com/ydb-platform/ydb-go-sdk/v3/table/result"
+	"github.com/ydb-platform/ydb-go-sdk/v3/table/types"
 )
 
 type client struct {
 	service Ydb_Scripting_V1.ScriptingServiceClient
 }
 
-func (c *client) ExecuteYql(
+func (c *client) Execute(
 	ctx context.Context,
 	query string,
 	params *table.QueryParameters,
@@ -53,11 +55,11 @@ func mode2mode(mode scripting.ExplainMode) Ydb_Scripting.ExplainYqlRequest_Mode
 	}
 }
 
-func (c *client) ExplainYql(
+func (c *client) Explain(
 	ctx context.Context,
 	query string,
 	mode scripting.ExplainMode,
-) (_ table.ScriptingYQLExplanation, err error) {
+) (e table.ScriptingYQLExplanation, err error) {
 	var (
 		request = &Ydb_Scripting.ExplainYqlRequest{
 			Script: query,
@@ -74,14 +76,20 @@ func (c *client) ExplainYql(
 	if err != nil {
 		return
 	}
-	return table.ScriptingYQLExplanation{
+	result.GetParametersTypes()
+	e = table.ScriptingYQLExplanation{
 		Explanation: table.Explanation{
 			Plan: result.GetPlan(),
 		},
-	}, nil
+		ParameterTypes: make(map[string]types.Type, len(result.GetParametersTypes())),
+	}
+	for k, v := range result.GetParametersTypes() {
+		e.ParameterTypes[k] = value.TypeFromYDB(v)
+	}
+	return e, nil
 }
 
-func (c *client) StreamExecuteYql(
+func (c *client) StreamExecute(
 	ctx context.Context,
 	query string,
 	params *table.QueryParameters,

internal/value/type.go

@@ -8,6 +8,7 @@ import (
 )
 
 type T interface {
+	String() string
 	toYDB() *Ydb.Type
 	toString(*bytes.Buffer)
 	equal(T) bool

options.go

@@ -31,6 +31,13 @@ func WithAccessTokenCredentials(accessToken string) Option {
 	)
 }
 
+func WithUserAgent(userAgent string) Option {
+	return func(ctx context.Context, c *connection) error {
+		c.options = append(c.options, config.WithUserAgent(userAgent))
+		return nil
+	}
+}
+
 func WithConnectionString(dsn string) Option {
 	return func(ctx context.Context, c *connection) error {
 		params, err := ConnectionString(dsn)