idstore

Documentation

Overview

Package idstore implements the (principal, idempotency_key) → job_id dedupe map. Implementations may persist; the default is in-memory with a TTL sweep.

Index

• type Entry
• type Memory
  • func NewMemory(ttl time.Duration) *Memory
  • func (s *Memory) Get(ctx context.Context, principal, key string) (Entry, bool, error)
  • func (s *Memory) PutIfAbsent(ctx context.Context, e Entry) (Entry, bool, error)
  • func (s *Memory) Sweep(ctx context.Context, olderThan time.Time) (int, error)
• type Store

Types

type Entry

type Entry struct {
	Principal string
	Key       string
	JobID     string
	CreatedAt time.Time
}

Entry is one stored mapping.

type Memory

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

Memory is an in-memory Store with a 24h default TTL.

func NewMemory

func NewMemory(ttl time.Duration) *Memory

NewMemory returns a Memory store with the given TTL. Zero ttl uses 24 hours.

func (*Memory) Get

func (s *Memory) Get(ctx context.Context, principal, key string) (Entry, bool, error)

Get returns the entry for (principal, key) if present.

func (*Memory) PutIfAbsent

func (s *Memory) PutIfAbsent(ctx context.Context, e Entry) (Entry, bool, error)

PutIfAbsent inserts e if no entry exists for (principal, key).

func (*Memory) Sweep

func (s *Memory) Sweep(ctx context.Context, olderThan time.Time) (int, error)

Sweep removes entries older than the cutoff.

type Store

type Store interface {
	PutIfAbsent(ctx context.Context, e Entry) (Entry, bool, error)
	Get(ctx context.Context, principal, key string) (Entry, bool, error)
	Sweep(ctx context.Context, olderThan time.Time) (int, error)
}

Store is the dedupe interface. PutIfAbsent inserts entry and returns the stored entry plus true if the row is new; if a row already exists, it returns the existing entry and false.