Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions eventutils/event/event.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func setListWatchSourceOptionsDefaults(o *ListWatchSourceOptions) {
}
}

func NewListWatchSource[E api.Object](listFunc func(ctx context.Context) (
func NewListWatchSource[E api.Object](listFunc func(ctx context.Context, opts ...store.ListOption) (
[]E, error),
watchFunc func(ctx context.Context) (store.Watch[E], error),
opts ListWatchSourceOptions,
Expand All @@ -73,7 +73,7 @@ func NewListWatchSource[E api.Object](listFunc func(ctx context.Context) (
}

type ListWatchSource[E api.Object] struct {
listFunc func(ctx context.Context) ([]E, error)
listFunc func(ctx context.Context, opts ...store.ListOption) ([]E, error)
watchFunc func(ctx context.Context) (store.Watch[E], error)

handlesMu sync.RWMutex
Expand Down
18 changes: 16 additions & 2 deletions storeutils/host/host_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ import (

type Dummy struct {
api.Metadata `json:"metadata,omitempty"`
Spec string `json:"spec,omitempty"`
}

var (
tmpDir string
dummyStore store.Store[*Dummy]
tmpDir string
dummyStore store.Store[*Dummy]
dummyStoreField *host.Store[*Dummy]
)

const (
Expand Down Expand Up @@ -56,4 +58,16 @@ var _ = BeforeSuite(func() {
},
})
Expect(err).NotTo(HaveOccurred())

fieldTmpDir := GinkgoT().TempDir()
dummyStoreField, err = host.NewStore[*Dummy](host.Options[*Dummy]{
Dir: fieldTmpDir,
NewFunc: func() *Dummy {
return &Dummy{}
},
FieldIndexers: map[string]store.IndexerFunc[*Dummy]{
"spec": func(d *Dummy) string { return d.Spec },
},
})
Expect(err).NotTo(HaveOccurred())
})
203 changes: 197 additions & 6 deletions storeutils/host/store.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import (
"github.com/ironcore-dev/provider-utils/storeutils/store"
utilssync "github.com/ironcore-dev/provider-utils/storeutils/sync"
"github.com/ironcore-dev/provider-utils/storeutils/utils"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/selection"
"k8s.io/apimachinery/pkg/util/json"
"k8s.io/apimachinery/pkg/util/sets"
)
Expand All @@ -26,6 +28,7 @@ type Options[E api.Object] struct {
NewFunc func() E
CreateStrategy CreateStrategy[E]
WatchBufferSize int
FieldIndexers map[string]store.IndexerFunc[E]
}

func (o *Options[E]) Defaults() {
Expand All @@ -45,7 +48,12 @@ func NewStore[E api.Object](opts Options[E]) (*Store[E], error) {
return nil, fmt.Errorf("error creating store directory: %w", err)
}

return &Store[E]{
indexers := make(map[string]store.IndexerFunc[E], len(opts.FieldIndexers))
for k, v := range opts.FieldIndexers {
indexers[k] = v
}

s := &Store[E]{
dir: opts.Dir,

idMu: utilssync.NewMutexMap[string](),
Expand All @@ -55,26 +63,168 @@ func NewStore[E api.Object](opts Options[E]) (*Store[E], error) {

watches: sets.New[*watch[E]](),
watchBufferSize: opts.WatchBufferSize,
}, nil

indexers: indexers,
labelIndex: make(map[string]map[string]sets.Set[string]),
fieldIndex: make(map[string]map[string]sets.Set[string]),
}

entries, err := os.ReadDir(opts.Dir)
if err != nil {
return nil, fmt.Errorf("error reading store directory: %w", err)
}
for _, entry := range entries {
if entry.IsDir() {
continue
}
obj, err := s.get(entry.Name())
if err != nil {
return nil, fmt.Errorf("error warming up index: %w", err)
}
s.addToIndex(obj)
}

return s, nil
}

type Store[E api.Object] struct {
dir string

idMu *utilssync.MutexMap[string]

newFunc func() E
createStrategy CreateStrategy[E]

newFunc func() E
createStrategy CreateStrategy[E]
watchBufferSize int
watchesMu sync.RWMutex
watches sets.Set[*watch[E]]

indexers map[string]store.IndexerFunc[E]

indexMu sync.RWMutex
labelIndex map[string]map[string]sets.Set[string]
fieldIndex map[string]map[string]sets.Set[string]
}

type CreateStrategy[E api.Object] interface {
PrepareForCreate(obj E)
}

func (s *Store[E]) addToIndex(obj E) {
s.indexMu.Lock()
defer s.indexMu.Unlock()

id := obj.GetID()
for k, v := range obj.GetLabels() {
if s.labelIndex[k] == nil {
s.labelIndex[k] = make(map[string]sets.Set[string])
}
if s.labelIndex[k][v] == nil {
s.labelIndex[k][v] = sets.New[string]()
}
s.labelIndex[k][v].Insert(id)
}
for field, fn := range s.indexers {
v := fn(obj)
if s.fieldIndex[field] == nil {
s.fieldIndex[field] = make(map[string]sets.Set[string])
}
if s.fieldIndex[field][v] == nil {
s.fieldIndex[field][v] = sets.New[string]()
}
s.fieldIndex[field][v].Insert(id)
}
}

func (s *Store[E]) removeFromIndex(obj E) {
s.indexMu.Lock()
defer s.indexMu.Unlock()

id := obj.GetID()
for k, v := range obj.GetLabels() {
if m := s.labelIndex[k]; m != nil {
m[v].Delete(id)
}
}
for field, fn := range s.indexers {
v := fn(obj)
if m := s.fieldIndex[field]; m != nil {
m[v].Delete(id)
}
}
}

// resolveCandidateIDs returns the set of IDs matching all positive index-backed
// requirements. Returns nil when no filters are present (full scan needed).
// Negative label requirements (NotIn, DoesNotExist) are skipped here and
// applied as a post-filter in List.
func (s *Store[E]) resolveCandidateIDs(opts *store.ListOptions) sets.Set[string] {
s.indexMu.RLock()
defer s.indexMu.RUnlock()

var result sets.Set[string]
hasFilter := false

if opts.LabelSelector != nil {
reqs, selectable := opts.LabelSelector.Requirements()
if !selectable {
return sets.New[string]()
}
for _, req := range reqs {
switch req.Operator() {
case selection.Equals, selection.DoubleEquals, selection.In:
hasFilter = true
ids := sets.New[string]()
if m := s.labelIndex[req.Key()]; m != nil {
for v := range req.Values() {
if s := m[v]; s != nil {
ids = ids.Union(s)
}
}
}
result = indexIntersect(result, ids)
case selection.Exists:
hasFilter = true
ids := sets.New[string]()
if m := s.labelIndex[req.Key()]; m != nil {
for _, s := range m {
ids = ids.Union(s)
}
}
result = indexIntersect(result, ids)
}
}
}

if opts.FieldSelector != nil {
for _, req := range opts.FieldSelector.Requirements() {
hasFilter = true
ids := sets.New[string]()
if m := s.fieldIndex[req.Field]; m != nil {
if s := m[req.Value]; s != nil {
ids = s.Union(sets.New[string]())
}
}
result = indexIntersect(result, ids)
}
}

if !hasFilter {
return nil
}
if result == nil {
return sets.New[string]()
}
return result
}

// indexIntersect intersects a and b. A nil a means "universe" — returns a copy of b.
func indexIntersect(a, b sets.Set[string]) sets.Set[string] {
if a == nil {
return b.Union(sets.New[string]())
}
return a.Intersection(b)
}

func (s *Store[E]) Create(_ context.Context, obj E) (E, error) {
s.idMu.Lock(obj.GetID())
defer s.idMu.Unlock(obj.GetID())
Expand All @@ -100,6 +250,8 @@ func (s *Store[E]) Create(_ context.Context, obj E) (E, error) {
return utils.Zero[E](), err
}

s.addToIndex(obj)

s.enqueue(store.WatchEvent[E]{
Type: store.WatchEventTypeCreated,
Object: obj,
Expand Down Expand Up @@ -151,6 +303,9 @@ func (s *Store[E]) Update(_ context.Context, obj E) (E, error) {
return utils.Zero[E](), err
}

s.removeFromIndex(oldObj)
s.addToIndex(obj)

s.enqueue(store.WatchEvent[E]{
Type: store.WatchEventTypeUpdated,
Object: obj,
Expand Down Expand Up @@ -192,7 +347,37 @@ func (s *Store[E]) Delete(_ context.Context, id string) error {
return nil
}

func (s *Store[E]) List(ctx context.Context) ([]E, error) {
func (s *Store[E]) List(ctx context.Context, opts ...store.ListOption) ([]E, error) {
listOpts := &store.ListOptions{}
for _, opt := range opts {
opt.ApplyToList(listOpts)
}

if listOpts.FieldSelector != nil {
for _, req := range listOpts.FieldSelector.Requirements() {
if _, ok := s.indexers[req.Field]; !ok {
return nil, fmt.Errorf("field selector references unindexed field %q", req.Field)
}
}
}

candidateIDs := s.resolveCandidateIDs(listOpts)

if candidateIDs != nil {
var objs []E
for _, id := range candidateIDs.UnsortedList() {
obj, err := s.Get(ctx, id)
if err != nil {
return nil, fmt.Errorf("failed to read object: %w", err)
}
if listOpts.LabelSelector != nil && !listOpts.LabelSelector.Matches(labels.Set(obj.GetLabels())) {
continue
}
objs = append(objs, obj)
}
return objs, nil
}

entries, err := os.ReadDir(s.dir)
if err != nil {
return nil, fmt.Errorf("failed to list objects: %w", err)
Expand All @@ -210,6 +395,10 @@ func (s *Store[E]) List(ctx context.Context) ([]E, error) {
return nil, fmt.Errorf("failed to read object: %w", err)
}

if listOpts.LabelSelector != nil && !listOpts.LabelSelector.Matches(labels.Set(object.GetLabels())) {
continue
}

objs = append(objs, object)
}

Expand Down Expand Up @@ -262,6 +451,8 @@ func (s *Store[E]) set(obj E) (E, error) {
}

func (s *Store[E]) delete(obj E) error {
s.removeFromIndex(obj)

if err := os.Remove(filepath.Join(s.dir, obj.GetID())); err != nil {
return fmt.Errorf("failed to delete object from store: %w", err)
}
Expand Down
Loading