From 378ccb8945ae9719dd985a87ce49f69d6a2f8eee Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Mon, 31 Dec 2018 17:46:56 -0600 Subject: [PATCH] PG error type is *pgconn.PgError --- batch_test.go | 7 ++++--- conn.go | 6 +++--- conn_pool_test.go | 5 +++-- conn_test.go | 3 ++- copy_from_test.go | 11 ++++++----- copy_to_test.go | 4 ++-- large_objects_test.go | 5 +++-- messages.go | 4 +--- pgconn/pgconn.go | 10 +++++----- pgconn/pgconn_test.go | 4 ++-- query_test.go | 3 ++- stress_test.go | 3 ++- tx_test.go | 4 ++-- v4.md | 5 +++-- 14 files changed, 40 insertions(+), 34 deletions(-) diff --git a/batch_test.go b/batch_test.go index 98772f62..e302a794 100644 --- a/batch_test.go +++ b/batch_test.go @@ -6,6 +6,7 @@ import ( "testing" "github.com/jackc/pgx" + "github.com/jackc/pgx/pgconn" "github.com/jackc/pgx/pgtype" ) @@ -430,12 +431,12 @@ func TestConnBeginBatchQueryError(t *testing.T) { } } - if pgErr, ok := rows.Err().(pgx.PgError); !(ok && pgErr.Code == "22012") { + if pgErr, ok := rows.Err().(*pgconn.PgError); !(ok && pgErr.Code == "22012") { t.Errorf("rows.Err() => %v, want error code %v", rows.Err(), 22012) } err = batch.Close() - if pgErr, ok := err.(pgx.PgError); !(ok && pgErr.Code == "22012") { + if pgErr, ok := err.(*pgconn.PgError); !(ok && pgErr.Code == "22012") { t.Errorf("rows.Err() => %v, want error code %v", err, 22012) } @@ -464,7 +465,7 @@ func TestConnBeginBatchQuerySyntaxError(t *testing.T) { var n int32 err = batch.QueryRowResults().Scan(&n) - if pgErr, ok := err.(pgx.PgError); !(ok && pgErr.Code == "42601") { + if pgErr, ok := err.(*pgconn.PgError); !(ok && pgErr.Code == "42601") { t.Errorf("rows.Err() => %v, want error code %v", err, 42601) } diff --git a/conn.go b/conn.go index e0f9a01e..dd9b8e27 100644 --- a/conn.go +++ b/conn.go @@ -449,7 +449,7 @@ func (c *Conn) crateDBTypesQuery(err error) (*pgtype.ConnInfo, error) { // [2] https://github.com/crate/crate/issues/5027 // [3] https://github.com/jackc/pgx/issues/320 - if pgErr, ok := err.(PgError); ok && + if pgErr, ok := err.(*pgconn.PgError); ok && (pgErr.Code == "XX000" || strings.Contains(pgErr.Message, "TableUnknownException") || strings.Contains(pgErr.Message, "ColumnUnknownException")) { @@ -922,8 +922,8 @@ func hexMD5(s string) string { return hex.EncodeToString(hash.Sum(nil)) } -func (c *Conn) rxErrorResponse(msg *pgproto3.ErrorResponse) PgError { - err := PgError{ +func (c *Conn) rxErrorResponse(msg *pgproto3.ErrorResponse) *pgconn.PgError { + err := &pgconn.PgError{ Severity: msg.Severity, Code: msg.Code, Message: msg.Message, diff --git a/conn_pool_test.go b/conn_pool_test.go index 5331fbd4..aed9d00f 100644 --- a/conn_pool_test.go +++ b/conn_pool_test.go @@ -12,6 +12,7 @@ import ( "github.com/pkg/errors" "github.com/jackc/pgx" + "github.com/jackc/pgx/pgconn" ) func createConnPool(t *testing.T, maxConnections int) *pgx.ConnPool { @@ -892,7 +893,7 @@ func TestConnPoolPrepare(t *testing.T) { } err = pool.QueryRow("test", "hello").Scan(&s) - if err, ok := err.(pgx.PgError); !(ok && err.Code == "42601") { + if err, ok := err.(*pgconn.PgError); !(ok && err.Code == "42601") { t.Errorf("Expected error calling deallocated prepared statement, but got: %v", err) } } @@ -996,7 +997,7 @@ func TestConnPoolPrepareWhenConnIsAlreadyAcquired(t *testing.T) { var s string err = pool.QueryRow("test", "hello").Scan(&s) - if err, ok := err.(pgx.PgError); !(ok && err.Code == "42601") { + if err, ok := err.(*pgconn.PgError); !(ok && err.Code == "42601") { t.Errorf("Expected error calling deallocated prepared statement, but got: %v", err) } } diff --git a/conn_test.go b/conn_test.go index 5b70a9ac..784f3168 100644 --- a/conn_test.go +++ b/conn_test.go @@ -11,6 +11,7 @@ import ( "time" "github.com/jackc/pgx" + "github.com/jackc/pgx/pgconn" "github.com/jackc/pgx/pgtype" "github.com/stretchr/testify/require" ) @@ -874,7 +875,7 @@ func TestFatalRxError(t *testing.T) { var s string err := conn.QueryRow("select 1::int4, pg_sleep(10)::varchar").Scan(&n, &s) if err == pgx.ErrDeadConn { - } else if pgErr, ok := err.(pgx.PgError); ok && pgErr.Severity == "FATAL" { + } else if pgErr, ok := err.(*pgconn.PgError); ok && pgErr.Severity == "FATAL" { } else { t.Fatalf("Expected QueryRow Scan to return fatal PgError or ErrDeadConn, but instead received %v", err) } diff --git a/copy_from_test.go b/copy_from_test.go index 9481c476..73c27e18 100644 --- a/copy_from_test.go +++ b/copy_from_test.go @@ -12,6 +12,7 @@ import ( "time" "github.com/jackc/pgx" + "github.com/jackc/pgx/pgconn" "github.com/pkg/errors" ) @@ -332,7 +333,7 @@ func TestConnCopyFromFailServerSideMidway(t *testing.T) { if err == nil { t.Errorf("Expected CopyFrom return error, but it did not") } - if _, ok := err.(pgx.PgError); !ok { + if _, ok := err.(*pgconn.PgError); !ok { t.Errorf("Expected CopyFrom return pgx.PgError, but instead it returned: %v", err) } if copyCount != 0 { @@ -367,7 +368,7 @@ func TestConnCopyFromFailServerSideMidway(t *testing.T) { if err == nil { t.Errorf("Expected CopyFromReader return error, but it did not") } - if _, ok := err.(pgx.PgError); !ok { + if _, ok := err.(*pgconn.PgError); !ok { t.Errorf("Expected CopyFromReader return pgx.PgError, but instead it returned: %v", err) } copyCount = int(res.RowsAffected()) @@ -437,7 +438,7 @@ func TestConnCopyFromFailServerSideMidwayAbortsWithoutWaiting(t *testing.T) { if err == nil { t.Errorf("Expected CopyFrom return error, but it did not") } - if _, ok := err.(pgx.PgError); !ok { + if _, ok := err.(*pgconn.PgError); !ok { t.Errorf("Expected CopyFrom return pgx.PgError, but instead it returned: %v", err) } if copyCount != 0 { @@ -637,7 +638,7 @@ func TestConnCopyFromReaderQueryError(t *testing.T) { t.Errorf("Expected CopyFromReader return error, but it did not") } - if _, ok := err.(pgx.PgError); !ok { + if _, ok := err.(*pgconn.PgError); !ok { t.Errorf("Expected CopyFromReader return pgx.PgError, but instead it returned: %v", err) } @@ -662,7 +663,7 @@ func TestConnCopyFromReaderNoTableError(t *testing.T) { t.Errorf("Expected CopyFromReader return error, but it did not") } - if _, ok := err.(pgx.PgError); !ok { + if _, ok := err.(*pgconn.PgError); !ok { t.Errorf("Expected CopyFromReader return pgx.PgError, but instead it returned: %v", err) } diff --git a/copy_to_test.go b/copy_to_test.go index 1c2f8a6c..de0b00dc 100644 --- a/copy_to_test.go +++ b/copy_to_test.go @@ -5,7 +5,7 @@ import ( "os" "testing" - "github.com/jackc/pgx" + "github.com/jackc/pgx/pgconn" ) func TestConnCopyToWriterSmall(t *testing.T) { @@ -103,7 +103,7 @@ func TestConnCopyToWriterQueryError(t *testing.T) { t.Errorf("Expected CopyToWriter return error, but it did not") } - if _, ok := err.(pgx.PgError); !ok { + if _, ok := err.(*pgconn.PgError); !ok { t.Errorf("Expected CopyToWriter return pgx.PgError, but instead it returned: %v", err) } diff --git a/large_objects_test.go b/large_objects_test.go index 5192ac4f..e6279822 100644 --- a/large_objects_test.go +++ b/large_objects_test.go @@ -7,6 +7,7 @@ import ( "testing" "github.com/jackc/pgx" + "github.com/jackc/pgx/pgconn" ) func TestLargeObjects(t *testing.T) { @@ -117,7 +118,7 @@ func TestLargeObjects(t *testing.T) { } _, err = lo.Open(id, pgx.LargeObjectModeRead) - if e, ok := err.(pgx.PgError); !ok || e.Code != "42704" { + if e, ok := err.(*pgconn.PgError); !ok || e.Code != "42704" { t.Errorf("Expected undefined_object error (42704), got %#v", err) } } @@ -261,7 +262,7 @@ func TestLargeObjectsMultipleTransactions(t *testing.T) { } _, err = lo2.Open(id, pgx.LargeObjectModeRead) - if e, ok := err.(pgx.PgError); !ok || e.Code != "42704" { + if e, ok := err.(*pgconn.PgError); !ok || e.Code != "42704" { t.Errorf("Expected undefined_object error (42704), got %#v", err) } } diff --git a/messages.go b/messages.go index 9b6db02d..633ddad1 100644 --- a/messages.go +++ b/messages.go @@ -79,11 +79,9 @@ func (fd FieldDescription) Type() reflect.Type { } } -type PgError = pgconn.PgError - // Notice represents a notice response message reported by the PostgreSQL // server. Be aware that this is distinct from LISTEN/NOTIFY notification. -type Notice PgError +type Notice pgconn.PgError // appendParse appends a PostgreSQL wire protocol parse message to buf and returns it. func appendParse(buf []byte, name string, query string, parameterOIDs []pgtype.OID) []byte { diff --git a/pgconn/pgconn.go b/pgconn/pgconn.go index a7c4eea3..fef113e0 100644 --- a/pgconn/pgconn.go +++ b/pgconn/pgconn.go @@ -45,7 +45,7 @@ type PgError struct { Routine string } -func (pe PgError) Error() string { +func (pe *PgError) Error() string { return pe.Severity + ": " + pe.Message + " (SQLSTATE " + pe.Code + ")" } @@ -118,7 +118,7 @@ func ConnectConfig(ctx context.Context, config *Config) (pgConn *PgConn, err err pgConn, err = connect(ctx, config, fc) if err == nil { return pgConn, nil - } else if err, ok := err.(PgError); ok { + } else if err, ok := err.(*PgError); ok { return nil, err } } @@ -199,7 +199,7 @@ func connect(ctx context.Context, config *Config, fallbackConfig *FallbackConfig // handled by ReceiveMessage case *pgproto3.ErrorResponse: pgConn.NetConn.Close() - return nil, PgError{ + return nil, &PgError{ Severity: msg.Severity, Code: msg.Code, Message: msg.Message, @@ -654,8 +654,8 @@ func (pgConn *PgConn) Exec(ctx context.Context, sql string) (*PgResult, error) { return result, nil } -func errorResponseToPgError(msg *pgproto3.ErrorResponse) PgError { - return PgError{ +func errorResponseToPgError(msg *pgproto3.ErrorResponse) *PgError { + return &PgError{ Severity: msg.Severity, Code: msg.Code, Message: msg.Message, diff --git a/pgconn/pgconn_test.go b/pgconn/pgconn_test.go index 741c1b4b..e46093b0 100644 --- a/pgconn/pgconn_test.go +++ b/pgconn/pgconn_test.go @@ -269,7 +269,7 @@ func TestConnExecMultipleQueriesError(t *testing.T) { result, err := pgConn.Exec(context.Background(), "select 1; select 1/0; select 1") require.NotNil(t, err) require.Nil(t, result) - if pgErr, ok := err.(pgconn.PgError); ok { + if pgErr, ok := err.(*pgconn.PgError); ok { assert.Equal(t, "22012", pgErr.Code) } else { t.Errorf("unexpected error: %v", err) @@ -331,7 +331,7 @@ func TestConnCancelQuery(t *testing.T) { require.Nil(t, err) _, err = pgConn.GetResult(context.Background()).Close() - if err, ok := err.(pgconn.PgError); ok { + if err, ok := err.(*pgconn.PgError); ok { assert.Equal(t, "57014", err.Code) } else { t.Errorf("expected pgconn.PgError got %v", err) diff --git a/query_test.go b/query_test.go index c617f109..07e7b2c4 100644 --- a/query_test.go +++ b/query_test.go @@ -13,6 +13,7 @@ import ( "github.com/cockroachdb/apd" "github.com/jackc/pgx" + "github.com/jackc/pgx/pgconn" "github.com/jackc/pgx/pgtype" satori "github.com/jackc/pgx/pgtype/ext/satori-uuid" uuid "github.com/satori/go.uuid" @@ -415,7 +416,7 @@ func TestConnQueryErrorWhileReturningRows(t *testing.T) { rows.Scan(&n) } - if err, ok := rows.Err().(pgx.PgError); !ok { + if err, ok := rows.Err().(*pgconn.PgError); !ok { t.Fatalf("Expected pgx.PgError, got %v", err) } diff --git a/stress_test.go b/stress_test.go index d6b89c51..6ee49c5e 100644 --- a/stress_test.go +++ b/stress_test.go @@ -13,6 +13,7 @@ import ( "github.com/jackc/fake" "github.com/jackc/pgx" + "github.com/jackc/pgx/pgconn" ) type execer interface { @@ -190,7 +191,7 @@ func queryErrorWhileReturningRows(q queryer, actionNum int) error { rows.Scan(&n) } - if _, ok := rows.Err().(pgx.PgError); ok { + if _, ok := rows.Err().(*pgconn.PgError); ok { return nil } return rows.Err() diff --git a/tx_test.go b/tx_test.go index 133f1d3b..32a2ab08 100644 --- a/tx_test.go +++ b/tx_test.go @@ -142,7 +142,7 @@ func TestTxCommitSerializationFailure(t *testing.T) { } err = tx2.Commit() - if pgErr, ok := err.(pgx.PgError); !ok || pgErr.Code != "40001" { + if pgErr, ok := err.(*pgconn.PgError); !ok || pgErr.Code != "40001" { t.Fatalf("Expected serialization error 40001, got %#v", err) } } @@ -228,7 +228,7 @@ func TestBeginExReadOnly(t *testing.T) { defer tx.Rollback() _, err = conn.Exec("create table foo(id serial primary key)") - if pgErr, ok := err.(pgx.PgError); !ok || pgErr.Code != "25006" { + if pgErr, ok := err.(*pgconn.PgError); !ok || pgErr.Code != "25006" { t.Errorf("Expected error SQLSTATE 25006, but got %#v", err) } } diff --git a/v4.md b/v4.md index 326668a8..6396500d 100644 --- a/v4.md +++ b/v4.md @@ -34,8 +34,9 @@ Minor Potential Changes: ## Changes -`pgconn.PgConn` now contains core PostgreSQL connection functionality. -Test configuration now done with environment variables instead of `.gitignore`'d locally modified `conn_config_test.go` file. +* `pgconn.PgConn` now contains core PostgreSQL connection functionality. +* Test configuration now done with environment variables instead of `.gitignore`'d locally modified `conn_config_test.go` file. +* PostgreSQL errors are now `*pgconn.PgError` instead of `pgx.PgError`. ### Incompatible Changes