cache

type InMemoryClientCacheProvider struct {
	// contains filtered or unexported fields
}

type InvalidationHandler func(ctx context.Context, key Key) error

type Key string

type KeyNameID string

type KeyNameProvider interface {
	GetKeyName(id KeyNameID, components []string) Key
	// GetKeyNameWithID is a wrapper around GetKeyName that converts the itemID to []string
	GetKeyNameWithID(id KeyNameID, itemID uuid.UUID) Key
	// GetKeyNameWithString is a wrapper around GetKeyName that converts the itemName to []string
	GetKeyNameWithString(id KeyNameID, itemName string) Key
	// GetKeyNameStatic is a wrapper around GetKeyName that passing in empty []string
	GetKeyNameStatic(id KeyNameID) Key
	// GetPrefix returns the prefix for the cache keys
	GetPrefix() string
	// GetAllKeyIDs returns all the key IDs that are used by the cache
	GetAllKeyIDs() []string
}

type KeyTTLID string

type Manager struct {
	P Provider
	N KeyNameProvider
	T TTLProvider
}

type OptionInMem interface {
	// contains filtered or unexported methods
}

type OptionRedis interface {
	// contains filtered or unexported methods
}

type Provider interface {
	// GetValue gets the value in cache key (if any) and tries to lock the key for Read is lockOnMiss = true
	GetValue(ctx context.Context, key Key, lockOnMiss bool) (*string, *string, Sentinel, error)
	// GetValues gets the value in cache key (if any) and tries to lock the key for Read is lockOnMiss = true
	GetValues(ctx context.Context, keys []Key, lockOnMiss []bool) ([]*string, []*string, []Sentinel, error)
	// SetValue sets the value in cache key(s) to val with given expiration time if the sentinel matches lkey and returns true if the value was set
	SetValue(ctx context.Context, lkey Key, keysToSet []Key, val string, sentinel Sentinel, ttl time.Duration) (bool, bool, error)
	// DeleteValue deletes the value(s) in passed in keys, force is true also deletes keys with sentinel or tombstone values
	DeleteValue(ctx context.Context, key []Key, setTombstone bool, force bool) error
	// WriteSentinel writes the sentinel value into the given keys, returns NoLockSentinel if it couldn't acquire the lock
	WriteSentinel(ctx context.Context, stype SentinelType, keys []Key) (Sentinel, error)
	// ReleaseSentinel clears the sentinel value from the given keys
	ReleaseSentinel(ctx context.Context, keys []Key, s Sentinel)
	// AddDependency adds the given cache key(s) as dependencies of an item represented by by key. Fails if any of the dependency keys passed in contain tombstone
	AddDependency(ctx context.Context, keysIn []Key, dependentKey []Key, ttl time.Duration) error
	// ClearDependencies clears the dependencies of an item represented by key and removes all dependent keys from the cache
	ClearDependencies(ctx context.Context, key Key, setTombstone bool) error
	// Flush flushes the cache
	Flush(ctx context.Context, prefix string, flushTombstones bool) error
	// GetCacheName returns the global name of the cache if any
	GetCacheName(ctx context.Context) string
	// RegisterInvalidationHandler registers a handler to be called when the specified key is invalidated
	RegisterInvalidationHandler(ctx context.Context, handler InvalidationHandler, key Key) error
	// LogKeyValues is debugging only method that logs the values of the keys with the given prefix
	LogKeyValues(ctx context.Context, prefix string) error
}

type RedisClientCacheProvider struct {
	// contains filtered or unexported fields
}

type Sentinel string

type SentinelManager interface {
	GenerateSentinel(stype SentinelType) Sentinel
	CanAlwaysSetSentinel(newVal Sentinel) bool
	CanSetSentinelGivenCurrVal(currVal Sentinel, newVal Sentinel) bool
	CanSetValue(currVal string, val string, sentinel Sentinel) (set bool, clear bool, conflict bool, refresh bool)
	IsSentinelValue(val string) bool
}

type SentinelType string

type SingleItem interface {
	// GetPrimaryKey returns the primary cache key where the item is stored and which is used to lock the item
	GetPrimaryKey(c KeyNameProvider) Key
	// GetSecondaryKeys returns any secondary keys which also contain the item for lookup by another dimension (ie TypeName, Alias, etc)
	GetSecondaryKeys(c KeyNameProvider) []Key
	// GetGlobalCollectionKey returns the key for the collection of all items of this type (ie all ObjectTypes, all EdgeTypes, etc)
	GetGlobalCollectionKey(c KeyNameProvider) Key
	// GetPerItemCollectionKey returns the key for the collection of per item items of another type (ie Edges in/out of a specific Object)
	GetPerItemCollectionKey(c KeyNameProvider) Key
	// GetDependenciesKey returns the key containing dependent keys that should invalidated if the item is invalidated
	GetDependenciesKey(c KeyNameProvider) Key
	// GetDependencyKeys returns the list of keys for items this item depends on (ie Edge depends on both source and target objects)
	GetDependencyKeys(c KeyNameProvider) []Key
	// GetIsModifiedKey returns the key containing a tombstone sentinel if the item has been modified in last TTL seconds
	GetIsModifiedKey(c KeyNameProvider) Key
	// TTL returns the TTL for the item
	TTL(c TTLProvider) time.Duration
	// Validate method is used to validate the item. Every CacheSingleItem is expected to implement Validatable interface
	infra.Validateable
}

type TTLProvider interface {
	TTL(id KeyTTLID) time.Duration
}

type WriteThroughCacheSentinelManager struct {
}