refactor: renaming core classes and APIs #646

csviri · 2021-11-02T09:47:32Z

Considering this as the next step for refactoring the core classes. Not necessary final in this regard, we might want to do more iterations on this.

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/ControllerUtils.java

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

metacosm · 2021-11-04T09:47:21Z

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -126,28 +126,28 @@ public void close() {
   * passing it the controller's original configuration. The effective registration of the
   * controller is delayed till the operator is started.
   *
-   * @param controller the controller to register
+   * @param reconciler part of the controller to register


I think that if we do this change, we need to remove the controller part completely everywhere and only talk about Reconciler because otherwiser it gets too confusing. Like what is a Controller is our SDK?

Answered above, the controller. Reconciler is just the logic how to reconciler, but this is basically same in controller runtime, the controller is the whole , reconciler is just part of it.
Unfortunate that we don't have a class representing the controller itslef, Maybe to renamae ConfiguredController to Controller?

...ator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/Reconciler.java

metacosm · 2021-11-04T09:55:09Z

...ramework-core/src/main/java/io/javaoperatorsdk/operator/processing/ConfiguredController.java

 import io.javaoperatorsdk.operator.processing.event.DefaultEventSourceManager;
 import io.javaoperatorsdk.operator.processing.event.EventSourceManager;

-public class ConfiguredController<R extends CustomResource<?, ?>> implements ResourceController<R>,
+public class ConfiguredController<R extends CustomResource<?, ?>> implements Reconciler<R>,


Maybe this class should be renamed ConfiguredReconciler or maybe simply Controller, where for our SDK a Controller would be a Reconciler associated with its configuration? In this case, we should also rename the Controller annotation to something different, maybe Configuration… Then again, the more I think about it, maybe we shouldn't be renaming things too much if there is no obvious benefit from doing so… because otherwise it will mean that we confuse our existing users and we will need to update all our existing documentation / articles…

hehe, yes also wrote this above , maybe this should be the Controller, and the @Controller annotation should be @ControllerConfiguration.

I think this class should be our high level aggregate (therefore name it as Controller), so it will contiain the Reconciler, the EventSourceManager, the EventProcessor (former DefaultEventHandler). Basically every aspect of a single controller instance.

The benefit is that we are now closer to go terminology, but on the other hand yes it can be confusing for the users. But getting it right now for v2 is probably the good time to do it "once and for all" :)

- ConfiguredController now feels more like an overall aggregate. Now centrally starts and stop some aggregated components.

# Conflicts: # operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/event/EventSourceTestCustomReconciler.java

metacosm · 2021-11-04T20:41:38Z

...ework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java

@@ -13,7 +13,7 @@
 public interface ControllerConfiguration<R extends CustomResource<?, ?>> {

  default String getName() {
-    return ControllerUtils.getDefaultResourceReconcilerName(getAssociatedControllerClassName());
+    return ControllerUtils.getDefaultReconcilerName(getAssociatedControllerClassName());


getAssociatedControllerClassName should also be renamed to getAssociatedReconcilerClassName

metacosm · 2021-11-08T09:13:42Z

DECISION_LOG.md

@@ -7,6 +7,6 @@

 The original idea was to explicitly support retry in the scheduler. However, this turned out to complicate the algorithm
 in case of event sources. Mostly it would be harder to manage the buffer, and the other event sources, thus what
-does it mean for other event sources that there was a failed controller execution? Probably it would be better to
-manage this in an abstract controller, and just use the "reprocess event-source" source in case of an error. 
+does it mean for other event sources that there was a failed controllerConfiguration execution? Probably it would be better to


Looks like you got too eager with search and replace :)

It's intellij too intelligent :) will fix these

but probably we can delete Decision log since it is not used

metacosm · 2021-11-08T09:13:58Z

README.md

@@ -130,7 +130,7 @@ dependencies {
 ```

 Once you've added the dependency, define a main method initializing the Operator and registering a
-controller.
+controllerConfiguration.


metacosm · 2021-11-08T09:14:28Z

docs/documentation/features.md

@@ -14,7 +14,7 @@ other configuration options are provided to fine tune or turn off these features
 ## Controller Execution in a Nutshell

 Controller execution is always triggered by an event. Events typically come from the custom resource
-(i.e. custom resource is created, updated or deleted) that the controller is watching, but also from different sources
+(i.e. custom resource is created, updated or deleted) that the controllerConfiguration is watching, but also from different sources


metacosm · 2021-11-08T09:14:34Z

docs/documentation/features.md

@@ -24,7 +24,7 @@ i.e. [ResourceController](https://github.com/java-operator-sdk/java-operator-sdk
 called, a post-processing phase follows, where typically framework checks if:

 - an exception was thrown during execution, if yes schedules a retry.
- there are new events received during the controller execution, if yes schedule the execution again.
+- there are new events received during the controllerConfiguration execution, if yes schedule the execution again.


metacosm

Many instances of controller got renamed to controllerConfiguration when they shouldn't have.

csviri · 2021-11-08T09:17:52Z

Many instances of controller got renamed to controllerConfiguration when they shouldn't have.

ahh ok thx, will check it.

csviri · 2021-11-08T13:20:51Z

@metacosm @lburgazzoli @adam-sandor can I merge this?
will address the stability issues of tests in a separate PR.

…tionAnnotationProcessor

refactor: renaming central classes and APIs

d478e35

csviri requested review from metacosm and lburgazzoli November 2, 2021 09:47

csviri marked this pull request as draft November 2, 2021 09:47

csviri linked an issue Nov 2, 2021 that may be closed by this pull request

Question & Opinion) ResourceController's init(EventSourceManager) method feels a bit vague. #615

Closed

csviri added 3 commits November 2, 2021 11:07

Merge branch 'v2' into renamings-reconciler

3b76d5e

refactor!: moving reconciler related classes to reconciler package

5919eac

refactor: moving reconciler and related classes to separate package

74920ab

csviri marked this pull request as ready for review November 3, 2021 08:04

csviri linked an issue Nov 3, 2021 that may be closed by this pull request

[resource-controller] rename createOrUpdateResource ? #374

Closed

csviri changed the title ~~refactor: renaming central classes and APIs~~ refactor: renaming core classes and APIs Nov 3, 2021

metacosm reviewed Nov 4, 2021

View reviewed changes

refactor!: further renamings

3f92747

- ConfiguredController now feels more like an overall aggregate. Now centrally starts and stop some aggregated components.

csviri requested a review from metacosm November 4, 2021 13:56

csviri added 4 commits November 4, 2021 15:02

refactor!: renamed ConfiguredController to Controller

fb58685

Merge branch 'v2' into renamings-reconciler

55b859d

Merge branch 'v2' into renamings-reconciler

6f07321

# Conflicts: # operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/event/EventSourceTestCustomReconciler.java

fix: removed unused method

444f7d1

metacosm reviewed Nov 4, 2021

View reviewed changes

csviri added 2 commits November 5, 2021 08:50

refactor: reconcile and cleanup

8b1be24

refactor: EventDispatcher to ReconciliationDispatcher

424f800

csviri linked an issue Nov 5, 2021 that may be closed by this pull request

Summary of Proposed Changes for Naming and Related Refactoring for V2 #655

Closed

csviri added 3 commits November 5, 2021 10:00

refactor: associated controller to reconciler

adc543a

fix: drawio pic

1d148ac

refactor!: renaming @controller to @ControllerAnnotation

9ec3471

metacosm reviewed Nov 8, 2021

View reviewed changes

metacosm requested changes Nov 8, 2021

View reviewed changes

fix: controllerConfiguration refactor issues in docs

910293a

csviri requested review from metacosm and adam-sandor November 8, 2021 09:34

refactor: image consistent naming

349fc11

csviri self-assigned this Nov 8, 2021

snowdrop-bot mentioned this pull request Nov 8, 2021

refactor: renaming core classes and APIs snowdrop-zen/java-operator-sdk#90

Closed

csviri and others added 11 commits November 9, 2021 13:28

fix: cleanup IT

2e0ec8b

fix: fix imports

75b8e0e

fix: improvements

8811dc3

fix: log message for crd apply in IT

224bcdf

fix: propagate cause to MissingCRD exception

94980ee

fix: naming

cadbc8a

fix: increased minikube version

0f9eaba

fix: experiment with CR IT issue

725fb06

docs: comment on sleep

b51e69b

fix: formatting

0521f8e

refactor: rename ControllerAnnotationProcessor to ControllerConfigura…

4105def

…tionAnnotationProcessor

metacosm approved these changes Nov 10, 2021

View reviewed changes

csviri merged commit 86245ca into v2 Nov 10, 2021

csviri deleted the renamings-reconciler branch November 10, 2021 13:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: renaming core classes and APIs #646

refactor: renaming core classes and APIs #646

csviri commented Nov 2, 2021 •

edited

Loading

metacosm Nov 4, 2021

csviri Nov 4, 2021

metacosm Nov 4, 2021

csviri Nov 4, 2021 •

edited

Loading

metacosm Nov 4, 2021

metacosm Nov 8, 2021

csviri Nov 8, 2021

csviri Nov 8, 2021

metacosm Nov 8, 2021

metacosm Nov 8, 2021

metacosm Nov 8, 2021

metacosm left a comment

csviri commented Nov 8, 2021

csviri commented Nov 8, 2021 •

edited

Loading

refactor: renaming core classes and APIs #646

refactor: renaming core classes and APIs #646

Conversation

csviri commented Nov 2, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

csviri Nov 4, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

metacosm left a comment

Choose a reason for hiding this comment

csviri commented Nov 8, 2021

csviri commented Nov 8, 2021 • edited Loading

csviri commented Nov 2, 2021 •

edited

Loading

csviri Nov 4, 2021 •

edited

Loading

csviri commented Nov 8, 2021 •

edited

Loading