make key fields private

Author: maciaszczykm

modules/common/client/cache/cache.go

@@ -14,14 +14,15 @@ import (
 var (
 	// cache is a global resource cache that maps our custom keys
 	// created based on information provided by the specific resource client.
-	// It stores resource lists in order to speed up the client response times.
+	// It stores resource lists to speed up the client response times.
 	cache *theine.Cache[string, any]
 
 	// cacheLocks is used as a set that holds information about
 	// cache keys that are currently fetching the latest data from the
-	// kubernetes API server in background. It allows us to avoid
-	// multiple concurrent update calls being sent to the K8S API.
-	// Once lock is removed, next update call can be initiated.
+	// kubernetes API server in the background.
+	// It allows us to avoid multiple concurrent update calls being sent
+	// to the Kubernetes API.
+	// Once the lock is removed, the next update call can be initiated.
 	cacheLocks sync.Map
 )
 
@@ -33,7 +34,7 @@ func init() {
 }
 
 // Get gives access to cache entries. It requires Key structure
-// to be provided which is used to calculate cache key sha.
+// to be provided which is used to calculate cache key SHA.
 func Get[T any](key Key) (T, bool, error) {
 	typedValue := lo.Empty[T]()
 
@@ -51,7 +52,7 @@ func Get[T any](key Key) (T, bool, error) {
 }
 
 // Set allows updating cache with specific values.
-// It requires Key structure to be provided which is used to calculate cache key sha.
+// It requires Key structure to be provided which is used to calculate cache key SHA.
 func Set[T any](key Key, value T) error {
 	cacheKey, err := key.SHA()
 	if err != nil {
@@ -62,7 +63,7 @@ func Set[T any](key Key, value T) error {
 	return nil
 }
 
-// DeferredLoad updates cache in background with the data fetched using the loadFunc.
+// DeferredLoad updates cache in the background with the data fetched using the loadFunc.
 func DeferredLoad[T any](key Key, loadFunc func() (T, error)) {
 	go func() {
 		cacheKey, err := key.SHA()

modules/common/client/cache/key.go

@@ -22,19 +22,19 @@ var contextCache *theine.Cache[string, string]
 // a unique cache key SHA. It is used when
 // `cluster-context-enabled=false`.
 type key struct {
-	// Kind is a kubernetes resource kind
-	Kind types.ResourceKind
+	// kind is a kubernetes resource kind
+	kind types.ResourceKind
 
-	// Namespaces is a kubernetes resource namespace
-	Namespace string
+	// namespace is a kubernetes resource namespace
+	namespace string
 
 	// Opts is a list options object used by the kubernetes client.
-	Opts metav1.ListOptions
+	opts metav1.ListOptions
 }
 
 // SHA calculates sha based on the internal key fields.
 func (k key) SHA() (string, error) {
-	k.Opts = metav1.ListOptions{LabelSelector: k.Opts.LabelSelector, FieldSelector: k.Opts.FieldSelector}
+	k.opts = metav1.ListOptions{LabelSelector: k.opts.LabelSelector, FieldSelector: k.opts.FieldSelector}
 	return helpers.HashObject(k)
 }
 
@@ -44,8 +44,8 @@ func (k key) SHA() (string, error) {
 type Key struct {
 	key
 
-	// Token is an auth token used to exchange it for the context ID.
-	Token string
+	// token is an auth token used to exchange it for the context ID.
+	token string
 
 	// context is an internal identifier used in conjunction with the key
 	// structure fields to create a cache key SHA that will be unique across
@@ -62,28 +62,25 @@ func (k Key) SHA() (sha string, err error) {
 		return k.key.SHA()
 	}
 
-	contextKey, exists := contextCache.Get(k.Token)
+	contextKey, exists := contextCache.Get(k.token)
 	if !exists {
-		contextKey, err = exchangeToken(k.Token)
+		contextKey, err = exchangeToken(k.token)
 		if err != nil {
 			return "", err
 		}
 
-		contextCache.SetWithTTL(k.Token, contextKey, 1, args.CacheTTL())
+		contextCache.SetWithTTL(k.token, contextKey, 1, args.CacheTTL())
 	}
 
-	k.Opts = metav1.ListOptions{LabelSelector: k.Opts.LabelSelector, FieldSelector: k.Opts.FieldSelector}
-	k.Token = ""
+	k.opts = metav1.ListOptions{LabelSelector: k.opts.LabelSelector, FieldSelector: k.opts.FieldSelector}
+	k.token = ""
 	k.context = contextKey
 	return helpers.HashObject(k)
 }
 
 // NewKey creates a new cache Key.
 func NewKey(kind types.ResourceKind, namespace, token string, opts metav1.ListOptions) Key {
-	return Key{
-		key:   key{Kind: kind, Namespace: namespace, Opts: opts},
-		Token: token,
-	}
+	return Key{key: key{kind, namespace, opts}, token: token}
 }
 
 type tokenExchangeTransport struct {