Reconciliation reason gets stuck as "reconciler requested retry" even if short-circuited

[nightkr]

Current and expected behavior

Currently, a reconciler that returns Ok(controller::Action::requeue(Duration::from_secs(10))) will always have the reconciliation reason be listed as "reconciler requested retry", even if they are triggered by an actual change. Instead, the overriding change should take priority and be listed instead.

Possible solution

Currently, the controller (scheduler, actually) latches on to the first reason that it sees to schedule any given reconciliation. Instead, it should use the reason behind the earliest time to reconcile, just like how the scheduler currently allows subsequent requests to cause the reconciliation to happen earlier.

I suspect that this means that ScheduleRequest will need to take an extra reason parameter, which we'd move into ScheduledEntry.

Additional context

No response

Environment

This is a kube-runtime issue, the cluster is irrelevant.

Configuration and features

kube = { version = "0.77.0", features = ["runtime"] }

Affected crates

kube-runtime

Would you like to work on fixing this bug?

yes

[aryan9600]

hey i'd like to take this on, if thats okay. i had a question regarding the new reason field.

so ScheduleRequest has a message field which is generic, but the controller always populates it with a ReconcileRequest object which already has a field called reason. so, i was wondering if we could reuse that somehow instead of introducing a new field in ScheduleRequest, but i guess it isn't possible because we want to keep the scheduler as generic as possible and free of any controller/reconciler specific code and APIs. this is making me think about the type of the new reason field that needs to be added in ScheduleRequest. these are the options i can think of:

• String (maybe a bit inflexible, but acceptable imo)
• ReconcileReason/Into<ReconcileReason> (defeats the purpose of keeping the scheduler generic)
• a new type: ScheduleReason

i'm open to other suggestions as well :)