[server] Rewrite gRPC read Service to align with Netty-Based HTTP Server #1163

sushantmane · 2024-09-09T23:07:03Z

Rewrite gRPC read Service to align with Netty-Based HTTP Server

Refactored the Netty handler to enable code reuse for gRPC handlers
Added missing APIs to the gRPC service to close feature gaps with the
HTTP implementation.
Fixed the gRPC I/O request path threading model: previously, requests
were handled by the gRPC executor thread pool, but now they are processed
by the StorageReadExecutor thread pool for better performance.
- Deprecated the old get and multiGet gRPC services, which relied on
  a single schema and encouraged tightly coupled code. This refactor paves
  the way for implementing server-side streaming support for batch get
  requests more easily.
Simplified the request processing logic by replacing the chain of
responsibility pattern with a single processor class.

How was this PR tested?

WIP (UTs and E2E will be added)

Does this PR introduce any user-facing changes?

No. You can skip the rest of this section.
Yes. Make sure to explain your proposed changes and call out the behavior change.

FelixGV

Thanks a lot Sushant! The gRPC code needs a lot of polishing and this PR looks like a very good change. I left a bunch of comments, though they are likely all minor. We also need to fix the static analysis and code coverage... Thanks again, I'm looking forward to seeing this merged in, great work!

.../src/main/java/com/linkedin/venice/listener/grpc/handlers/GrpcStorageReadRequestHandler.java

services/venice-server/src/main/java/com/linkedin/venice/listener/request/GetRouterRequest.java

...-server/src/main/java/com/linkedin/venice/listener/request/MultiGetRouterRequestWrapper.java

services/venice-server/src/main/java/com/linkedin/venice/listener/request/RouterRequest.java

services/venice-server/src/main/java/com/linkedin/venice/grpc/GrpcRequestContext.java

...ce-server/src/main/java/com/linkedin/venice/listener/HttpStorageResponseHandlerCallback.java

...venice-server/src/main/java/com/linkedin/venice/listener/StorageResponseHandlerCallback.java

...ces/venice-server/src/main/java/com/linkedin/venice/listener/OutboundHttpWrapperHandler.java

services/venice-server/src/main/java/com/linkedin/venice/grpc/GrpcIoRequestProcessor.java

… - Added missing APIs to the gRPC service to close feature gaps with the HTTP implementation. - Fixed the gRPC I/O request path threading model: previously, requests were handled by the gRPC executor thread pool, but now they are processed by the `StorageReadExecutor` thread pool for better performance. - Deprecated the old `get` and `multiGet` gRPC services, which relied on a single schema and encouraged tightly coupled code. This refactor paves the way for implementing server-side streaming support for batch get requests more easily. - Simplified the request processing logic by replacing the chain of responsibility pattern with a single processor class.

…for permission. ^_^

FelixGV

Doing another pass on this PR... thanks for iterating on it. Looks good so far, but I'm not done going through it... I left some minor comments, and I will resume my second pass later...

internal/venice-common/src/main/java/com/linkedin/venice/grpc/GrpcUtils.java

FelixGV · 2024-09-16T15:18:53Z

internal/venice-common/src/main/java/com/linkedin/venice/meta/ServerAdminAction.java

 public enum ServerAdminAction {
  DUMP_INGESTION_STATE(0), DUMP_SERVER_CONFIGS(1);

+  private static final Map<Integer, ServerAdminAction> ADMIN_ACTION_MAP = new HashMap<>(2);
+
+  static {
+    for (ServerAdminAction action: values()) {
+      ADMIN_ACTION_MAP.put(action.getValue(), action);
+    }
+  }


FYI, for the common case of enum codes that range from 0..N monotonically, we have a cleaner solution than using a map... See EnumUtils::getEnumValuesArray and VeniceEnumValue. It is very easy to use, more performant, and will require a bit fewer lines of code than you have here...

FelixGV · 2024-09-16T15:30:10Z

internal/venice-common/src/main/proto/VeniceReadService.proto

-  rpc get (VeniceClientRequest) returns (VeniceServerResponse) {}
-  rpc batchGet(VeniceClientRequest) returns (VeniceServerResponse) {}
+
+  rpc get (VeniceClientRequest) returns (VeniceServerResponse) {
+    option deprecated = true;
+  }
+
+  rpc batchGet(VeniceClientRequest) returns (VeniceServerResponse) {
+    option deprecated = true;
+  }
+
+  rpc singleGet(SingleGetRequest) returns (SingleGetResponse) {}
+
+  rpc multiGet(MultiGetRequest) returns (MultiKeyResponse) {}


Sorry for the confusion here... I know I am the one that asked for marking one of the APIs as deprecated, but I did not have the full understanding at the time I said that...

Since we are not yet implementing the new protocol buffers on the client-side, then effectively these old get/batchGet protocols are still the only valid one... the new ones are still experimental, they're not implemented end-to-end, and they might still change before becoming the new protocols we use (e.g. in case we decide to model the multi-key content as separate units).

So given all of the above, I think it's incorrect to mark the old protocols as deprecated, both here and in the Java code which use them.

Sorry again for the flip flopping...

internal/venice-common/src/main/proto/VeniceReadService.proto

sushantmane · 2024-10-17T18:52:53Z

I'm still working on client side changes to support streaming within a single route. I've figured out structure for it and working on changes

FelixGV · 2024-10-17T19:08:57Z

I'm still working on client side changes to support streaming within a single route. I've figured out structure for it and working changes

Nice, looking forward to it. When you're ready with your next iteration, please rebase, push it up and LMK. I'll take another look.

sushantmane changed the title ~~[server] Rewrite gRPC read service to bridge gap with Netty-based HTTP server~~ [server] Rewrite gRPC read Service to align with Netty-Based HTTP Server Sep 9, 2024

sushantmane force-pushed the li-rewrite-grpc-service branch from 2a298ff to 4205a50 Compare September 10, 2024 01:57

FelixGV reviewed Sep 10, 2024

View reviewed changes

sushantmane force-pushed the li-rewrite-grpc-service branch 2 times, most recently from 63de457 to 1f17f5b Compare September 11, 2024 21:08

FelixGV reviewed Sep 12, 2024

View reviewed changes

...ces/venice-server/src/main/java/com/linkedin/venice/listener/OutboundHttpWrapperHandler.java Outdated Show resolved Hide resolved

sushantmane force-pushed the li-rewrite-grpc-service branch from 1f17f5b to e8b6679 Compare September 12, 2024 02:24

sushantmane commented Sep 12, 2024

View reviewed changes

services/venice-server/src/main/java/com/linkedin/venice/grpc/GrpcIoRequestProcessor.java Outdated Show resolved Hide resolved

sushantmane force-pushed the li-rewrite-grpc-service branch 3 times, most recently from fdad603 to 3458eb8 Compare September 13, 2024 12:24

sushantmane added 13 commits September 14, 2024 23:04

Move responseObserver ops in a mutex

efcd9d8

Address Felix's comments: 7

b5a93f3

Cleanup StatsHandler: It’s better to ask for forgiveness than to ask …

42a71bb

…for permission. ^_^

Add unit tests for ServerAdminAction & GrpcUtilsTest

ae0d241

Stats cleanup

f355f76

Fix venice-common cc issue

7847976

Move request stats recording to a single place

d84e6ad

Add comments

5a2bda1

Add ut for: BinaryResponseTest, Health check gRPC

7ce9a1b

Rename .getStatsRecorder() to .getReadResponseStatsRecorder()

e7479b5

Add unit tests for new gRPC APIs

f1e94cf

Add unit tests for GrpcIoRequestProcessor

8ae1141

sushantmane force-pushed the li-rewrite-grpc-service branch from 3458eb8 to 8ae1141 Compare September 15, 2024 06:05

FelixGV reviewed Sep 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[server] Rewrite gRPC read Service to align with Netty-Based HTTP Server #1163

[server] Rewrite gRPC read Service to align with Netty-Based HTTP Server #1163

sushantmane commented Sep 9, 2024 •

edited

Loading

FelixGV left a comment

FelixGV left a comment

FelixGV Sep 16, 2024

FelixGV Sep 16, 2024

sushantmane commented Oct 17, 2024 •

edited

Loading

FelixGV commented Oct 17, 2024

[server] Rewrite gRPC read Service to align with Netty-Based HTTP Server #1163

Are you sure you want to change the base?

[server] Rewrite gRPC read Service to align with Netty-Based HTTP Server #1163

Conversation

sushantmane commented Sep 9, 2024 • edited Loading

Rewrite gRPC read Service to align with Netty-Based HTTP Server

How was this PR tested?

Does this PR introduce any user-facing changes?

FelixGV left a comment

Choose a reason for hiding this comment

FelixGV left a comment

Choose a reason for hiding this comment

FelixGV Sep 16, 2024

Choose a reason for hiding this comment

FelixGV Sep 16, 2024

Choose a reason for hiding this comment

sushantmane commented Oct 17, 2024 • edited Loading

FelixGV commented Oct 17, 2024

sushantmane commented Sep 9, 2024 •

edited

Loading

sushantmane commented Oct 17, 2024 •

edited

Loading