mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
8afbe9c6a4
* MM-18167: fix KV* helpers error handling Returning a `nil` `*model.AppError` does not make a `nil` `error` interface. As a consequence, all of the KV* helper methods would always appear to fail, even if the underlying API call was successful. Fix this mismatch by explicitly assigning `appErr` in the helpers and only ever returning a `nil` `error` interface. Extend unit tests to achieve 100% coverage of the associated files. In the long run, we must change all function signatures to return the `error` interface instead of the abomination that is returning `*model.AppError` today.
106 lines
2.5 KiB
Go
106 lines
2.5 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"encoding/json"
|
|
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
// KVGetJSON is a wrapper around KVGet to simplify reading a JSON object from the key value store.
|
|
func (p *HelpersImpl) KVGetJSON(key string, value interface{}) (bool, error) {
|
|
data, appErr := p.API.KVGet(key)
|
|
if appErr != nil {
|
|
return false, appErr
|
|
}
|
|
if data == nil {
|
|
return false, nil
|
|
}
|
|
|
|
err := json.Unmarshal(data, value)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
|
|
return true, nil
|
|
}
|
|
|
|
// KVSetJSON is a wrapper around KVSet to simplify writing a JSON object to the key value store.
|
|
func (p *HelpersImpl) KVSetJSON(key string, value interface{}) error {
|
|
data, err := json.Marshal(value)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
appErr := p.API.KVSet(key, data)
|
|
if appErr != nil {
|
|
return appErr
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// KVCompareAndSetJSON is a wrapper around KVCompareAndSet to simplify atomically writing a JSON object to the key value store.
|
|
func (p *HelpersImpl) KVCompareAndSetJSON(key string, oldValue interface{}, newValue interface{}) (bool, error) {
|
|
var oldData, newData []byte
|
|
var err error
|
|
|
|
if oldValue != nil {
|
|
oldData, err = json.Marshal(oldValue)
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "unable to marshal old value")
|
|
}
|
|
}
|
|
|
|
if newValue != nil {
|
|
newData, err = json.Marshal(newValue)
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "unable to marshal new value")
|
|
}
|
|
}
|
|
|
|
set, appErr := p.API.KVCompareAndSet(key, oldData, newData)
|
|
if appErr != nil {
|
|
return set, appErr
|
|
}
|
|
|
|
return set, nil
|
|
}
|
|
|
|
// KVCompareAndDeleteJSON is a wrapper around KVCompareAndDelete to simplify atomically deleting a JSON object from the key value store.
|
|
func (p *HelpersImpl) KVCompareAndDeleteJSON(key string, oldValue interface{}) (bool, error) {
|
|
var oldData []byte
|
|
var err error
|
|
|
|
if oldValue != nil {
|
|
oldData, err = json.Marshal(oldValue)
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "unable to marshal old value")
|
|
}
|
|
}
|
|
|
|
deleted, appErr := p.API.KVCompareAndDelete(key, oldData)
|
|
if appErr != nil {
|
|
return deleted, appErr
|
|
}
|
|
|
|
return deleted, nil
|
|
}
|
|
|
|
// KVSetWithExpiryJSON is a wrapper around KVSetWithExpiry to simplify atomically writing a JSON object with expiry to the key value store.
|
|
func (p *HelpersImpl) KVSetWithExpiryJSON(key string, value interface{}, expireInSeconds int64) error {
|
|
data, err := json.Marshal(value)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
appErr := p.API.KVSetWithExpiry(key, data, expireInSeconds)
|
|
if appErr != nil {
|
|
return appErr
|
|
}
|
|
|
|
return nil
|
|
}
|