Merge pull request #1458 from benluddy/resolver-cache

Add an operator cache for use by the resolver.

Author: openshift-merge-robot

pkg/controller/registry/grpc/source.go

@@ -190,18 +190,19 @@ func (s *SourceStore) Remove(key resolver.CatalogKey) error {
 	return source.Conn.Close()
 }
 
-func (s *SourceStore) AsClients(globalNamespace, localNamespace string) map[resolver.CatalogKey]client.Interface {
+func (s *SourceStore) AsClients(namespaces ...string) map[resolver.CatalogKey]client.Interface {
 	refs := map[resolver.CatalogKey]client.Interface{}
 	s.sourcesLock.RLock()
 	defer s.sourcesLock.RUnlock()
 	for key, source := range s.sources {
-		if !(key.Namespace == globalNamespace || key.Namespace == localNamespace) {
-			continue
-		}
 		if source.LastConnect.IsZero() {
 			continue
 		}
-		refs[key] = client.NewClientFromConn(source.Conn)
+		for _, namespace := range namespaces {
+			if key.Namespace == namespace {
+				refs[key] = client.NewClientFromConn(source.Conn)
+			}
+		}
 	}
 
 	// TODO : remove unhealthy

pkg/controller/registry/resolver/cache.go

@@ -0,0 +1,308 @@
+package resolver
+
+import (
+	"context"
+	"fmt"
+	"sync"
+	"time"
+
+	"github.com/blang/semver"
+	"github.com/sirupsen/logrus"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
+	"github.com/operator-framework/operator-registry/pkg/client"
+)
+
+type ClientProvider interface {
+	Get() (client.Interface, error)
+}
+
+type LazyClient struct {
+	address string
+	c       client.Interface
+	m       sync.Mutex
+}
+
+func (lc *LazyClient) Get() (client.Interface, error) {
+	lc.m.Lock()
+	defer lc.m.Unlock()
+	if lc.c != nil {
+		return lc.c, nil
+	}
+	client, err := client.NewClient(lc.address)
+	if err != nil {
+		return nil, err
+	}
+	lc.c = client
+	return lc.c, nil
+}
+
+type RegistryClientProvider interface {
+	ClientsForNamespaces(namespaces ...string) map[CatalogKey]ClientProvider
+}
+
+type DefaultRegistryClientProvider struct {
+	logger logrus.FieldLogger
+	c      versioned.Interface
+}
+
+func NewDefaultRegistryClientProvider(c versioned.Interface) *DefaultRegistryClientProvider {
+	return &DefaultRegistryClientProvider{
+		logger: logrus.New(),
+		c:      c,
+	}
+}
+
+func (rcp *DefaultRegistryClientProvider) ClientsForNamespaces(namespaces ...string) map[CatalogKey]ClientProvider {
+	result := make(map[CatalogKey]ClientProvider)
+	for _, namespace := range namespaces {
+		list, err := rcp.c.OperatorsV1alpha1().CatalogSources(namespace).List(context.TODO(), metav1.ListOptions{})
+		if err != nil {
+			rcp.logger.Errorf("failed to list catalogsources in %s: %s", namespace, err.Error())
+			continue
+		}
+		for _, source := range list.Items {
+			if source.Status.RegistryServiceStatus == nil {
+				continue
+			}
+			key := CatalogKey{
+				Namespace: source.Namespace,
+				Name:      source.Name,
+			}
+			result[key] = &LazyClient{address: source.Address()}
+		}
+	}
+	return result
+}
+
+type CatalogDependencyCache interface {
+	GetCSVNameFromCatalog(csvName string, catalog CatalogKey) (Operator, error)
+	GetCSVNameFromAllCatalogs(csvName string) ([]Operator, error)
+	GetPackageFromAllCatalogs(pkg string) ([]Operator, error)
+	GetPackageVersionFromAllCatalogs(pkg string, version semver.Version) ([]Operator, error)
+}
+
+type OperatorCache struct {
+	logger    logrus.FieldLogger
+	rcp       RegistryClientProvider
+	snapshots map[CatalogKey]*CatalogSnapshot
+	ttl       time.Duration
+	sem       chan struct{}
+	m         sync.RWMutex
+}
+
+func NewOperatorCache(rcp RegistryClientProvider) *OperatorCache {
+	const (
+		MaxConcurrentSnapshotUpdates = 4
+	)
+
+	return &OperatorCache{
+		logger:    logrus.New(),
+		rcp:       rcp,
+		snapshots: make(map[CatalogKey]*CatalogSnapshot),
+		ttl:       5 * time.Minute,
+		sem:       make(chan struct{}, MaxConcurrentSnapshotUpdates),
+	}
+}
+
+type NamespacedOperatorCache struct {
+	snapshots map[CatalogKey]*CatalogSnapshot
+}
+
+var _ CatalogDependencyCache = &NamespacedOperatorCache{}
+
+func (c *OperatorCache) Namespaced(namespaces ...string) *NamespacedOperatorCache {
+	const (
+		CachePopulateTimeout = time.Minute
+	)
+
+	now := time.Now()
+	clients := c.rcp.ClientsForNamespaces(namespaces...)
+
+	result := NamespacedOperatorCache{
+		snapshots: make(map[CatalogKey]*CatalogSnapshot),
+	}
+
+	var misses []CatalogKey
+	func() {
+		c.m.RLock()
+		defer c.m.RUnlock()
+		for key := range clients {
+			if snapshot, ok := c.snapshots[key]; ok && !snapshot.Expired(now) {
+				result.snapshots[key] = snapshot
+			} else {
+				misses = append(misses, key)
+			}
+		}
+	}()
+
+	if len(misses) == 0 {
+		return &result
+	}
+
+	c.m.Lock()
+	defer c.m.Unlock()
+
+	// Take the opportunity to clear expired snapshots while holding the lock.
+	var expired []CatalogKey
+	for key, snapshot := range c.snapshots {
+		if snapshot.Expired(now) {
+			snapshot.Cancel()
+			expired = append(expired, key)
+		}
+	}
+	for _, key := range expired {
+		delete(c.snapshots, key)
+
+	}
+
+	// Check for any snapshots that were populated while waiting to acquire the lock.
+	var found int
+	for i := range misses {
+		if snapshot, ok := c.snapshots[misses[i]]; ok && !snapshot.Expired(now) {
+			result.snapshots[misses[i]] = snapshot
+			misses[found], misses[i] = misses[i], misses[found]
+			found++
+		}
+	}
+	misses = misses[found:]
+
+	for _, miss := range misses {
+		ctx, cancel := context.WithTimeout(context.Background(), CachePopulateTimeout)
+		s := CatalogSnapshot{
+			logger: c.logger.WithField("catalog", miss),
+			key:    miss,
+			expiry: now.Add(c.ttl),
+			pop:    cancel,
+		}
+		s.m.Lock()
+		c.snapshots[miss] = &s
+		result.snapshots[miss] = &s
+		go c.populate(ctx, &s, clients[miss])
+	}
+
+	return &result
+}
+
+func (c *OperatorCache) populate(ctx context.Context, snapshot *CatalogSnapshot, provider ClientProvider) {
+	defer snapshot.m.Unlock()
+
+	c.sem <- struct{}{}
+	defer func() { <-c.sem }()
+
+	registry, err := provider.Get()
+	if err != nil {
+		snapshot.logger.Errorf("failed to connect to registry: %s", err.Error())
+		return
+	}
+
+	it, err := registry.ListBundles(ctx)
+	if err != nil {
+		snapshot.logger.Errorf("failed to list bundles: %s", err.Error())
+		return
+	}
+
+	var operators []Operator
+	for b := it.Next(); b != nil; b = it.Next() {
+		o, err := NewOperatorFromBundle(b, "", snapshot.key)
+		if err != nil {
+			snapshot.logger.Warnf("failed to construct operator from bundle, continuing: %s", err.Error())
+			continue
+		}
+		operators = append(operators, *o)
+	}
+	if err := it.Error(); err != nil {
+		snapshot.logger.Warnf("error encountered while listing bundles: %s", err.Error())
+	}
+
+	snapshot.operators = operators
+}
+
+type CatalogSnapshot struct {
+	logger    logrus.FieldLogger
+	key       CatalogKey
+	expiry    time.Time
+	operators []Operator
+	m         sync.RWMutex
+	pop       context.CancelFunc
+}
+
+func (s *CatalogSnapshot) Cancel() {
+	s.pop()
+}
+
+func (s *CatalogSnapshot) Expired(at time.Time) bool {
+	return !at.Before(s.expiry)
+}
+
+type OperatorPredicate func(*Operator) bool
+
+func (s *CatalogSnapshot) Find(p OperatorPredicate) []Operator {
+	s.m.RLock()
+	defer s.m.RUnlock()
+
+	var result []Operator
+	for _, o := range s.operators {
+		if p(&o) {
+			result = append(result, o)
+		}
+	}
+	return result
+}
+
+func (n *NamespacedOperatorCache) GetCSVNameFromCatalog(csvName string, catalog CatalogKey) (Operator, error) {
+	s, ok := n.snapshots[catalog]
+	if !ok {
+		return Operator{}, fmt.Errorf("catalog %s not found", catalog)
+	}
+	operators := s.Find(func(o *Operator) bool {
+		return o.name == csvName
+	})
+	if len(operators) == 0 {
+		return Operator{}, fmt.Errorf("operator %s not found in catalog %s", csvName, catalog)
+	}
+	if len(operators) > 1 {
+		return Operator{}, fmt.Errorf("multiple operators named %s found in catalog %s", csvName, catalog)
+	}
+	return operators[0], nil
+}
+
+func (n *NamespacedOperatorCache) GetCSVNameFromAllCatalogs(csvName string) ([]Operator, error) {
+	var result []Operator
+	for _, s := range n.snapshots {
+		result = append(result, s.Find(func(o *Operator) bool {
+			return o.name == csvName
+		})...)
+	}
+	if len(result) == 0 {
+		return nil, fmt.Errorf("operator %s not found in any catalog", csvName)
+	}
+	return result, nil
+}
+
+func (n *NamespacedOperatorCache) GetPackageFromAllCatalogs(pkg string) ([]Operator, error) {
+	var result []Operator
+	for _, s := range n.snapshots {
+		result = append(result, s.Find(func(o *Operator) bool {
+			return o.Package() == pkg
+		})...)
+	}
+	if len(result) == 0 {
+		return nil, fmt.Errorf("operator with package %s not found in any catalog", pkg)
+	}
+	return result, nil
+}
+
+func (n *NamespacedOperatorCache) GetPackageVersionFromAllCatalogs(pkg string, version semver.Version) ([]Operator, error) {
+	var result []Operator
+	for _, s := range n.snapshots {
+		result = append(result, s.Find(func(o *Operator) bool {
+			return o.Package() == pkg && o.version.Equals(version)
+		})...)
+	}
+	if len(result) == 0 {
+		return nil, fmt.Errorf("operator with package %s and version %s not found in any catalog", pkg, version)
+	}
+	return result, nil
+}