cache/driver.go

package cache

import (
	"encoding/json"
	"errors"

	"github.com/gookit/gsr"
)

type (
	// MarshalFunc define
	MarshalFunc func(v any) ([]byte, error)

	// UnmarshalFunc define
	UnmarshalFunc func(data []byte, v any) error
)

// data (Un)marshal func
var (
	Marshal   MarshalFunc   = json.Marshal
	Unmarshal UnmarshalFunc = json.Unmarshal

	errNoMarshal   = errors.New("must set Marshal func")
	errNoUnmarshal = errors.New("must set Unmarshal func")
)

// Option struct
type Option struct {
	Debug bool
	// Encode (Un)marshal save data
	Encode bool
	Logger gsr.Printer
	// Prefix key prefix
	Prefix string
}

/*************************************************************
 * base driver
 *************************************************************/

// BaseDriver struct
type BaseDriver struct {
	opt Option
	// last error
	lastErr error
}

// WithDebug add option: debug
func WithDebug(debug bool) func(opt *Option) {
	return func(opt *Option) {
		opt.Debug = debug
	}
}

// WithEncode add option: encode
func WithEncode(encode bool) func(opt *Option) {
	return func(opt *Option) {
		opt.Encode = encode
	}
}

// WithPrefix add option: prefix
func WithPrefix(prefix string) func(opt *Option) {
	return func(opt *Option) {
		opt.Prefix = prefix
	}
}

// WithOptions for driver
func (l *BaseDriver) WithOptions(optFns ...func(option *Option)) {
	for _, optFn := range optFns {
		optFn(&l.opt)
	}
}

// MustMarshal cache value
func (l *BaseDriver) MustMarshal(val any) ([]byte, error) {
	if Marshal == nil {
		return nil, errNoMarshal
	}
	return Marshal(val)
}

// Marshal cache value
func (l *BaseDriver) Marshal(val any) (any, error) {
	if l.opt.Encode && Marshal != nil {
		return Marshal(val)
	}

	return val, nil
}

// UnmarshalTo cache value
func (l *BaseDriver) UnmarshalTo(bts []byte, ptr any) error {
	if Unmarshal == nil {
		return errNoUnmarshal
	}
	return Unmarshal(bts, ptr)
}

// Unmarshal cache value
func (l *BaseDriver) Unmarshal(val []byte, err error) any {
	if err != nil {
		l.SetLastErr(err)
		return nil
	}

	var newV any
	if l.opt.Encode && Unmarshal != nil {
		err := Unmarshal(val, &newV)
		l.SetLastErr(err)
		return newV
	}

	return val
}

// Key real cache key build
func (l *BaseDriver) Key(key string) string {
	if l.opt.Prefix != "" {
		return l.opt.Prefix + key
	}
	return key
}

// BuildKeys real cache keys build
func (l *BaseDriver) BuildKeys(keys []string) []string {
	if l.opt.Prefix == "" {
		return keys
	}

	rks := make([]string, 0, len(keys))

	for _, key := range keys {
		rks = append(rks, l.opt.Prefix+key)
	}
	return rks
}

// Debugf print an debug message
func (l *BaseDriver) Debugf(format string, v ...any) {
	if l.opt.Debug && l.opt.Logger != nil {
		l.opt.Logger.Printf(format, v...)
	}
}

// Logf print an log message
func (l *BaseDriver) Logf(format string, v ...any) {
	if l.opt.Logger != nil {
		l.opt.Logger.Printf(format, v...)
	}
}

// SetLastErr save last error
func (l *BaseDriver) SetLastErr(err error) {
	if err != nil {
		l.lastErr = err
		l.Logf("redis error: %s\n", err.Error())
	}
}

// LastErr get
func (l *BaseDriver) LastErr(key string) error {
	return l.lastErr
}

// IsDebug get
func (l *BaseDriver) IsDebug() bool {
	return l.opt.Debug
}