fix(customize): metacontroller#414 - Use 'UID' as cache key to avoid …

…collisions between objects in different namespaces

Closes metacontroller#414

Signed-off-by: grzesuav <grzesuav@gmail.com>

pkg/controller/common/customize/cache.go

@@ -19,6 +19,8 @@ package customize
 import (
 	"time"
 
+	"k8s.io/apimachinery/pkg/types"
+
 	"zgo.at/zcache"
 )
 
@@ -42,17 +44,17 @@ type customizeResponseCacheEntry struct {
 }
 
 // Add adds a given response for given parent and its generation
-func (responseCache *ResponseCache) Add(name string, parentGeneration int64, response *CustomizeHookResponse) {
+func (responseCache *ResponseCache) Add(uid types.UID, parentGeneration int64, response *CustomizeHookResponse) {
 	responseCacheEntry := customizeResponseCacheEntry{
 		parentGeneration: parentGeneration,
 		cachedResponse:   response,
 	}
-	responseCache.cache.Set(name, &responseCacheEntry, zcache.DefaultExpiration)
+	responseCache.cache.Set(toKey(uid), &responseCacheEntry, zcache.DefaultExpiration)
 }
 
 // Get returns response from cache or nil when not found
-func (responseCache *ResponseCache) Get(name string, parentGeneration int64) *CustomizeHookResponse {
-	value, found := responseCache.cache.Get(name)
+func (responseCache *ResponseCache) Get(uid types.UID, parentGeneration int64) *CustomizeHookResponse {
+	value, found := responseCache.cache.Get(toKey(uid))
 	if !found {
 		return nil
 	}
@@ -62,3 +64,7 @@ func (responseCache *ResponseCache) Get(name string, parentGeneration int64) *Cu
 	}
 	return responseCacheEntry.cachedResponse
 }
+
+func toKey(uid types.UID) string {
+	return string(uid)
+}

pkg/controller/common/customize/manager.go

@@ -116,7 +116,7 @@ func (rm *Manager) Stop() {
 }
 
 func (rm *Manager) getCachedCustomizeHookResponse(parent *unstructured.Unstructured) *CustomizeHookResponse {
-	return rm.customizeCache.Get(parent.GetName(), parent.GetGeneration())
+	return rm.customizeCache.Get(parent.GetUID(), parent.GetGeneration())
 }
 
 func (rm *Manager) getCustomizeHookResponse(parent *unstructured.Unstructured) (*CustomizeHookResponse, error) {
@@ -133,7 +133,7 @@ func (rm *Manager) getCustomizeHookResponse(parent *unstructured.Unstructured) (
 			return nil, err
 		}
 
-		rm.customizeCache.Add(parent.GetName(), parent.GetGeneration(), &response)
+		rm.customizeCache.Add(parent.GetUID(), parent.GetGeneration(), &response)
 		return &response, nil
 	}
 }

pkg/controller/common/customize/manager_test.go

@@ -90,7 +90,7 @@ func TestGetRelatedObject_requestResponse(t *testing.T) {
 
 	customizeManagerWithFakeController.customizeHook = NewHookExecutorStub(expectedResponse)
 	parent := &unstructured.Unstructured{}
-	parent.SetName("othertest")
+	parent.SetUID("some")
 	parent.SetGeneration(1)
 
 	response, err := customizeManagerWithFakeController.getCustomizeHookResponse(parent)
@@ -103,7 +103,7 @@ func TestGetRelatedObject_requestResponse(t *testing.T) {
 		t.Errorf("Response should be equal to %v, got %v", expectedResponse, response)
 	}
 
-	if customizeManagerWithFakeController.customizeCache.Get("othertest", 1) == nil {
+	if customizeManagerWithFakeController.customizeCache.Get("some", 1) == nil {
 		t.Error("Expected not nil here, response should be cached")
 	}
 }