Added support for non-serial pField mutation (#39)

* Added support for non-serial pField mutation

Yet this implememnation gidoes not protect from accidental mutation of pk

* Added test to cover changes,
Removed unnecessary break

* Prevented setting mutable PK from Convert method

* Added pk set  prevention for change method

* Allowed Change to mut PK and updated desc for Convert

* Updated tests

* Simplified PK update logic

* Fixed naming, added annotations to tests

Author: talkanbaev-artur

changeset.go

@@ -12,13 +12,14 @@ import (
 
 // Changeset used to cast and validate data before saving it to the database.
 type Changeset struct {
-	errors      []error
-	params      params.Params
-	changes     map[string]interface{}
-	values      map[string]interface{}
-	types       map[string]reflect.Type
-	constraints Constraints
-	zero        bool
+	errors        []error
+	params        params.Params
+	changes       map[string]interface{}
+	values        map[string]interface{}
+	types         map[string]reflect.Type
+	constraints   Constraints
+	zero          bool
+	ignorePrimary bool
 }
 
 // Errors of changeset.
@@ -87,7 +88,7 @@ func (c *Changeset) Apply(doc *rel.Document, mut *rel.Mutation) {
 				c.applyAssocMany(doc, field, mut, v)
 			}
 		default:
-			if field != pField && scannable(c.types[field]) {
+			if (pField != field || pField == field && !c.ignorePrimary) && scannable(c.types[field]) {
 				c.set(doc, mut, field, v)
 			}
 		}

changeset_test.go

@@ -22,6 +22,15 @@ type User struct {
 	DeletedAt    *time.Time
 }
 
+type UUIDUser struct {
+	UUID      string `db:"uuid,primary"`
+	Name      string
+	Age       int
+	CreatedAt time.Time
+	UpdatedAt time.Time
+	DeletedAt *time.Time
+}
+
 type Transaction struct {
 	ID      int
 	Item    string
@@ -206,3 +215,113 @@ func TestChangesetApply_constraint(t *testing.T) {
 		UpdatedAt: now,
 	}, user)
 }
+
+//If PK is explicitly caseted then it should be updated
+func TestChangesetApply_updatePK(t *testing.T) {
+	var (
+		user  UUIDUser
+		now   = time.Now().Truncate(time.Second)
+		doc   = rel.NewDocument(&user)
+		input = params.Map{
+			"uuid": "3a90fc96-6cff-4914-9ce8-01c9e607b28b",
+			"name": "Luffy",
+			"age":  20,
+		}
+		userMutation = rel.Apply(rel.NewDocument(&UUIDUser{}),
+			rel.Set("uuid", "3a90fc96-6cff-4914-9ce8-01c9e607b28b"),
+			rel.Set("name", "Luffy"),
+			rel.Set("age", 20),
+			rel.Set("created_at", now),
+			rel.Set("updated_at", now),
+		)
+	)
+
+	ch := Cast(user, input, []string{"name", "age", "uuid"})
+	UniqueConstraint(ch, "name")
+	mut := rel.Apply(doc, ch)
+
+	assert.Nil(t, ch.Error())
+	assert.Equal(t, userMutation.Mutates, mut.Mutates)
+	assert.NotNil(t, mut.ErrorFunc)
+	assert.Equal(t, UUIDUser{
+		UUID:      "3a90fc96-6cff-4914-9ce8-01c9e607b28b",
+		Name:      "Luffy",
+		Age:       20,
+		CreatedAt: now,
+		UpdatedAt: now,
+	}, user)
+}
+
+//Covert function should ignore the PK updates for safety reasons
+func TestChangesetApply_updatePK_fromConvert(t *testing.T) {
+	var (
+		user  UUIDUser
+		now   = time.Now().Truncate(time.Second)
+		doc   = rel.NewDocument(&user)
+		input = struct {
+			UUID string
+			Name string
+			Age  int
+		}{
+			UUID: "3a90fc96-6cff-4914-9ce8-01c9e607b28b",
+			Name: "Luffy",
+			Age:  20,
+		}
+		userMutation = rel.Apply(rel.NewDocument(&UUIDUser{}),
+			rel.Set("name", "Luffy"),
+			rel.Set("age", 20),
+			rel.Set("created_at", now),
+			rel.Set("updated_at", now),
+		)
+	)
+
+	ch := Convert(input)
+	UniqueConstraint(ch, "name")
+	mut := rel.Apply(doc, ch)
+
+	assert.Nil(t, ch.Error())
+	assert.Equal(t, userMutation.Mutates, mut.Mutates)
+	assert.NotNil(t, mut.ErrorFunc)
+	assert.Equal(t, UUIDUser{
+		Name:      "Luffy",
+		Age:       20,
+		CreatedAt: now,
+		UpdatedAt: now,
+	}, user)
+}
+
+//If PK is explicitly set in the Change function it should be updated
+func TestChangesetApply_updatePK_fromChange(t *testing.T) {
+	var (
+		user  UUIDUser
+		now   = time.Now().Truncate(time.Second)
+		doc   = rel.NewDocument(&user)
+		input = map[string]interface{}{
+			"uuid": "3a90fc96-6cff-4914-9ce8-01c9e607b28b",
+			"name": "Luffy",
+			"age":  20,
+		}
+		userMutation = rel.Apply(rel.NewDocument(&UUIDUser{}),
+			rel.Set("uuid", "3a90fc96-6cff-4914-9ce8-01c9e607b28b"),
+			rel.Set("name", "Luffy"),
+			rel.Set("age", 20),
+			rel.Set("created_at", now),
+			rel.Set("updated_at", now),
+		)
+	)
+
+	ch := Change(user, input)
+	UniqueConstraint(ch, "name")
+	mut := rel.Apply(doc, ch)
+
+	assert.Nil(t, ch.Error())
+	assert.Equal(t, userMutation.Mutates, mut.Mutates)
+	assert.NotNil(t, mut.ErrorFunc)
+	assert.Equal(t, UUIDUser{
+		UUID:      "3a90fc96-6cff-4914-9ce8-01c9e607b28b",
+		Name:      "Luffy",
+		Age:       20,
+		CreatedAt: now,
+		UpdatedAt: now,
+	}, user)
+}

convert.go

@@ -1,10 +1,11 @@
 package changeset
 
 // Convert a struct as changeset, every field's value will be treated as changes. Returns a new changeset.
+// PK changes in the changeset created with this function will be ignored
 func Convert(data interface{}) *Changeset {
 	ch := &Changeset{}
 	ch.values = make(map[string]interface{})
 	ch.changes, ch.types, _ = mapSchema(data, false)
-
+	ch.ignorePrimary = true // set ignore primary to prevent implicit PK change
 	return ch
 }