minkapi

type App struct {
	// Server is the MinKAPI server instance.
	Server Server
	// Ctx is the application context.
	Ctx context.Context
	// Cancel is the context cancellation function.
	Cancel context.CancelFunc
}

type Config struct {
	// BasePrefix is the path prefix at which the base View of the minkapi service is served. ie KAPI-Service at http://<MinKAPIHost>:<MinKAPIPort>/BasePrefix
	// Defaults to [DefaultBasePrefix]
	BasePrefix string
	commontypes.ServerConfig
	// WatchConfig holds config parameters relevant for watchers.
	WatchConfig WatchConfig
}

type CreateSandboxViewFunc = func(log logr.Logger, delegateView View, args *ViewArgs) (View, error)

type EventSink interface {
	Resettable
	events.EventSink
	// List returns all events in the sink.
	List() []eventsv1.Event
}

type MatchCriteria struct {
	// Namespace specifies the namespace to match. Empty means all namespaces.
	Namespace string
	// Names specifies the set of object names to match. Empty means all names.
	Names sets.Set[string]
	// LabelSelector specifies the label selector for matching objects.
	LabelSelector labels.Selector
}

type Resettable interface {
	// Reset resets the state of the implementing type.
	Reset()
}

type ResourceStore interface {
	Resettable
	io.Closer
	// GetObjAndListGVK gets the object GVK and object list GVK associated with this resource store.
	GetObjAndListGVK() (objKind schema.GroupVersionKind, objListKind schema.GroupVersionKind)
	// Add adds a new object to the store.
	Add(mo metav1.Object) error
	// GetByKey retrieves an object from the store by its key.
	GetByKey(key string) (o runtime.Object, err error)
	// Get retrieves an object from the store by its name.
	Get(objName cache.ObjectName) (o runtime.Object, err error)
	// Update updates an existing object in the store.
	Update(mo metav1.Object) error
	// DeleteByKey deletes an object from the store by its key.
	DeleteByKey(key string) error
	// Delete deletes an object from the store by its name.
	Delete(objName cache.ObjectName) error
	// DeleteObjects deletes objects matching the given criteria and returns the count of deleted objects.
	DeleteObjects(c MatchCriteria) (delCount int, err error)
	// List lists objects matching the given criteria.
	List(c MatchCriteria) (listObj runtime.Object, err error)
	// ListMetaObjects lists metadata objects matching the given criteria.
	ListMetaObjects(c MatchCriteria) (metaObjs []metav1.Object, maxVersion int64, err error)
	// Watch watches object changes in this store starting from the given startVersion, belonging to the given namespace and matching the given labelSelector and then constructs a watch.Event followed by invoking eventCallback.
	Watch(ctx context.Context, startVersion int64, namespace string, labelSelector labels.Selector, eventCallback WatchEventCallback) error
	// GetWatcher returns a watcher - an implementation of watch.Interface to watch changes in objects beginning from options.ResourceVersion and belonging to the given namespace, then use the  options.labelSelector to filter, and supply watch events via the watch.Interface.ResultChan.
	// options.FieldSelector is currently not supported.
	GetWatcher(ctx context.Context, namespace string, options metav1.ListOptions) (watch.Interface, error)
	// GetVersionCounter returns the atomic counter for generating monotonically increasing resource versions
	GetVersionCounter() *atomic.Int64
}

type ResourceStoreArgs struct {
	// Name is the name of the resource store.
	Name string
	// ObjectGVK is the GroupVersionKind for objects stored in this store.
	ObjectGVK schema.GroupVersionKind
	// ObjectListGVK is the GroupVersionKind for object lists from this store.
	ObjectListGVK schema.GroupVersionKind
	// Scheme is the runtime Scheme used by the KAPI objects storable in this store.
	Scheme *runtime.Scheme
	// WatchConfig contains configuration for watch operations.
	WatchConfig WatchConfig
	// VersionCounter is the atomic counter for generating monotonically increasing resource versions
	VersionCounter *atomic.Int64 //optional
	// Log is the logger instance for this store.
	Log logr.Logger
}

type Server interface {
	commontypes.Service
	// GetBaseView returns the foundational View of the KAPI Server which is exposed at http://<MinKAPIHost>:<MinKAPIPort>/basePrefix
	GetBaseView() View
	// GetSandboxView creates or returns a sandboxed KAPI View with the given name that is also served as a KAPI Service
	// at http://<MinKAPIHost>:<MinKAPIPort>/sandboxName. A kubeconfig named `minkapi-<name>.yaml` is also generated
	// in the same directory as the base `minkapi.yaml`.  The sandbox name should be a valid path-prefix, ie no-spaces.
	//
	// TODO: discuss whether the above is OK.
	GetSandboxView(log logr.Logger, name string) (View, error)
}

type View interface {
	Resettable
	io.Closer
	// GetName returns the name of this view.
	GetName() string
	// GetType returns the type of this view (base or sandbox).
	GetType() ViewType
	// GetClientFacades gets the in-memory implementation ClientFacades that can be used by code to interact with this view
	// via standard k8s client and informer interfaces
	GetClientFacades() (commontypes.ClientFacades, error)
	// GetResourceStore returns the resource store for the specified GroupVersionKind.
	GetResourceStore(gvk schema.GroupVersionKind) (ResourceStore, error)
	// GetEventSink returns the event sink for this view.
	GetEventSink() EventSink
	// CreateObject creates a new object of the specified GVK in this view.
	CreateObject(gvk schema.GroupVersionKind, obj metav1.Object) error
	// GetObject retrieves an object of the specified GVK by name.
	GetObject(gvk schema.GroupVersionKind, objName cache.ObjectName) (runtime.Object, error)
	// UpdateObject updates an existing object of the specified GVK.
	UpdateObject(gvk schema.GroupVersionKind, obj metav1.Object) error
	// UpdatePodNodeBinding updates a pod's node binding and returns the updated pod.
	UpdatePodNodeBinding(podName cache.ObjectName, binding corev1.Binding) (*corev1.Pod, error)
	// PatchObject applies a patch to an object of the specified GVK.
	PatchObject(gvk schema.GroupVersionKind, objName cache.ObjectName, patchType types.PatchType, patchData []byte) (patchedObj runtime.Object, err error)
	// PatchObjectStatus applies a patch to an object's status subresource.
	PatchObjectStatus(gvk schema.GroupVersionKind, objName cache.ObjectName, patchData []byte) (patchedObj runtime.Object, err error)
	// ListMetaObjects lists metadata objects matching the given criteria.
	ListMetaObjects(gvk schema.GroupVersionKind, criteria MatchCriteria) (metaObjs []metav1.Object, maxVersion int64, err error)
	// ListObjects lists objects in the store while matching the criteria and returns the matching objects as a runtime.Object which is actually a *<Kind>List. Ex: *PodList
	// TODO: consider better name for this method.
	ListObjects(gvk schema.GroupVersionKind, criteria MatchCriteria) (runtime.Object, error)
	// WatchObjects watches for changes to objects of the specified GVK.
	WatchObjects(ctx context.Context, gvk schema.GroupVersionKind, startVersion int64, namespace string, labelSelector labels.Selector, eventCallback WatchEventCallback) error
	// GetWatcher returns a watcher for objects of the specified GVK.
	GetWatcher(ctx context.Context, gvk schema.GroupVersionKind, namespace string, opts metav1.ListOptions) (watch.Interface, error)
	// DeleteObject deletes an object of the specified GVK by name.
	DeleteObject(gvk schema.GroupVersionKind, objName cache.ObjectName) error
	// DeleteObjects deletes objects of the specified GVK matching the criteria.
	DeleteObjects(gvk schema.GroupVersionKind, criteria MatchCriteria) error
	// ListNodes returns nodes matching the specified node names, or all nodes if none specified.
	ListNodes(matchingNodeNames ...string) ([]corev1.Node, error)
	// ListPods returns pods matching the specified criteria.
	ListPods(criteria MatchCriteria) ([]corev1.Pod, error)
	// ListEvents returns events in the specified namespace.
	ListEvents(namespace string) ([]eventsv1.Event, error)
	// GetObjectChangeCount returns the current change count made to objects through this view.
	GetObjectChangeCount() int64
	// GetKubeConfigPath returns the path to the kubeconfig file for this view.
	GetKubeConfigPath() string
}

type ViewArgs struct {
	// Name represents name of View
	Name string
	// KubeConfigPath is the path of the kubeconfig file corresponding to this view
	KubeConfigPath string
	// Scheme is the runtime Scheme used by KAPI objects exposed by this view
	Scheme *runtime.Scheme
	// WatchConfig contains configuration for watch operations.
	WatchConfig WatchConfig
}

type ViewType string

type WatchConfig struct {
	// QueueSize is the maximum number of events to queue per watcher
	QueueSize int
	// Timeout represents the timeout for watches following which MinKAPI service will close the connection and ends the watch.
	Timeout time.Duration
}

type WatchEventCallback func(watch.Event) (err error)