-
Notifications
You must be signed in to change notification settings - Fork 222
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(storage): move from lib/pq to pgx (#2996)
* refactor(storage): move from lib/pq to pgx Signed-off-by: Roman Dmytrenko <[email protected]> * ignore golang mock files by codecov Signed-off-by: Roman Dmytrenko <[email protected]> * address PR feedback Signed-off-by: Roman Dmytrenko <[email protected]> --------- Signed-off-by: Roman Dmytrenko <[email protected]> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
- Loading branch information
1 parent
722e0bf
commit a2d18fc
Showing
13 changed files
with
356 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,3 +9,4 @@ ignore: | |
| - "rpc/flipt/flipt.pb.*" | ||
| - "rpc/flipt/meta" | ||
| - "ui" | ||
| - "**/mock_*.go" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| package sql | ||
|
|
||
| import ( | ||
| "context" | ||
| "database/sql/driver" | ||
| "time" | ||
|
|
||
| pgx "github.com/jackc/pgx/v5/stdlib" | ||
| ) | ||
|
|
||
| const adaptedDriverOpenTimeout = 60 * time.Second | ||
|
|
||
| // This is the wrapper around sql driver. By default, pgx driver returns connection | ||
| // error with the host, username and password. `adaptedDriver` and `postgresConnector` | ||
| // allow to customize errors and preventing leakage of the credentials to outside. | ||
| func newAdaptedPostgresDriver(d Driver) driver.Driver { | ||
| return &adaptedDriver{origin: &pgx.Driver{}, adapter: d} | ||
| } | ||
|
|
||
| var _ driver.Driver = (*adaptedDriver)(nil) | ||
| var _ driver.DriverContext = (*adaptedDriver)(nil) | ||
|
|
||
| type adaptedDriver struct { | ||
| adapter Driver | ||
| origin driver.DriverContext | ||
| } | ||
|
|
||
| func (d *adaptedDriver) Open(name string) (driver.Conn, error) { | ||
| connector, err := d.OpenConnector(name) | ||
| if err != nil { | ||
| return nil, d.adapter.AdaptError(err) | ||
| } | ||
| ctx, cancel := context.WithTimeout(context.Background(), adaptedDriverOpenTimeout) | ||
| defer cancel() | ||
| return connector.Connect(ctx) | ||
| } | ||
|
|
||
| func (d *adaptedDriver) OpenConnector(name string) (driver.Connector, error) { | ||
| connector, err := d.origin.OpenConnector(name) | ||
| if err != nil { | ||
| return nil, d.adapter.AdaptError(err) | ||
| } | ||
| return &adaptedConnector{origin: connector, driver: d, adapter: d.adapter}, nil | ||
| } | ||
|
|
||
| var _ driver.Connector = (*adaptedConnector)(nil) | ||
|
|
||
| type adaptedConnector struct { | ||
| origin driver.Connector | ||
| driver driver.Driver | ||
| adapter Driver | ||
| } | ||
|
|
||
| func (c *adaptedConnector) Driver() driver.Driver { | ||
| return c.driver | ||
| } | ||
|
|
||
| func (c *adaptedConnector) Connect(ctx context.Context) (driver.Conn, error) { | ||
| conn, err := c.origin.Connect(ctx) | ||
| if err != nil { | ||
| return nil, c.adapter.AdaptError(err) | ||
| } | ||
| return conn, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| package sql | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "testing" | ||
|
|
||
| "github.com/jackc/pgx/v5/pgconn" | ||
| "github.com/stretchr/testify/mock" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestAdaptedDriver(t *testing.T) { | ||
| mockDriver := NewMockDriverContext(t) | ||
| t.Run("failure", func(t *testing.T) { | ||
| name := "pgx://failure" | ||
| mockDriver.On("OpenConnector", name).Return(nil, &pgconn.PgError{}) | ||
| d := &adaptedDriver{origin: mockDriver, adapter: Postgres} | ||
| _, err := d.Open(name) | ||
| require.Error(t, err) | ||
| }) | ||
| t.Run("success", func(t *testing.T) { | ||
| o := newMockConnector(t) | ||
| var mockConn = &mockDriverConn{} | ||
| o.On("Connect", mock.Anything).Once().Return(mockConn, nil) | ||
| name := "pgx://success" | ||
| mockDriver.On("OpenConnector", name).Return(o, nil) | ||
| d := &adaptedDriver{origin: mockDriver, adapter: Postgres} | ||
| conn, err := d.Open(name) | ||
| require.NoError(t, err) | ||
| require.Equal(t, mockConn, conn) | ||
| }) | ||
| } | ||
|
|
||
| func TestAdaptedConnectorConnect(t *testing.T) { | ||
| o := newMockConnector(t) | ||
| d := &adaptedDriver{} | ||
| c := &adaptedConnector{ | ||
| origin: o, | ||
| adapter: Postgres, | ||
| driver: d, | ||
| } | ||
| require.Equal(t, d, c.Driver()) | ||
| t.Run("failure", func(t *testing.T) { | ||
| var mockConn *mockDriverConn | ||
| ctx := context.Background() | ||
| o.On("Connect", ctx).Once().Return(mockConn, &pgconn.ConnectError{}) | ||
| _, err := c.Connect(ctx) | ||
| require.Error(t, err) | ||
| require.Equal(t, err, errConnectionFailed) | ||
| }) | ||
|
|
||
| t.Run("success", func(t *testing.T) { | ||
| var mockConn = &mockDriverConn{} | ||
| ctx := context.Background() | ||
| o.On("Connect", ctx).Once().Return(mockConn, nil) | ||
| conn, err := c.Connect(ctx) | ||
| require.NoError(t, err) | ||
| require.Equal(t, mockConn, conn) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.