Add some logging to the repository cache

[#226] Co-authored-by: Todd Ritchie <tritchie@vmware.com>
vmware-tanzu · Oct 22, 2021 · 7b92d08 · 7b92d08
1 parent c4aff20
commit 7b92d08
Show file tree

Hide file tree

Showing 4 changed files with 149 additions and 9 deletions.
diff --git a/pkg/registrar/registrar.go b/pkg/registrar/registrar.go
@@ -82,7 +82,7 @@ func RegisterControllers(mgr manager.Manager) error {
 }
 
 func registerWorkloadController(mgr manager.Manager) error {
-	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring()))
+	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring(), mgr.GetLogger().WithName("workload-repo-cache")))
 
 	ctrl, err := pkgcontroller.New("workload", mgr, pkgcontroller.Options{
 		Reconciler: workload.NewReconciler(repo, conditions.NewConditionManager, realizerworkload.NewRealizer()),
@@ -114,7 +114,7 @@ func registerWorkloadController(mgr manager.Manager) error {
 }
 
 func registerSupplyChainController(mgr manager.Manager) error {
-	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring()))
+	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring(), mgr.GetLogger().WithName("supply-chain-repo-cache")))
 
 	ctrl, err := pkgcontroller.New("supply-chain", mgr, pkgcontroller.Options{
 		Reconciler: supplychain.NewReconciler(repo, conditions.NewConditionManager),
@@ -134,7 +134,7 @@ func registerSupplyChainController(mgr manager.Manager) error {
 }
 
 func registerDeliveryController(mgr manager.Manager) error {
-	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring()))
+	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring(), mgr.GetLogger().WithName("delivery-repo-cache")))
 
 	ctrl, err := pkgcontroller.New("delivery", mgr, pkgcontroller.Options{
 		Reconciler: delivery.NewReconciler(repo),
@@ -154,7 +154,7 @@ func registerDeliveryController(mgr manager.Manager) error {
 }
 
 func registerDeliverableController(mgr manager.Manager) error {
-	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring()))
+	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring(), mgr.GetLogger().WithName("deliverable-repo-cache")))
 
 	ctrl, err := pkgcontroller.New("deliverable", mgr, pkgcontroller.Options{
 		Reconciler: deliverable.NewReconciler(repo, conditions.NewConditionManager, realizerdeliverable.NewRealizer()),
@@ -186,7 +186,7 @@ func registerDeliverableController(mgr manager.Manager) error {
 }
 
 func registerPipelineServiceController(mgr manager.Manager) error {
-	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring()))
+	repo := repository.NewRepository(mgr.GetClient(), repository.NewCache(cache.NewExpiring(), mgr.GetLogger().WithName("pipeline-repo-cache")))
 
 	reconciler := pipeline.NewReconciler(repo, realizerpipeline.NewRealizer())
 	ctrl, err := pkgcontroller.New("pipeline-service", mgr, pkgcontroller.Options{

diff --git a/pkg/repository/cache.go b/pkg/repository/cache.go
@@ -26,6 +26,12 @@ const submittedCachePrefix = "submitted"
 const persistedCachePrefix = "persisted"
 const CacheExpiryDuration = 1 * time.Hour
 
+//counterfeiter:generate . Logger
+type Logger interface {
+	Error(err error, msg string, keysAndValues ...interface{})
+	Info(msg string, keysAndValues ...interface{})
+}
+
 //counterfeiter:generate . ExpiringCache
 type ExpiringCache interface {
 	Get(key interface{}) (val interface{}, ok bool)
@@ -39,14 +45,16 @@ type RepoCache interface {
 	Refresh(submitted *unstructured.Unstructured)
 }
 
-func NewCache(c ExpiringCache) RepoCache {
+func NewCache(c ExpiringCache, l Logger) RepoCache {
 	return &cache{
-		ec: c,
+		ec:     c,
+		logger: l,
 	}
 }
 
 type cache struct {
-	ec ExpiringCache
+	ec     ExpiringCache
+	logger Logger
 }
 
 func (c *cache) Set(submitted, persisted *unstructured.Unstructured) {
@@ -76,24 +84,33 @@ func (c *cache) UnchangedSinceCached(submitted *unstructured.Unstructured, exist
 	persistedCached := c.getPersistedCached(persistedKey)
 
 	if !submittedUnchanged {
+		if submittedCached != nil {
+			c.logger.Info("miss: submitted object in cache is different from submitted object")
+		} else {
+			c.logger.Info("miss: object not in cache")
+		}
 		return nil
 	}
 
 	for _, existing := range existingList {
 		existingSpec, ok := existing.Object["spec"]
 		if !ok {
+			c.logger.Info("miss: object on apiserver has no spec")
 			continue
 		}
 
 		persistedCachedSpec, ok := persistedCached.Object["spec"]
 		if !ok {
+			c.logger.Info("miss: persisted object in cache has no spec")
 			continue
 		}
 
 		sameSame := reflect.DeepEqual(existingSpec, persistedCachedSpec)
 		if sameSame {
+			c.logger.Info("hit: persisted object in cache matches spec on apiserver")
 			return existing
 		} else {
+			c.logger.Info("miss: persisted object in cache DOES NOT match spec on apiserver")
 			continue
 		}
 	}

diff --git a/pkg/repository/cache_test.go b/pkg/repository/cache_test.go
@@ -27,12 +27,14 @@ var _ = Describe("Cache", func() {
 	var (
 		cache                repository.RepoCache
 		fakeExpiringCache    *repositoryfakes.FakeExpiringCache
+		fakeLogger           *repositoryfakes.FakeLogger
 		submitted, persisted *unstructured.Unstructured
 	)
 
 	BeforeEach(func() {
 		fakeExpiringCache = &repositoryfakes.FakeExpiringCache{}
-		cache = repository.NewCache(fakeExpiringCache)
+		fakeLogger = &repositoryfakes.FakeLogger{}
+		cache = repository.NewCache(fakeExpiringCache, fakeLogger)
 
 		objKind := "the-kind"
 		objName := "its-name"

diff --git a/pkg/repository/repositoryfakes/fake_logger.go b/pkg/repository/repositoryfakes/fake_logger.go