cache

Features

Requirements

Modules

Installation

go get github.com/coefficient-engineering/cache

go get github.com/coefficient-engineering/cache/adapters/l2/redis

go get github.com/coefficient-engineering/cache/adapters/backplane/redis

Quick Start

package main
import (
	"context"
	"log/slog"
	"time"
	"github.com/coefficient-engineering/cache"
	redisbp "github.com/coefficient-engineering/cache/adapters/backplane/redis"
	redisl2 "github.com/coefficient-engineering/cache/adapters/l2/redis"
	"github.com/coefficient-engineering/cache/adapters/serializer/json"
	"github.com/redis/go-redis/v9"
)
func main() {
	ctx := context.Background()
	rdb := redis.NewClient(&redis.Options{Addr: "localhost:6379"})
	l2 := redisl2.New(rdb,
		redisl2.WithKeyPrefix("myapp:"),
		redisl2.WithLogger(slog.Default()),
	)
	bp := redisbp.New(rdb,
		redisbp.WithChannel("myapp:backplane"),
		redisbp.WithLogger(slog.Default()),
	)
	c, err := cache.New(
		cache.WithCacheName("myapp"),
		cache.WithL2(l2),
		cache.WithSerializer(&json.Serializer{}),
		cache.WithBackplane(bp),
		cache.WithLogger(slog.Default()),
		cache.WithL2CircuitBreaker(5, 10*time.Second),
		cache.WithDefaultEntryOptions(cache.EntryOptions{
			Duration: 5 * time.Minute,
			IsFailSafeEnabled: true,
			FailSafeMaxDuration: 2 * time.Hour,
			FailSafeThrottleDuration: 30 * time.Second,
			EagerRefreshThreshold: 0.9,
			FactorySoftTimeout: 100 * time.Millisecond,
			FactoryHardTimeout: 2 * time.Second,
			JitterMaxDuration: 10 * time.Second,
		}),
	)
	if err != nil {
		panic(err)
	}
	defer c.Close()
	type Product struct {
		ID int
		Name string
	}
	product, err := cache.GetOrSet[*Product](ctx, c, "product:42",
		func(ctx context.Context, fctx *cache.FactoryExecutionContext) (*Product, error) {
			// Replace with a real database call.
			return &Product{ID: 42, Name: "Widget"}, nil
		},
	)
	if err != nil {
		panic(err)
	}
	_ = product
}

Adapters