Changed the pvcToSnapshotsMap type and addressed some TODOs

Author: kolluria

pkg/csi/service/common/commonco/k8sorchestrator/k8sorchestrator.go

@@ -249,12 +249,11 @@ func (n namespacedName) String() string {
 }
 
 // pvcToSnapshotsMap maps a PVC to its snapshots.
-// Key is the namespaced name of the PVC and value is a map.
-// The key of the inner map is the namespaced name of the snapshot.
-// TODO: change the key of the inner map to string
+// The primary key is the namespaced name of the PVC and value is a map.
+// The key of the inner map is the name of the snapshot.
 type pvcToSnapshotsMap struct {
 	*sync.RWMutex
-	items map[namespacedName]map[namespacedName]struct{}
+	items map[namespacedName]map[string]struct{}
 }
 
 func (m *pvcToSnapshotsMap) add(pvc, snapshot, namespace string) {
@@ -266,13 +265,9 @@ func (m *pvcToSnapshotsMap) add(pvc, snapshot, namespace string) {
 		name:      pvc,
 	}
 	if _, ok := m.items[pvcKey]; !ok {
-		m.items[pvcKey] = make(map[namespacedName]struct{})
+		m.items[pvcKey] = make(map[string]struct{})
 	}
-	snapKey := namespacedName{
-		namespace: namespace,
-		name:      snapshot,
-	}
-	m.items[pvcKey][snapKey] = struct{}{}
+	m.items[pvcKey][snapshot] = struct{}{}
 }
 
 func (m *pvcToSnapshotsMap) get(pvc, namespace string) []string {
@@ -289,8 +284,8 @@ func (m *pvcToSnapshotsMap) get(pvc, namespace string) []string {
 	}
 
 	snaps := make([]string, 0, len(snapMap))
-	for k := range snapMap {
-		snaps = append(snaps, k.name)
+	for snap := range snapMap {
+		snaps = append(snaps, snap)
 	}
 	return snaps
 }
@@ -308,11 +303,7 @@ func (m *pvcToSnapshotsMap) delete(pvc, snapshot, namespace string) {
 		return
 	}
 
-	snapKey := namespacedName{
-		namespace: namespace,
-		name:      snapshot,
-	}
-	delete(snapMap, snapKey)
+	delete(snapMap, snapshot)
 	if len(snapMap) != 0 {
 		m.items[pvcKey] = snapMap
 		return
@@ -2045,7 +2036,7 @@ func initPVCToSnapshotsMap(ctx context.Context, controllerClusterFlavor cnstypes
 
 	k8sOrchestratorInstance.pvcToSnapshotsMap = pvcToSnapshotsMap{
 		RWMutex: &sync.RWMutex{},
-		items:   make(map[namespacedName]map[namespacedName]struct{}),
+		items:   make(map[namespacedName]map[string]struct{}),
 	}
 	snapshotAdded := func(obj any) {
 		snap, ok := obj.(*snapshotv1.VolumeSnapshot)
@@ -2086,6 +2077,8 @@ func initPVCToSnapshotsMap(ctx context.Context, controllerClusterFlavor cnstypes
 		func(obj any) {
 			snapshotAdded(obj)
 		},
+		// Since the name of PVC associated with a snapshot is immutable,
+		// update events do not have any impact on the state of the cache.
 		nil,
 		func(obj any) {
 			snapshotDeleted(obj)

pkg/kubernetes/informers.go

@@ -18,7 +18,6 @@ package kubernetes
 
 import (
 	"context"
-	"fmt"
 	"sync"
 	"time"
 
@@ -322,8 +321,6 @@ func (im *InformerManager) Listen() (stopCh <-chan struct{}) {
 
 	go im.snapshotInformerFactory.Start(im.stopCh)
 	cacheSync := im.snapshotInformerFactory.WaitForCacheSync(im.stopCh)
-	// TODO: remove
-	fmt.Print(cacheSync)
 	for _, isSynced := range cacheSync {
 		if !isSynced {
 			return
@@ -332,3 +329,26 @@ func (im *InformerManager) Listen() (stopCh <-chan struct{}) {
 
 	return im.stopCh
 }
+
+// NewConfigMapListener creates a new configmap listener in the given namespace.
+// NOTE: This creates a NewSharedIndexInformer everytime and does not use the informer factory.
+// Only use this function when you need a configmap listener in a different namespace than the
+// one already present in the informer factory.
+func NewConfigMapListener(ctx context.Context, client clientset.Interface, namespace string,
+	add func(obj interface{}), update func(oldObj, newObj interface{}), remove func(obj interface{})) error {
+	log := logger.GetLogger(ctx)
+	configMapInformer := v1.NewFilteredConfigMapInformer(client, namespace, resyncPeriodConfigMapInformer,
+		cache.Indexers{}, nil)
+
+	_, err := configMapInformer.AddEventHandler(cache.ResourceEventHandlerFuncs{
+		AddFunc:    add,
+		UpdateFunc: update,
+		DeleteFunc: remove,
+	})
+	if err != nil {
+		return logger.LogNewErrorf(log, "failed to add event handler on configmap listener. Error: %v", err)
+	}
+	stopCh := make(chan struct{})
+	go configMapInformer.Run(stopCh)
+	return nil
+}

pkg/kubernetes/types.go

@@ -51,7 +51,7 @@ type InformerManager struct {
 	client clientset.Interface
 	// main shared informer factory
 	informerFactory informers.SharedInformerFactory
-	
+	// snapshot informer factory
 	snapshotInformerFactory externalversions.SharedInformerFactory
 
 	// main signal