Skip to content

CNTRLPLANE-3532: add JSON Patch status helper #9550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vsolanki12 wants to merge 1 commit into from
Closed

CNTRLPLANE-3532: add JSON Patch status helper #9550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 4 additions & 73 deletions control-plane-operator/hostedclusterconfigoperator/controllers/hcpstatus/hcpstatus.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
package hcpstatus

import (
"bytes"
"context"
"encoding/json"
"fmt"

hyperv1 "github.com/openshift/hypershift/api/hypershift/v1beta1"
"github.com/openshift/hypershift/control-plane-operator/hostedclusterconfigoperator/operator"
"github.com/openshift/hypershift/support/releaseinfo"
"github.com/openshift/hypershift/support/statuspatching"

configv1 "github.com/openshift/api/config/v1"

"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
Expand Down Expand Up @@ -66,86 +64,19 @@ type hcpStatusReconciler struct {
}

func (h *hcpStatusReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error) {
log := ctrl.LoggerFrom(ctx)
hcp := &hyperv1.HostedControlPlane{}
if err := h.mgtClusterClient.Get(ctx, req.NamespacedName, hcp); err != nil {
return reconcile.Result{}, fmt.Errorf("failed to get hcp %s: %w", req, err)
}
originalHCP := hcp.DeepCopy()
if err := h.reconcile(ctx, hcp); err != nil {
return reconcile.Result{}, err
}

if equality.Semantic.DeepEqual(hcp.Status, originalHCP.Status) {
return reconcile.Result{}, nil
}

// Use JSON Patch (RFC 6902) instead of JSON Merge Patch (RFC 7386).
// Merge patch interprets null as "delete field" (RFC 7386 §7), which corrupts
// +required +nullable fields in configv1.ClusterVersionStatus that have no
// omitempty and serialize nil as JSON null:
// - AvailableUpdates []configv1.Release `json:"availableUpdates"` — nil slice → null
// - CompletionTime *metav1.Time `json:"completionTime"` (in UpdateHistory) — nil pointer → null
// JSON Patch "replace"/"add" ops carry null as a literal value, preserving it correctly.
patch, err := buildStatusPatch(originalHCP, hcp)
if err != nil {
return reconcile.Result{}, fmt.Errorf("failed to build status patch: %w", err)
}

log.Info("Patching HCP status with new configuration and version status")
if err := h.mgtClusterClient.Status().Patch(ctx, hcp,
crclient.RawPatch(types.JSONPatchType, patch)); err != nil {
if err := statuspatching.PatchStatusWithJSONPatch(ctx, h.mgtClusterClient, hcp, func() error {
return h.reconcile(ctx, hcp)
}); err != nil {
return reconcile.Result{}, fmt.Errorf("failed to patch hcp status: %w", err)
}
log.Info("Successfully patched HCP status")

return reconcile.Result{}, nil
}

type jsonPatchOp struct {
Op string `json:"op"`
Path string `json:"path"`
Value interface{} `json:"value,omitempty"`
}

func buildStatusPatch(original, modified *hyperv1.HostedControlPlane) ([]byte, error) {
origJSON, err := json.Marshal(original.Status)
if err != nil {
return nil, err
}
modJSON, err := json.Marshal(modified.Status)
if err != nil {
return nil, err
}

var origMap, modMap map[string]json.RawMessage
if err := json.Unmarshal(origJSON, &origMap); err != nil {
return nil, err
}
if err := json.Unmarshal(modJSON, &modMap); err != nil {
return nil, err
}

// Optimistic lock: fail if the object was modified since our read.
ops := []jsonPatchOp{{Op: "test", Path: "/metadata/resourceVersion", Value: original.ResourceVersion}}

for key, modVal := range modMap {
origVal, exists := origMap[key]
if !exists {
ops = append(ops, jsonPatchOp{Op: "add", Path: "/status/" + key, Value: modVal})
} else if !bytes.Equal(origVal, modVal) {
ops = append(ops, jsonPatchOp{Op: "replace", Path: "/status/" + key, Value: modVal})
}
}
for key := range origMap {
if _, exists := modMap[key]; !exists {
ops = append(ops, jsonPatchOp{Op: "remove", Path: "/status/" + key})
}
}

return json.Marshal(ops)
}

// findClusterOperatorStatusCondition is identical to meta.FindStatusCondition except that it works on config1.ClusterOperatorStatusCondition instead of
// metav1.StatusCondition
func findClusterOperatorStatusCondition(conditions []configv1.ClusterOperatorStatusCondition, conditionType configv1.ClusterStatusConditionType) *configv1.ClusterOperatorStatusCondition {
Expand Down
Loading
Loading