Merge pull request #874 from ydb-platform/xstring-buffer

* Moved `internal/allocator.Buffers` to package `internal/xstring`
ydb-platform · Oct 23, 2023 · 15ba102 · 15ba102
2 parents e1a1bb5 + 94565ea
commit 15ba102
Show file tree

Hide file tree

Showing 25 changed files with 152 additions and 134 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,4 @@
+* Moved `internal/allocator.Buffers` to package `internal/xstring`
 * Bumped `golang.org/x/sync` to `v0.3.0`
 * Bumped `google.golang.org/protobuf` to `v1.31.0`
 * Bumped `google.golang.org/grpc` to `v1.57.1`

diff --git a/internal/allocator/allocator.go b/internal/allocator/allocator.go
@@ -4,9 +4,6 @@
 package allocator
 
 import (
-	"bytes"
-	"sync"
-
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb"
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb_Table"
 )
@@ -192,22 +189,3 @@ func (a *Allocator) TableQueryID(id string) (v *Ydb_Table.Query_Id) {
 		Id: id,
 	}
 }
-
-var Buffers = &buffersPoolType{}
-
-type buffersPoolType struct {
-	sync.Pool
-}
-
-func (p *buffersPoolType) Get() *bytes.Buffer {
-	v := p.Pool.Get()
-	if v == nil {
-		v = new(bytes.Buffer)
-	}
-	return v.(*bytes.Buffer)
-}
-
-func (p *buffersPoolType) Put(b *bytes.Buffer) {
-	b.Reset()
-	p.Pool.Put(b)
-}
diff --git a/internal/allocator/allocator_go1.18.go b/internal/allocator/allocator_go1.18.go
@@ -4,7 +4,6 @@
 package allocator
 
 import (
-	"bytes"
 	"sync"
 
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb"
@@ -880,17 +879,7 @@ func (p *Pool[T]) Put(t *T) {
 	(*sync.Pool)(p).Put(t)
 }
 
-type buffersPoolType struct {
-	Pool[bytes.Buffer]
-}
-
-func (p *buffersPoolType) Put(b *bytes.Buffer) {
-	b.Reset()
-	p.Pool.Put(b)
-}
-
 var (
-	Buffers                          = &buffersPoolType{}
 	allocatorPool                    Pool[Allocator]
 	valuePool                        Pool[Ydb.Value]
 	typePool                         Pool[Ydb.Type]

diff --git a/internal/bind/auto_declare.go b/internal/bind/auto_declare.go
@@ -3,8 +3,8 @@ package bind
 import (
 	"sort"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 )
 
 type AutoDeclare struct{}
@@ -27,9 +27,9 @@ func (m AutoDeclare) RewriteQuery(query string, args ...interface{}) (
 
 	var (
 		declares = make([]string, 0, len(params))
-		buffer   = allocator.Buffers.Get()
+		buffer   = xstring.Buffer()
 	)
-	defer allocator.Buffers.Put(buffer)
+	defer buffer.Free()
 
 	buffer.WriteString("-- bind declares\n")
 

diff --git a/internal/bind/bind.go b/internal/bind/bind.go
@@ -3,8 +3,8 @@ package bind
 import (
 	"sort"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 	"github.com/ydb-platform/ydb-go-sdk/v3/table"
 )
 
@@ -38,8 +38,8 @@ func (bindings Bindings) RewriteQuery(query string, args ...interface{}) (
 		return query, table.NewQueryParameters(params...), nil
 	}
 
-	buffer := allocator.Buffers.Get()
-	defer allocator.Buffers.Put(buffer)
+	buffer := xstring.Buffer()
+	defer buffer.Free()
 
 	for i := range bindings {
 		query, args, err = bindings[len(bindings)-1-i].RewriteQuery(query, args...)

diff --git a/internal/bind/numeric_args.go b/internal/bind/numeric_args.go
@@ -5,8 +5,8 @@ import (
 	"strconv"
 	"unicode/utf8"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 	"github.com/ydb-platform/ydb-go-sdk/v3/table"
 )
 
@@ -30,10 +30,10 @@ func (m NumericArgs) RewriteQuery(sql string, args ...interface{}) (
 	}
 
 	var (
-		buffer = allocator.Buffers.Get()
+		buffer = xstring.Buffer()
 		param  table.ParameterOption
 	)
-	defer allocator.Buffers.Put(buffer)
+	defer buffer.Free()
 
 	if len(args) > 0 {
 		newArgs = make([]interface{}, len(args))

diff --git a/internal/bind/positional_args.go b/internal/bind/positional_args.go
@@ -5,8 +5,8 @@ import (
 	"strconv"
 	"unicode/utf8"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 	"github.com/ydb-platform/ydb-go-sdk/v3/table"
 )
 
@@ -30,11 +30,11 @@ func (m PositionalArgs) RewriteQuery(sql string, args ...interface{}) (
 	}
 
 	var (
-		buffer   = allocator.Buffers.Get()
+		buffer   = xstring.Buffer()
 		position = 0
 		param    table.ParameterOption
 	)
-	defer allocator.Buffers.Put(buffer)
+	defer buffer.Free()
 
 	for _, p := range l.parts {
 		switch p := p.(type) {

diff --git a/internal/bind/table_path_prefix.go b/internal/bind/table_path_prefix.go
@@ -4,7 +4,7 @@ import (
 	"path"
 	"strings"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 )
 
 type TablePathPrefix string
@@ -27,8 +27,8 @@ func (tablePathPrefix TablePathPrefix) NormalizePath(folderOrTable string) strin
 func (tablePathPrefix TablePathPrefix) RewriteQuery(query string, args ...interface{}) (
 	yql string, newArgs []interface{}, err error,
 ) {
-	buffer := allocator.Buffers.Get()
-	defer allocator.Buffers.Put(buffer)
+	buffer := xstring.Buffer()
+	defer buffer.Free()
 
 	buffer.WriteString("-- bind TablePathPrefix\n")
 	buffer.WriteString("PRAGMA TablePathPrefix(\"")

diff --git a/internal/credentials/access_error.go b/internal/credentials/access_error.go
@@ -1,20 +1,20 @@
 package credentials
 
 import (
-	"bytes"
 	"fmt"
+	"io"
 	"reflect"
 	"strconv"
 
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb"
 	grpcCodes "google.golang.org/grpc/codes"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 )
 
 type authErrorOption interface {
-	applyAuthErrorOption(buffer *bytes.Buffer)
+	applyAuthErrorOption(w io.Writer)
 }
 
 var (
@@ -26,9 +26,9 @@ var (
 
 type addressAuthErrorOption string
 
-func (address addressAuthErrorOption) applyAuthErrorOption(buffer *bytes.Buffer) {
-	buffer.WriteString("address:")
-	fmt.Fprintf(buffer, "%q", address)
+func (address addressAuthErrorOption) applyAuthErrorOption(w io.Writer) {
+	fmt.Fprint(w, "address:")
+	fmt.Fprintf(w, "%q", address)
 }
 
 func WithAddress(address string) addressAuthErrorOption {
@@ -37,9 +37,9 @@ func WithAddress(address string) addressAuthErrorOption {
 
 type endpointAuthErrorOption string
 
-func (endpoint endpointAuthErrorOption) applyAuthErrorOption(buffer *bytes.Buffer) {
-	buffer.WriteString("endpoint:")
-	fmt.Fprintf(buffer, "%q", endpoint)
+func (endpoint endpointAuthErrorOption) applyAuthErrorOption(w io.Writer) {
+	fmt.Fprint(w, "endpoint:")
+	fmt.Fprintf(w, "%q", endpoint)
 }
 
 func WithEndpoint(endpoint string) endpointAuthErrorOption {
@@ -48,9 +48,9 @@ func WithEndpoint(endpoint string) endpointAuthErrorOption {
 
 type databaseAuthErrorOption string
 
-func (address databaseAuthErrorOption) applyAuthErrorOption(buffer *bytes.Buffer) {
-	buffer.WriteString("database:")
-	fmt.Fprintf(buffer, "%q", address)
+func (address databaseAuthErrorOption) applyAuthErrorOption(w io.Writer) {
+	fmt.Fprint(w, "database:")
+	fmt.Fprintf(w, "%q", address)
 }
 
 func WithDatabase(database string) databaseAuthErrorOption {
@@ -59,9 +59,9 @@ func WithDatabase(database string) databaseAuthErrorOption {
 
 type nodeIDAuthErrorOption uint32
 
-func (id nodeIDAuthErrorOption) applyAuthErrorOption(buffer *bytes.Buffer) {
-	buffer.WriteString("nodeID:")
-	buffer.WriteString(strconv.FormatUint(uint64(id), 10))
+func (id nodeIDAuthErrorOption) applyAuthErrorOption(w io.Writer) {
+	fmt.Fprint(w, "nodeID:")
+	fmt.Fprint(w, strconv.FormatUint(uint64(id), 10))
 }
 
 func WithNodeID(id uint32) authErrorOption {
@@ -72,13 +72,13 @@ type credentialsUnauthenticatedErrorOption struct {
 	credentials Credentials
 }
 
-func (opt credentialsUnauthenticatedErrorOption) applyAuthErrorOption(buffer *bytes.Buffer) {
-	buffer.WriteString("credentials:")
+func (opt credentialsUnauthenticatedErrorOption) applyAuthErrorOption(w io.Writer) {
+	fmt.Fprint(w, "credentials:")
 	if stringer, has := opt.credentials.(fmt.Stringer); has {
-		fmt.Fprintf(buffer, "%q", stringer.String())
+		fmt.Fprintf(w, "%q", stringer.String())
 	} else {
 		t := reflect.TypeOf(opt.credentials)
-		fmt.Fprintf(buffer, "%q", t.PkgPath()+"."+t.Name())
+		fmt.Fprintf(w, "%q", t.PkgPath()+"."+t.Name())
 	}
 }
 
@@ -89,8 +89,8 @@ func WithCredentials(credentials Credentials) credentialsUnauthenticatedErrorOpt
 }
 
 func AccessError(msg string, err error, opts ...authErrorOption) error {
-	buffer := allocator.Buffers.Get()
-	defer allocator.Buffers.Put(buffer)
+	buffer := xstring.Buffer()
+	defer buffer.Free()
 	buffer.WriteString(msg)
 	buffer.WriteString(" (")
 	for i, opt := range opts {

diff --git a/internal/credentials/access_token.go b/internal/credentials/access_token.go
@@ -4,9 +4,9 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/secret"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/stack"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 )
 
 var (
@@ -44,8 +44,8 @@ func (c AccessToken) Token(_ context.Context) (string, error) {
 
 // Token implements Credentials.
 func (c AccessToken) String() string {
-	buffer := allocator.Buffers.Get()
-	defer allocator.Buffers.Put(buffer)
+	buffer := xstring.Buffer()
+	defer buffer.Free()
 	buffer.WriteString("AccessToken(token:")
 	fmt.Fprintf(buffer, "%q", secret.Token(c.token))
 	if c.sourceInfo != "" {

diff --git a/internal/credentials/anonymous.go b/internal/credentials/anonymous.go
@@ -4,8 +4,8 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/stack"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 )
 
 var (
@@ -40,8 +40,8 @@ func (c Anonymous) Token(_ context.Context) (string, error) {
 
 // Token implements Credentials.
 func (c Anonymous) String() string {
-	buffer := allocator.Buffers.Get()
-	defer allocator.Buffers.Put(buffer)
+	buffer := xstring.Buffer()
+	defer buffer.Free()
 	buffer.WriteString("Anonymous(")
 	if c.sourceInfo != "" {
 		buffer.WriteString("from:")

diff --git a/internal/credentials/static.go b/internal/credentials/static.go
@@ -13,10 +13,10 @@ import (
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb_Operations"
 	"google.golang.org/grpc"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/secret"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/stack"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 )
 
 var (
@@ -145,8 +145,8 @@ func parseExpiresAt(raw string) (expiresAt time.Time, err error) {
 }
 
 func (c *Static) String() string {
-	buffer := allocator.Buffers.Get()
-	defer allocator.Buffers.Put(buffer)
+	buffer := xstring.Buffer()
+	defer buffer.Free()
 	buffer.WriteString("Static(user:")
 	fmt.Fprintf(buffer, "%q", c.user)
 	buffer.WriteString(",password:")

diff --git a/internal/stack/record.go b/internal/stack/record.go
@@ -5,7 +5,7 @@ import (
 	"runtime"
 	"strings"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 )
 
 type recordOptions struct {
@@ -109,8 +109,8 @@ func Record(depth int, opts ...recordOption) string {
 		structName = split[1]
 	}
 
-	buffer := allocator.Buffers.Get()
-	defer allocator.Buffers.Put(buffer)
+	buffer := xstring.Buffer()
+	defer buffer.Free()
 	if optionsHolder.packagePath {
 		buffer.WriteString(pkgPath)
 	}

diff --git a/internal/table/scanner/scanner.go b/internal/table/scanner/scanner.go
@@ -11,7 +11,6 @@ import (
 
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb"
 
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/allocator"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/value"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
@@ -251,8 +250,8 @@ func (s *scanner) reset(set *Ydb.ResultSet, columnNames ...string) {
 }
 
 func (s *scanner) path() string {
-	buf := allocator.Buffers.Get()
-	defer allocator.Buffers.Put(buf)
+	buf := xstring.Buffer()
+	defer buf.Free()
 	_, _ = s.writePathTo(buf)
 	return buf.String()
 }