quota

type Factory ¶

type Factory func(h framework.Handle, args framework.Args) (Provider, error)

Factory constructs a quota Provider from shared runtime dependencies and provider-specific parameters. Passing nil args is legal for Providers that take no parameters (e.g. Noop).

func Get(name string) (Factory, error)

type Noop ¶

type Noop struct{}

Noop is a Provider that reports the quota feature as disabled. It is the default for open-source builds where no quota backend is configured.

func (Noop) Enabled() bool

func (Noop) ListForUser(_ context.Context, _, _ string) ([]QuotaInfo, *domain.AppError)

type Provider ¶

type Provider interface {
	// Enabled reports whether the provider can answer queries. False means
	// the quota feature is unavailable (no backend configured, CRD missing,
	// etc.) — callers should skip quota checks gracefully.
	Enabled() bool

	// ListForUser returns all quotas visible to the (user, team) pair.
	// Returns (nil, nil) when the provider is disabled or the user has no
	// visible quotas; returns an AppError only on transient/system failures.
	ListForUser(ctx context.Context, user, team string) ([]QuotaInfo, *domain.AppError)
}

Provider exposes read-only access to quota information.

A nil Provider is not valid; callers should always hold at least a Noop. Use Enabled() to decide whether to expose quota-related UI.

func Build(name string, h framework.Handle, args framework.Args) (Provider, error)

func NewNoop() Provider

func NoopFactory(_ framework.Handle, _ framework.Args) (Provider, error)

type QuotaInfo ¶

type QuotaInfo = domain.QuotaInfo

QuotaInfo is re-exported from the domain package to keep callers decoupled from the service layer. When the Scitix implementation is extracted this remains the stable type.