v1.27.0

January 30, 2024

🌟 New features

xDS-based EndpointGroup: You can utilize xDS protocol to create XdsEndpointGroup for service discovery. #5342 #5336

XdsBootstrap bootstrap = XdsBootstrap.of(...);
EndpointGroup endpointGroup = XdsEndpointGroup.of(boostrap.listenerRoot("my-envoy-service"));
WebClient client = WebClient.of(SessionProtocol.HTTP, endpointGroup);

GraphQL Subscriptions over WebSocket: You can now enable GraphQL subscriptions over WebSocket for live updates to your clients. #4999 #5280

GraphqlService
  .builder()
  .enableWebSocket(true)
  .webSocketServiceCustomizer(ws -> {
    // Customize the underlying WebSocket service.
  })
  .build();

Service-specific EventLoopGroup: You can now assign a different EventLoopGroup to each service for finer grained resource control. #4099 #5233

Server
  .builder()
  .serviceWorkerGroup(globalServiceWorkerGroup)
  .route()
     .path("/user")
     // Use userServiceWorkerGroup for the user service.
     .serviceWorkerGroup(userServiceWorkerGroup)
     .build(userService)
  .route()
     .path("/api")
     // Use apiServiceWorkerGroup for the API service.
     .serviceWorkerGroup(apiServiceWorkerGroup)
     .build(apiService)
  .build();

Thrift Service Decorators: You can now use @Decorator annotations to conveniently apply custom decorators to Thrift services. #4230 #5356

@Decorator(ClassDecorator.class)
class MyHelloService implements HelloService.AsyncIface {
  @Decorator(MethodDecorator.class)
  @Override
  public void hello(String name, AsyncMethodCallback<String> handler) throws TException {
    ...
  }
}

Sensitive Header Masking: You can now easily mask request and response headers using HeadersSanitizer. #5175 #5188

HeadersSanitizer<String> headersSanitizer =
 HeadersSanitizer
   .builderForText()
   .sensitiveHeaders("Authorization", "API-Key", "Proxy-Authorization")
   ...
   .build();

LogFormatter
  .builderForText()
  .requestHeadersSanitizer(headersSanitizer)
  ...

Custom Exception Handling for gRPC clients: You can customize how your gRPC clients respond to exceptions by implementing GrpcExceptionHandlerFunction. #5347 #5351

GrpcClients
  .builder("https://my-grpc-server.com")
  .exceptionHandler((ctx, cause, metadata) -> {
    // Handle the exception.
    return Status.INTERNAL.withDescription("Something went wrong");
  })

Kubernetes Client Integration: You can now use the popular Fabric Kubernetes client seamlessly on top of Armeria when using the armeria-kubernetes module. #5167

WebSocket Service Fallback: You can now set up a fallback service for WebSocketService to handle both WebSocket and non-WebSocket requests on the same path with WebSocketServiceBuilder.fallbackService() #5368

WebSocketService webSocketService =
  WebSocketService
    .builder()
    // The fallback service is used when the request
    // is not a WebSocket request.
    .fallbackService(httpService)
    .build();
Server
  .builder()
  .service("/ws-or-http", webSocketService)
  .build();

WebSocket Frame Aggregation: You can now enable to aggregate WebSocket continuation frames for simplified message processing using WebSocketServiceBuilder.aggregateContinuation(). #5357
```
WebSocketService
  .builder()
  // Aggregate continuation frames into a single frame.
  .aggregateContinuation(true)
  .build();
```

Active Connection Monitoring: You can monitor the number of active connections with armeria.client.connections#value{state="active"} for your clients when using ConnectionPoolListener.metricCollecting() #4277 #5288

ConnectionPoolListener connectionPoolListener =
  ConnectionPoolListener.metricCollecting(meterRegistry);

ClientFactory clientFactory =
  ClientFactory
    .builder()
    .connectionPoolListener(connectionPoolListener)
    .build();

Graceful Executor Shutdown: You can now gracefully terminate a custom ExecutorService in sync with the Server's shutdown procedure. #5031 #5087

ServerListener
  .builder()
  // Shutdown the executor service when the server is stopping.
  .shutdownWhenStopping(preStopExecutorService)
  // Shutdown the executor service when the server is stopped.
  .shutdownWhenStopped(postStopExecutorService)
  .build()

Session Protocol in RoutingContext: You can now acquire SessionProtocol directly from RoutingContext.sessionProtocol() for enhanced routing and ExchangeType decisions.

Eureka Health Check Customization: You can override the default health check URL when registering a service with Eureka. #5369

EurekaUpdatingListener
  .builder()
  // Override the default health check path provided by HealthCheckService.
  .healthCheckUrlPath("/healthcheck")
  .build();

📈 Improvements

Annotated services now support HttpResult wrapped in RxJava objects. #5380 #5386
You can now create HttpFile with Spring Boot nested JAR URL. #5390 #5391
WebSocketService is restructured as an interface, allowing for custom implementations. #5368
Introduce PreTlsHandshakeException to better report exceptions occurring before a TLS handshake initiates. #5344
Error messages for gRPC client stub generation have been clarified. #5387

🛠️ Bug fixes

The completions of ClientRequestContext.whenResponseCancelling() and ClientRequestContext.whenResponseCancelled() are now guaranteed even if RequestContext.cancel() is invoked before the initialization of the timeout scheduler. #5212
Fixed a leak within WebSocketClient when an invalid response is received. #5412
json_name pseudo-option in protobuf files is now correctly respected for matching query parameters during gRPC HTTP/JSON transcoding. #5193 #5366
Implicit request objects are now correctly converted. #5389 #5393
CloseWebSocketFrame with empty reason phrases are now correctly handled. #5388
Flags now correctly logs all messages when RequestContextExportingAppender is configured in logback.xml. #5327 #5361
You no longer see EndpointSelectionTimeoutException when HealthCheckedEndpointGroup is initialized with duplicate Endpoints. #5343
HttpHeaders.containsBoolean() now checks all header entries with the same name. #5319
GrpcService provides more consistent ServerCall.Listener behavior under error conditions. #5273