cachecontroller

Documentation

Index

• type CacheController
  • func NewCacheController(ds storage.OpenFGADatastore, cache storage.InMemoryCache[any], ...) CacheController
  • func NewNoopCacheController() CacheController
• type InMemoryCacheController
  • func (c *InMemoryCacheController) DetermineInvalidationTime(ctx context.Context, storeID string) time.Time
  • func (c *InMemoryCacheController) InvalidateIfNeeded(ctx context.Context, storeID string)
• type InMemoryCacheControllerOpt
  • func WithLogger(logger logger.Logger) InMemoryCacheControllerOpt
• type NoopCacheController
  • func (c *NoopCacheController) DetermineInvalidationTime(_ context.Context, _ string) time.Time
  • func (c *NoopCacheController) InvalidateIfNeeded(_ context.Context, _ string)

Types

type CacheController

type CacheController interface {
	// DetermineInvalidationTime returns the timestamp of the last write for the specified store if it was in cache,
	// Else it returns Zero time and triggers InvalidateIfNeeded().
	DetermineInvalidationTime(context.Context, string) time.Time

	// InvalidateIfNeeded checks to see if an invalidation is currently in progress for a store,
	// and if not it will spawn a goroutine to invalidate cached records conditionally
	// based on timestamp. It may invalidate all cache records, some, or none.
	InvalidateIfNeeded(context.Context, string)
}

func NewCacheController

func NewCacheController(ds storage.OpenFGADatastore, cache storage.InMemoryCache[any], ttl time.Duration, iteratorCacheTTL time.Duration, opts ...InMemoryCacheControllerOpt) CacheController

func NewNoopCacheController

func NewNoopCacheController() CacheController

type InMemoryCacheController

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

InMemoryCacheController will invalidate cache iterator (InMemoryCache) and sub problem cache (CachedCheckResolver) entries that are more recent than the last write for the specified store. Note that the invalidation is done asynchronously, and only after a Check request is received. It will be eventually consistent.

func (*InMemoryCacheController) DetermineInvalidationTime

func (c *InMemoryCacheController) DetermineInvalidationTime(
	ctx context.Context,
	storeID string,
) time.Time

DetermineInvalidationTime returns the timestamp of the last write for the specified store if it was in cache, Else it returns Zero time and triggers InvalidateIfNeeded().

func (*InMemoryCacheController) InvalidateIfNeeded

func (c *InMemoryCacheController) InvalidateIfNeeded(ctx context.Context, storeID string)

type InMemoryCacheControllerOpt

type InMemoryCacheControllerOpt func(*InMemoryCacheController)

InMemoryCacheControllerOpt defines an option that can be used to change the behavior of InMemoryCacheController instance.

func WithLogger

func WithLogger(logger logger.Logger) InMemoryCacheControllerOpt

WithLogger sets the logger for InMemoryCacheController.

type NoopCacheController

type NoopCacheController struct{}

func (*NoopCacheController) DetermineInvalidationTime

func (c *NoopCacheController) DetermineInvalidationTime(_ context.Context, _ string) time.Time

func (*NoopCacheController) InvalidateIfNeeded

func (c *NoopCacheController) InvalidateIfNeeded(_ context.Context, _ string)