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/06/01 06:51:55 UTC
[GitHub] [helix] xyuanlu opened a new pull request, #2127: [WIP] Add HelixEventHandlingUtil and use that util for cloud event - Add API
xyuanlu opened a new pull request, #2127:
URL: https://github.com/apache/helix/pull/2127
### 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
- [ ] Here are some details about my PR, including screenshots of any UI changes:
(Write a concise description including what, why, how)
### Tests
- [ ] The following tests are written for this issue:
(List the names of added unit/integration tests)
- 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] xyuanlu commented on pull request #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
xyuanlu commented on PR #2127:
URL: https://github.com/apache/helix/pull/2127#issuecomment-1145390218
This change is ready to be merged. Approved by @qqu0127
Final commit message:
**Add HelixEventHandlingUtil and use that util for cloud event - API Only**
Previously helix event handling depends on batch enable/disable instance. We would like to move away the dependence on generic batch enable/disable instance and use a dedicated Util only for event handling use case. This change adds API signature for util functions/
--
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 #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
xyuanlu commented on code in PR #2127:
URL: https://github.com/apache/helix/pull/2127#discussion_r888196211
##########
helix-core/src/main/java/org/apache/helix/cloud/event/helix/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,56 @@
+package org.apache.helix.cloud.event.helix;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.helix.BaseDataAccessor;
+
+
+ class HelixEventHandlingUtil {
+
+ /**
+ * Enable or disable an instance for cloud event.
+ * It will enable/disable Helix for that instance. Also add the instance cloud event info to
+ * clusterConfig Znode when enable.
+ * @param clusterName
+ * @param instanceName
+ * @param message
+ * @param isEnable
Review Comment:
This function will enable or disable an instance. would `isEnable` be better to indicate the operation type? I feel like "enabled" is used to describe the state if an instance, not the operation type.
--
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 #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
xyuanlu commented on code in PR #2127:
URL: https://github.com/apache/helix/pull/2127#discussion_r887388292
##########
helix-core/src/main/java/org/apache/helix/cloud/event/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,23 @@
+package org.apache.helix.cloud.event;
+
+import org.apache.helix.BaseDataAccessor;
+
+
+public class HelixEventHandlingUtil {
+
+ public static boolean enableInstanceForCloudEvent(String clusterName, String instanceName, boolean isEnable, long timeStamp,
+ BaseDataAccessor dataAccessor) {
+ return true;
+ }
+
+ public static boolean IsInstanceDisabledForCloudEvent(String clusterName, String instanceName,
+ BaseDataAccessor dataAccessor) {
+ return true;
+ }
+
+ public static Long getInstanceDisabledTimestamp(String clusterName, String instanceName,
Review Comment:
Is intend to be the timestamp for cloud event. I updated the signature to take a message. It will be less ambiguous.
--
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 #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
xyuanlu commented on code in PR #2127:
URL: https://github.com/apache/helix/pull/2127#discussion_r887387978
##########
helix-core/src/main/java/org/apache/helix/cloud/event/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,23 @@
+package org.apache.helix.cloud.event;
+
+import org.apache.helix.BaseDataAccessor;
+
+
+public class HelixEventHandlingUtil {
Review Comment:
TFTR. Updated
--
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 #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
qqu0127 commented on code in PR #2127:
URL: https://github.com/apache/helix/pull/2127#discussion_r888163721
##########
helix-core/src/main/java/org/apache/helix/cloud/event/helix/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,56 @@
+package org.apache.helix.cloud.event.helix;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.helix.BaseDataAccessor;
+
+
+ class HelixEventHandlingUtil {
+
+ /**
+ * Enable or disable an instance for cloud event.
+ * It will enable/disable Helix for that instance. Also add the instance cloud event info to
+ * clusterConfig Znode when enable.
+ * @param clusterName
+ * @param instanceName
+ * @param message
+ * @param isEnable
+ * @param dataAccessor
+ * @return return failure when either enable/disable failed or update cluster ZNode failed.
+ */
+ static boolean enableInstanceForCloudEvent(String clusterName, String instanceName, String message,
+ boolean isEnable, BaseDataAccessor dataAccessor) {
+ return true;
+ }
Review Comment:
Let's add TODO for this and below methods.
##########
helix-core/src/main/java/org/apache/helix/cloud/event/helix/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,56 @@
+package org.apache.helix.cloud.event.helix;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.helix.BaseDataAccessor;
+
+
+ class HelixEventHandlingUtil {
+
+ /**
+ * Enable or disable an instance for cloud event.
+ * It will enable/disable Helix for that instance. Also add the instance cloud event info to
+ * clusterConfig Znode when enable.
+ * @param clusterName
+ * @param instanceName
+ * @param message
+ * @param isEnable
Review Comment:
nit: enabled or isEnabled would be better
##########
helix-core/src/main/java/org/apache/helix/cloud/event/helix/DefaultCloudEventCallbackImpl.java:
##########
@@ -90,10 +90,9 @@ public void exitMaintenanceMode(HelixManager manager, Object eventInfo) {
// Check if there is any disabled live instance that was disabled due to cloud event,
// if none left, exit maintenance mode
HelixDataAccessor accessor = manager.getHelixDataAccessor();
- if (instances.stream().noneMatch(instance ->
- InstanceValidationUtil.getInstanceHelixDisabledType(accessor, instance)
- .equals(InstanceConstants.InstanceDisabledType.CLOUD_EVENT.name())
- && InstanceValidationUtil.isAlive(accessor, instance))) {
+ if (instances.stream().noneMatch(instance -> HelixEventHandlingUtil
+ .IsInstanceDisabledForCloudEvent(manager.getClusterName(), instance, accessor.getBaseDataAccessor())
+ && InstanceValidationUtil.isAlive(accessor, instance))) {
Review Comment:
With current implementation of `IsInstanceDisabledForCloudEvent`, it's always returning true, and we won't exit maintenance mode at all. Is this an issue?
--
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 #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
qqu0127 commented on code in PR #2127:
URL: https://github.com/apache/helix/pull/2127#discussion_r888225625
##########
helix-core/src/main/java/org/apache/helix/cloud/event/helix/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,56 @@
+package org.apache.helix.cloud.event.helix;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.helix.BaseDataAccessor;
+
+
+ class HelixEventHandlingUtil {
+
+ /**
+ * Enable or disable an instance for cloud event.
+ * It will enable/disable Helix for that instance. Also add the instance cloud event info to
+ * clusterConfig Znode when enable.
+ * @param clusterName
+ * @param instanceName
+ * @param message
+ * @param isEnable
Review Comment:
I'm fine either way. Feel free to resolve this.
--
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] mgao0 commented on a diff in pull request #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
mgao0 commented on code in PR #2127:
URL: https://github.com/apache/helix/pull/2127#discussion_r887310664
##########
helix-core/src/main/java/org/apache/helix/cloud/event/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,23 @@
+package org.apache.helix.cloud.event;
+
+import org.apache.helix.BaseDataAccessor;
+
+
+public class HelixEventHandlingUtil {
+
+ public static boolean enableInstanceForCloudEvent(String clusterName, String instanceName, boolean isEnable, long timeStamp,
+ BaseDataAccessor dataAccessor) {
+ return true;
+ }
+
+ public static boolean IsInstanceDisabledForCloudEvent(String clusterName, String instanceName,
+ BaseDataAccessor dataAccessor) {
+ return true;
+ }
+
+ public static Long getInstanceDisabledTimestamp(String clusterName, String instanceName,
Review Comment:
Is this timestamp for cloud event disable or for the general disable?
##########
helix-core/src/main/java/org/apache/helix/cloud/event/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,23 @@
+package org.apache.helix.cloud.event;
+
+import org.apache.helix.BaseDataAccessor;
+
+
+public class HelixEventHandlingUtil {
+
+ public static boolean enableInstanceForCloudEvent(String clusterName, String instanceName, boolean isEnable, long timeStamp,
+ BaseDataAccessor dataAccessor) {
+ return true;
+ }
+
+ public static boolean IsInstanceDisabledForCloudEvent(String clusterName, String instanceName,
Review Comment:
I understand why you name it like that - so it's more clear that this check is "for cloud event". But it is a bit counter intuitive because we return true for disabled, and return false for enabled. I'm thinking maybe we could still name it "enableInstance", "isInstanceEnabled", etc. But stress that these methods are for use cases under the cloud event context only in the method java doc, and should not be used for other purposes. What do you think?
##########
helix-core/src/main/java/org/apache/helix/cloud/event/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,23 @@
+package org.apache.helix.cloud.event;
+
+import org.apache.helix.BaseDataAccessor;
+
+
+public class HelixEventHandlingUtil {
+
+ public static boolean enableInstanceForCloudEvent(String clusterName, String instanceName, boolean isEnable, long timeStamp,
Review Comment:
1. Open for discussion. I think our intention is to hide away these APIs from users, maybe we can restrict the access to package-only?
2. Making a note on our "return false" or "throw exception" discussion when the action is failed
3. Should we use the timestamp when the instance is actually enabled/disabled instead of when we initiate this move?
##########
helix-core/src/main/java/org/apache/helix/cloud/event/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,23 @@
+package org.apache.helix.cloud.event;
+
+import org.apache.helix.BaseDataAccessor;
+
+
+public class HelixEventHandlingUtil {
Review Comment:
Is it class meant to be under `org.apache.helix.cloud.event.helix`?
--
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 #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
xyuanlu commented on code in PR #2127:
URL: https://github.com/apache/helix/pull/2127#discussion_r887392064
##########
helix-core/src/main/java/org/apache/helix/cloud/event/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,23 @@
+package org.apache.helix.cloud.event;
+
+import org.apache.helix.BaseDataAccessor;
+
+
+public class HelixEventHandlingUtil {
+
+ public static boolean enableInstanceForCloudEvent(String clusterName, String instanceName, boolean isEnable, long timeStamp,
Review Comment:
Updated.
--
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 #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
xyuanlu commented on code in PR #2127:
URL: https://github.com/apache/helix/pull/2127#discussion_r887388468
##########
helix-core/src/main/java/org/apache/helix/cloud/event/HelixEventHandlingUtil.java:
##########
@@ -0,0 +1,23 @@
+package org.apache.helix.cloud.event;
+
+import org.apache.helix.BaseDataAccessor;
+
+
+public class HelixEventHandlingUtil {
+
+ public static boolean enableInstanceForCloudEvent(String clusterName, String instanceName, boolean isEnable, long timeStamp,
+ BaseDataAccessor dataAccessor) {
+ return true;
+ }
+
+ public static boolean IsInstanceDisabledForCloudEvent(String clusterName, String instanceName,
Review Comment:
Based on our offline discussion, let's keep the current 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
[GitHub] [helix] xyuanlu commented on a diff in pull request #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
xyuanlu commented on code in PR #2127:
URL: https://github.com/apache/helix/pull/2127#discussion_r888191966
##########
helix-core/src/main/java/org/apache/helix/cloud/event/helix/DefaultCloudEventCallbackImpl.java:
##########
@@ -90,10 +90,9 @@ public void exitMaintenanceMode(HelixManager manager, Object eventInfo) {
// Check if there is any disabled live instance that was disabled due to cloud event,
// if none left, exit maintenance mode
HelixDataAccessor accessor = manager.getHelixDataAccessor();
- if (instances.stream().noneMatch(instance ->
- InstanceValidationUtil.getInstanceHelixDisabledType(accessor, instance)
- .equals(InstanceConstants.InstanceDisabledType.CLOUD_EVENT.name())
- && InstanceValidationUtil.isAlive(accessor, instance))) {
+ if (instances.stream().noneMatch(instance -> HelixEventHandlingUtil
+ .IsInstanceDisabledForCloudEvent(manager.getClusterName(), instance, accessor.getBaseDataAccessor())
+ && InstanceValidationUtil.isAlive(accessor, instance))) {
Review Comment:
This PR only adds a API signature. As cloud event handling feature is still under development, it is ok for this change.
--
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] zhangmeng916 merged pull request #2127: Add HelixEventHandlingUtil and use that util for cloud event - Add API
Posted by GitBox <gi...@apache.org>.
zhangmeng916 merged PR #2127:
URL: https://github.com/apache/helix/pull/2127
--
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