idmpt

README

idmpt

idempotent of cashe

Documentation

Overview

Реализует кеш для работы с идемпотентностью

Вся работа осуществляется через idmpt.Cache, при старте сервиса необходимо вызвать InitCache для инициализации кеша и запуска мусорщика (мусорщик работает с периодичностью параметра LockDelay тоесть время жизни блокировки)

Логика работы:

1. Get - ищет в кеше запись по ключу, если находит то возвращает данные либо ошибку если это блокировка, иначе идет дальше
2. Lock - выполняется первым, создает запись в кеше с небольшим временем жизни. Нужна для отбрасывания одинаковых запросов (тк первый запрос заблокировал ключ раньше то последующие будут падать с ошибкой, пока не выполнится первый)
3. handle - функция идущая выше по стеку, возвращает ошибку и данные
4. Unlock - если handle вернул ошибку то убираем блокировку с ключа, чтобы новые запросы (например из ретрая) прошли без проблем
5. Save - сохранят данные по ключу, убирая блокировку, и устанавливает новое значение времени жизни

Index

• Constants
• Variables
• func EnabledUnique() option
• func InitCache(ctx context.Context, conf *Config)
• func SetTTL(ttl time.Duration) option
• func SetTTLLock(ttl time.Duration) option
• type Config
• type IStore
  • func NewStore(countBucket byte, opts ...option) IStore
• type Option

Constants

const (
	CacheErrorCode = iota + 100
)

Variables

var (
	LockExistsError     = errors.New("lock already exists")
	LockNotFoundError   = errors.New("lock not found")
	LockExistsSaveError = errors.New("can't create lock, item already save")
	ItemExistsError     = errors.New("item already exists")
	ItemNotFound        = errors.New("item not found")
	ItemExpiredError    = errors.New("item already expired")
)

var Cache *idmptCache

Инстанс кеша для идемпотентности

var (

	// Ключ для хедера
	HeaderIdempotentKey = "X-MTS-IDMPT-KEY"
)

Functions

func EnabledUnique

func EnabledUnique() option

func InitCache

func InitCache(ctx context.Context, conf *Config)

Инициализация кеша и установка своих параметров

func SetTTL

func SetTTL(ttl time.Duration) option

func SetTTLLock

func SetTTLLock(ttl time.Duration) option

Types

type Config

type Config struct {
	LockDelay time.Duration
	Ttl       time.Duration
	SizeStore int
}

type IStore

type IStore interface {
	// Получить данные по ключу
	Get(key uuid.UUID) (data []byte, err error)
	// Сохранить данные по ключу
	Set(key uuid.UUID, data []byte) error
	// Создать презапись сохранения данных
	Lock(key uuid.UUID) error
	// Удалить презапись сохранения данных
	Unlock(key uuid.UUID)
	Reset()
	Clear()
}

func NewStore

func NewStore(countBucket byte, opts ...option) IStore

type Option

type Option func() option