From 9eccdd6a810ba1728f509a6a3905ced1aa96dee6 Mon Sep 17 00:00:00 2001 From: djsavvy Date: Sat, 29 Jan 2022 17:28:05 -0500 Subject: [PATCH 1/7] Clarify that Values() and Scan() require Next() to have been called on the rows object --- rows.go | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/rows.go b/rows.go index d57d5cbf..271c6e52 100644 --- a/rows.go +++ b/rows.go @@ -41,10 +41,13 @@ type Rows interface { // Scan reads the values from the current row into dest values positionally. // dest can include pointers to core types, values implementing the Scanner - // interface, and nil. nil will skip the value entirely. + // interface, and nil. nil will skip the value entirely. It is an error to + // call Scan without first calling Next() and checking that it returned true. Scan(dest ...interface{}) error - // Values returns the decoded row values. + // Values returns the decoded row values. As with Scan(), it is an error to + // call Values without first calling Next() and checking that it returned + // true. Values() ([]interface{}, error) // RawValues returns the unparsed bytes of the row values. The returned [][]byte is only valid until the next Next From d02b2ed013c33fbb5795b55e52aad4a1fb658f62 Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Sat, 5 Feb 2022 20:11:58 -0600 Subject: [PATCH 2/7] Add batch test for QueryRow without any rows refs #1150 --- batch_test.go | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/batch_test.go b/batch_test.go index 988a1682..309ae11d 100644 --- a/batch_test.go +++ b/batch_test.go @@ -2,6 +2,7 @@ package pgx_test import ( "context" + "errors" "os" "testing" @@ -33,6 +34,7 @@ func TestConnSendBatch(t *testing.T) { batch.Queue("insert into ledger(description, amount) values($1, $2)", "q3", 3) batch.Queue("select id, description, amount from ledger order by id") batch.Queue("select id, description, amount from ledger order by id") + batch.Queue("select * from ledger where false") batch.Queue("select sum(amount) from ledger") br := conn.SendBatch(context.Background(), batch) @@ -127,6 +129,11 @@ func TestConnSendBatch(t *testing.T) { t.Error(err) } + err = br.QueryRow().Scan(&id, &description, &amount) + if !errors.Is(err, pgx.ErrNoRows) { + t.Errorf("expected pgx.ErrNoRows but got: %v", err) + } + err = br.QueryRow().Scan(&amount) if err != nil { t.Error(err) From e8857f04a18e8650975d787b46fe280cf49bb9d4 Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Mon, 7 Feb 2022 10:44:39 -0600 Subject: [PATCH 3/7] Make BatchResults.Close safe to be called multiple times https://github.com/jackc/pgx/issues/1138 https://github.com/jackc/pgx/issues/938 --- batch.go | 33 ++++++++++++++++++++++------ pgxpool/pool_test.go | 52 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+), 7 deletions(-) diff --git a/batch.go b/batch.go index f0479ea6..7f86ad5c 100644 --- a/batch.go +++ b/batch.go @@ -3,6 +3,7 @@ package pgx import ( "context" "errors" + "fmt" "github.com/jackc/pgconn" ) @@ -46,17 +47,18 @@ type BatchResults interface { // Close closes the batch operation. This must be called before the underlying connection can be used again. Any error // that occurred during a batch operation may have made it impossible to resyncronize the connection with the server. - // In this case the underlying connection will have been closed. + // In this case the underlying connection will have been closed. Close is safe to call multiple times. Close() error } type batchResults struct { - ctx context.Context - conn *Conn - mrr *pgconn.MultiResultReader - err error - b *Batch - ix int + ctx context.Context + conn *Conn + mrr *pgconn.MultiResultReader + err error + b *Batch + ix int + closed bool } // Exec reads the results from the next query in the batch as if the query has been sent with Exec. @@ -64,6 +66,9 @@ func (br *batchResults) Exec() (pgconn.CommandTag, error) { if br.err != nil { return nil, br.err } + if br.closed { + return nil, fmt.Errorf("batch already closed") + } query, arguments, _ := br.nextQueryAndArgs() @@ -114,6 +119,11 @@ func (br *batchResults) Query() (Rows, error) { return &connRows{err: br.err, closed: true}, br.err } + if br.closed { + alreadyClosedErr := fmt.Errorf("batch already closed") + return &connRows{err: alreadyClosedErr, closed: true}, alreadyClosedErr + } + rows := br.conn.getRows(br.ctx, query, arguments) if !br.mrr.NextResult() { @@ -140,6 +150,10 @@ func (br *batchResults) Query() (Rows, error) { // QueryFunc reads the results from the next query in the batch as if the query has been sent with Conn.QueryFunc. func (br *batchResults) QueryFunc(scans []interface{}, f func(QueryFuncRow) error) (pgconn.CommandTag, error) { + if br.closed { + return nil, fmt.Errorf("batch already closed") + } + rows, err := br.Query() if err != nil { return nil, err @@ -179,6 +193,11 @@ func (br *batchResults) Close() error { return br.err } + if br.closed { + return nil + } + br.closed = true + // log any queries that haven't yet been logged by Exec or Query for { query, args, ok := br.nextQueryAndArgs() diff --git a/pgxpool/pool_test.go b/pgxpool/pool_test.go index 54b688a1..9a813ae2 100644 --- a/pgxpool/pool_test.go +++ b/pgxpool/pool_test.go @@ -979,3 +979,55 @@ func TestCreateMinPoolReturnsFirstError(t *testing.T) { require.True(t, connectAttempts >= 5, "Expected %d got %d", 5, connectAttempts) require.ErrorIs(t, err, mockErr) } + +func TestPoolSendBatchBatchCloseTwice(t *testing.T) { + t.Parallel() + + pool, err := pgxpool.Connect(context.Background(), os.Getenv("PGX_TEST_DATABASE")) + require.NoError(t, err) + defer pool.Close() + + errChan := make(chan error) + testCount := 5000 + + for i := 0; i < testCount; i++ { + go func() { + batch := &pgx.Batch{} + batch.Queue("select 1") + batch.Queue("select 2") + + br := pool.SendBatch(context.Background(), batch) + defer br.Close() + + var err error + var n int32 + err = br.QueryRow().Scan(&n) + if err != nil { + errChan <- err + return + } + if n != 1 { + errChan <- fmt.Errorf("expected 1 got %v", n) + return + } + + err = br.QueryRow().Scan(&n) + if err != nil { + errChan <- err + return + } + if n != 2 { + errChan <- fmt.Errorf("expected 2 got %v", n) + return + } + + err = br.Close() + errChan <- err + }() + } + + for i := 0; i < testCount; i++ { + err := <-errChan + assert.NoError(t, err) + } +} From c9eefd852a0d524689b6aceec84648abfc2db117 Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Mon, 7 Feb 2022 10:48:30 -0600 Subject: [PATCH 4/7] Upgrade to puddle v1.2.1 --- go.mod | 2 +- go.sum | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 1bc04650..6eb7d0ed 100644 --- a/go.mod +++ b/go.mod @@ -11,7 +11,7 @@ require ( github.com/jackc/pgio v1.0.0 github.com/jackc/pgproto3/v2 v2.2.0 github.com/jackc/pgtype v1.9.1 - github.com/jackc/puddle v1.2.0 + github.com/jackc/puddle v1.2.1 github.com/rs/zerolog v1.15.0 github.com/shopspring/decimal v1.2.0 github.com/sirupsen/logrus v1.4.2 diff --git a/go.sum b/go.sum index 90193e6d..61317f56 100644 --- a/go.sum +++ b/go.sum @@ -77,6 +77,8 @@ github.com/jackc/puddle v1.1.4 h1:5Ey/o5IfV7dYX6Znivq+N9MdK1S18OJI5OJq6EAAADw= github.com/jackc/puddle v1.1.4/go.mod h1:m4B5Dj62Y0fbyuIc15OsIqK0+JU8nkqQjsgx7dvjSWk= github.com/jackc/puddle v1.2.0 h1:DNDKdn/pDrWvDWyT2FYvpZVE81OAhWrjCv19I9n108Q= github.com/jackc/puddle v1.2.0/go.mod h1:m4B5Dj62Y0fbyuIc15OsIqK0+JU8nkqQjsgx7dvjSWk= +github.com/jackc/puddle v1.2.1 h1:gI8os0wpRXFd4FiAY2dWiqRK037tjj3t7rKFeO4X5iw= +github.com/jackc/puddle v1.2.1/go.mod h1:m4B5Dj62Y0fbyuIc15OsIqK0+JU8nkqQjsgx7dvjSWk= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/konsorten/go-windows-terminal-sequences v1.0.2 h1:DB17ag19krx9CFsz4o3enTrPXyIXCl+2iCXH/aMAp9s= From 6fea8eba5eb8da482e2b8b6cf4e54ffb8980e058 Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Mon, 7 Feb 2022 10:52:30 -0600 Subject: [PATCH 5/7] Upgrade to pgtype v1.10.0 --- go.mod | 2 +- go.sum | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 6eb7d0ed..050818d1 100644 --- a/go.mod +++ b/go.mod @@ -10,7 +10,7 @@ require ( github.com/jackc/pgconn v1.10.1 github.com/jackc/pgio v1.0.0 github.com/jackc/pgproto3/v2 v2.2.0 - github.com/jackc/pgtype v1.9.1 + github.com/jackc/pgtype v1.10.0 github.com/jackc/puddle v1.2.1 github.com/rs/zerolog v1.15.0 github.com/shopspring/decimal v1.2.0 diff --git a/go.sum b/go.sum index 61317f56..dd20bf99 100644 --- a/go.sum +++ b/go.sum @@ -65,6 +65,8 @@ github.com/jackc/pgtype v1.9.0 h1:/SH1RxEtltvJgsDqp3TbiTFApD3mey3iygpuEGeuBXk= github.com/jackc/pgtype v1.9.0/go.mod h1:LUMuVrfsFfdKGLw+AFFVv6KtHOFMwRgDDzBt76IqCA4= github.com/jackc/pgtype v1.9.1 h1:MJc2s0MFS8C3ok1wQTdQxWuXQcB6+HwAm5x1CzW7mf0= github.com/jackc/pgtype v1.9.1/go.mod h1:LUMuVrfsFfdKGLw+AFFVv6KtHOFMwRgDDzBt76IqCA4= +github.com/jackc/pgtype v1.10.0 h1:ILnBWrRMSXGczYvmkYD6PsYyVFUNLTnIUJHHDLmqk38= +github.com/jackc/pgtype v1.10.0/go.mod h1:LUMuVrfsFfdKGLw+AFFVv6KtHOFMwRgDDzBt76IqCA4= github.com/jackc/pgx/v4 v4.0.0-20190420224344-cc3461e65d96/go.mod h1:mdxmSJJuR08CZQyj1PVQBHy9XOp5p8/SHH6a0psbY9Y= github.com/jackc/pgx/v4 v4.0.0-20190421002000-1b8f0016e912/go.mod h1:no/Y67Jkk/9WuGR0JG/JseM9irFbnEPbuWV2EELPNuM= github.com/jackc/pgx/v4 v4.0.0-pre1.0.20190824185557-6972a5742186/go.mod h1:X+GQnOEnf1dqHGpw7JmHqHc1NxDoalibchSk9/RWuDc= From 67401de1c3b30eec4c5f4c2c35341d69ba9b95d7 Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Mon, 7 Feb 2022 10:55:29 -0600 Subject: [PATCH 6/7] Upgrade to pgconn v1.11.0 --- go.mod | 2 +- go.sum | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 050818d1..b0f68589 100644 --- a/go.mod +++ b/go.mod @@ -7,7 +7,7 @@ require ( github.com/cockroachdb/apd v1.1.0 github.com/go-kit/log v0.1.0 github.com/gofrs/uuid v4.0.0+incompatible - github.com/jackc/pgconn v1.10.1 + github.com/jackc/pgconn v1.11.0 github.com/jackc/pgio v1.0.0 github.com/jackc/pgproto3/v2 v2.2.0 github.com/jackc/pgtype v1.10.0 diff --git a/go.sum b/go.sum index dd20bf99..aa5a3ae9 100644 --- a/go.sum +++ b/go.sum @@ -34,6 +34,8 @@ github.com/jackc/pgconn v1.10.0 h1:4EYhlDVEMsJ30nNj0mmgwIUXoq7e9sMJrVC2ED6QlCU= github.com/jackc/pgconn v1.10.0/go.mod h1:4z2w8XhRbP1hYxkpTuBjTS3ne3J48K83+u0zoyvg2pI= github.com/jackc/pgconn v1.10.1 h1:DzdIHIjG1AxGwoEEqS+mGsURyjt4enSmqzACXvVzOT8= github.com/jackc/pgconn v1.10.1/go.mod h1:4z2w8XhRbP1hYxkpTuBjTS3ne3J48K83+u0zoyvg2pI= +github.com/jackc/pgconn v1.11.0 h1:HiHArx4yFbwl91X3qqIHtUFoiIfLNJXCQRsnzkiwwaQ= +github.com/jackc/pgconn v1.11.0/go.mod h1:4z2w8XhRbP1hYxkpTuBjTS3ne3J48K83+u0zoyvg2pI= github.com/jackc/pgio v1.0.0 h1:g12B9UwVnzGhueNavwioyEEpAmqMe1E/BN9ES+8ovkE= github.com/jackc/pgio v1.0.0/go.mod h1:oP+2QK2wFfUWgr+gxjoBH9KGBb31Eio69xUb0w5bYf8= github.com/jackc/pgmock v0.0.0-20190831213851-13a1b77aafa2/go.mod h1:fGZlG77KXmcq05nJLRkk0+p82V8B8Dw8KN2/V9c/OAE= From 2b7de82ef43e637b3ef444f9d8162e50f1cab3ee Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Mon, 7 Feb 2022 11:03:06 -0600 Subject: [PATCH 7/7] Release v4.15.0 --- CHANGELOG.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 198a6ea4..4dd93b30 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +# 4.15.0 (February 7, 2022) + +* Upgrade to pgconn v1.11.0 +* Upgrade to pgtype v1.10.0 +* Upgrade puddle to v1.2.1 +* Make BatchResults.Close safe to be called multiple times + # 4.14.1 (November 28, 2021) * Upgrade pgtype to v1.9.1 (fixes unintentional change to timestamp binary decoding)