fields.go

package flows

import (
	"encoding/json"
	"fmt"
	"strings"
	"time"

	"github.com/shopspring/decimal"

	"github.com/nyaruka/goflow/utils"
)

// FieldKey is the unique key for this field
type FieldKey string

// FieldValueType is the data type of values for each field
type FieldValueType string

const (
	FieldValueTypeText     FieldValueType = "text"
	FieldValueTypeNumeric  FieldValueType = "numeric"
	FieldValueTypeDatetime FieldValueType = "datetime"
	FieldValueTypeWard     FieldValueType = "ward"
	FieldValueTypeDistrict FieldValueType = "district"
	FieldValueTypeState    FieldValueType = "state"
)

var fieldLocationLevels = map[FieldValueType]utils.LocationLevel{
	FieldValueTypeState:    utils.LocationLevel(1),
	FieldValueTypeDistrict: utils.LocationLevel(2),
	FieldValueTypeWard:     utils.LocationLevel(3),
}

// Field represents a contact field
type Field struct {
	key       FieldKey
	label     string
	valueType FieldValueType
}

// NewField returns a new field object with the passed in uuid, key and value type
func NewField(key FieldKey, label string, valueType FieldValueType) *Field {
	return &Field{key: key, label: label, valueType: valueType}
}

// Key returns the key of the field
func (f *Field) Key() FieldKey { return f.key }

func (f *Field) ParseValue(env utils.Environment, value string) (interface{}, error) {
	switch f.valueType {
	case FieldValueTypeText:
		return value, nil
	case FieldValueTypeNumeric:
		return decimal.NewFromString(value)
	case FieldValueTypeDatetime:
		return utils.DateFromString(env, value)
	case FieldValueTypeState, FieldValueTypeDistrict, FieldValueTypeWard:
		locationID := utils.LocationID(value)
		locationLevel := fieldLocationLevels[f.valueType]
		locations, err := env.Locations()
		if err != nil {
			return nil, err
		}
		if locations == nil {
			return nil, fmt.Errorf("can't parse field '%s' (type %s) in enviroment which is not location enabled", f.key, f.valueType)
		}
		return locations.FindByID(locationID, locationLevel), nil
	}

	return nil, fmt.Errorf("field %s has invalid value type: '%s'", f.key, f.valueType)
}

// FieldValue represents a contact's value for a specific field
type FieldValue struct {
	field     *Field
	value     interface{}
	createdOn time.Time
}

func NewFieldValue(field *Field, value interface{}, createdOn time.Time) *FieldValue {
	return &FieldValue{field: field, value: value, createdOn: createdOn}
}

func (v *FieldValue) Resolve(key string) interface{} {
	switch key {
	case "value":
		return v.value
	case "created_on":
		return v.createdOn
	}
	return fmt.Errorf("no field '%s' on field value", key)
}

// Default returns the default value for FieldValue, which is the value
func (v *FieldValue) Default() interface{} {
	return v.value
}

// String returns the string representation of this field value
func (v *FieldValue) String() string {
	return fmt.Sprintf("%v", v.value)
}

// SerializeValue returns the string representation of this field value for serialization
func (v *FieldValue) SerializeValue() string {
	switch v.field.valueType {
	case FieldValueTypeText:
		return v.value.(string)
	case FieldValueTypeNumeric:
		return v.value.(decimal.Decimal).String()
	case FieldValueTypeDatetime:
		return utils.DateToISO(v.value.(time.Time))
	case FieldValueTypeState, FieldValueTypeDistrict, FieldValueTypeWard:
		return string(v.value.(*utils.Location).ID())
	}

	return fmt.Sprintf("%v", v.value)
}

type FieldValues map[FieldKey]*FieldValue

func (f FieldValues) Clone() FieldValues {
	clone := make(FieldValues, len(f))
	for k, v := range f {
		clone[k] = v
	}
	return clone
}

func (f FieldValues) Save(env utils.Environment, field *Field, rawValue string) error {
	value, err := field.ParseValue(env, rawValue)
	if err != nil {
		return err
	}

	f[field.key] = NewFieldValue(field, value, time.Now().UTC())
	return nil
}

func (f FieldValues) Resolve(key string) interface{} {
	return f[FieldKey(key)]
}

// Default returns the default value for FieldValues, which is ourselves
func (f FieldValues) Default() interface{} {
	return f
}

// String returns the string representation of these Fields, which is our JSON representation
func (f FieldValues) String() string {
	fields := make([]string, 0, len(f))
	for k, v := range f {
		// TODO serilalize field value according to type
		fields = append(fields, fmt.Sprintf("%s: %s", k, v.String()))
	}
	return strings.Join(fields, ", ")
}

var _ utils.VariableResolver = (FieldValues)(nil)

// FieldSet defines the unordered set of all fields for a session
type FieldSet struct {
	fields      []*Field
	fieldsByKey map[FieldKey]*Field
}

func NewFieldSet(fields []*Field) *FieldSet {
	s := &FieldSet{fields: fields, fieldsByKey: make(map[FieldKey]*Field, len(fields))}
	for _, field := range s.fields {
		s.fieldsByKey[field.key] = field
	}
	return s
}

func (s *FieldSet) FindByKey(key FieldKey) *Field {
	return s.fieldsByKey[key]
}

//------------------------------------------------------------------------------------------
// JSON Encoding / Decoding
//------------------------------------------------------------------------------------------

type fieldEnvelope struct {
	Key       FieldKey       `json:"key"`
	Label     string         `json:"label"`
	ValueType FieldValueType `json:"value_type,omitempty"`
}

func ReadField(data json.RawMessage) (*Field, error) {
	var fe fieldEnvelope
	if err := utils.UnmarshalAndValidate(data, &fe, "field"); err != nil {
		return nil, err
	}

	return NewField(fe.Key, fe.Label, fe.ValueType), nil
}

func ReadFieldSet(data json.RawMessage) (*FieldSet, error) {
	items, err := utils.UnmarshalArray(data)
	if err != nil {
		return nil, err
	}

	fields := make([]*Field, len(items))
	for d := range items {
		if fields[d], err = ReadField(items[d]); err != nil {
			return nil, err
		}
	}

	return NewFieldSet(fields), nil
}