managedcache

type AccessManagerKey struct {
	// UID ensures a re-created object also gets it's own cache.
	UID types.UID
	schema.GroupVersionKind
	client.ObjectKey
}

type Accessor interface {
	client.Writer
	TrackingCache
}

type ConfigMapperFunc[T RefType] func(
	context.Context, T, *rest.Config, cache.Options) (*rest.Config, cache.Options, error)

type EnqueueWatchingObjects struct {
	WatcherRefGetter ownerRefGetter
	// WatcherType is the type of the Owner object to look for in OwnerReferences.  Only Group and Kind are compared.
	WatcherType runtime.Object
	// contains filtered or unexported fields
}

type ObjectBoundAccessManager[T RefType] interface {
	manager.Runnable
	// Get returns a TrackingCache for the provided object if one exists.
	// If one does not exist, a new Cache is created and returned.
	Get(ctx context.Context, owner T) (Accessor, error)

	// GetWithUser returns a TrackingCache for the provided object if one exist.
	// If one does not exist, a new Cache is created and returned.
	// The additional user and usedFor parameters are used to automatically
	// stop informers for objects that are no longer watched.
	// After all users have called .FreeWithUser(), the cache itself will be stopped.
	GetWithUser(
		ctx context.Context, owner T,
		user client.Object, usedFor []client.Object,
	) (Accessor, error)

	// Free will stop and remove a TrackingCache for
	// the provided object, if one exists.
	Free(ctx context.Context, owner T) error

	// FreeWithUser informs the manager that the given user no longer needs
	// a cache scoped to owner T. If the cache has no active users, it will be stopped.
	FreeWithUser(ctx context.Context, owner T, user client.Object) error

	// Source returns a controller-runtime source to watch from a controller.
	Source(handler handler.EventHandler, predicates ...predicate.Predicate) source.Source

	GetWatchersForGVK(gvk schema.GroupVersionKind) (out []AccessManagerKey)

	CollectMetrics(ctx context.Context) (ObjectsPerOwnerPerGVK, error)
}

type ObjectsPerOwnerPerGVK map[AccessManagerKey]map[schema.GroupVersionKind]int

type RefType interface {
	client.Object
	comparable
}

type TrackingCache interface {
	cache.Cache

	// Source returns a source to watch from a controller.
	Source(handler handler.EventHandler, predicates ...predicate.Predicate) source.Source

	// RemoveOtherInformers stops all informers that are not needed to watch the given list of object types.
	RemoveOtherInformers(ctx context.Context, gvks sets.Set[schema.GroupVersionKind]) error

	// GetGVKs returns a list of GVKs known by this trackingCache.
	GetGVKs() []schema.GroupVersionKind

	Watch(ctx context.Context, user client.Object, gvks sets.Set[schema.GroupVersionKind]) error
	Free(ctx context.Context, user client.Object) error

	GetObjectsPerInformer(ctx context.Context) (map[schema.GroupVersionKind]int, error)
}