You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@helix.apache.org by GitBox <gi...@apache.org> on 2022/09/19 17:52:32 UTC
[GitHub] [helix] qqu0127 opened a new pull request, #2214: Add new interface IZkChildEventListener to allow pass in WatchedEvent
qqu0127 opened a new pull request, #2214:
URL: https://github.com/apache/helix/pull/2214
### Issues
- [ ] My PR addresses the following Helix issues and references them in the PR description:
(#200 - Link your issue number here: You can write "Fixes #XXX". Please use the proper keyword so that the issue gets closed automatically. See https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue
Any of the following keywords can be used: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved)
### Description
- [X] Here are some details about my PR, including screenshots of any UI changes:
Add a new interface for zk child listener and refactor to maintain backward compatibility.
The previous https://github.com/apache/helix/blob/ee61ff434ee37d4ab8456c739b2229f99d9e0e72/zookeeper-api/src/main/java/org/apache/helix/zookeeper/zkclient/IZkChildListener.java doesn't pass in `WatchedEvent` to the method, as a result implementation can't depend on different event types.
This PR introduce a new interface with the ideal API signature. The old interface is refactored to depend on the new one, AND use a default method for backward compatibility. New use cases should be changed to use `IZkChildEventListener` while there is no breaking change for existing users.
A few other places are changed to allow passing in the event and method signature change.
### Tests
- [X] The following tests are written for this issue:
Updated `TestZkBasis` and `TestBatchMessage`
- 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](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. 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)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] qqu0127 commented on a diff in pull request #2214: Add new interface IZkChildEventListener to allow pass in WatchedEvent
Posted by GitBox <gi...@apache.org>.
qqu0127 commented on code in PR #2214:
URL: https://github.com/apache/helix/pull/2214#discussion_r974661035
##########
zookeeper-api/src/main/java/org/apache/helix/zookeeper/zkclient/IZkChildListener.java:
##########
@@ -29,17 +31,31 @@
* guaranteed that events on the path are missing (see http://zookeeper.wiki.sourceforge.net/ZooKeeperWatches). An
* implementation of this class should take that into account.
*
+ * Deprecated: This interface is kept to maintain backward compatibility, please use {@link IZkChildEventListener}.
*/
-public interface IZkChildListener {
+@Deprecated
+public interface IZkChildListener extends IZkChildEventListener {
Review Comment:
How is that? There is a default implementation of the new method. There is no breaking change for existing classes, `ZkHelixClusterVerifier` is an example
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] junkaixue commented on a diff in pull request #2214: Add new interface IZkChildEventListener to allow pass in WatchedEvent
Posted by GitBox <gi...@apache.org>.
junkaixue commented on code in PR #2214:
URL: https://github.com/apache/helix/pull/2214#discussion_r974611140
##########
zookeeper-api/src/main/java/org/apache/helix/zookeeper/zkclient/IZkChildListener.java:
##########
@@ -29,17 +31,31 @@
* guaranteed that events on the path are missing (see http://zookeeper.wiki.sourceforge.net/ZooKeeperWatches). An
* implementation of this class should take that into account.
*
+ * Deprecated: This interface is kept to maintain backward compatibility, please use {@link IZkChildEventListener}.
*/
-public interface IZkChildListener {
+@Deprecated
+public interface IZkChildListener extends IZkChildEventListener {
Review Comment:
This is same effect as I mentioned. If you force this extends IZkChildEventListener, the impl of new API will be missing.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] qqu0127 closed pull request #2214: Add new interface IZkChildEventListener to allow pass in WatchedEvent
Posted by GitBox <gi...@apache.org>.
qqu0127 closed pull request #2214: Add new interface IZkChildEventListener to allow pass in WatchedEvent
URL: https://github.com/apache/helix/pull/2214
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org