OCPCLOUD-3172: machinesetsync: refactor to a generalized differ which can work independent of types #382

chrischdi · 2025-10-10T07:57:29Z

No description provided.

…endent of types

openshift-ci-robot · 2025-10-10T07:57:34Z

@chrischdi: This pull request references OCPCLOUD-3172 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.21.0" version, but no target version was set.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci · 2025-10-10T07:57:35Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

openshift-ci · 2025-10-10T07:57:45Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign racheljpg for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

coderabbitai · 2025-10-10T07:58:00Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

chrischdi · 2025-10-10T08:01:07Z

/test unit
/test lint
/test build

openshift-ci · 2025-10-10T08:26:14Z

@chrischdi: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/lint	`ac815fd`	link	true	`/test lint`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

mdbooth

I think this is great and a clear improvement. I have some follow-on ideas, but I would personally gladly merge this and iterate on it in the unlikely event it ever became worth it.

I shared a thought inline based on something similar we did in ORC with field indexers.

Not at all important, but I also feel that Unstructured is an internal implementation detail: e.g. the Diff method could be implemented with reflection and the signature would not change.

mdbooth · 2025-10-10T09:23:25Z

pkg/util/sync.go

+	differ := UnstructuredDiffer[clusterv1.MachineSetStatus]{
+		customDiff: []func(a clusterv1.MachineSetStatus, b clusterv1.MachineSetStatus) ([]string, error){
+			func(a, b clusterv1.MachineSetStatus) ([]string, error) {
+				return compareCAPIMachineSetConditions(a.Conditions, b.Conditions), nil
+			},
+		},
+		ignoreFields: [][]string{{"conditions"}},
+	}


differ := UnstructuredDiffer[clusterv1.MachineSetStatus]() differ = WithCustomDiff(differ, "conditions", func(x *clusterv1.MachineSetStatus) []clusterv1.Condition {return x.conditions}, compareCAPIConditions) func compareCAPIConditions(a, b []clusterv1.Conditions) []string { ... }

WithCustomDiff unfortunately can't be a method on UnstructuredDiffer as it has an additional type argument([]clusterv1.Condition).

Advantages of this approach:

ignoreField is a required argument of CustomDiff, removing a footgun

compareCAPIConditions is now reusable by all types with CAPI conditions

Disadvantages:

The argument to pull a field out is a bit ugly

ignoreField is a required argument of CustomDiff, removing a footgun

Are there cases when we want to ignore fields without custom diffs no? Maybe around deprecated fields?

openshift-merge-robot · 2025-10-10T22:33:36Z

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

JoelSpeed · 2025-10-19T18:50:52Z

pkg/util/diff.go

+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+type UnstructuredDiffer[T any] struct {


Godoc missing

JoelSpeed · 2025-10-19T18:51:41Z

pkg/util/diff.go

+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+type UnstructuredDiffer[T any] struct {


If this is unstructured, why is it also generic? Does it make this simpler than using runtime.Object for the a, b arguments?

JoelSpeed · 2025-10-19T18:52:20Z

pkg/util/diff.go

+
+	diff := deep.Equal(unstructuredA, unstructuredB)
+	if len(diff) > 0 {
+		diffs["deep.Equal"] = diff


Why the deep.Equal key? Does this get exposed to end users? Is this a magic word?

JoelSpeed · 2025-10-19T18:53:34Z

pkg/util/sync.go

+	// Maybe we can also have it this way:
+	// differ := NewUnstructuredDiffer(
+	// 	WithIgnoreField[clusterv1.MachineSetStatus]("conditions"),
+	// 	WithCustomDiff(func(a, b clusterv1.MachineSetStatus) ([]string, error) {
+	// 		return compareCAPIMachineSetConditions(a.Conditions, b.Conditions), nil
+	// 	}),
+	// )


I prefer this

JoelSpeed · 2025-10-19T18:54:52Z

pkg/util/sync.go

+	differ := UnstructuredDiffer[clusterv1.MachineSetStatus]{
+		customDiff: []func(a clusterv1.MachineSetStatus, b clusterv1.MachineSetStatus) ([]string, error){
+			func(a, b clusterv1.MachineSetStatus) ([]string, error) {
+				return compareCAPIMachineSetConditions(a.Conditions, b.Conditions), nil
+			},
+		},
+		ignoreFields: [][]string{{"conditions"}},
+	}


ignoreField is a required argument of CustomDiff, removing a footgun

Are there cases when we want to ignore fields without custom diffs no? Maybe around deprecated fields?

machinesetsync: refactor to a generalized differ which can work indep…

ac815fd

…endent of types

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Oct 10, 2025

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 10, 2025

mdbooth reviewed Oct 10, 2025

View reviewed changes

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 10, 2025

JoelSpeed reviewed Oct 19, 2025

View reviewed changes

Uh oh!

OCPCLOUD-3172: machinesetsync: refactor to a generalized differ which can work independent of types #382

Are you sure you want to change the base?

OCPCLOUD-3172: machinesetsync: refactor to a generalized differ which can work independent of types #382

Uh oh!

Conversation

chrischdi commented Oct 10, 2025

Uh oh!

openshift-ci-robot commented Oct 10, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci bot commented Oct 10, 2025

Uh oh!

openshift-ci bot commented Oct 10, 2025

Uh oh!

coderabbitai bot commented Oct 10, 2025

Review skipped

Uh oh!

chrischdi commented Oct 10, 2025

Uh oh!

openshift-ci bot commented Oct 10, 2025

Uh oh!

mdbooth left a comment

Choose a reason for hiding this comment

Uh oh!

mdbooth Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

JoelSpeed Oct 19, 2025

Choose a reason for hiding this comment

Uh oh!

openshift-merge-robot commented Oct 10, 2025

Uh oh!

JoelSpeed Oct 19, 2025

Choose a reason for hiding this comment

Uh oh!

JoelSpeed Oct 19, 2025

Choose a reason for hiding this comment

Uh oh!

JoelSpeed Oct 19, 2025

Choose a reason for hiding this comment

Uh oh!

JoelSpeed Oct 19, 2025

Choose a reason for hiding this comment

Uh oh!

JoelSpeed Oct 19, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

openshift-ci-robot commented Oct 10, 2025 •

edited by openshift-ci bot

Loading