GOMODULES
/
ksql
mirror of https://github.com/VinGarcia/ksql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #32 from VinGarcia/add-nullable-modifier 

Add nullable modifier
pull/34/head v1.6.0
Vinícius Garcia 2022-12-17 15:08:45 -03:00 committed by GitHub
parent 211fddf4ee 226b906746
commit 6ff67201c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 178 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
internal/modifiers/global_modifiers.go
View File

@ -19,6 +19,7 @@ func init() {
// This one is useful for serializing/desserializing structs:
modifiers.Store("json", jsonModifier)
modifiers.Store("json/nullable", jsonNullableModifier)
// This next two are useful for the UpdatedAt and Created fields respectively:
// They only work on time.Time attributes and will set the attribute to time.Now().
@ -29,6 +30,7 @@ func init() {
// to test the feature of skipping updates, inserts and queries.
modifiers.Store("skipUpdates", skipUpdatesModifier)
modifiers.Store("skipInserts", skipInsertsModifier)
modifiers.Store("nullable", nullableModifier)
}
// RegisterAttrModifier allow users to add custom modifiers on startup

7
internal/modifiers/json_modifier.go
View File

@ -39,3 +39,10 @@ var jsonModifier = ksqlmodifiers.AttrModifier{
return b, err
},
}
var jsonNullableModifier = ksqlmodifiers.AttrModifier{
Nullable: true,
Scan: jsonModifier.Scan,
Value: jsonModifier.Value,
}

4
internal/modifiers/skip_modifiers.go → internal/modifiers/skip_and_keep_modifiers.go
View File

@ -9,3 +9,7 @@ var skipInsertsModifier = ksqlmodifiers.AttrModifier{
var skipUpdatesModifier = ksqlmodifiers.AttrModifier{
SkipOnUpdate: true,
}
var nullableModifier = ksqlmodifiers.AttrModifier{
Nullable: true,
}

8
internal/structs/structs.go
View File

@ -150,11 +150,13 @@ func StructToMap(obj interface{}) (map[string]interface{}, error) {
field := v.Field(i)
ft := field.Type()
if ft.Kind() == reflect.Ptr {
if field.IsNil() {
if !field.IsNil() {
field = field.Elem()
} else {
if !fieldInfo.Modifier.Nullable {
continue
}
field = field.Elem()
}
}
m[fieldInfo.ColumnName] = field.Interface()

5
ksql.go
View File

@ -13,7 +13,6 @@ import (
"github.com/vingarcia/ksql/internal/modifiers"
"github.com/vingarcia/ksql/internal/structs"
"github.com/vingarcia/ksql/ksqlmodifiers"
"github.com/vingarcia/ksql/ksqltest"
)
var selectQueryCache = initializeQueryCache()
@ -631,7 +630,7 @@ func normalizeIDsAsMap(idNames []string, idOrMap interface{}) (idMap map[string]
switch t.Kind() {
case reflect.Struct:
idMap, err = ksqltest.StructToMap(idOrMap)
idMap, err = structs.StructToMap(idOrMap)
if err != nil {
return nil, fmt.Errorf("could not get ID(s) from input record: %w", err)
}
@ -724,7 +723,7 @@ func buildInsertQuery(
info structs.StructInfo,
record interface{},
) (query string, params []interface{}, scanValues []interface{}, err error) {
recordMap, err := ksqltest.StructToMap(record)
recordMap, err := structs.StructToMap(record)
if err != nil {
return "", nil, nil, err
}

4
ksqlmodifiers/attr_modifier.go
View File

@ -10,6 +10,10 @@ type AttrModifier struct {
SkipOnInsert bool
SkipOnUpdate bool
// Nullable will make sure that on Insert and Patch operations
// this field will not be ignored even if it is a NULL pointer.
Nullable bool
// Implement these functions if you want to override the default Scan/Value behavior
// for the target attribute.
Scan AttrScanner

157
test_adapters.go
View File

@ -3070,6 +3070,151 @@ func ModifiersTest(
tt.AssertEqual(t, taggedUser.Name, "Marta Ribeiro")
})
})
t.Run("nullable modifier", func(t *testing.T) {
t.Run("should prevent null fields from being ignored during insertions", func(t *testing.T) {
db, closer := newDBAdapter(t)
defer closer.Close()
c := newTestDB(db, driver)
// The default value of the column "nullable_field"
// is the string: "not_null".
//
// So the tagged struct below should insert passing NULL
// and the untagged should insert not passing any value
// for this column, thus, only the second one should create
// a recording using the default value.
var taggedUser struct {
ID uint `ksql:"id"`
NullableField *string `ksql:"nullable_field,nullable"`
}
var untaggedUser struct {
ID uint `ksql:"id"`
NullableField *string `ksql:"nullable_field"`
}
err := c.Insert(ctx, usersTable, &taggedUser)
tt.AssertNoErr(t, err)
tt.AssertNotEqual(t, taggedUser.ID, 0)
err = c.Insert(ctx, usersTable, &untaggedUser)
tt.AssertNoErr(t, err)
tt.AssertNotEqual(t, untaggedUser.ID, 0)
err = c.QueryOne(ctx, &taggedUser, `FROM users WHERE id = `+c.dialect.Placeholder(0), taggedUser.ID)
tt.AssertNoErr(t, err)
err = c.QueryOne(ctx, &untaggedUser, `FROM users WHERE id = `+c.dialect.Placeholder(0), untaggedUser.ID)
tt.AssertNoErr(t, err)
tt.AssertEqual(t, taggedUser.NullableField == nil, true)
tt.AssertEqual(t, untaggedUser.NullableField, nullable.String("not_null"))
})
t.Run("should prevent null fields from being ignored during updates", func(t *testing.T) {
db, closer := newDBAdapter(t)
defer closer.Close()
c := newTestDB(db, driver)
type userWithNoTags struct {
ID uint `ksql:"id"`
Name string `ksql:"name"`
NullableField *string `ksql:"nullable_field"`
}
untaggedUser := userWithNoTags{
Name: "Laurinha Ribeiro",
NullableField: nullable.String("fakeValue"),
}
err := c.Insert(ctx, usersTable, &untaggedUser)
tt.AssertNoErr(t, err)
tt.AssertNotEqual(t, untaggedUser.ID, 0)
type taggedUser struct {
ID uint `ksql:"id"`
Name string `ksql:"name"`
NullableField *string `ksql:"nullable_field,nullable"`
}
u := taggedUser{
ID: untaggedUser.ID,
Name: "Laura Ribeiro",
NullableField: nil,
}
err = c.Patch(ctx, usersTable, u)
tt.AssertNoErr(t, err)
var untaggedUser2 userWithNoTags
err = c.QueryOne(ctx, &untaggedUser2, "FROM users WHERE id = "+c.dialect.Placeholder(0), untaggedUser.ID)
tt.AssertNoErr(t, err)
tt.AssertEqual(t, untaggedUser2.Name, "Laura Ribeiro")
tt.AssertEqual(t, untaggedUser2.NullableField == nil, true)
})
t.Run("should not alter the value on queries", func(t *testing.T) {
db, closer := newDBAdapter(t)
defer closer.Close()
c := newTestDB(db, driver)
type userWithNoTags struct {
ID uint `ksql:"id"`
Name *string `ksql:"name"`
}
untaggedUser := userWithNoTags{
Name: nullable.String("Marta Ribeiro"),
}
err := c.Insert(ctx, usersTable, &untaggedUser)
tt.AssertNoErr(t, err)
tt.AssertNotEqual(t, untaggedUser.ID, 0)
var taggedUser struct {
ID uint `ksql:"id"`
Name *string `ksql:"name,nullable"`
}
err = c.QueryOne(ctx, &taggedUser, "FROM users WHERE id = "+c.dialect.Placeholder(0), untaggedUser.ID)
tt.AssertNoErr(t, err)
tt.AssertEqual(t, taggedUser.ID, untaggedUser.ID)
tt.AssertEqual(t, taggedUser.Name, nullable.String("Marta Ribeiro"))
})
t.Run("should cause no effect if used on a non pointer field", func(t *testing.T) {
db, closer := newDBAdapter(t)
defer closer.Close()
c := newTestDB(db, driver)
type user struct {
ID uint `ksql:"id"`
Name string `ksql:"name,nullable"`
Age int `ksql:"age,nullable"`
}
u1 := user{
Name: "Marta Ribeiro",
}
err := c.Insert(ctx, usersTable, &u1)
tt.AssertNoErr(t, err)
tt.AssertNotEqual(t, u1.ID, 0)
err = c.Patch(ctx, usersTable, &struct {
ID uint `ksql:"id"`
Age int `ksql:"age,nullable"`
}{
ID: u1.ID,
Age: 42,
})
tt.AssertNoErr(t, err)
var u2 user
err = c.QueryOne(ctx, &u2, "FROM users WHERE id = "+c.dialect.Placeholder(0), u1.ID)
tt.AssertNoErr(t, err)
tt.AssertEqual(t, u2.ID, u1.ID)
tt.AssertEqual(t, u2.Name, "Marta Ribeiro")
tt.AssertEqual(t, u2.Age, 42)
})
})
})
}
@ -3317,7 +3462,8 @@ func createTables(driver string, connStr string) error {
name TEXT,
address BLOB,
created_at DATETIME,
updated_at DATETIME
updated_at DATETIME,
nullable_field TEXT DEFAULT "not_null"
)`)
case "postgres":
_, err = db.Exec(`CREATE TABLE users (
@ -3326,7 +3472,8 @@ func createTables(driver string, connStr string) error {
name VARCHAR(50),
address jsonb,
created_at TIMESTAMP,
updated_at TIMESTAMP
updated_at TIMESTAMP,
nullable_field VARCHAR(50) DEFAULT 'not_null'
)`)
case "mysql":
_, err = db.Exec(`CREATE TABLE users (
@ -3335,7 +3482,8 @@ func createTables(driver string, connStr string) error {
name VARCHAR(50),
address JSON,
created_at DATETIME,
updated_at DATETIME
updated_at DATETIME,
nullable_field VARCHAR(50) DEFAULT "not_null"
)`)
case "sqlserver":
_, err = db.Exec(`CREATE TABLE users (
@ -3344,7 +3492,8 @@ func createTables(driver string, connStr string) error {
name VARCHAR(50),
address NVARCHAR(4000),
created_at DATETIME,
updated_at DATETIME
updated_at DATETIME,
nullable_field VARCHAR(50) DEFAULT 'not_null'
)`)
}
if err != nil {