v1.22.0

February 9, 2023

🌟 New features

CircuitBreakerClient integration with Resilience4j's circuit breaker is now available. #1469 #4139

Note that armeria-resilience4j2 requires Java 17 or higher.

Resilience4jCircuitBreakerMapping mapping =
  Resilience4jCircuitBreakerMapping.of();
WebClient client = WebClient
  .builder()
  .decorator(CircuitBreakerClient
    .builder(CircuitBreakerRule.onException())
    .handler(Resilience4JCircuitBreakerClientHandler.of(mapping)) // 👈👈👈
    .newDecorator())
  ...

You can now use AsyncServerInterceptor to asynchronously intercept gRPC service calls. #4647

class AuthServerInterceptor implements AsyncServerInterceptor {
  @Override
  <I, O> CompletableFuture<Listener<I>> asyncInterceptCall(
        ServerCall<I, O> call, Metadata headers, ServerCallHandler<I, O> next) {
    return authorizer.authorize(headers).thenApply(result -> {
      if (result) {
        return next.startCall(call, headers);
      } else {
        throw new AuthenticationException("Invalid access");
      }
    });
  }
}

GrpcService.builder()
           .intercept(new AuthServerInterceptor()) // 👈👈👈
           .addService(...)
           ...

@Blocking annotation can now be used with gRPC services. #4389 #4585

@Blocking // 👈👈👈 applies to all methods in the class
class MyGrpcServiceImpl extends MyGrpcServiceImplBase {
  @Blocking // 👈👈👈 applies to a single method
  public void blockingCall(...) {
    ...
  }
}

Armeria server with Spring integration can now be configured to bind to non-ip addresses. #4597 #4598
The authenticated remote user set by RequestLogBuilder.authenticatedUser() is now logged in access logs. #4634
DocService now exposes JSON Schema via the /schemas.json endpoint. #4518

📈 Improvements

Server.reconfigure() now dynamically updates TLS configurations correctly. #4637
Thrift typedefs are now correctly displayed in DocService. #4628
DocService front-end assets are now compressed using gzip instead of Brotli. #4616
An exception is raised if TLS is set for a port-based virtual host. #4588

🛠️ Bug fixes

A NullPointerException is not raised anymore when an aborted StreamMessage is collected. #4652
A ClosedSessionException is not set to RequestLog.responseCause() anymore when an HTTP/1 connection is closed after response data has been fully sent. #4632
gRPC HTTP/JSON transcoding now doesn't throw an exception when used with nested messages. #4631 #4641
431 Request Header Fields Too Large is now returned instead of 400 Bad Request if the header size exceeds ServerConfig.http1MaxHeaderSize(). #4609 #4655
Warnings on duplicate parameters in DocService are no longer visible when annotations are added to Kotlin data classes. #4645
gRPC HTTP/JSON transcoding now correctly interprets google.protobuf.FieldMask type as a string. #4633 #4640
gRPC metadata is now exposed via StatusRuntimeException in RequestLog.responseCause(). #4635 #4636
Square brackets "[]" that are specified in path segments are correctly encoded. #4607 #4615
DecodingService and DecodingClient now correctly limit the max length of decompressed streaming data. #4613
Client-side gRPC callback ClientCall.Listener.onHeaders() is now invoked correctly. #4583 #4608
DocService now correctly displays multiple example requests for a single endpoint. #4576 #4605

🏚️ Deprecations

ArmeriaSettings.ports.ip is deprecated in favor of ArmeriaSettings.ports.address. #4597 #4598

☢️ Breaking changes

Armeria's gRPC services now try to throw a StatusRuntimeException instead of a StatusException. #4658
- Note that users are still recommended to perform error handling for both StatusRuntimeException and StatusException for gRPC services.
We are planning on stopping support for integration with Spring Boot 1. Please join the discussion at our Github issue if you have any opinions. #4651