change Store.Insert() to take arguments by pointer

This increases memory overhead slightly, but when converting Gorp uses
into Oblast, I saw that there is a legitimate risk of just ignoring the
result value and continuing with the unupdated records. So according to
the design priorities that I myself laid down, I'm sacrificing some
performance for safety of use.

1 files changed, 30 insertions, 27 deletions

diff --git a/query_test.go b/query_test.go
index 2d14a88..ae60db9 100644
--- a/query_test.go
+++ b/query_test.go
@@ -31,15 +31,15 @@ func TestInsertBasicUsingLastInsertId(t *testing.T) {
 
 	for _, batchSize := range []int{1, oblast.PrepareThreshold - 1, oblast.PrepareThreshold + 1} {
 		t.Run("N="+strconv.Itoa(batchSize), func(t *testing.T) {
-			records := make([]basicRecord, batchSize)
+			records := make([]*basicRecord, batchSize)
 			for idx := range batchSize {
-				records[idx] = basicRecord{Name: "new"}
+				records[idx] = &basicRecord{Name: "new"}
 				md.ForQuery(`INSERT INTO "basic_records" ("name") VALUES (?)`).
 					ExpectExecWithArgs("new").
 					AndReturnLastInsertId(int64(42 + idx)).
 					AndReturnRowsAffected(1)
 			}
-			records = must.Return(store.Insert(db, records...))(t)
+			must.Succeed(t, store.Insert(db, records...))
 			for idx, r := range records {
 				assert.Equal(t, r.ID, int64(42+idx))
 			}
@@ -63,15 +63,15 @@ func TestInsertBasicUsingReturningClause(t *testing.T) {
 
 	for _, batchSize := range []int{1, oblast.PrepareThreshold - 1, oblast.PrepareThreshold + 1} {
 		t.Run("N="+strconv.Itoa(batchSize), func(t *testing.T) {
-			records := make([]basicRecord, batchSize)
+			records := make([]*basicRecord, batchSize)
 			for idx := range batchSize {
-				records[idx] = basicRecord{Name: "new"}
+				records[idx] = &basicRecord{Name: "new"}
 				md.ForQuery(`INSERT INTO "basic_records" ("name") VALUES ($1) RETURNING "id"`).
 					ExpectQueryWithArgs("new").
 					AndReturnColumns("id").
 					WithRow(int64(42 + idx))
 			}
-			records = must.Return(store.Insert(db, records...))(t)
+			must.Succeed(t, store.Insert(db, records...))
 			for idx, r := range records {
 				assert.Equal(t, r.ID, int64(42+idx))
 			}
@@ -151,7 +151,7 @@ func TestWriteQueriesNotPossible(t *testing.T) {
 	)
 
 	r := basicRecord{Name: "foo"}
-	_, err := store.Insert(db, r)
+	err := store.Insert(db, &r)
 	assert.ErrEqual(t, err, "cannot execute Insert() because query could not be autogenerated")
 
 	r.ID = 42
@@ -178,11 +178,13 @@ func TestWriteQueriesFailDuringPrepare(t *testing.T) {
 
 	for _, batchSize := range []int{1, oblast.PrepareThreshold - 1, oblast.PrepareThreshold + 1} {
 		records := make([]basicRecord, batchSize)
+		recordsForInsert := make([]*basicRecord, batchSize)
 		for idx := range batchSize {
-			records[idx] = basicRecord{Name: "foo"}
+			records[idx] = basicRecord{ID: int64(42 + idx), Name: "foo"}
+			recordsForInsert[idx] = &basicRecord{Name: "foo"}
 		}
 
-		_, err := store.Insert(db, records...)
+		err := store.Insert(db, recordsForInsert...)
 		baseError := `unexpected query: INSERT INTO "basic_records" ("name") VALUES (?)`
 		if batchSize < oblast.PrepareThreshold {
 			assert.ErrEqual(t, err, "during Exec() for record with idx = 0: "+baseError)
@@ -190,10 +192,6 @@ func TestWriteQueriesFailDuringPrepare(t *testing.T) {
 			assert.ErrEqual(t, err, "during Prepare(): "+baseError)
 		}
 
-		for idx := range batchSize {
-			records[idx].ID = int64(42 + idx)
-		}
-
 		err = store.Update(db, records...)
 		baseError = `unexpected query: UPDATE "basic_records" SET "name" = ? WHERE "id" = ?`
 		if batchSize < oblast.PrepareThreshold {
@@ -218,12 +216,12 @@ func TestWriteQueriesFailDuringPrepare(t *testing.T) {
 	)
 
 	for _, batchSize := range []int{1, oblast.PrepareThreshold - 1, oblast.PrepareThreshold + 1} {
-		records := make([]basicRecord, batchSize)
+		recordsForInsert := make([]*basicRecord, batchSize)
 		for idx := range batchSize {
-			records[idx] = basicRecord{Name: "foo"}
+			recordsForInsert[idx] = &basicRecord{Name: "foo"}
 		}
 
-		_, err := store.Insert(db, records...)
+		err := store.Insert(db, recordsForInsert...)
 		baseError := `unexpected query: INSERT INTO "basic_records" ("name") VALUES ($1) RETURNING "id"`
 		if batchSize < oblast.PrepareThreshold {
 			assert.ErrEqual(t, err, "during QueryRow() for record with idx = 0: "+baseError)
@@ -277,15 +275,16 @@ func TestInsertWithUnsignedIdField(t *testing.T) {
 			ExpectExecWithArgs("first").
 			AndReturnLastInsertId(42).
 			AndReturnRowsAffected(1)
-		records := must.Return(store.Insert(db, basicRecord{Name: "first"}))(t)
-		assert.SliceEqual(t, records, basicRecord{ID: 42, Name: "first"})
+		record := basicRecord{Name: "first"}
+		must.Succeed(t, store.Insert(db, &record))
+		assert.Equal(t, record, basicRecord{ID: 42, Name: "first"})
 
 		// error case: negative ID cannot be cast to uint64
 		md.ForQuery(`INSERT INTO "basic_records" ("name") VALUES (?)`).
 			ExpectExecWithArgs("second").
 			AndReturnLastInsertId(-42).
 			AndReturnRowsAffected(1)
-		_, err := store.Insert(db, basicRecord{Name: "second"})
+		err := store.Insert(db, &basicRecord{Name: "second"})
 		assert.ErrEqual(t, err, "LastInsertId() = -42 for record with idx = 0 cannot be converted to uint")
 
 		// error case: cannot Insert() a record that already has its ID field filled
@@ -293,7 +292,7 @@ func TestInsertWithUnsignedIdField(t *testing.T) {
 			ExpectExecWithArgs("third").
 			AndReturnLastInsertId(42).
 			AndReturnRowsAffected(1)
-		_, err = store.Insert(db, basicRecord{ID: 23, Name: "third"})
+		err = store.Insert(db, &basicRecord{ID: 23, Name: "third"})
 		assert.ErrEqual(t, err, `refusing to INSERT record with idx = 0 that already has non-zero values in its "auto" columns`)
 	})
 
@@ -309,15 +308,16 @@ func TestInsertWithUnsignedIdField(t *testing.T) {
 			ExpectQueryWithArgs("first").
 			AndReturnColumns("id").
 			WithRow(42)
-		records := must.Return(store.Insert(db, basicRecord{Name: "first"}))(t)
-		assert.SliceEqual(t, records, basicRecord{ID: 42, Name: "first"})
+		record := basicRecord{Name: "first"}
+		must.Succeed(t, store.Insert(db, &record))
+		assert.Equal(t, record, basicRecord{ID: 42, Name: "first"})
 
 		// error case: negative ID cannot be cast to uint64
 		md.ForQuery(`INSERT INTO "basic_records" ("name") VALUES ($1) RETURNING "id"`).
 			ExpectQueryWithArgs("second").
 			AndReturnColumns("id").
 			WithRow(-42)
-		_, err := store.Insert(db, basicRecord{Name: "second"})
+		err := store.Insert(db, &basicRecord{Name: "second"})
 		assert.ErrEqual(t, err, `during QueryRow() for record with idx = 0: sql: Scan error on column index 0, name "id": converting driver.Value type int ("-42") to a uint64: invalid syntax`)
 
 		// error case: cannot Insert() a record that already has its ID field filled
@@ -325,7 +325,7 @@ func TestInsertWithUnsignedIdField(t *testing.T) {
 			ExpectQueryWithArgs("third").
 			AndReturnColumns("id").
 			WithRow(42)
-		_, err = store.Insert(db, basicRecord{ID: 23, Name: "third"})
+		err = store.Insert(db, &basicRecord{ID: 23, Name: "third"})
 		assert.ErrEqual(t, err, `refusing to INSERT record with idx = 0 that already has non-zero values in its "auto" columns`)
 	})
 }
@@ -348,12 +348,15 @@ func TestInsertWithoutAutoColumns(t *testing.T) {
 		md.ForQuery(query).
 			ExpectExecWithArgs(1, 3).
 			AndReturnRowsAffected(1)
-		relations := []relation{
+		relations := []*relation{
 			{FooID: 1, BarID: 2},
 			{FooID: 1, BarID: 3},
 		}
-		insertedRelations := must.Return(store.Insert(db, relations...))(t)
-		assert.SliceEqual(t, insertedRelations, relations...)
+		must.Succeed(t, store.Insert(db, relations...))
+		assert.SliceDeepEqual(t, relations,
+			&relation{FooID: 1, BarID: 2},
+			&relation{FooID: 1, BarID: 3},
+		)
 	}
 
 	t.Run("in dialect using LastInsertID", func(t *testing.T) {