[MM-20353] Change KVSetWithOptions to accept a byte slice (#13213)

* Drop EncodeJSON from PluginKVSetOptions

* Add unit tests for KVSetWithOptions with nil values
Этот коммит содержится в:
Ben Schumacher
2019-12-03 10:46:15 +01:00
коммит произвёл GitHub
родитель 3543fcce6c
Коммит d0d6ce0a70
11 изменённых файлов: 104 добавлений и 161 удалений

Просмотреть файл

@@ -4,16 +4,14 @@
package model
import (
"encoding/json"
"net/http"
)
// PluginKVSetOptions contains information on how to store a value in the plugin KV store.
type PluginKVSetOptions struct {
EncodeJSON bool // If true, store the JSON encoding of newValue
Atomic bool // Only store the value if the current value matches the oldValue
OldValue interface{} // The value to compare with the current value. Only used when Atomic is true
ExpireInSeconds int64 // Set an expire counter
Atomic bool // Only store the value if the current value matches the oldValue
OldValue []byte // The value to compare with the current value. Only used when Atomic is true
ExpireInSeconds int64 // Set an expire counter
}
// IsValid returns nil if the chosen options are valid.
@@ -31,36 +29,8 @@ func (opt *PluginKVSetOptions) IsValid() *AppError {
return nil
}
// GetOldValueSerialized returns the serialized old value either as directly
// or encoded as JSON depending on the chosen options.
func (opt *PluginKVSetOptions) GetOldValueSerialized() ([]byte, *AppError) {
return opt.serializeValue(opt.OldValue)
}
func (opt *PluginKVSetOptions) serializeValue(value interface{}) ([]byte, *AppError) {
if opt.EncodeJSON {
data, err := json.Marshal(value)
if err != nil {
return nil, NewAppError("PluginKVSetOptions.serializeValue", "model.plugin_kvset_options.serialize_value.app_error", map[string]interface{}{"EncodeJSON": opt.EncodeJSON}, "Could not serialize JSON value", http.StatusBadRequest)
}
return data, nil
}
castResult, ok := value.([]byte)
if !ok {
return nil, NewAppError("PluginKVSetOptions.SerializeValue", "model.plugin_kvset_options.serialize_value.app_error", map[string]interface{}{"EncodeJSON": opt.EncodeJSON}, "Could not cast value to []byte", http.StatusBadRequest)
}
return castResult, nil
}
// NewPluginKeyValueFromOptions return a PluginKeyValue given a pluginID, a KV pair and options.
func NewPluginKeyValueFromOptions(pluginId, key string, value interface{}, opt PluginKVSetOptions) (*PluginKeyValue, *AppError) {
serializedValue, err := opt.serializeValue(value)
if err != nil {
return nil, err
}
func NewPluginKeyValueFromOptions(pluginId, key string, value []byte, opt PluginKVSetOptions) (*PluginKeyValue, *AppError) {
expireAt := int64(0)
if opt.ExpireInSeconds > 0 {
expireAt = GetMillis() + (opt.ExpireInSeconds * 1000)
@@ -69,7 +39,7 @@ func NewPluginKeyValueFromOptions(pluginId, key string, value interface{}, opt P
kv := &PluginKeyValue{
PluginId: pluginId,
Key: key,
Value: serializedValue,
Value: value,
ExpireAt: expireAt,
}