From a9487aae55e6fb3b5d4751d1bf9582a93b617146 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Garcia?= Date: Sun, 21 May 2023 11:02:32 -0300 Subject: [PATCH] Remove Update method deprecated on Feb 2022 --- contracts.go | 9 +++----- ksql.go | 13 ------------ mocks.go | 18 +--------------- mocks_test.go | 55 ++++-------------------------------------------- test_adapters.go | 28 ++++++++++++------------ 5 files changed, 22 insertions(+), 101 deletions(-) diff --git a/contracts.go b/contracts.go index fa2a6e0..d3a679a 100644 --- a/contracts.go +++ b/contracts.go @@ -9,7 +9,7 @@ import ( ) // ErrRecordNotFound informs that a given query failed because the record was not found. -// This error can be returned by the following methods: Update(), QueryOne() and Delete(). +// This error can be returned by the following methods: Patch(), QueryOne() and Delete(). var ErrRecordNotFound error = fmt.Errorf("ksql: the query returned no results: %w", sql.ErrNoRows) // ErrNoValuesToUpdate informs the error of trying to make an update that would not change any attributes. @@ -41,9 +41,6 @@ type Provider interface { Patch(ctx context.Context, table Table, record interface{}) error Delete(ctx context.Context, table Table, idOrRecord interface{}) error - // Deprecated: use the Patch() method instead. - Update(ctx context.Context, table Table, record interface{}) error - Query(ctx context.Context, records interface{}, query string, params ...interface{}) error QueryOne(ctx context.Context, record interface{}, query string, params ...interface{}) error QueryChunks(ctx context.Context, parser ChunkParser) error @@ -56,7 +53,7 @@ type Provider interface { // deleting entities from the database by ID using the 3 helper functions // created for that purpose. type Table struct { - // this name must be set in order to use the Insert, Delete and Update helper + // this name must be set in order to use the Insert, Delete and Patch helper // functions. If you only intend to make queries or to use the Exec function // it is safe to leave this field unset. name string @@ -73,7 +70,7 @@ type Table struct { // This Table is required only for using the helper methods: // // - Insert -// - Update +// - Patch // - Delete // // Passing multiple ID columns will be interpreted diff --git a/ksql.go b/ksql.go index 0230c1d..6181157 100644 --- a/ksql.go +++ b/ksql.go @@ -647,19 +647,6 @@ func normalizeIDsAsMap(idNames []string, idOrMap interface{}) (idMap map[string] return idMap, validateIfAllIdsArePresent(idNames, idMap) } -// Update updates the given instances on the database by id. -// -// Partial updates are supported, i.e. it will ignore nil pointer attributes -// -// Deprecated: Use the Patch method instead -func (c DB) Update( - ctx context.Context, - table Table, - record interface{}, -) error { - return c.Patch(ctx, table, record) -} - // Patch applies a partial update (explained below) to the given instance on the database by id. // // Partial updates will ignore any nil pointer attributes from the struct, updating only diff --git a/mocks.go b/mocks.go index 7b17f37..b382916 100644 --- a/mocks.go +++ b/mocks.go @@ -53,8 +53,6 @@ type Mock struct { PatchFn func(ctx context.Context, table Table, record interface{}) error DeleteFn func(ctx context.Context, table Table, idOrRecord interface{}) error - UpdateFn func(ctx context.Context, table Table, record interface{}) error - QueryFn func(ctx context.Context, records interface{}, query string, params ...interface{}) error QueryOneFn func(ctx context.Context, record interface{}, query string, params ...interface{}) error QueryChunksFn func(ctx context.Context, parser ChunkParser) error @@ -93,7 +91,7 @@ type MockResult struct { // } // // mockdb := ksql.Mock{ -// UpdateFn: func(_ context.Context, _ ksql.Table, record interface{}) error { +// PatchFn: func(_ context.Context, _ ksql.Table, record interface{}) error { // return ksql.ErrRecordNotFound // }, // }.SetFallbackDatabase(db) @@ -112,10 +110,6 @@ func (m Mock) SetFallbackDatabase(db Provider) Mock { m.DeleteFn = db.Delete } - if m.UpdateFn == nil { - m.UpdateFn = db.Update - } - if m.QueryFn == nil { m.QueryFn = db.Query } @@ -166,16 +160,6 @@ func (m Mock) Delete(ctx context.Context, table Table, idOrRecord interface{}) e return m.DeleteFn(ctx, table, idOrRecord) } -// Update mocks the behavior of the Update method. -// If UpdateFn is set it will just call it returning the same return values. -// If UpdateFn is unset it will panic with an appropriate error message. -func (m Mock) Update(ctx context.Context, table Table, record interface{}) error { - if m.UpdateFn == nil { - panic(fmt.Errorf("ksql.Mock.Update(ctx, %v, %v) called but the ksql.Mock.UpdateFn() is not set", table, record)) - } - return m.UpdateFn(ctx, table, record) -} - // Query mocks the behavior of the Query method. // If QueryFn is set it will just call it returning the same return values. // If QueryFn is unset it will panic with an appropriate error message. diff --git a/mocks_test.go b/mocks_test.go index 4f77bd0..2c31d8f 100644 --- a/mocks_test.go +++ b/mocks_test.go @@ -50,22 +50,6 @@ func TestMock(t *testing.T) { tt.AssertErrContains(t, err, "ksql.Mock.Patch(", "ksql.Mock.PatchFn", "not set") }) - t.Run("Update should panic", func(t *testing.T) { - ctx := context.Background() - mock := ksql.Mock{} - panicPayload := tt.PanicHandler(func() { - mock.Update(ctx, UsersTable, &User{ - ID: 4242, - Name: "fake-name", - Age: 42, - }) - }) - - err, ok := panicPayload.(error) - tt.AssertEqual(t, ok, true) - tt.AssertErrContains(t, err, "ksql.Mock.Update(", "ksql.Mock.UpdateFn", "not set") - }) - t.Run("Delete should panic", func(t *testing.T) { ctx := context.Background() mock := ksql.Mock{} @@ -221,37 +205,6 @@ func TestMock(t *testing.T) { }) }) - t.Run("Update", func(t *testing.T) { - ctx := context.Background() - var capturedArgs struct { - ctx context.Context - table ksql.Table - record interface{} - } - mock := ksql.Mock{ - UpdateFn: func(ctx context.Context, table ksql.Table, record interface{}) error { - capturedArgs.ctx = ctx - capturedArgs.table = table - capturedArgs.record = record - return fmt.Errorf("fake-error") - }, - } - err := mock.Update(ctx, UsersTable, &User{ - ID: 4242, - Name: "fake-name", - Age: 42, - }) - - tt.AssertErrContains(t, err, "fake-error") - tt.AssertEqual(t, capturedArgs.ctx, ctx) - tt.AssertEqual(t, capturedArgs.table, UsersTable) - tt.AssertEqual(t, capturedArgs.record, &User{ - ID: 4242, - Name: "fake-name", - Age: 42, - }) - }) - t.Run("Delete", func(t *testing.T) { ctx := context.Background() var capturedArgs struct { @@ -431,8 +384,8 @@ func TestMock(t *testing.T) { InsertFn: func(ctx context.Context, table ksql.Table, record interface{}) error { return fmt.Errorf("called from InsertFn") }, - UpdateFn: func(ctx context.Context, table ksql.Table, record interface{}) error { - return fmt.Errorf("called from UpdateFn") + PatchFn: func(ctx context.Context, table ksql.Table, record interface{}) error { + return fmt.Errorf("called from PatchFn") }, DeleteFn: func(ctx context.Context, table ksql.Table, record interface{}) error { return fmt.Errorf("called from DeleteFn") @@ -460,8 +413,8 @@ func TestMock(t *testing.T) { var user User err := testMock.Insert(ctx, UsersTable, &user) tt.AssertErrContains(t, err, "called from InsertFn") - err = testMock.Update(ctx, UsersTable, &user) - tt.AssertErrContains(t, err, "called from UpdateFn") + err = testMock.Patch(ctx, UsersTable, &user) + tt.AssertErrContains(t, err, "called from PatchFn") err = testMock.Delete(ctx, UsersTable, &user) tt.AssertErrContains(t, err, "called from DeleteFn") diff --git a/test_adapters.go b/test_adapters.go index 6e37572..fdcb03f 100644 --- a/test_adapters.go +++ b/test_adapters.go @@ -1608,7 +1608,7 @@ func PatchTest( tt.AssertNoErr(t, err) tt.AssertNotEqual(t, u.ID, uint(0)) - err = c.Update(ctx, usersTable, user{ + err = c.Patch(ctx, usersTable, user{ ID: u.ID, Name: "Thayane", }) @@ -1636,7 +1636,7 @@ func PatchTest( tt.AssertNoErr(t, err) tt.AssertNotEqual(t, u.ID, uint(0)) - err = c.Update(ctx, usersTable, &user{ + err = c.Patch(ctx, usersTable, &user{ ID: u.ID, Name: "Thayane", }) @@ -1666,7 +1666,7 @@ func PatchTest( tt.AssertNotEqual(t, existingPerm.ID, 0) tt.AssertEqual(t, existingPerm.Type, "existingFakeType") - err = c.Update(ctx, NewTable("user_permissions", "id", "user_id", "perm_id"), &userPermission{ + err = c.Patch(ctx, NewTable("user_permissions", "id", "user_id", "perm_id"), &userPermission{ ID: existingPerm.ID, UserID: 42, PermID: 43, @@ -1704,7 +1704,7 @@ func PatchTest( tt.AssertNoErr(t, err) tt.AssertNotEqual(t, u.ID, uint(0)) - err = c.Update(ctx, usersTable, partialUser{ + err = c.Patch(ctx, usersTable, partialUser{ ID: u.ID, // Should be updated because it is not null, just empty: Name: "", @@ -1741,7 +1741,7 @@ func PatchTest( tt.AssertNotEqual(t, u.ID, uint(0)) // Should update all fields: - err = c.Update(ctx, usersTable, partialUser{ + err = c.Patch(ctx, usersTable, partialUser{ ID: u.ID, Name: "Thay", Age: nullable.Int(42), @@ -1762,7 +1762,7 @@ func PatchTest( c := newTestDB(db, dialect) - err = c.Update(ctx, usersTable, user{ + err = c.Patch(ctx, usersTable, user{ ID: 4200, Name: "Thayane", }) @@ -1775,7 +1775,7 @@ func PatchTest( c := newTestDB(db, dialect) - err = c.Update(ctx, NewTable("non_existing_table"), user{ + err = c.Patch(ctx, NewTable("non_existing_table"), user{ ID: 1, Name: "Thayane", }) @@ -1789,7 +1789,7 @@ func PatchTest( c := newTestDB(db, dialect) var u *user - err := c.Update(ctx, usersTable, u) + err := c.Patch(ctx, usersTable, u) tt.AssertNotEqual(t, err, nil) }) @@ -1799,7 +1799,7 @@ func PatchTest( c := newTestDB(db, dialect) - err = c.Update(ctx, usersTable, struct { + err = c.Patch(ctx, usersTable, struct { ID uint `ksql:"id"` // ID fields are not updated Name string `ksql:"name,skipUpdates"` // the skipUpdate modifier should rule this one out Age *int `ksql:"age"` // Age is a nil pointer so it would not be updated @@ -1817,7 +1817,7 @@ func PatchTest( c := newTestDB(db, dialect) - err := c.Update(ctx, usersTable, &user{ + err := c.Patch(ctx, usersTable, &user{ // Missing ID Name: "Jane", }) @@ -1830,7 +1830,7 @@ func PatchTest( c := newTestDB(db, dialect) - err := c.Update(ctx, NewTable("user_permissions", "id", "user_id", "perm_id"), &userPermission{ + err := c.Patch(ctx, NewTable("user_permissions", "id", "user_id", "perm_id"), &userPermission{ ID: 1, // Missing UserID PermID: 42, @@ -1846,7 +1846,7 @@ func PatchTest( c := newTestDB(db, dialect) - err := c.Update(ctx, usersTable, &struct { + err := c.Patch(ctx, usersTable, &struct { // Missing ID Name string `ksql:"name"` }{ @@ -1861,7 +1861,7 @@ func PatchTest( c := newTestDB(db, dialect) - err := c.Update(ctx, NewTable("user_permissions", "id", "user_id", "perm_id"), &struct { + err := c.Patch(ctx, NewTable("user_permissions", "id", "user_id", "perm_id"), &struct { ID int `ksql:"id"` // Missing UserID PermID int `ksql:"perm_id"` @@ -1882,7 +1882,7 @@ func PatchTest( c := newTestDB(db, dialect) - err = c.Update(ctx, usersTable, user{ + err = c.Patch(ctx, usersTable, user{ ID: 1, Name: "Thayane", })