stickystore

Documentation

Index

• type Store
  • func New(ctx context.Context, cfg *envconfig.EnvConfig) (Store, io.Closer, error)

Types

type Store

type Store interface {
	// Get returns the installation ID for the given key. ok is false on
	// cache miss or if the backend is unreachable (callers fall back to
	// round-robin).
	Get(ctx context.Context, key string) (installationID int64, ok bool, err error)

	// Put persists a mapping. scope, identity, and subject are stored by
	// backends that support operator debuggability (e.g. Firestore);
	// backends that do not need them may ignore them.
	Put(ctx context.Context, key string, installationID int64, scope, identity, subject string) error
}

Store persists sticky (scope, identity) -> installation ID mappings for checks:write policies. Implementations must be safe for concurrent use.

func New

func New(ctx context.Context, cfg *envconfig.EnvConfig) (Store, io.Closer, error)

New creates a Store from the given env config. Returns nil (no store) if StickyStore is empty. The returned io.Closer must be closed when the store is no longer needed (it may close underlying clients).