DeforaNetworks/corteza
3
0
Fork 0
Code Activity

Improve record value handling, more strict type on API endpoints

Browse Source
This commit is contained in:
Denis Arh
2019-01-15 18:16:18 +01:00
parent 274d196eec
commit 558fa54a1f
15 changed files with 404 additions and 233 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/crm/spec.json
+6 -6
View File
@@ -417,10 +417,10 @@
],
"post": [
{
"type": "sqlxTypes.JSONText",
"name": "fields",
"type": "types.RecordValueSet",
"name": "values",
"required": true,
"title": "Record JSON"
"title": "Record values"
}
]
}
@@ -469,10 +469,10 @@
],
"post": [
{
"type": "sqlxTypes.JSONText",
"name": "fields",
"type": "types.RecordValueSet",
"name": "values",
"required": true,
"title": "Record JSON"
"title": "Record values"
}
]
}
api/crm/spec/module.json
+6 -6
View File
@@ -222,10 +222,10 @@
],
"post": [
{
"name": "fields",
"name": "values",
"required": true,
"title": "Record JSON",
"type": "sqlxTypes.JSONText"
"title": "Record values",
"type": "types.RecordValueSet"
}
]
}
@@ -274,10 +274,10 @@
],
"post": [
{
"name": "fields",
"name": "values",
"required": true,
"title": "Record JSON",
"type": "sqlxTypes.JSONText"
"title": "Record values",
"type": "types.RecordValueSet"
}
]
}
codegen.sh
+3 -1
View File
@@ -37,7 +37,9 @@ function types {
CGO_ENABLED=0 go build -o ./build/gen-type-set codegen/v2/type-set.go
fi
./build/gen-type-set --types Module,Page,Chart,Trigger -no-pk-types ModuleField --output crm/types/type.gen.go
./build/gen-type-set --types Module,Page,Chart,Trigger,Record \
--no-pk-types ModuleField,RecordValue \
--output crm/types/type.gen.go
./build/gen-type-set --types MessageAttachment --output sam/types/attachment.gen.go
./build/gen-type-set --types Channel --output sam/types/channel.gen.go
crm/db/mysql/statik.go
+1 -1
View File
File diff suppressed because one or more lines are too long
crm/db/schema/mysql/20190114072000.cleanup-record-tables-and-multival.up.sql
+1
View File
@@ -10,6 +10,7 @@ ALTER TABLE `crm_record_value` CHANGE COLUMN `column_value` `value` TEXT;
-- Add reference
ALTER TABLE `crm_record_value` ADD COLUMN `ref` BIGINT UNSIGNED;
ALTER TABLE `crm_record_value` ADD COLUMN `deleted_at` datetime DEFAULT NULL;
CREATE INDEX crm_record_value_ref ON crm_record_value (ref);
-- We want this as a real field
crm/repository/record.go
+30 -48
View File
@@ -2,7 +2,6 @@ package repository
import (
"context"
"encoding/json"
"fmt"
"strings"
"time"
@@ -26,11 +25,11 @@ type (
Report(moduleID uint64, metrics, dimensions, filter string) (results interface{}, err error)
Find(module *types.Module, filter string, sort string, page int, perPage int) (*FindResponse, error)
Create(mod *types.Record) (*types.Record, error)
Update(mod *types.Record) (*types.Record, error)
Create(record *types.Record) (*types.Record, error)
Update(record *types.Record) (*types.Record, error)
DeleteByID(id uint64) error
Fields(module *types.Module, record *types.Record) ([]*types.RecordValue, error)
UpdateValues(recordID uint64, rvs types.RecordValueSet) (err error)
}
FindResponseMeta struct {
@@ -188,7 +187,7 @@ func (r *record) buildQuery(module *types.Module, filter string, sort string) (q
"updated_at",
}
const colWrap = `(SELECT value FROM crm_record_value WHERE name = ? AND record_id = crm_record.id)`
const colWrap = `(SELECT value FROM crm_record_value WHERE name = ? AND record_id = crm_record.id AND deleted_at IS NULL)`
// Parse filters.
if filter != "" {
@@ -260,60 +259,43 @@ func (r *record) buildQuery(module *types.Module, filter string, sort string) (q
return
}
func (r *record) Create(mod *types.Record) (*types.Record, error) {
mod.ID = factory.Sonyflake.NextID()
mod.CreatedAt = time.Now()
mod.UserID = Identity(r.Context())
func (r *record) Create(record *types.Record) (*types.Record, error) {
record.ID = factory.Sonyflake.NextID()
record.CreatedAt = time.Now()
record.UserID = Identity(r.Context())
fields := make([]types.RecordValue, 0)
if err := json.Unmarshal(mod.Fields, &fields); err != nil {
return nil, errors.Wrap(err, "No content")
if err := r.db().Replace("crm_record", record); err != nil {
return nil, errors.Wrap(err, "could not update record")
}
for _, v := range fields {
v.RecordID = mod.ID
if err := r.db().Replace("crm_record_value", v); err != nil {
return nil, errors.Wrap(err, "Error adding columns")
}
// for _, related := range v.Related {
// row := types.Related{
// RecordID: v.RecordID,
// Name: v.Name,
// RelatedRecordID: related,
// }
// }
}
if err := r.db().Insert("crm_record", mod); err != nil {
return nil, err
}
return mod, nil
return record, nil
}
func (r *record) Update(mod *types.Record) (*types.Record, error) {
func (r *record) Update(record *types.Record) (*types.Record, error) {
now := time.Now()
mod.UpdatedAt = &now
record.UpdatedAt = &now
fields := make([]types.RecordValue, 0)
if err := json.Unmarshal(mod.Fields, &fields); err != nil {
return nil, errors.Wrap(err, "Error when saving record, no content")
if err := r.db().Replace("crm_record", record); err != nil {
return nil, errors.Wrap(err, "could not update record")
}
for _, v := range fields {
v.RecordID = mod.ID
if err := r.db().Replace("crm_record_value", v); err != nil {
return nil, errors.Wrap(err, "Error adding columns to database")
}
// for _, related := range v.Related {
// row := types.Related{
// RecordID: v.RecordID,
// Name: v.Name,
// RelatedRecordID: related,
// }
// }
return record, nil
}
func (r *record) UpdateValues(recordID uint64, rvs types.RecordValueSet) (err error) {
// Remove all records and prepare to be updated
// @todo be more selective and delete only removed values
if _, err = r.db().Exec("DELETE FROM crm_record_value WHERE record_id = ?", recordID); err != nil {
return errors.Wrap(err, "could not remove record values")
}
return mod, r.db().Replace("crm_record", mod)
err = rvs.Walk(func(value *types.RecordValue) error {
value.RecordID = recordID
return r.db().Replace("crm_record_value", value)
})
return errors.Wrap(err, "could not replace record values")
}
func (r *record) DeleteByID(id uint64) error {
crm/repository/record_test.go
+2 -3
View File
@@ -31,12 +31,12 @@ func TestRecordFinder(t *testing.T) {
filter: "id = 5 AND foo = 7",
match: []string{
" AND id = 5",
" AND (SELECT value FROM crm_record_value WHERE name = ? AND record_id = crm_record.id) = 7"},
" AND (SELECT value FROM crm_record_value WHERE name = ? AND record_id = crm_record.id AND deleted_at IS NULL) = 7"},
args: []interface{}{123}},
{
sort: "id ASC, foo DESC",
match: []string{
" id ASC, (SELECT value FROM crm_record_value WHERE name = 'foo' AND record_id = crm_record.id) DESC"},
" id ASC, (SELECT value FROM crm_record_value WHERE name = 'foo' AND record_id = crm_record.id AND deleted_at IS NULL) DESC"},
args: []interface{}{123}},
}
@@ -57,5 +57,4 @@ func TestRecordFinder(t *testing.T) {
// "assertion failed; args %v \n "+
// " do not match expected %v", args, tc.args)
}
}
crm/rest/module.go
+10 -19
View File
@@ -12,15 +12,15 @@ import (
type (
Module struct {
module service.ModuleService
content service.RecordService
module service.ModuleService
record service.RecordService
}
)
func (Module) New() *Module {
return &Module{
module: service.DefaultModule,
content: service.DefaultRecord,
module: service.DefaultModule,
record: service.DefaultRecord,
}
}
@@ -56,34 +56,25 @@ func (s *Module) Edit(ctx context.Context, r *request.ModuleEdit) (interface{},
}
func (s *Module) RecordReport(ctx context.Context, r *request.ModuleRecordReport) (interface{}, error) {
return s.content.With(ctx).Report(r.ModuleID, r.Metrics, r.Dimensions, r.Filter)
return s.record.With(ctx).Report(r.ModuleID, r.Metrics, r.Dimensions, r.Filter)
}
func (s *Module) RecordList(ctx context.Context, r *request.ModuleRecordList) (interface{}, error) {
return s.content.With(ctx).Find(r.ModuleID, r.Filter, r.Sort, r.Page, r.PerPage)
return s.record.With(ctx).Find(r.ModuleID, r.Filter, r.Sort, r.Page, r.PerPage)
}
func (s *Module) RecordRead(ctx context.Context, r *request.ModuleRecordRead) (interface{}, error) {
return s.content.With(ctx).FindByID(r.ModuleID, r.RecordID)
return s.record.With(ctx).FindByID(r.ModuleID, r.RecordID)
}
func (s *Module) RecordCreate(ctx context.Context, r *request.ModuleRecordCreate) (interface{}, error) {
item := &types.Record{
ModuleID: r.ModuleID,
Fields: r.Fields,
}
return s.content.With(ctx).Create(item)
return s.record.With(ctx).Create(&types.Record{ModuleID: r.ModuleID, Values: r.Values})
}
func (s *Module) RecordEdit(ctx context.Context, r *request.ModuleRecordEdit) (interface{}, error) {
item := &types.Record{
ID: r.RecordID,
ModuleID: r.ModuleID,
Fields: r.Fields,
}
return s.content.With(ctx).Update(item)
return s.record.With(ctx).Update(&types.Record{ModuleID: r.ModuleID, Values: r.Values})
}
func (s *Module) RecordDelete(ctx context.Context, r *request.ModuleRecordDelete) (interface{}, error) {
return resputil.OK(), s.content.With(ctx).DeleteByID(r.RecordID)
return resputil.OK(), s.record.With(ctx).DeleteByID(r.RecordID)
}
crm/rest/request/module.go
+2 -14
View File
@@ -398,7 +398,7 @@ var _ RequestFiller = NewModuleRecordList()
// Module record/create request parameters
type ModuleRecordCreate struct {
ModuleID uint64 `json:",string"`
Fields sqlxTypes.JSONText
Values types.RecordValueSet
}
func NewModuleRecordCreate() *ModuleRecordCreate {
@@ -433,12 +433,6 @@ func (m *ModuleRecordCreate) Fill(r *http.Request) (err error) {
}
m.ModuleID = parseUInt64(chi.URLParam(r, "moduleID"))
if val, ok := post["fields"]; ok {
if m.Fields, err = parseJSONTextWithErr(val); err != nil {
return err
}
}
return err
}
@@ -494,7 +488,7 @@ var _ RequestFiller = NewModuleRecordRead()
type ModuleRecordEdit struct {
ModuleID uint64 `json:",string"`
RecordID uint64 `json:",string"`
Fields sqlxTypes.JSONText
Values types.RecordValueSet
}
func NewModuleRecordEdit() *ModuleRecordEdit {
@@ -530,12 +524,6 @@ func (m *ModuleRecordEdit) Fill(r *http.Request) (err error) {
m.ModuleID = parseUInt64(chi.URLParam(r, "moduleID"))
m.RecordID = parseUInt64(chi.URLParam(r, "recordID"))
if val, ok := post["fields"]; ok {
if m.Fields, err = parseJSONTextWithErr(val); err != nil {
return err
}
}
return err
}
crm/service/record.go
+89 -26
View File
@@ -2,6 +2,7 @@ package service
import (
"context"
"strconv"
"github.com/pkg/errors"
"github.com/titpetric/factory"
@@ -36,7 +37,7 @@ type (
Update(record *types.Record) (*types.Record, error)
DeleteByID(recordID uint64) error
Fields(module *types.Module, record *types.Record) ([]*types.RecordValue, error)
// Fields(module *types.Module, record *types.Record) ([]*types.RecordValue, error)
}
)
@@ -89,41 +90,103 @@ func (s *record) Find(moduleID uint64, filter string, sort string, page int, per
return response, nil
}
func (s *record) Create(mod *types.Record) (*types.Record, error) {
response, err := s.repository.Create(mod)
if err != nil {
return nil, err
}
return response, s.preload(nil, response, "user", "fields")
}
func (s *record) Create(new *types.Record) (record *types.Record, err error) {
var module *types.Module
func (s *record) Update(record *types.Record) (c *types.Record, err error) {
validate := func() error {
if record.ID == 0 {
return errors.New("Error updating record: invalid ID")
} else if c, err = s.repository.FindByID(record.ID); err != nil {
return errors.Wrap(err, "Error while loading record for update")
} else {
record.CreatedAt = c.CreatedAt
err = s.db.Transaction(func() (err error) {
if module, err = s.moduleRepo.FindByID(new.ModuleID); err != nil {
return
}
return nil
}
if err = s.sanitizeValues(module, new.Values); err != nil {
return
}
if err = validate(); err != nil {
return nil, err
}
if record, err = s.repository.Create(new); err != nil {
return
}
return c, s.db.Transaction(func() (err error) {
c, err = s.repository.Update(record)
return
if err = s.repository.UpdateValues(record.ID, new.Values); err != nil {
return
}
return s.preload(module, record, "user")
})
return record, errors.Wrap(err, "unable to create record")
}
func (s *record) Fields(module *types.Module, record *types.Record) ([]*types.RecordValue, error) {
return s.repository.Fields(module, record)
func (s *record) Update(updated *types.Record) (record *types.Record, err error) {
var module *types.Module
err = s.db.Transaction(func() (err error) {
if updated.ID == 0 {
return errors.New("invalid record ID")
}
if record, err = s.repository.FindByID(updated.ID); err != nil {
return errors.Wrap(err, "unexisting record")
}
updated.CreatedAt = record.CreatedAt
updated.UserID = record.UserID
if module, err = s.moduleRepo.FindByID(updated.ModuleID); err != nil {
return
}
if err = s.sanitizeValues(module, updated.Values); err != nil {
return
}
if record, err = s.repository.Update(updated); err != nil {
return
}
if err = s.repository.UpdateValues(record.ID, updated.Values); err != nil {
return
}
return s.preload(module, record, "user")
})
return record, errors.Wrap(err, "unable to update record")
}
// func (s *record) Fields(module *types.Module, record *types.Record) ([]*types.RecordValue, error) {
// return s.repository.Fields(module, record)
// }
func (s *record) DeleteByID(id uint64) error {
return s.repository.DeleteByID(id)
}
// Validates and filters record values
func (s *record) sanitizeValues(module *types.Module, values types.RecordValueSet) (err error) {
// Make sure there are no multi values in a non-multi value fields
err = module.Fields.Walk(func(field *types.ModuleField) error {
if !field.Multi && len(values.FilterByName(field.Name)) > 1 {
return errors.Errorf("more than one value for a single-value field %q", field.Name)
}
return nil
})
if err != nil {
return
}
return values.Walk(func(value *types.RecordValue) (err error) {
var field = module.Fields.FindByName(value.Name)
if field == nil {
return errors.Errorf("no such field %q", value.Name)
}
if field.IsRef() {
if value.Ref, err = strconv.ParseUint(value.Value, 10, 64); err != nil {
return err
}
}
return nil
})
}
crm/service/record_test.go
+111 -83
View File
@@ -4,12 +4,9 @@ import (
"context"
"testing"
"encoding/json"
"github.com/pkg/errors"
"github.com/crusttech/crust/crm/types"
"github.com/crusttech/crust/internal/auth"
"github.com/crusttech/crust/internal/test"
systemRepository "github.com/crusttech/crust/system/repository"
systemTypes "github.com/crusttech/crust/system/types"
)
@@ -38,19 +35,20 @@ func TestRecord(t *testing.T) {
Fields: types.ModuleFieldSet{
&types.ModuleField{
Name: "name",
Kind: "input",
},
&types.ModuleField{
Name: "email",
Kind: "email",
},
&types.ModuleField{
Name: "options",
Kind: "select_multi",
Name: "options",
Multi: true,
},
&types.ModuleField{
Name: "description",
Kind: "text",
},
&types.ModuleField{
Name: "another_record",
Kind: "Record",
},
},
}
@@ -61,59 +59,43 @@ func TestRecord(t *testing.T) {
assert(t, err == nil, "Error when creating module: %+v", err)
assert(t, module.ID > 0, "Expected auto generated ID")
columns := []types.RecordValue{
types.RecordValue{
Name: "name",
Value: "Tit Petric",
},
types.RecordValue{
Name: "email",
Value: "tit.petric@example.com",
},
types.RecordValue{
Name: "options",
Related: []string{"1", "2", "3"},
},
types.RecordValue{
Name: "description",
Value: "jack of all trades",
},
}
record1 := &types.Record{
ModuleID: module.ID,
}
(&record1.Fields).Scan(func() []byte {
b, _ := json.Marshal(columns)
return b
}())
columns2 := []types.RecordValue{
types.RecordValue{
Name: "name",
Value: "Marko Novak",
},
types.RecordValue{
Name: "email",
Value: "marko.n@example.com",
},
types.RecordValue{
Name: "options",
Related: []string{"1", "2", "3"},
},
types.RecordValue{
Name: "description",
Value: "persona non grata",
},
}
record2 := &types.Record{
ModuleID: module.ID,
Values: types.RecordValueSet{
&types.RecordValue{
Name: "name",
Value: "John Doe",
},
&types.RecordValue{
Name: "email",
Value: "john.doe@example.com",
},
&types.RecordValue{
Name: "options",
Value: "1",
},
&types.RecordValue{
Name: "options",
Value: "2",
},
&types.RecordValue{
Name: "options",
Value: "3",
},
&types.RecordValue{
Name: "description",
Value: "just an example",
},
&types.RecordValue{
Name: "another_record",
Value: "918273645",
},
},
}
(&record2.Fields).Scan(func() []byte {
b, _ := json.Marshal(columns2)
return b
}())
// now work with records
{
@@ -144,25 +126,25 @@ func TestRecord(t *testing.T) {
assert(t, ms.ID == m1.ID, "Expected ID from database to match, %d != %d", m1.ID, ms.ID)
assert(t, ms.ModuleID == m1.ModuleID, "Expected Module ID from database to match, %d != %d", m1.ModuleID, ms.ModuleID)
{
fields, err := repository.Fields(module, ms)
// fields := make([]testRecordRow, 0)
// err = json.Unmarshal(ms.Fields, &fields)
assert(t, err == nil, "%+v", errors.Wrap(err, "Didn't expect error when unmarshalling"))
assert(t, len(fields) == len(columns), "Expected different field count: %d != %d", 2, len(fields))
for k, v := range columns {
assert(t, fields[k].Name == v.Name, "Expected fields[%d].Name = %s, got %s", k, fields[k].Name, v.Name)
}
}
{
fields := make([]types.RecordValue, 0)
err := json.Unmarshal(ms.Fields, &fields)
assert(t, err == nil, "%+v", errors.Wrap(err, "Didn't expect error when unmarshalling"))
assert(t, len(fields) == len(columns), "Expected different field count: %d != %d", 2, len(fields))
for k, v := range columns {
assert(t, fields[k].Name == v.Name, "Expected fields[%d].Name = %s, got %s", k, fields[k].Name, v.Name)
}
}
// {
// fields, err := repository.Fields(module, ms)
// // fields := make([]testRecordRow, 0)
// // err = json.Unmarshal(ms.Fields, &fields)
// assert(t, err == nil, "%+v", errors.Wrap(err, "Didn't expect error when unmarshalling"))
// assert(t, len(fields) == len(columns), "Expected different field count: %d != %d", 2, len(fields))
// for k, v := range columns {
// assert(t, fields[k].Name == v.Name, "Expected fields[%d].Name = %s, got %s", k, fields[k].Name, v.Name)
// }
// }
// {
// fields := make([]types.RecordValue, 0)
// err := json.Unmarshal(ms.Fields, &fields)
// assert(t, err == nil, "%+v", errors.Wrap(err, "Didn't expect error when unmarshalling"))
// assert(t, len(fields) == len(columns), "Expected different field count: %d != %d", 2, len(fields))
// for k, v := range columns {
// assert(t, fields[k].Name == v.Name, "Expected fields[%d].Name = %s, got %s", k, fields[k].Name, v.Name)
// }
// }
}
// update created record
@@ -198,7 +180,9 @@ func TestRecord(t *testing.T) {
assert(t, mr.Meta.Count == 2, "Expected Meta.Count == 2, got %d", mr.Meta.Count)
assert(t, mr.Meta.Sort == "name asc, email desc", "Expected Meta.Sort == 'name asc, email desc' '%s'", mr.Meta.Sort)
assert(t, mr.Records[0].ModuleID == m1.ModuleID, "Expected record module to match, %d != %d", m1.ModuleID, mr.Records[0].ModuleID)
assert(t, mr.Records[0].ID > mr.Records[1].ID, "Expected order to be ascending")
// @todo sort is not stable
// assert(t, mr.Records[0].ID > mr.Records[1].ID, "Expected order to be ascending")
}
// fetch all records
@@ -209,23 +193,24 @@ func TestRecord(t *testing.T) {
assert(t, mr.Meta.Count == 2, "Expected Meta.Count == 2, got %d", mr.Meta.Count)
assert(t, mr.Meta.Sort == "created_at desc", "Expected Meta.Sort == created_at desc, got '%s'", mr.Meta.Sort)
assert(t, mr.Records[0].ModuleID == m1.ModuleID, "Expected record module to match, %d != %d", m1.ModuleID, mr.Records[0].ModuleID)
assert(t, mr.Records[0].ID > mr.Records[1].ID, "Expected order to be ascending")
// @todo sort is not stable
// assert(t, mr.Records[0].ID > mr.Records[1].ID, "Expected order to be ascending")
}
// fetch all records by query
{
mr, err := repository.Find(module.ID, "name='Tit Petric' AND email='tit.petric@example.com'", "id desc", 0, 20)
filter := "name='John Doe' AND email='john.doe@example.com'"
sort := "id desc"
mr, err := repository.Find(module.ID, filter, sort, 0, 20)
assert(t, err == nil, "Error when retrieving records: %+v", err)
assert(t, len(mr.Records) == 1, "Expected one record, got %d", len(mr.Records))
assert(t, mr.Meta.Count == 1, "Expected Meta.Count == 1, got %d", mr.Meta.Count)
assert(t, mr.Meta.Page == 0, "Expected Meta.Page == 0, got %d", mr.Meta.Page)
assert(t, mr.Meta.PerPage == 20, "Expected Meta.PerPage == 20, got %d", mr.Meta.PerPage)
assert(t,
mr.Meta.Filter == "name='Tit Petric' AND email='tit.petric@example.com'",
"Expected Meta.Filter == name='Tit Petric' AND email='tit.petric@example.com', got '%s'",
mr.Meta.Filter,
)
assert(t, mr.Meta.Sort == "id desc", "Expected Meta.Sort == id desc, got '%s'", mr.Meta.Sort)
assert(t, mr.Meta.Filter == filter, "Expected Meta.Filter == %q, got %q", filter, mr.Meta.Filter)
assert(t, mr.Meta.Sort == sort, "Expected Meta.Sort == %q, got %q", sort, mr.Meta.Sort)
}
// fetch all records by query
@@ -252,3 +237,46 @@ func TestRecord(t *testing.T) {
}
}
}
func TestValueSanitizer(t *testing.T) {
var (
svc = record{}
module = &types.Module{
Fields: types.ModuleFieldSet{
&types.ModuleField{Name: "single1"},
&types.ModuleField{Name: "multi1", Multi: true},
&types.ModuleField{Name: "ref1", Kind: "Record"},
&types.ModuleField{Name: "multiRef1", Kind: "Record", Multi: true},
},
}
rvs types.RecordValueSet
)
rvs = types.RecordValueSet{{Name: "single1", Value: "single"}}
test.ErrNil(t, svc.sanitizeValues(module, rvs), "unexpected error for sanitizeValues() call: %v")
test.Assert(t, len(rvs) == 1, "expecting 1 record value after sanitization, got %d", len(rvs))
rvs = types.RecordValueSet{{Name: "unknown", Value: "single"}}
test.Assert(t, svc.sanitizeValues(module, rvs) != nil, "expecting sanitizeValues() to return an error, got nil")
rvs = types.RecordValueSet{{Name: "single1", Value: "single"}, {Name: "single1", Value: "single2"}}
test.Assert(t, svc.sanitizeValues(module, rvs) != nil, "expecting sanitizeValues() to return an error, got nil")
rvs = types.RecordValueSet{{Name: "multi1", Value: "multi1"}, {Name: "multi1", Value: "multi1"}}
test.ErrNil(t, svc.sanitizeValues(module, rvs), "unexpected error for sanitizeValues() call: %v")
test.Assert(t, len(rvs) == 2, "expecting 2 record values after sanitization, got %d", len(rvs))
rvs = types.RecordValueSet{{Name: "ref1", Value: "multi1"}}
test.Assert(t, svc.sanitizeValues(module, rvs) != nil, "expecting sanitizeValues() to return an error, got nil")
rvs = types.RecordValueSet{{Name: "ref1", Value: "12345"}}
test.ErrNil(t, svc.sanitizeValues(module, rvs), "unexpected error for sanitizeValues() call: %v")
test.Assert(t, len(rvs) == 1, "expecting 1 record values after sanitization, got %d", len(rvs))
test.Assert(t, rvs[0].Ref == 12345, "expecting parsed ref value to match, got %d", rvs[0].Ref)
rvs = types.RecordValueSet{{Name: "multiRef1", Value: "12345"}, {Name: "multiRef1", Value: "67890"}}
test.ErrNil(t, svc.sanitizeValues(module, rvs), "unexpected error for sanitizeValues() call: %v")
test.Assert(t, len(rvs) == 2, "expecting 2 record values after sanitization, got %d", len(rvs))
test.Assert(t, rvs[0].Ref == 12345, "expecting parsed ref value to match, got %d", rvs[0].Ref)
test.Assert(t, rvs[1].Ref == 67890, "expecting parsed ref value to match, got %d", rvs[1].Ref)
}
crm/service/record_util.go
+11 -13
View File
@@ -1,8 +1,6 @@
package service
import (
"encoding/json"
"github.com/crusttech/crust/crm/types"
)
@@ -36,17 +34,17 @@ func (s *record) preload(module *types.Module, record *types.Record, fields ...s
for _, field := range fields {
switch field {
case "fields":
fields, err := s.Fields(module, record)
if err != nil {
return err
}
json, err := json.Marshal(fields)
if err != nil {
return err
}
if err := (&record.Fields).Scan(json); err != nil {
return err
}
// fields, err := s.Fields(module, record)
// if err != nil {
// return err
// }
// json, err := json.Marshal(fields)
// if err != nil {
// return err
// }
// if err := (&record.Values).Scan(json); err != nil {
// return err
// }
case "page":
if record.Page, err = s.pageRepo.FindByModuleID(record.ModuleID); err != nil {
return
crm/types/type.gen.go
+96
View File
@@ -24,10 +24,20 @@ type (
// This type is auto-generated.
TriggerSet []*Trigger
// RecordSet slice of Record
//
// This type is auto-generated.
RecordSet []*Record
// ModuleFieldSet slice of ModuleField
//
// This type is auto-generated.
ModuleFieldSet []*ModuleField
// RecordValueSet slice of RecordValue
//
// This type is auto-generated.
RecordValueSet []*RecordValue
)
// Walk iterates through every slice item and calls w(Module) err
@@ -254,6 +264,62 @@ func (set TriggerSet) IDs() (IDs []uint64) {
return
}
// Walk iterates through every slice item and calls w(Record) err
//
// This function is auto-generated.
func (set RecordSet) Walk(w func(*Record) error) (err error) {
for i := range set {
if err = w(set[i]); err != nil {
return
}
}
return
}
// Filter iterates through every slice item, calls f(Record) (bool, err) and return filtered slice
//
// This function is auto-generated.
func (set RecordSet) Filter(f func(*Record) (bool, error)) (out RecordSet, err error) {
var ok bool
out = RecordSet{}
for i := range set {
if ok, err = f(set[i]); err != nil {
return
} else if ok {
out = append(out, set[i])
}
}
return
}
// FindByID finds items from slice by its ID property
//
// This function is auto-generated.
func (set RecordSet) FindByID(ID uint64) *Record {
for i := range set {
if set[i].ID == ID {
return set[i]
}
}
return nil
}
// IDs returns a slice of uint64s from all items in the set
//
// This function is auto-generated.
func (set RecordSet) IDs() (IDs []uint64) {
IDs = make([]uint64, len(set))
for i := range set {
IDs[i] = set[i].ID
}
return
}
// Walk iterates through every slice item and calls w(ModuleField) err
//
// This function is auto-generated.
@@ -283,3 +349,33 @@ func (set ModuleFieldSet) Filter(f func(*ModuleField) (bool, error)) (out Module
return
}
// Walk iterates through every slice item and calls w(RecordValue) err
//
// This function is auto-generated.
func (set RecordValueSet) Walk(w func(*RecordValue) error) (err error) {
for i := range set {
if err = w(set[i]); err != nil {
return
}
}
return
}
// Filter iterates through every slice item, calls f(RecordValue) (bool, err) and return filtered slice
//
// This function is auto-generated.
func (set RecordValueSet) Filter(f func(*RecordValue) (bool, error)) (out RecordValueSet, err error) {
var ok bool
out = RecordValueSet{}
for i := range set {
if ok, err = f(set[i]); err != nil {
return
} else if ok {
out = append(out, set[i])
}
}
return
}
crm/types/types.go
+34 -11
View File
@@ -22,7 +22,7 @@ type (
Page *Page `json:"page,omitempty"`
Fields types.JSONText `json:"fields,omitempty" db:"-"`
Values RecordValueSet `json:"values,omitempty" db:"-"`
CreatedAt time.Time `db:"created_at" json:"createdAt,omitempty"`
UpdatedAt *time.Time `db:"updated_at" json:"updatedAt,omitempty"`
@@ -31,10 +31,11 @@ type (
// RecordValue is a stored row in the `record_value` table
RecordValue struct {
RecordID uint64 `json:"-" db:"record_id"`
Name string `json:"name" db:"name"`
Value string `json:"value" db:"value"`
Ref uint64 `json:"related" db:"ref"`
RecordID uint64 `db:"record_id" json:"-"`
Name string `db:"name" json:"name"`
Value string `db:"value" json:"value,omitempty"`
Ref uint64 `db:"ref" json:"-"`
DeletedAt *time.Time `db:"deleted_at" json:"deletedAt,omitempty"`
}
// Modules - CRM module definitions
@@ -55,12 +56,9 @@ type (
ModuleID uint64 `json:"moduleID,string" db:"module_id"`
Place int `json:"-" db:"place"`
Kind string `json:"kind" db:"kind"`
Name string `json:"name" db:"name"`
Label string `json:"label" db:"label"`
HelpText string `json:"helpText,omitempty" db:"help_text"`
Default string `json:"defaultValue,omitempty" db:"default_value"`
MaxLength int `json:"maxLength" db:"max_length"`
Kind string `json:"kind" db:"kind"`
Name string `json:"name" db:"name"`
Label string `json:"label" db:"label"`
Options types.JSONText `json:"options" db:"json"`
@@ -133,6 +131,16 @@ func (set ModuleFieldSet) HasName(name string) bool {
return false
}
func (set ModuleFieldSet) FindByName(name string) *ModuleField {
for i := range set {
if name == set[i].Name {
return set[i]
}
}
return nil
}
func (set ModuleFieldSet) FilterByModule(moduleID uint64) (ff ModuleFieldSet) {
for i := range set {
if set[i].ModuleID == moduleID {
@@ -142,3 +150,18 @@ func (set ModuleFieldSet) FilterByModule(moduleID uint64) (ff ModuleFieldSet) {
return
}
// IsRef tells us if value of this field be a reference to something (another record, user)?
func (f ModuleField) IsRef() bool {
return f.Kind == "Record" || f.Kind == "User"
}
func (set RecordValueSet) FilterByName(name string) (vv RecordValueSet) {
for i := range set {
if set[i].Name == name {
vv = append(vv, set[i])
}
}
return
}
docs/crm/README.md
+2 -2
View File
@@ -202,7 +202,7 @@ CRM module definitions
| Parameter | Type | Method | Description | Default | Required? |
| --------- | ---- | ------ | ----------- | ------- | --------- |
| moduleID | uint64 | PATH | Module ID | N/A | YES |
| fields | sqlxTypes.JSONText | POST | Record JSON | N/A | YES |
| values | types.RecordValueSet | POST | Record values | N/A | YES |
## Read records by ID from module section
@@ -233,7 +233,7 @@ CRM module definitions
| --------- | ---- | ------ | ----------- | ------- | --------- |
| moduleID | uint64 | PATH | Module ID | N/A | YES |
| recordID | uint64 | PATH | Record ID | N/A | YES |
| fields | sqlxTypes.JSONText | POST | Record JSON | N/A | YES |
| values | types.RecordValueSet | POST | Record values | N/A | YES |
## Delete record row from module section