✏ update comments

This commit is contained in:
Fenny
2020-11-17 13:56:09 +01:00
parent deb10fb2a7
commit ddef41c2ee
28 changed files with 173 additions and 99 deletions

View File

@@ -13,7 +13,8 @@ A MongoDB storage driver using [mongodb/mongo-go-driver](https://github.com/mong
```go
func New(config ...Config) Storage
var ErrNotExist = errors.New("key does not exist")
// ErrNotFound means that a get call did not find the requested key.
var ErrNotFound = errors.New("key not found")
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) Set(key string, val []byte, exp time.Duration) error

View File

@@ -21,8 +21,9 @@ type Storage struct {
items *sync.Pool
}
// Common storage errors
var ErrNotExist = errors.New("key does not exist")
// ErrNotFound means that a get call did not find the requested key.
var ErrNotFound = errors.New("key not found")
type item struct {
ObjectID primitive.ObjectID `json:"_id,omitempty" bson:"_id,omitempty"`
@@ -112,14 +113,14 @@ func New(config ...Config) *Storage {
// Get value by key
func (s *Storage) Get(key string) ([]byte, error) {
if len(key) <= 0 {
return nil, ErrNotExist
return nil, ErrNotFound
}
res := s.col.FindOne(context.Background(), bson.M{"key": key})
item := s.acquireItem()
if err := res.Err(); err != nil {
if err == mongo.ErrNoDocuments {
return nil, ErrNotExist
return nil, ErrNotFound
}
return nil, err
}
@@ -128,7 +129,7 @@ func (s *Storage) Get(key string) ([]byte, error) {
}
if !item.Expiration.IsZero() && item.Expiration.Unix() <= time.Now().Unix() {
return nil, ErrNotExist
return nil, ErrNotFound
}
// // not safe?
// res := item.Val

View File

@@ -67,14 +67,14 @@ func Test_MongoDB_Get_Expired(t *testing.T) {
)
result, err := testStore.Get(key)
utils.AssertEqual(t, ErrNotExist, err)
utils.AssertEqual(t, ErrNotFound, err)
utils.AssertEqual(t, true, len(result) == 0)
}
func Test_MongoDB_Get_NotExist(t *testing.T) {
result, err := testStore.Get("notexist")
utils.AssertEqual(t, ErrNotExist, err)
utils.AssertEqual(t, ErrNotFound, err)
utils.AssertEqual(t, true, len(result) == 0)
}
@@ -91,7 +91,7 @@ func Test_MongoDB_Delete(t *testing.T) {
utils.AssertEqual(t, nil, err)
result, err := testStore.Get(key)
utils.AssertEqual(t, ErrNotExist, err)
utils.AssertEqual(t, ErrNotFound, err)
utils.AssertEqual(t, true, len(result) == 0)
}
@@ -110,11 +110,11 @@ func Test_MongoDB_Reset(t *testing.T) {
utils.AssertEqual(t, nil, err)
result, err := testStore.Get("john1")
utils.AssertEqual(t, ErrNotExist, err)
utils.AssertEqual(t, ErrNotFound, err)
utils.AssertEqual(t, true, len(result) == 0)
result, err = testStore.Get("john2")
utils.AssertEqual(t, ErrNotExist, err)
utils.AssertEqual(t, ErrNotFound, err)
utils.AssertEqual(t, true, len(result) == 0)
}