kvstore.go

package orbitdb

import (
	"fmt"
	"sync"

	"github.com/keks/go-ipfs-colog"
	"github.com/keks/go-orbitdb/handler"
)

var (
	// ErrNotFound is returned when the given key could not be found in the db.
	ErrNotFound = fmt.Errorf("key not found")
)

type kvPayload struct {
	Key        string `json:"key"`
	Value      string `json:"value"`
	handler.Op `json:"op"`
}

func kvCast(e *colog.Entry) (pl kvPayload, err error) {
	err = e.Get(&pl)
	return pl, err
}

type kvIndex struct {
	l sync.Mutex

	kv map[string]string
}

func (idx *kvIndex) handlePut(e *colog.Entry) error {
	pl, err := kvCast(e)
	if err != nil {
		return err
	}

	idx.l.Lock()
	idx.kv[pl.Key] = pl.Value
	idx.l.Unlock()

	return nil
}

func (idx *kvIndex) handleDel(e *colog.Entry) error {
	pl, err := kvCast(e)
	if err != nil {
		return err
	}

	idx.l.Lock()
	delete(idx.kv, pl.Key)
	idx.l.Unlock()

	return nil
}

func (idx *kvIndex) Get(key string) (value string, err error) {
	var ok bool

	idx.l.Lock()
	value, ok = idx.kv[key]
	idx.l.Unlock()

	if !ok {
		err = ErrNotFound
	}

	return value, err
}

// KVStore provides a key-value store on an OrbitDB.
type KVStore struct {
	db  *OrbitDB
	idx *kvIndex
}

// NewKVStore returns a new KVStore for the given OrbitDB.
func NewKVStore(db *OrbitDB) *KVStore {
	kvs := &KVStore{
		db: db,
		idx: &kvIndex{
			kv: make(map[string]string),
		},
	}

	mux := handler.NewMux()
	mux.AddHandler(OpPut, kvs.idx.handlePut)
	mux.AddHandler(OpDel, kvs.idx.handleDel)

	go db.Notify(mux)

	return kvs
}

// Put adds a key-value pair to the KVStore.
func (kv *KVStore) Put(key, value string) error {
	payload := kvPayload{
		Key:   key,
		Value: value,
		Op:    OpPut,
	}

	_, err := kv.db.Add(&payload)
	return err
}

// Get retrieves the value stored at a given key.
func (kv *KVStore) Get(key string) (string, error) {
	return kv.idx.Get(key)
}

// Delete deletes the value at the given key,
func (kv *KVStore) Delete(key string) error {
	payload := kvPayload{
		Key: key,
		Op:  OpDel,
	}

	_, err := kv.db.Add(&payload)
	return err
}