caching

Documentation

Index

• Constants
• Variables
• func ForceClientCaching(ctx context.Context, ttl time.Duration)
• func RegisterProtoType(msg proto.Message, f func(msg protoreflect.ProtoMessage) string)
• func WithBypassCache(ctx context.Context) context.Context
• func WithCacheControlHeaders(ctx context.Context, cacheType string, values ...string) context.Context
• func WithGrpcClientCaching(ctx context.Context, d time.Duration) context.Context
• func WithHttpMaxAgeCachingHeader(h http.Header, maxAge time.Duration)
• func WithHttpNoCachingHeader(h http.Header)
• func WithHttpNoStoreHeader(h http.Header)
• type CacheKeyer
• type CachingProvider
  • func NewDefaultCachingProvider[T any]() CachingProvider[T]
• type GrpcCachingInterceptor
• type GrpcClientTtlCacher
  • func NewClientGrpcTtlCacher() *GrpcClientTtlCacher
  • func (g *GrpcClientTtlCacher) UnaryClientInterceptor() grpc.UnaryClientInterceptor
  • func (g *GrpcClientTtlCacher) UnaryServerInterceptor() grpc.UnaryServerInterceptor
• type HttpCachingTransport
• type InMemoryGrpcTtlCache
  • func NewInMemoryGrpcTtlCache(memoryLimitBytes int64, maxAge time.Duration) *InMemoryGrpcTtlCache[protoreflect.ProtoMessage]
  • func (i InMemoryGrpcTtlCache[T]) Delete(key string)
  • func (i InMemoryGrpcTtlCache[T]) Get(key string) (resp T, ok bool)
  • func (i InMemoryGrpcTtlCache[T]) MaxAge() time.Duration
  • func (i InMemoryGrpcTtlCache[T]) Set(key string, resp T, ttl time.Duration)
• type InMemoryHttpTtlCache
  • func NewInMemoryHttpTtlCache(memoryLimitBytes int64, maxAge time.Duration) *InMemoryHttpTtlCache[[]byte]
  • func (i InMemoryHttpTtlCache[T]) Delete(key string)
  • func (i InMemoryHttpTtlCache[T]) Get(key string) (req T, ok bool)
  • func (i InMemoryHttpTtlCache[T]) MaxAge() time.Duration
  • func (i InMemoryHttpTtlCache[T]) Set(key string, req T)
• type InternalHttpCachingTransport
  • func NewInternalHttpCacheTransport(cache storage.HttpTtlCache[[]byte]) *InternalHttpCachingTransport
  • func (t *InternalHttpCachingTransport) Use(client *http.Client) error

Constants

const (
	// headers
	CacheTypeClient = "client"
	CacheTypeServer = "server"

	GrpcNoCache = "no-cache"
	// server can also manually set this to revalidate the cache
	GrpcMustRevalidateCache = "must-revalidate"
	GrpcCacheMiss           = "miss"
	GrpcCacheHit            = "hit"

	GrpcCacheIdentifier = "x-cache-req-id"
)

Variables

var (
	GrpcCacheControlHeader = func(cacheType string) string {
		return "cache-control-" + cacheType
	}
	GrpcCacheStatusHeader = func(fullMethod string) string {
		return "x-cache-" + fullMethod
	}

	GrpcMaxAge = func(d time.Duration) string {
		return fmt.Sprintf("max-age=%d", int(d.Seconds()))
	}
)

Functions

func ForceClientCaching

func ForceClientCaching(ctx context.Context, ttl time.Duration)

ForceClientCaching The client calling this RPC will be forced into caching the response for the given TTL, unless the client has explicitly opted-out of caching.

func RegisterProtoType

func RegisterProtoType(msg proto.Message, f func(msg protoreflect.ProtoMessage) string)

Register at init time a proto message from an external package to be used with the caching interceptor

func WithBypassCache

func WithBypassCache(ctx context.Context) context.Context

func WithCacheControlHeaders

func WithCacheControlHeaders(
	ctx context.Context,
	cacheType string,
	values ...string,
) context.Context

func WithGrpcClientCaching

func WithGrpcClientCaching(ctx context.Context, d time.Duration) context.Context

func WithHttpMaxAgeCachingHeader

func WithHttpMaxAgeCachingHeader(h http.Header, maxAge time.Duration)

WithHttpMaxAgeCachingHeader : header in the request or response that indicates the transport should set the value in the cache with ttl specified by maxAge

func WithHttpNoCachingHeader

func WithHttpNoCachingHeader(h http.Header)

WithHttpNoCachingHeader : header in the request or response that indicates the transport should skip the cache

func WithHttpNoStoreHeader

func WithHttpNoStoreHeader(h http.Header)

WithHttpNoStoreHeader : header in the request or response that indicates the response should not be stored in the cache

Types

type CacheKeyer

type CacheKeyer interface {
	CacheKey() string
}

CacheKeyer opt-in interface that proto messages implement. Used to determine if they are unique without hashing

type CachingProvider

type CachingProvider[T any] interface {
	storage.GrpcTtlCache[T]
	SetCache(storage.GrpcTtlCache[T])
	// contains filtered or unexported methods
}

func NewDefaultCachingProvider

func NewDefaultCachingProvider[T any]() CachingProvider[T]

type GrpcCachingInterceptor

type GrpcCachingInterceptor interface {
	UnaryServerInterceptor() grpc.UnaryServerInterceptor
	UnaryClientInterceptor() grpc.UnaryClientInterceptor
	CachingProvider[proto.Message]
}

type GrpcClientTtlCacher

type GrpcClientTtlCacher struct {
	CachingProvider[proto.Message]
	// contains filtered or unexported fields
}

func NewClientGrpcTtlCacher

func NewClientGrpcTtlCacher() *GrpcClientTtlCacher

func (*GrpcClientTtlCacher) UnaryClientInterceptor

func (g *GrpcClientTtlCacher) UnaryClientInterceptor() grpc.UnaryClientInterceptor

func (*GrpcClientTtlCacher) UnaryServerInterceptor

func (g *GrpcClientTtlCacher) UnaryServerInterceptor() grpc.UnaryServerInterceptor

type HttpCachingTransport

type HttpCachingTransport interface {
	http.RoundTripper
	storage.HttpTtlCache[[]byte]

	Use(*http.Client) error
}

HttpCachingTransport

!! Client libraries that use a *http.Client may overwrite the transport so you may want to consider using this interface with something like https://github.com/hashicorp/go-cleanhttp

type InMemoryGrpcTtlCache

type InMemoryGrpcTtlCache[T any] struct {
	// contains filtered or unexported fields
}

func NewInMemoryGrpcTtlCache

func NewInMemoryGrpcTtlCache(
	memoryLimitBytes int64,
	maxAge time.Duration,
) *InMemoryGrpcTtlCache[protoreflect.ProtoMessage]

func (InMemoryGrpcTtlCache[T]) Delete

func (i InMemoryGrpcTtlCache[T]) Delete(key string)

func (InMemoryGrpcTtlCache[T]) Get

func (i InMemoryGrpcTtlCache[T]) Get(key string) (resp T, ok bool)

func (InMemoryGrpcTtlCache[T]) MaxAge

func (i InMemoryGrpcTtlCache[T]) MaxAge() time.Duration

func (InMemoryGrpcTtlCache[T]) Set

func (i InMemoryGrpcTtlCache[T]) Set(key string, resp T, ttl time.Duration)

type InMemoryHttpTtlCache

type InMemoryHttpTtlCache[T any] struct {
	// contains filtered or unexported fields
}

func NewInMemoryHttpTtlCache

func NewInMemoryHttpTtlCache(
	memoryLimitBytes int64,
	maxAge time.Duration,
) *InMemoryHttpTtlCache[[]byte]

func (InMemoryHttpTtlCache[T]) Delete

func (i InMemoryHttpTtlCache[T]) Delete(key string)

func (InMemoryHttpTtlCache[T]) Get

func (i InMemoryHttpTtlCache[T]) Get(key string) (req T, ok bool)

func (InMemoryHttpTtlCache[T]) MaxAge

func (i InMemoryHttpTtlCache[T]) MaxAge() time.Duration

func (InMemoryHttpTtlCache[T]) Set

func (i InMemoryHttpTtlCache[T]) Set(key string, req T)

type InternalHttpCachingTransport

type InternalHttpCachingTransport struct {
	*httpcache.Transport
	storage.HttpTtlCache[[]byte]
}

InternalHttpCachingTransport Mostly RFC7234 compliant, see https://pkg.go.dev/github.com/gregjones/httpcache Should be used for internal caching only, not for LB, proxying, etc.

func NewInternalHttpCacheTransport

func NewInternalHttpCacheTransport(cache storage.HttpTtlCache[[]byte]) *InternalHttpCachingTransport

func (*InternalHttpCachingTransport) Use

func (t *InternalHttpCachingTransport) Use(client *http.Client) error