fix(patch): Add kind, apiVersion, status to ignored fields and make JsonPatch preview feature

Author: buehler

src/KubeOps.Abstractions/Entities/JsonPatchExtensions.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information.
 
+using System.Runtime.Versioning;
 using System.Text;
 using System.Text.Json.Nodes;
 
@@ -16,6 +17,9 @@ namespace KubeOps.Abstractions.Entities;
 /// <summary>
 /// Method extensions for JSON diffing between two entities (<see cref="IKubernetesObject{TMetadata}"/>).
 /// </summary>
+[RequiresPreviewFeatures("JsonPatch extensions are a preview feature and may change in the future." +
+                         "Because maybe the default filtering does not catch all volatile and non-impactful" +
+                         "properties.")]
 public static class JsonPatchExtensions
 {
     /// <summary>
@@ -46,6 +50,9 @@ public static class JsonPatchExtensions
         "/metadata/resourceVersion",
         "/metadata/selfLink",
         "/metadata/uid",
+        "/status",
+        "/kind",
+        "/apiVersion",
     ];
 
     /// <summary>
@@ -64,7 +71,9 @@ public static class JsonPatchExtensions
     /// </list>
     /// </summary>
     public static readonly Func<IReadOnlyList<PatchOperation>, IReadOnlyList<PatchOperation>> DefaultOperationsFilter =
-        operations => operations.Where(o => !DefaultIgnoredProperties.Contains(o.Path.ToString())).ToList();
+        operations =>
+            operations.Where(o => !DefaultIgnoredProperties.Any(ignored => o.Path.ToString().StartsWith(ignored)))
+                .ToList();
 
     /// <summary>
     /// Convert a <see cref="IKubernetesObject{TMetadata}"/> into a <see cref="JsonNode"/>.

src/KubeOps.KubernetesClient/IKubernetesClient.cs

@@ -2,6 +2,8 @@
 // The .NET Foundation licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information.
 
+using System.Runtime.Versioning;
+
 using Json.Patch;
 
 using k8s;
@@ -338,6 +340,10 @@ TEntity UpdateStatus<TEntity>(TEntity entity)
     /// <param name="cancellationToken">Cancellation token to monitor for cancellation requests.</param>
     /// <returns>The patched entity.</returns>
     /// <exception cref="InvalidOperationException">Thrown if the entity to be patched does not exist on the API.</exception>
+    [RequiresPreviewFeatures("This method is using the JsonPatch feature which is in preview." +
+                             "Return values may change (e.g. if the patch was actually applied" +
+                             "when no changes were detected. Also, the filtering may not include" +
+                             "all volatile properties yet.")]
     Task<TEntity> PatchAsync<TEntity>(
         TEntity entity,
         Func<IReadOnlyList<PatchOperation>, IReadOnlyList<PatchOperation>>? operationsFilter = null,
@@ -370,6 +376,10 @@ Task<TEntity> PatchAsync<TEntity>(
     /// <param name="operationsFilter">The filter that is applied to the <see cref="PatchOperation"/>s in the <see cref="JsonPatch"/> to determine if changes are present.</param>
     /// <param name="cancellationToken">Cancellation token to monitor for cancellation requests.</param>
     /// <returns>The patched entity.</returns>
+    [RequiresPreviewFeatures("This method is using the JsonPatch feature which is in preview." +
+                             "Return values may change (e.g. if the patch was actually applied" +
+                             "when no changes were detected. Also, the filtering may not include" +
+                             "all volatile properties yet.")]
     Task<TEntity> PatchAsync<TEntity>(
         TEntity from,
         TEntity to,
@@ -391,6 +401,10 @@ Task<TEntity> PatchAsync<TEntity>(
     /// <param name="patch">The <see cref="JsonPatch"/> representing the changes to apply.</param>
     /// <param name="cancellationToken">Cancellation token to monitor for cancellation requests.</param>
     /// <returns>The patched entity.</returns>
+    [RequiresPreviewFeatures("This method is using the JsonPatch feature which is in preview." +
+                             "Return values may change (e.g. if the patch was actually applied" +
+                             "when no changes were detected. Also, the filtering may not include" +
+                             "all volatile properties yet.")]
     Task<TEntity> PatchAsync<TEntity>(TEntity entity, JsonPatch patch, CancellationToken cancellationToken = default)
         where TEntity : IKubernetesObject<V1ObjectMeta> =>
         PatchAsync(entity, patch.ToKubernetesPatch(), cancellationToken);
@@ -430,6 +444,10 @@ Task<TEntity> PatchAsync<TEntity>(
     /// <param name="entity">The entity containing the desired updates.</param>
     /// <returns>The patched entity.</returns>
     /// <exception cref="InvalidOperationException">Thrown if the entity to be patched does not exist on the API.</exception>
+    [RequiresPreviewFeatures("This method is using the JsonPatch feature which is in preview." +
+                             "Return values may change (e.g. if the patch was actually applied" +
+                             "when no changes were detected. Also, the filtering may not include" +
+                             "all volatile properties yet.")]
     TEntity Patch<TEntity>(TEntity entity)
         where TEntity : IKubernetesObject<V1ObjectMeta>
         => PatchAsync(entity).GetAwaiter().GetResult();
@@ -441,6 +459,10 @@ TEntity Patch<TEntity>(TEntity entity)
     /// <param name="from">The current/original entity.</param>
     /// <param name="to">The updated entity with desired changes.</param>
     /// <returns>The patched entity.</returns>
+    [RequiresPreviewFeatures("This method is using the JsonPatch feature which is in preview." +
+                             "Return values may change (e.g. if the patch was actually applied" +
+                             "when no changes were detected. Also, the filtering may not include" +
+                             "all volatile properties yet.")]
     TEntity Patch<TEntity>(TEntity from, TEntity to)
         where TEntity : IKubernetesObject<V1ObjectMeta>
         => PatchAsync(from, to).GetAwaiter().GetResult();
@@ -452,6 +474,10 @@ TEntity Patch<TEntity>(TEntity from, TEntity to)
     /// <param name="entity">The entity to patch.</param>
     /// <param name="patch">The <see cref="JsonPatch"/> representing the changes to apply.</param>
     /// <returns>The patched entity.</returns>
+    [RequiresPreviewFeatures("This method is using the JsonPatch feature which is in preview." +
+                             "Return values may change (e.g. if the patch was actually applied" +
+                             "when no changes were detected. Also, the filtering may not include" +
+                             "all volatile properties yet.")]
     TEntity Patch<TEntity>(TEntity entity, JsonPatch patch)
         where TEntity : IKubernetesObject<V1ObjectMeta>
         => PatchAsync(entity, patch).GetAwaiter().GetResult();

src/KubeOps.Operator.Web/Webhooks/Admission/Mutation/MutationResult.cs

@@ -68,6 +68,7 @@ public async Task ExecuteResultAsync(ActionContext context)
             return;
         }
 
+#pragma warning disable CA2252 // TODO: as soon as patch is fully stable, remove this.
         await response.WriteAsJsonAsync(
             new AdmissionResponse
             {
@@ -83,5 +84,6 @@ await response.WriteAsJsonAsync(
                         : OriginalObject!.CreatePatch(ModifiedObject.ToNode()).ToBase64String(),
                 },
             });
+#pragma warning restore CA2252
     }
 }

src/KubeOps.Operator.Web/Webhooks/Admission/Mutation/MutationWebhook{TEntity}.cs

@@ -110,11 +110,13 @@ public async Task<IActionResult> Mutate(
         [FromBody] AdmissionRequest<TEntity> request,
         CancellationToken cancellationToken)
     {
+#pragma warning disable CA2252 // TODO: remove this once the patch is stable.
         var original = request.Request.Operation switch
         {
             CreateOperation or UpdateOperation => request.Request.Object!.ToNode(),
             _ => request.Request.OldObject!.ToNode(),
         };
+#pragma warning restore CA2252
 
         var result = request.Request.Operation switch
         {

test/KubeOps.Abstractions.Test/Entities/JsonPatchExtensions.Test.cs

@@ -4,6 +4,7 @@
 
 using FluentAssertions;
 
+using k8s;
 using k8s.Models;
 
 using KubeOps.Abstractions.Entities;
@@ -192,7 +193,8 @@ public void GetJsonDiff_Removes_Object_From_Containers_List()
     [Fact]
     public void GetJsonDiff_Filters_Metadata_Fields()
     {
-        var from = new V1ConfigMap { Metadata = new V1ObjectMeta { Name = "test", ResourceVersion = "1" } };
+        var from = new V1ConfigMap { Metadata = new V1ObjectMeta { Name = "test", ResourceVersion = "1" } }
+            .Initialize();
         var to = new V1ConfigMap { Metadata = new V1ObjectMeta { Name = "test", ResourceVersion = "2" } };
         var diff = from.CreateJsonPatch(to);
         diff.Operations.Should().HaveCount(0);