You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@helix.apache.org by "xyuanlu (via GitHub)" <gi...@apache.org> on 2024/07/17 06:43:47 UTC
[PR] Add protobuff definition and an empty grpc service [helix]
xyuanlu opened a new pull request, #2834:
URL: https://github.com/apache/helix/pull/2834
### Issues
- [X] 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:
This PR adds a proto definition and an empty grpc service endpoint.
### Tests
- [X] The following tests are written for this issue:
(List the names of added unit/integration tests)
run mvn clean install
- 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
Re: [PR] Add protobuff definition and an empty grpc service [helix]
Posted by "junkaixue (via GitHub)" <gi...@apache.org>.
junkaixue commented on code in PR #2834:
URL: https://github.com/apache/helix/pull/2834#discussion_r1681480488
##########
helix-gateway/src/main/proto/HelixGatewayService.proto:
##########
@@ -0,0 +1,52 @@
+syntax = "proto3";
+
+package proto.org.apache.helix.gateway;
+
+message SingleTransitionMessage {
+ enum TransitionType {
+ ADD_SHARD = 0;
+ DELETE_SHARD = 1;
+ CHANGE_ROLE = 2;
+ }
+ string transitionID = 1; // ID of transition message
+ TransitionType transitionType = 2; // Transition type for shard operations
+ string resourceID = 3; // Resource ID
+ string shardID = 4; // Shard to perform operation
+ string startState = 5; // Shard start state
Review Comment:
This should be optional as we decide to let user report their states.
##########
helix-gateway/src/main/proto/HelixGatewayService.proto:
##########
@@ -0,0 +1,52 @@
+syntax = "proto3";
+
+package proto.org.apache.helix.gateway;
+
+message SingleTransitionMessage {
+ enum TransitionType {
+ ADD_SHARD = 0;
+ DELETE_SHARD = 1;
+ CHANGE_ROLE = 2;
+ }
+ string transitionID = 1; // ID of transition message
+ TransitionType transitionType = 2; // Transition type for shard operations
+ string resourceID = 3; // Resource ID
+ string shardID = 4; // Shard to perform operation
+ string startState = 5; // Shard start state
+ string targetState = 6; // Shard target state.
+}
+
+message StateTransitionMessage{
Review Comment:
We call single transition message previously, then following naming should be consistent. This should be called as TransitionMessages as well.
##########
helix-gateway/src/main/java/org/apache/helix/gateway/grpcService/HelixGatewayServiceService.java:
##########
@@ -0,0 +1,35 @@
+package org.apache.helix.gateway.grpcService;
Review Comment:
The package path should not contain any capital characters.
##########
helix-gateway/src/main/proto/HelixGatewayService.proto:
##########
@@ -0,0 +1,52 @@
+syntax = "proto3";
+
+package proto.org.apache.helix.gateway;
+
+message SingleTransitionMessage {
+ enum TransitionType {
+ ADD_SHARD = 0;
+ DELETE_SHARD = 1;
+ CHANGE_ROLE = 2;
+ }
+ string transitionID = 1; // ID of transition message
+ TransitionType transitionType = 2; // Transition type for shard operations
+ string resourceID = 3; // Resource ID
+ string shardID = 4; // Shard to perform operation
+ string startState = 5; // Shard start state
+ string targetState = 6; // Shard target state.
+}
+
+message StateTransitionMessage{
+ repeated SingleTransitionMessage request = 1;
+}
+
+message SingleReplicaStateTransitionStatus {
Review Comment:
Shall we ignore replica in the naming? It is asymmetrical for naming in request/response. Also it is status of message also means for a replica already.
--
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
Re: [PR] Add protobuff definition and an empty grpc service [helix]
Posted by "xyuanlu (via GitHub)" <gi...@apache.org>.
xyuanlu commented on PR #2834:
URL: https://github.com/apache/helix/pull/2834#issuecomment-2234759116
The change is approved by @junkaixue // Thanks
Commit message
Add protobuff definition and an empty grpc service
--
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
Re: [PR] Add protobuff definition and an empty grpc service [helix]
Posted by "xyuanlu (via GitHub)" <gi...@apache.org>.
xyuanlu commented on code in PR #2834:
URL: https://github.com/apache/helix/pull/2834#discussion_r1681612308
##########
helix-gateway/src/main/proto/HelixGatewayService.proto:
##########
@@ -0,0 +1,52 @@
+syntax = "proto3";
+
+package proto.org.apache.helix.gateway;
+
+message SingleTransitionMessage {
+ enum TransitionType {
+ ADD_SHARD = 0;
+ DELETE_SHARD = 1;
+ CHANGE_ROLE = 2;
+ }
+ string transitionID = 1; // ID of transition message
+ TransitionType transitionType = 2; // Transition type for shard operations
+ string resourceID = 3; // Resource ID
+ string shardID = 4; // Shard to perform operation
+ string startState = 5; // Shard start state
+ string targetState = 6; // Shard target state.
+}
+
+message StateTransitionMessage{
+ repeated SingleTransitionMessage request = 1;
+}
+
+message SingleReplicaStateTransitionStatus {
Review Comment:
The outer request is names "replicaState", so I think probably we want to keep the replica in name. But we can simplify it as "SingleReplicaTransitionStatus"
--
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
Re: [PR] Add protobuff definition and an empty grpc service [helix]
Posted by "xyuanlu (via GitHub)" <gi...@apache.org>.
xyuanlu commented on code in PR #2834:
URL: https://github.com/apache/helix/pull/2834#discussion_r1681544472
##########
helix-gateway/src/main/java/org/apache/helix/gateway/grpcService/HelixGatewayServiceService.java:
##########
@@ -0,0 +1,35 @@
+package org.apache.helix.gateway.grpcService;
Review Comment:
TFTR will update
--
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
Re: [PR] Add protobuff definition and an empty grpc service [helix]
Posted by "xyuanlu (via GitHub)" <gi...@apache.org>.
xyuanlu merged PR #2834:
URL: https://github.com/apache/helix/pull/2834
--
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