Skip to content

Add live instance data change listener#1745

Closed
huizhilu wants to merge 1 commit intoapache:cluster-pause-modefrom
huizhilu:liveInstanceDataChange
Closed

Add live instance data change listener#1745
huizhilu wants to merge 1 commit intoapache:cluster-pause-modefrom
huizhilu:liveInstanceDataChange

Conversation

@huizhilu
Copy link
Contributor

@huizhilu huizhilu commented May 18, 2021

Issues

  • My PR addresses the following Helix issues and references them in the PR description:

Resolves #1743

Description

  • Here are some details about my PR, including screenshots of any UI changes:

For cluster pause mode feature: controller needs to listen to the live instance status change and resume the cluster from pause mode upon all live instances fully exit pause mode.

Add a new listener to controller and implement the callback. Listener type: DataChange

Tests

  • The following tests are written for this issue:

testLiveInstanceDataChangeListener

  • The following is the result of the "mvn test" command on the appropriate module:

(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)

Changes that Break Backward Compatibility (Optional)

  • My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:

(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)

Documentation (Optional)

  • In case of new functionality, my PR adds documentation in the following wiki page:

(Link the GitHub wiki you added)

Commits

  • My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Code Quality

  • My diff has been formatted using helix-style.xml
    (helix-style-intellij.xml if IntelliJ IDE is used)

listenerClass = LiveInstanceDataChangeListener.class;
break;
default:
logger.warn("Unexpected change type {} in callback {}", _changeType, _uid);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a new case. I think if we do arrive at this case, we should log it as an error.

_clusterName);
// Selectively refresh live instances cache.
notifyCaches(context, ChangeType.LIVE_INSTANCE);
pushToEventQueues(ClusterEventType.LiveInstanceChange, context, Collections.emptyMap());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to reuse the previous event type? If this is a new use case, we can have a new event type to distinguish individual instance data change from previous live instance children change.

_manager.addLiveInstanceDataChangeListener(listener, instanceName);
accessor.updateProperty(accessor.keyBuilder().liveInstance(instanceName), liveInstance);

Assert.assertTrue(liveInstanceDataChangeNotified.get());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest to use TestHelper.verify(() instead of directly "assert" to validate the results so that the test is more stable. You can take a look at other test cases in this file as an example.

*/
default void addLiveInstanceDataChangeListener(LiveInstanceDataChangeListener listener,
String instanceName) {
throw new NotImplementedException("Not implemented");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is unnecessary, as following the pattern for most other listeners in this class.

@huizhilu huizhilu closed this May 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants