improve: related resource reference change by csviri · Pull Request #3425 · operator-framework/java-operator-sdk

csviri · 2026-06-17T14:50:55Z

When there is a resource that references (not owner reference) one or more custom resources (see sample), and the reference changes, we want to trigger reconciliation for both old and new resources referenced.
This PR fixes it by calling also the SeondaryToPrimary mapper twice (also for old resource) on update operation.

It adjusts also PrimaryToSecondaryIndex so when a reference changes it removed from the secondary from the old primary. That is a more strict, but correct behavior.

We did not have this issue for now, since usually the reference for (typically) "config resources" that serve as an input for the reconciliation (among the spec) is usually is other way around.
Note that for this use case PrimaryToSecondaryMapper is NOT needed, since basically this is very similar to classic owner reference scenario.

TODO:

filtering caching update path should not call SecondaryToPrimaryMapper twice

Copilot

Pull request overview

This PR improves handling of secondary→primary reference changes by extending the primary-to-secondary index update semantics, adding targeted tests (unit + integration), and introducing a new sample scenario demonstrating reconciliations when a secondary’s referenced primary set changes.

Changes:

Updated the informer eventing/indexing pipeline so updates can reconcile both newly referenced and no-longer-referenced primaries.
Added new core tests covering narrowing/moving references across updates.
Added a new operator-framework integration test + sample resources demonstrating subset reference changes.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/secondarytoprimaryreferencechange/TargetStatus.java	Adds a simple status model used by the sample primary CR.
operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/secondarytoprimaryreferencechange/TargetReconciler.java	Sample reconciler driven by a referencing secondary CR via an informer event source.
operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/secondarytoprimaryreferencechange/TargetCustomResource.java	Sample primary custom resource type for the new scenario.
operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/secondarytoprimaryreferencechange/SecondaryToPrimaryReferenceChangeIT.java	New IT demonstrating subset reference changes and expected reconciliation behavior.
operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/secondarytoprimaryreferencechange/ConfigToTargetMapper.java	Secondary→primary mapper for the sample that maps config.targetNames to targets.
operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/secondarytoprimaryreferencechange/ConfigSpec.java	Spec model for the sample secondary CR, including targetNames and value.
operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/secondarytoprimaryreferencechange/ConfigCustomResource.java	Sample secondary custom resource type.
operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/informer/PrimaryToSecondaryIndexTest.java	Adds tests verifying index updates remove obsolete primaries on update.
operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSourceTest.java	Updates mocks/verifications for new index method signatures and delete behavior.
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/SecondaryToPrimaryMapper.java	Updates mapper Javadoc wording.
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/PrimaryToSecondaryIndex.java	Changes index callbacks to return affected primary IDs.
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/NOOPPrimaryToSecondaryIndex.java	Adapts NOOP implementation to new return types.
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java	Uses index-returned primaries to drive reconciliation propagation and unions old/new mappings.
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/DefaultPrimaryToSecondaryIndex.java	Tracks and removes obsolete primaries on update; returns affected primaries for reconciliation.
docs/content/en/docs/documentation/eventing.md	Documents secondary→primary mapping behavior (currently inconsistent with the API).

Copilot

Pull request overview

Copilot reviewed 15 out of 15 changed files in this pull request and generated 5 comments.

+   * Maps a secondary resource to the set of primary resources that should be reconciled in
+   * response.
+   *
+   * @param resource the secondary resource for which an event was received
+   * @return set of primary resource IDs to enqueue for reconciliation; an empty set means the event
+   *     is irrelevant and no reconciliation is triggered. This is called also the old and the new
+   *     resources, in case of an update.


csviri · 2026-06-18T08:26:42Z

+    if (primaryResourceIdSet == null) {
+      primaryResourceIdSet = new HashSet<>();
+      primaryResourceIdSet.addAll(
+          configuration().getSecondaryToPrimaryMapper().toPrimaryResourceIDs(resource));
+      if (oldResource != null) {


This is relevant will take a look

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 4 comments.

csviri · 2026-06-18T10:39:07Z

  @Override
-  public void onAddOrUpdate(R resource) {
-    // empty method because of noop implementation
+  public Set<ResourceID> onAddOrUpdate(R resource, R oldResource) {
+    return null;
  }

  @Override
-  public void onDelete(R resource) {
+  public Set<ResourceID> onDelete(R resource) {
    // empty method because of noop implementation
+    return null;
  }


THis is relevant, but will need a refactoring to remove, will get rid of it in a subsequent PR

dvob · 2026-06-17T19:18:47Z

I updated my reproducer and it works as expected (dvob/java-operator-sdk-repo-example@1ce1404).

Also I like that with this approach we no longer need a special wiring.

@csviri thanks a lot for your effort!

csviri · 2026-06-18T06:51:42Z

-  public void onAddOrUpdate(R resource) {
-    // empty method because of noop implementation
+  public Set<ResourceID> onAddOrUpdate(R resource, R oldResource) {
+    return null;


This is very ugly, might be better to remove the NOOP index

…urce This might needed in some corner cases where might help with optimizations to which resource to trigger. Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

csviri · 2026-06-18T06:54:17Z

I updated my reproducer and it works as expected (dvob/java-operator-sdk-repo-example@1ce1404).

Also I like that with this approach we no longer need a special wiring.

@csviri thanks a lot for your effort!

Thank you @dvob for feedback and highlighting this use case, that helps a lot!

csviri · 2026-06-18T06:55:34Z

@metacosm @xstefank after this is merged I will do a small refactoring in the InformerEventSource since that coudl be a bit simpler, just did not want to do it in same PR. Please take a look on this.

metacosm · 2026-06-18T08:17:45Z

Can we focus this PR on what it needs to accomplish instead of also renaming methods and changing their visibility (if possible)?

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

csviri · 2026-06-18T08:25:03Z

Can we focus this PR on what it needs to accomplish instead of also renaming methods and changing their visibility (if possible)?

yep, np, I did

Copilot AI review requested due to automatic review settings June 17, 2026 14:50

openshift-ci Bot requested review from metacosm and xstefank June 17, 2026 14:51

Copilot started reviewing on behalf of csviri June 17, 2026 14:52 View session

csviri mentioned this pull request Jun 17, 2026

improve: extend SecondaryToPrimaryMapper so it also gets the old resource #3388

Closed

csviri linked an issue Jun 17, 2026 that may be closed by this pull request

InformerEventSource: trigger reconciles based on old and new resource state #3401

Open

Copilot AI reviewed Jun 17, 2026

View reviewed changes

csviri marked this pull request as draft June 17, 2026 15:04

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 Jun 17, 2026

csviri requested a review from Copilot June 17, 2026 15:12

csviri changed the title ~~improve: related resource owner reference change~~ improve: related resource reference change Jun 17, 2026

Copilot started reviewing on behalf of csviri June 17, 2026 15:15 View session

Copilot AI reviewed Jun 17, 2026

View reviewed changes

csviri changed the title ~~improve: related resource reference change~~ [WIP] improve: related resource reference change Jun 17, 2026

csviri force-pushed the strict-primary-to-secondary-index branch from 8170175 to 74c83aa Compare June 17, 2026 15:35

csviri requested a review from Copilot June 17, 2026 17:41

Copilot started reviewing on behalf of csviri June 17, 2026 17:42 View session

Copilot AI reviewed Jun 17, 2026

View reviewed changes

csviri changed the title ~~[WIP] improve: related resource reference change~~ improve: related resource reference change Jun 18, 2026

csviri marked this pull request as ready for review June 18, 2026 06:50

openshift-ci Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 18, 2026

csviri commented Jun 18, 2026

View reviewed changes

csviri added 7 commits June 18, 2026 08:53

improve: extend SecondaryToPrimaryMapper so it also gets the old reso…

58301d5

…urce This might needed in some corner cases where might help with optimizations to which resource to trigger. Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

format

8c03c7e

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

javadoc improve

5add551

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

naive IT

a662e1a

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

fix

8f80b29

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

fix test

04b809a

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

feat: strcit secondary to primary index

c289cc8

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

csviri and others added 12 commits June 18, 2026 08:53

fix

696769c

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

1228324

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

fix

53ce6c6

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

fixes

5d80f99

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

refactor

bd8c204

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

integration test updated

200c964

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

docs update

9a8aeed

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Potential fix for pull request finding

4ec2a75

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

format

e0fdd26

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

temp fix noop primary to secondary index

a9d6acf

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

a08970a

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Potential fix for pull request finding

22e4a58

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

csviri force-pushed the strict-primary-to-secondary-index branch from dcaa6c0 to 22e4a58 Compare June 18, 2026 06:53

csviri added 2 commits June 18, 2026 10:22

revert internal method name change

53eaf0b

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

visibility change

0268865

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Conversation

csviri commented Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

csviri Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

csviri Jun 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dvob commented Jun 17, 2026

Uh oh!

csviri Jun 18, 2026

Choose a reason for hiding this comment

Uh oh!

csviri commented Jun 18, 2026

Uh oh!

csviri commented Jun 18, 2026

Uh oh!

metacosm commented Jun 18, 2026

Uh oh!

csviri commented Jun 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

csviri commented Jun 17, 2026 •

edited

Loading

csviri Jun 18, 2026 •

edited

Loading