Move gRPC server deadline filter, allow custom insertion order #2421

Scottmitch · 2022-11-12T02:52:31Z

Motivation:
The default insertion order for gRPC deadline filter is after user filters. If a user's filter deadlocks the timeout will never be applied.

Some use cases may necessitate applying the deadline timeout filter in a custom order (e.g. relative to retries). There is currently no way to customize the append ordering.

Modifications:

Move the gRPC server deadline filter to the beginning of the filter chain so timeouts are applied regardless if user filter code hangs.
Add appendTimeoutFilter method to gRPC client and server builder to give users control over filter append ordering.
Introduce GrpcFilters utility class to create the filters that apply deadline propagation.

...icetalk-grpc-api/src/main/java/io/servicetalk/grpc/api/GrpcExceptionMapperServiceFilter.java

servicetalk-grpc-api/src/main/java/io/servicetalk/grpc/api/GrpcFilters.java

servicetalk-grpc-api/src/main/java/io/servicetalk/grpc/api/GrpcClientBuilder.java

servicetalk-grpc-netty/build.gradle

servicetalk-grpc-api/src/main/java/io/servicetalk/grpc/api/GrpcStatus.java

Scottmitch · 2022-11-12T19:35:09Z

PR depends upon #2422 (for consistent error codes return when client times out)

servicetalk-grpc-api/src/main/java/io/servicetalk/grpc/api/GrpcFilters.java

servicetalk-grpc-netty/src/main/java/io/servicetalk/grpc/netty/DefaultGrpcClientBuilder.java

Motivation: The default insertion order for gRPC deadline filter is after user filters. If a user's filter deadlocks the timeout will never be applied. Some use cases may necessitate applying the deadline timeout filter in a custom order (e.g. relative to retries). There is currently no way to customize the append ordering. Modifications: - Move the gRPC server deadline filter to the beginning of the filter chain so timeouts are applied regardless if user filter code hangs. - Add appendTimeoutFilter method to gRPC client and server builder to give users control over filter append ordering. - Introduce GrpcFilters utility class to create the filters that apply deadline propagation.

…Exception

idelpivnitskiy

🚀
Thank you for taking care of this!

Scottmitch requested review from mgodave, tkountis and idelpivnitskiy November 12, 2022 02:52