repolist

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

type Config struct {
	// TTL is how long a snapshot is served without any provider call.
	TTL time.Duration
	// StaleMax is how long an expired snapshot may still be served while it
	// refreshes in the background or the provider is failing.
	StaleMax time.Duration
	// RefreshMin throttles manual refreshes of one connection.
	RefreshMin time.Duration
	// MaxItems caps one connection's list; beyond it the list is marked truncated.
	MaxItems int
}

type FetchFunc func(ctx context.Context, prior *Snapshot) (Snapshot, error)

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

type Mode string

type OwnerCount struct {
	Login string `json:"login"`
	Count int    `json:"count"`
}

type Page struct {
	Items  []Repo
	Total  int
	Limit  int
	Offset int
	// NextOffset is the offset of the following page, or -1 on the last page.
	NextOffset int
	Owners     []OwnerCount
}

type Query struct {
	Search   string
	Owner    string
	Archived Mode
	Forks    Mode
	Limit    int
	Offset   int
}

type Repo struct {
	Key           string `json:"key"`
	FullName      string `json:"full_name"`
	Name          string `json:"name"`
	Owner         string `json:"owner"`
	Private       bool   `json:"private"`
	Archived      bool   `json:"archived"`
	Fork          bool   `json:"fork"`
	DefaultBranch string `json:"default_branch"`
	CloneURL      string `json:"clone_url"`
	WebURL        string `json:"web_url,omitempty"`
	Language      string `json:"language,omitempty"`
	PushedAt      string `json:"pushed_at,omitempty"`
	ProjectID     int64  `json:"project_id,omitempty"`
	AccountType   string `json:"account_type,omitempty"`
	// Provider, ConnectionID, ConnectionLabel and Account say which
	// connection a row came from; they are stamped when lists merge and are
	// never cached.
	Provider        string `json:"provider,omitempty"`
	ConnectionID    string `json:"connection_id,omitempty"`
	ConnectionLabel string `json:"connection_label,omitempty"`
	Account         string `json:"account,omitempty"`
}

type Result struct {
	Snapshot
	// Stale is true when the snapshot is older than the TTL.
	Stale bool
	// Refreshing is true when a background refresh was started for it.
	Refreshing bool
	// RateLimit is set when a refresh was blocked by the provider's rate limit.
	RateLimit *gitprovider.RateLimitError
	// RefreshErr is set when a refresh failed and the stale snapshot was served instead.
	RefreshErr error
}

type Snapshot struct {
	Repos     []Repo
	Truncated bool
	FetchedAt time.Time
	// Meta is provider-specific revalidation data (GitHub page ETags).
	Meta string
}

type Store interface {
	GetGitRepoListCache(ctx context.Context, key string) (store.GitRepoListCacheEntry, error)
	PutGitRepoListCache(ctx context.Context, e store.GitRepoListCacheEntry) error
	DeleteGitRepoListCachePrefix(ctx context.Context, prefix string) error
}