You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@helix.apache.org by "qqu0127 (via GitHub)" <gi...@apache.org> on 2023/02/14 16:18:50 UTC
[GitHub] [helix] qqu0127 opened a new pull request, #2376: Create separate API for persistent and one-time listener
qqu0127 opened a new pull request, #2376:
URL: https://github.com/apache/helix/pull/2376
### Issues
- [ ] My PR addresses the following Helix issues and references them in the PR description:
N.A.
### Description
- [X] Here are some details about my PR, including screenshots of any UI changes:
As suggested in https://github.com/apache/helix/pull/2353#discussion_r1090064049.
Currently we are passing in a boolean param indicating the type of listener, one-time or persistent. In this PR, we are replacing it with separate APIs for subscribing with persistent vs one-time listener, to make the interface more clear.
The difference the two types are:
- One-time listener is fired at most once on event, and removed right after its invocation
- Persistent listener can only be removed explicitly by client, and should not miss event firing. However, it's still possible the client is offline while the event is happening.
Specifically, we created new set of default methods in the interface with `NotImplementedException` thrown for one-time listener. The implementation logic and unit tests are updated accordingly.
### Tests
- [X] The following tests are written for this issue:
Updated tests in `TestZkMetaClient`
- 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 pull request #2376: Create separate API for persistent and one-time listener
Posted by "qqu0127 (via GitHub)" <gi...@apache.org>.
qqu0127 commented on PR #2376:
URL: https://github.com/apache/helix/pull/2376#issuecomment-1431811972
This PR is ready to merge, approved by @xyuanlu
Commit message:
Create separate API for persistent and one-time listener
--
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 #2376: Create separate API for persistent and one-time listener
Posted by "qqu0127 (via GitHub)" <gi...@apache.org>.
qqu0127 commented on code in PR #2376:
URL: https://github.com/apache/helix/pull/2376#discussion_r1106237326
##########
meta-client/src/main/java/org/apache/helix/metaclient/api/MetaClientInterface.java:
##########
@@ -378,61 +379,105 @@ void asyncCreate(final String key, final T data, final EntryMode mode,
/**
* Subscribe change of a particular entry. Including entry data change, entry deletion and creation
* of the given key.
+ * The listener should be permanent until it's unsubscribed.
* @param key Key to identify the entry
* @param listener An implementation of DataChangeListener
* @see org.apache.helix.metaclient.api.DataChangeListener
* @param skipWatchingNonExistNode Will not register lister to an non-exist key if set to true.
* Please set to false if you are expecting ENTRY_CREATED type.
- * @param persistListener The listener will persist when set to true. Otherwise it will be a one
- * time triggered listener.
* @return Return an boolean indication if subscribe succeeded.
*/
- boolean subscribeDataChange(String key, DataChangeListener listener,
- boolean skipWatchingNonExistNode, boolean persistListener);
+ boolean subscribeDataChange(String key, DataChangeListener listener, boolean skipWatchingNonExistNode);
+
+ /**
+ * Subscribe a one-time change of a particular entry. Including entry data change, entry deletion and creation
+ * of the given key.
+ * The implementation should use at-most-once delivery semantic.
+ * @param key Key to identify the entry
+ * @param listener An implementation of DataChangeListener
+ * @see org.apache.helix.metaclient.api.DataChangeListener
+ * @param skipWatchingNonExistNode Will not register lister to an non-exist key if set to true.
+ * Please set to false if you are expecting ENTRY_CREATED type.
+ * @return Return an boolean indication if subscribe succeeded.
+ */
+ default boolean subscribeOneTimeDataChange(String key, DataChangeListener listener,
+ boolean skipWatchingNonExistNode) {
+ throw new NotImplementedException("subscribeOneTimeDataChange is not implemented");
+ }
/**
* Subscribe for direct child change event on a particular key. It includes new child
* creation or deletion. It does not include existing child data change.
+ * The listener should be permanent until it's unsubscribed.
* For hierarchy key spaces like zookeeper, it refers to an entry's direct children nodes.
* For flat key spaces, it refers to keys that matches `prefix*separator`.
* @param key key to identify the entry.
* @param listener An implementation of DirectSubEntryChangeListener.
* @see org.apache.helix.metaclient.api.DirectChildChangeListener
* @param skipWatchingNonExistNode If the passed in key does not exist, no listener wil be registered.
- * @param persistListener The listener will persist when set to true. Otherwise it will be a one
- * time triggered listener.
*
* @return Return an DirectSubEntrySubscribeResult. It will contain a list of direct sub children if
* subscribe succeeded.
*/
DirectChildSubscribeResult subscribeDirectChildChange(String key,
- DirectChildChangeListener listener, boolean skipWatchingNonExistNode,
- boolean persistListener);
+ DirectChildChangeListener listener, boolean skipWatchingNonExistNode);
+
+ /**
+ * Subscribe for a one-time direct child change event on a particular key. It includes new child
+ * creation or deletion. It does not include existing child data change.
+ * The implementation should use at-most-once delivery semantic.
+ * For hierarchy key spaces like zookeeper, it refers to an entry's direct children nodes.
+ * For flat key spaces, it refers to keys that matches `prefix*separator`.
+ *
+ * @param key key to identify the entry.
+ * @param listener An implementation of DirectSubEntryChangeListener.
+ * @see org.apache.helix.metaclient.api.DirectChildChangeListener
+ * @param skipWatchingNonExistNode If the passed in key does not exist, no listener wil be registered.
+ *
+ * @return Return an DirectSubEntrySubscribeResult. It will contain a list of direct sub children if
+ * subscribe succeeded.
+ */
+ default DirectChildSubscribeResult subscribeOneTimeDirectChildChange(String key,
+ DirectChildChangeListener listener, boolean skipWatchingNonExistNode) {
+ throw new NotImplementedException("subscribeOneTimeDirectChildChange is not implemented");
+ }
/**
* Subscribe for connection state change.
+ * The listener should be permanent until it's unsubscribed.
* @param listener An implementation of ConnectStateChangeListener.
* @see org.apache.helix.metaclient.api.ConnectStateChangeListener
- * @param persistListener The listener will persist when set to true. Otherwise it will be a one
- * time triggered listener.
*
* @return Return an boolean indication if subscribe succeeded.
*/
- boolean subscribeStateChanges(ConnectStateChangeListener listener, boolean persistListener);
+ boolean subscribeStateChanges(ConnectStateChangeListener listener);
/**
* Subscribe change for all children including entry change and data change.
+ * The listener should be permanent until it's unsubscribed.
+ * For hierarchy key spaces like zookeeper, it would watch the whole tree structure.
+ * For flat key spaces, it would watch for keys with certain prefix.
+ * @param key key to identify the entry.
+ * @param listener An implementation of ChildChangeListener.
+ * @see org.apache.helix.metaclient.api.ChildChangeListener
+ * @param skipWatchingNonExistNode If the passed in key does not exist, no listener wil be registered.
+ */
+ boolean subscribeChildChanges(String key, ChildChangeListener listener, boolean skipWatchingNonExistNode);
Review Comment:
IMHO, permanent listener is the most common and default option for most cases, also the behavior is commented. I'd keep it this way unless you have strong opinion. Thanks.
--
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] xyuanlu merged pull request #2376: Create separate API for persistent and one-time listener
Posted by "xyuanlu (via GitHub)" <gi...@apache.org>.
xyuanlu merged PR #2376:
URL: https://github.com/apache/helix/pull/2376
--
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] xyuanlu commented on a diff in pull request #2376: Create separate API for persistent and one-time listener
Posted by "xyuanlu (via GitHub)" <gi...@apache.org>.
xyuanlu commented on code in PR #2376:
URL: https://github.com/apache/helix/pull/2376#discussion_r1106203203
##########
meta-client/src/main/java/org/apache/helix/metaclient/api/MetaClientInterface.java:
##########
@@ -378,61 +379,105 @@ void asyncCreate(final String key, final T data, final EntryMode mode,
/**
* Subscribe change of a particular entry. Including entry data change, entry deletion and creation
* of the given key.
+ * The listener should be permanent until it's unsubscribed.
* @param key Key to identify the entry
* @param listener An implementation of DataChangeListener
* @see org.apache.helix.metaclient.api.DataChangeListener
* @param skipWatchingNonExistNode Will not register lister to an non-exist key if set to true.
* Please set to false if you are expecting ENTRY_CREATED type.
- * @param persistListener The listener will persist when set to true. Otherwise it will be a one
- * time triggered listener.
* @return Return an boolean indication if subscribe succeeded.
*/
- boolean subscribeDataChange(String key, DataChangeListener listener,
- boolean skipWatchingNonExistNode, boolean persistListener);
+ boolean subscribeDataChange(String key, DataChangeListener listener, boolean skipWatchingNonExistNode);
+
+ /**
+ * Subscribe a one-time change of a particular entry. Including entry data change, entry deletion and creation
+ * of the given key.
+ * The implementation should use at-most-once delivery semantic.
+ * @param key Key to identify the entry
+ * @param listener An implementation of DataChangeListener
+ * @see org.apache.helix.metaclient.api.DataChangeListener
+ * @param skipWatchingNonExistNode Will not register lister to an non-exist key if set to true.
+ * Please set to false if you are expecting ENTRY_CREATED type.
+ * @return Return an boolean indication if subscribe succeeded.
+ */
+ default boolean subscribeOneTimeDataChange(String key, DataChangeListener listener,
+ boolean skipWatchingNonExistNode) {
+ throw new NotImplementedException("subscribeOneTimeDataChange is not implemented");
+ }
/**
* Subscribe for direct child change event on a particular key. It includes new child
* creation or deletion. It does not include existing child data change.
+ * The listener should be permanent until it's unsubscribed.
* For hierarchy key spaces like zookeeper, it refers to an entry's direct children nodes.
* For flat key spaces, it refers to keys that matches `prefix*separator`.
* @param key key to identify the entry.
* @param listener An implementation of DirectSubEntryChangeListener.
* @see org.apache.helix.metaclient.api.DirectChildChangeListener
* @param skipWatchingNonExistNode If the passed in key does not exist, no listener wil be registered.
- * @param persistListener The listener will persist when set to true. Otherwise it will be a one
- * time triggered listener.
*
* @return Return an DirectSubEntrySubscribeResult. It will contain a list of direct sub children if
* subscribe succeeded.
*/
DirectChildSubscribeResult subscribeDirectChildChange(String key,
- DirectChildChangeListener listener, boolean skipWatchingNonExistNode,
- boolean persistListener);
+ DirectChildChangeListener listener, boolean skipWatchingNonExistNode);
+
+ /**
+ * Subscribe for a one-time direct child change event on a particular key. It includes new child
+ * creation or deletion. It does not include existing child data change.
+ * The implementation should use at-most-once delivery semantic.
+ * For hierarchy key spaces like zookeeper, it refers to an entry's direct children nodes.
+ * For flat key spaces, it refers to keys that matches `prefix*separator`.
+ *
+ * @param key key to identify the entry.
+ * @param listener An implementation of DirectSubEntryChangeListener.
+ * @see org.apache.helix.metaclient.api.DirectChildChangeListener
+ * @param skipWatchingNonExistNode If the passed in key does not exist, no listener wil be registered.
+ *
+ * @return Return an DirectSubEntrySubscribeResult. It will contain a list of direct sub children if
+ * subscribe succeeded.
+ */
+ default DirectChildSubscribeResult subscribeOneTimeDirectChildChange(String key,
+ DirectChildChangeListener listener, boolean skipWatchingNonExistNode) {
+ throw new NotImplementedException("subscribeOneTimeDirectChildChange is not implemented");
+ }
/**
* Subscribe for connection state change.
+ * The listener should be permanent until it's unsubscribed.
* @param listener An implementation of ConnectStateChangeListener.
* @see org.apache.helix.metaclient.api.ConnectStateChangeListener
- * @param persistListener The listener will persist when set to true. Otherwise it will be a one
- * time triggered listener.
*
* @return Return an boolean indication if subscribe succeeded.
*/
- boolean subscribeStateChanges(ConnectStateChangeListener listener, boolean persistListener);
+ boolean subscribeStateChanges(ConnectStateChangeListener listener);
/**
* Subscribe change for all children including entry change and data change.
+ * The listener should be permanent until it's unsubscribed.
+ * For hierarchy key spaces like zookeeper, it would watch the whole tree structure.
+ * For flat key spaces, it would watch for keys with certain prefix.
+ * @param key key to identify the entry.
+ * @param listener An implementation of ChildChangeListener.
+ * @see org.apache.helix.metaclient.api.ChildChangeListener
+ * @param skipWatchingNonExistNode If the passed in key does not exist, no listener wil be registered.
+ */
+ boolean subscribeChildChanges(String key, ChildChangeListener listener, boolean skipWatchingNonExistNode);
Review Comment:
Should we mention `permanent listener` in function name?
--
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