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 <lennart.jern@est.tech>

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,14 @@ 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() {
+requestIdentifier, err = ComputeRequestIdentifier(c.Scheme(), modifiedUnstructuredBeforeApply, modifiedUnstructured)
+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

@@ -52,22 +52,33 @@ func TestPatch(t *testing.T) {
 createObject := initialObject.DeepCopy()
 g.Expect(Patch(ctx, env.GetClient(), fieldManager, createObject)).To(Succeed())
 
-// 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())
+// 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(), modifiedUnstructuredBeforeApply, objectAfterApply)
+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 +90,12 @@ 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())
 // 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) {
@@ -129,24 +140,39 @@ func TestPatch(t *testing.T) {
 // 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())
 // 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(), modifiedUnstructuredBeforeApply, objectAfterApplyUnstructured)
+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 +192,12 @@ 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())
 // 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()))
 })