Add items to cache immediately after apply

This improves the SSA helper by avoding a second no-op patch just to add
items to the cache. Instead we calculate the new request identifier and
add to the cache directly.

Signed-off-by: Lennart Jern <[email protected]>

Author: lentzi90

internal/util/ssa/patch.go

@@ -84,6 +84,7 @@ func Patch(ctx context.Context, c client.Client, fieldManager string, modified c
 	if err != nil {
 		return err
 	}
+	modifiedUnstructuredBeforeApply := modifiedUnstructured.DeepCopy()
 
 	gvk, err := apiutil.GVKForObject(modifiedUnstructured, c.Scheme())
 	if err != nil {
@@ -132,10 +133,16 @@ func Patch(ctx context.Context, c client.Client, fieldManager string, modified c
 
 	// Add the request to the cache only if dry-run was not used.
 	if options.WithCachingProxy && !options.WithDryRun {
-		// If the SSA call did not update the object, add the request to the cache.
-		if options.Original.GetResourceVersion() == modifiedUnstructured.GetResourceVersion() {
-			options.Cache.Add(requestIdentifier)
+		// If the object changed, we need to recompute the request identifier before caching.
+		if options.Original.GetResourceVersion() != modifiedUnstructured.GetResourceVersion() {
+			// NOTE: This takes the resourceVersion from modifiedUnstructured, and the hash from
+			// modifiedUnstructuredBeforeApply, which is what we want.
+			requestIdentifier, err = ComputeRequestIdentifier(c.Scheme(), modifiedUnstructured, modifiedUnstructuredBeforeApply)
+			if err != nil {
+				return errors.Wrapf(err, "failed to compute request identifier after apply")
+			}
 		}
+		options.Cache.Add(requestIdentifier)
 	}
 
 	return nil

internal/util/ssa/patch_test.go

@@ -17,19 +17,48 @@ limitations under the License.
 package ssa
 
 import (
+	"context"
+	"sync"
 	"testing"
 	"time"
 
 	. "github.com/onsi/gomega"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta2"
 	"sigs.k8s.io/cluster-api/util/test/builder"
 )
 
+// applyCountingClient wraps a client and counts Apply calls.
+type applyCountingClient struct {
+	client.Client
+	applyCount int
+	mu         sync.Mutex
+}
+
+func (c *applyCountingClient) Apply(ctx context.Context, obj runtime.ApplyConfiguration, opts ...client.ApplyOption) error {
+	c.mu.Lock()
+	c.applyCount++
+	c.mu.Unlock()
+	return c.Client.Apply(ctx, obj, opts...)
+}
+
+func (c *applyCountingClient) getCount() int {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+	return c.applyCount
+}
+
+func (c *applyCountingClient) resetCount() {
+	c.mu.Lock()
+	c.applyCount = 0
+	c.mu.Unlock()
+}
+
 func TestPatch(t *testing.T) {
 	g := NewWithT(t)
 
@@ -48,26 +77,43 @@ func TestPatch(t *testing.T) {
 		fieldManager := "test-manager"
 		ssaCache := NewCache("test-controller")
 
+		// Wrap the client to count API calls
+		countingClient := &applyCountingClient{Client: env.GetClient()}
+
 		// 1. Create the object
 		createObject := initialObject.DeepCopy()
-		g.Expect(Patch(ctx, env.GetClient(), fieldManager, createObject)).To(Succeed())
+		g.Expect(Patch(ctx, countingClient, fieldManager, createObject)).To(Succeed())
+		g.Expect(countingClient.getCount()).To(Equal(1), "Expected 1 API call for create")
 
-		// 2. Update the object and verify that the request was not cached as the object was changed.
+		// 2. Update the object and verify that the request was not cached with the old identifier,
+		// but is cached with a new identifier (after apply).
 		// Get the original object.
 		originalObject := initialObject.DeepCopy()
 		g.Expect(env.GetAPIReader().Get(ctx, client.ObjectKeyFromObject(originalObject), originalObject)).To(Succeed())
 		// Modify the object
 		modifiedObject := initialObject.DeepCopy()
 		g.Expect(unstructured.SetNestedField(modifiedObject.Object, "baz", "spec", "foo")).To(Succeed())
-		// Compute request identifier, so we can later verify that the update call was not cached.
+		// Compute request identifier before the update, so we can later verify that the update call was not cached with this identifier.
 		modifiedUnstructured, err := prepareModified(env.Scheme(), modifiedObject)
 		g.Expect(err).ToNot(HaveOccurred())
-		requestIdentifier, err := ComputeRequestIdentifier(env.GetScheme(), originalObject, modifiedUnstructured)
+		oldRequestIdentifier, err := ComputeRequestIdentifier(env.GetScheme(), originalObject, modifiedUnstructured)
 		g.Expect(err).ToNot(HaveOccurred())
+		// Save a copy of modifiedUnstructured before apply to compute the new identifier later
+		modifiedUnstructuredBeforeApply := modifiedUnstructured.DeepCopy()
 		// Update the object
-		g.Expect(Patch(ctx, env.GetClient(), fieldManager, modifiedObject, WithCachingProxy{Cache: ssaCache, Original: originalObject})).To(Succeed())
-		// Verify that request was not cached (as it changed the object)
-		g.Expect(ssaCache.Has(requestIdentifier, initialObject.GetKind())).To(BeFalse())
+		countingClient.resetCount()
+		g.Expect(Patch(ctx, countingClient, fieldManager, modifiedObject, WithCachingProxy{Cache: ssaCache, Original: originalObject})).To(Succeed())
+		g.Expect(countingClient.getCount()).To(Equal(1), "Expected 1 API call for first update (object changed)")
+		// Verify that request was not cached with the old identifier (as it changed the object)
+		g.Expect(ssaCache.Has(oldRequestIdentifier, initialObject.GetKind())).To(BeFalse())
+		// Get the actual object from server after apply to compute the new request identifier
+		objectAfterApply := initialObject.DeepCopy()
+		g.Expect(env.GetAPIReader().Get(ctx, client.ObjectKeyFromObject(objectAfterApply), objectAfterApply)).To(Succeed())
+		// Compute the new request identifier (after apply)
+		newRequestIdentifier, err := ComputeRequestIdentifier(env.GetScheme(), objectAfterApply, modifiedUnstructuredBeforeApply)
+		g.Expect(err).ToNot(HaveOccurred())
+		// Verify that request was cached with the new identifier (after apply)
+		g.Expect(ssaCache.Has(newRequestIdentifier, initialObject.GetKind())).To(BeTrue())
 
 		// 3. Repeat the same update and verify that the request was cached as the object was not changed.
 		// Get the original object.
@@ -79,12 +125,14 @@ func TestPatch(t *testing.T) {
 		// Compute request identifier, so we can later verify that the update call was cached.
 		modifiedUnstructured, err = prepareModified(env.Scheme(), modifiedObject)
 		g.Expect(err).ToNot(HaveOccurred())
-		requestIdentifier, err = ComputeRequestIdentifier(env.GetScheme(), originalObject, modifiedUnstructured)
+		requestIdentifierNoOp, err := ComputeRequestIdentifier(env.GetScheme(), originalObject, modifiedUnstructured)
 		g.Expect(err).ToNot(HaveOccurred())
 		// Update the object
-		g.Expect(Patch(ctx, env.GetClient(), fieldManager, modifiedObject, WithCachingProxy{Cache: ssaCache, Original: originalObject})).To(Succeed())
+		countingClient.resetCount()
+		g.Expect(Patch(ctx, countingClient, fieldManager, modifiedObject, WithCachingProxy{Cache: ssaCache, Original: originalObject})).To(Succeed())
+		g.Expect(countingClient.getCount()).To(Equal(0), "Expected 0 API calls for repeat update (should hit cache)")
 		// Verify that request was cached (as it did not change the object)
-		g.Expect(ssaCache.Has(requestIdentifier, initialObject.GetKind())).To(BeTrue())
+		g.Expect(ssaCache.Has(requestIdentifierNoOp, initialObject.GetKind())).To(BeTrue())
 	})
 
 	t.Run("Test patch with Machine", func(*testing.T) {
@@ -123,30 +171,51 @@ func TestPatch(t *testing.T) {
 		fieldManager := "test-manager"
 		ssaCache := NewCache("test-controller")
 
+		// Wrap the client to count API calls
+		countingClient := &applyCountingClient{Client: env.GetClient()}
+
 		// 1. Create the object
 		createObject := initialObject.DeepCopy()
-		g.Expect(Patch(ctx, env.GetClient(), fieldManager, createObject)).To(Succeed())
+		g.Expect(Patch(ctx, countingClient, fieldManager, createObject)).To(Succeed())
+		g.Expect(countingClient.getCount()).To(Equal(1), "Expected 1 API call for create")
 		// Verify that gvk is still set
 		g.Expect(createObject.GroupVersionKind()).To(Equal(initialObject.GroupVersionKind()))
 
-		// 2. Update the object and verify that the request was not cached as the object was changed.
+		// 2. Update the object and verify that the request was not cached with the old identifier,
+		// but is cached with a new identifier (after apply).
 		// Get the original object.
 		originalObject := initialObject.DeepCopy()
 		g.Expect(env.GetAPIReader().Get(ctx, client.ObjectKeyFromObject(originalObject), originalObject)).To(Succeed())
 		// Modify the object
 		modifiedObject := initialObject.DeepCopy()
 		modifiedObject.Spec.Deletion.NodeDrainTimeoutSeconds = ptr.To(int32(5))
-		// Compute request identifier, so we can later verify that the update call was not cached.
+		// Compute request identifier before the update, so we can later verify that the update call was not cached with this identifier.
 		modifiedUnstructured, err := prepareModified(env.Scheme(), modifiedObject)
 		g.Expect(err).ToNot(HaveOccurred())
-		requestIdentifier, err := ComputeRequestIdentifier(env.GetScheme(), originalObject, modifiedUnstructured)
+		oldRequestIdentifier, err := ComputeRequestIdentifier(env.GetScheme(), originalObject, modifiedUnstructured)
 		g.Expect(err).ToNot(HaveOccurred())
+		// Save a copy of modifiedUnstructured before apply to compute the new identifier later
+		modifiedUnstructuredBeforeApply := modifiedUnstructured.DeepCopy()
 		// Update the object
-		g.Expect(Patch(ctx, env.GetClient(), fieldManager, modifiedObject, WithCachingProxy{Cache: ssaCache, Original: originalObject})).To(Succeed())
+		countingClient.resetCount()
+		g.Expect(Patch(ctx, countingClient, fieldManager, modifiedObject, WithCachingProxy{Cache: ssaCache, Original: originalObject})).To(Succeed())
+		g.Expect(countingClient.getCount()).To(Equal(1), "Expected 1 API call for first update (object changed)")
 		// Verify that gvk is still set
 		g.Expect(modifiedObject.GroupVersionKind()).To(Equal(initialObject.GroupVersionKind()))
-		// Verify that request was not cached (as it changed the object)
-		g.Expect(ssaCache.Has(requestIdentifier, initialObject.GetObjectKind().GroupVersionKind().Kind)).To(BeFalse())
+		// Verify that request was not cached with the old identifier (as it changed the object)
+		g.Expect(ssaCache.Has(oldRequestIdentifier, initialObject.GetObjectKind().GroupVersionKind().Kind)).To(BeFalse())
+		// Get the actual object from server after apply to compute the new request identifier
+		objectAfterApply := initialObject.DeepCopy()
+		g.Expect(env.GetAPIReader().Get(ctx, client.ObjectKeyFromObject(objectAfterApply), objectAfterApply)).To(Succeed())
+		// Convert to unstructured WITHOUT filtering to preserve server fields (like resourceVersion)
+		objectAfterApplyUnstructured := &unstructured.Unstructured{}
+		err = env.GetScheme().Convert(objectAfterApply, objectAfterApplyUnstructured, nil)
+		g.Expect(err).ToNot(HaveOccurred())
+		// Compute the new request identifier (after apply)
+		newRequestIdentifier, err := ComputeRequestIdentifier(env.GetScheme(), objectAfterApplyUnstructured, modifiedUnstructuredBeforeApply)
+		g.Expect(err).ToNot(HaveOccurred())
+		// Verify that request was cached with the new identifier (after apply)
+		g.Expect(ssaCache.Has(newRequestIdentifier, initialObject.GetObjectKind().GroupVersionKind().Kind)).To(BeTrue())
 
 		// Wait for 1 second. We are also trying to verify in this test that the resourceVersion of the Machine
 		// is not increased. Under some circumstances this would only happen if the timestamp in managedFields would
@@ -166,12 +235,14 @@ func TestPatch(t *testing.T) {
 		// Compute request identifier, so we can later verify that the update call was cached.
 		modifiedUnstructured, err = prepareModified(env.Scheme(), modifiedObject)
 		g.Expect(err).ToNot(HaveOccurred())
-		requestIdentifier, err = ComputeRequestIdentifier(env.GetScheme(), originalObject, modifiedUnstructured)
+		requestIdentifierNoOp, err := ComputeRequestIdentifier(env.GetScheme(), originalObject, modifiedUnstructured)
 		g.Expect(err).ToNot(HaveOccurred())
 		// Update the object
-		g.Expect(Patch(ctx, env.GetClient(), fieldManager, modifiedObject, WithCachingProxy{Cache: ssaCache, Original: originalObject})).To(Succeed())
+		countingClient.resetCount()
+		g.Expect(Patch(ctx, countingClient, fieldManager, modifiedObject, WithCachingProxy{Cache: ssaCache, Original: originalObject})).To(Succeed())
+		g.Expect(countingClient.getCount()).To(Equal(0), "Expected 0 API calls for repeat update (should hit cache)")
 		// Verify that request was cached (as it did not change the object)
-		g.Expect(ssaCache.Has(requestIdentifier, initialObject.GetObjectKind().GroupVersionKind().Kind)).To(BeTrue())
+		g.Expect(ssaCache.Has(requestIdentifierNoOp, initialObject.GetObjectKind().GroupVersionKind().Kind)).To(BeTrue())
 		// Verify that gvk is still set
 		g.Expect(modifiedObject.GroupVersionKind()).To(Equal(initialObject.GroupVersionKind()))
 	})