v1.26.0

October 23, 2023

🌟 New features

Context Path Support: You can now set services/decorators under a context path fluently. #3591 #4802 #5037 #5157 #5260

Server.builder()
      .baseContextPath("/api")
      .contextPath("/v1", "/v2")
      .service(myService) // served under "/api/v1" and "/api/v2"
      .and()
      .virtualHost("foo.com")
      .contextPath("/v3")
      .service(myService) // served by virtual host "foo.com" under "/api/v3"
      .build();

You can also set the context path via Spring property.

armeria:
  context-path: /api/v1

Easier Request Scoping for Kotlin: You can now easily propagate an Armeria RequestContext in Kotlin using ContextAwareExecutor.asCoroutineDispatcher(). #5171
```
withContext(ctx.eventLoop().asCoroutineDispatcher()) {
  assert(RequestContext.current() == ctx)
  ...
}
```

gRPC Exception Handler Annotation: You can now easily handle an exception that is raised from a gRPC service using @GrpcExceptionHandler annotation. #5046

@GrpcExceptionHandler(MyGrpcExceptionHandlerFunction.class)
@Override
public void unaryCall(
  SimpleRequest request,
  StreamObserver<SimpleResponse> responseObserver) {
    ...
}

class MyGrpcExceptionHandlerFunction implements GrpcExceptionHandlerFunction {
  @Override
  public Status apply(RequestContext ctx, Throwable cause, Metadata metadata) {
    if (unauthenticatedException(cause)) {
      return Status.UNAUTHENTICATED;
    }
    ...
  }
}

StreamMessage finalizer: You can now produce the last value for a StreamMessage when it completes exceptionally or successfully using StreamMessage.endWith(). #4816 #5198

StreamMessage<Integer> message =
  original.endWith(th -> {
      if (th instanceof AbortedStreamException) {
          return 100;
      }
      return -1;
  });

Disable HTTP/2 for Requests: You can now disable HTTP/2 protocol when sending HTTP or HTTPS requests. #5168
```
ClientFactory
  .builder()
  .preferHttp1(true)
  .build();
```
Client Certificate Metrics: You can now monitor client certificates with the following metrics. #5155
- armeria.client.tls.certificates.validity: 1 if valid, 0 otherwise.
- armeria.client.tls.certificates.validity.days: The number of days until the certificate expires.

You can now add a hook that is invoked when a RequestContext is pushed and popped. #4991 #5107

Supplier<AutoCloseable> contextHook = () -> {
  System.out.println("Context is pushed.");
  return () -> {
    System.out.println("Context is popped.");
  };
}

// Client
WebClient
  .builder()
  .contextHook(contextHook)
  ...
  .build();
// Server
Server
  .builder()
  .contextHook(contextHook)
  ...
  .build();

New Circuit Breaker and Retry Rule for Time-consuming Requests: You can now report a failure to a circuit breaking or retry when the total duration exceeds a certain threshold. #4782 #4827

final CircuitBreakerRuleWithContent<HttpResponse> rule =
      CircuitBreakerRuleWithContent
              .<HttpResponse>builder()
              .onTotalDuration(
                  (ctx, duration) -> duration.toMillis() > 10000)
              .thenFailure();

RST Flood Attack Prevention: You can now protect your server against DDoS caused by RST flood attack using ServerBuilder.http2MaxResetFramesPerWindow(). #5232
- The default maximum number of allowed RST frames for an HTTP/2 connection is 400 per minute.
```
Server
  .builder()
  .http2MaxResetFramesPerWindow(100, 10)
  .build();
```

📈 Improvements

Acquiring an EventLoop for sending a request is now improved when the number of EventLoops is small. #4439 #4682
Snappy is now supported for content compression. #5125 #5174
The CompletableFutures of a RequestLog are now completed with the RequestContext.eventLoop() thus their callbacks are also executed by the EventLoop. #5189
Adding services and decorators are now unified. #5038 #5040

🛠️ Bug fixes

RequestLog.responseCause() is correctly propagated to CircuitBreakerRule when using a CircuitBreakerClient with a RetryingClient. #5242
A WebSocket session is correctly established even if the Connection header has upgrade value that is concateneted with other values using a comma. #5165 #5230
No more leaks when the size of a request exceeds the max content length. #3803 #5227
An IllegalStateException is raised if GrpcSerializationFormats.JSON isn't set when GrpcServiceBuilder.enableHttpJsonTranscoding() is enabled. #5176 #5224
CookieClient is now correctly working with redirects. #5221
You no longer see duplicate ClientOptions when creating a derived client via Clients.newDerivedClient(). #5194
You no longer see UnsupportedOperationException when creating an HttpResponse with a CompletationStage. #5190
A new HTTP/2 connection is created and correctly reused from the pending requests when the number of requests exceeds max concurrent streams. #5173
You no longer see a false negative EndpointSelectionTimeoutException when EndpointSelectionStrategy.weightedRoundRobin() is used with a DynamicEndpointGroup. #5163
NullPointerException isn't raised anymore when a client establishes an HTTP session. #5162
Pending exceptions that are raised while sending requests or receiving responses are now correctly propagated to users. #5154
Armeria gRPC service no longer schedules a timeout if grpc-timeout header is omitted when GrpcServiceBuilder.useClientTimeoutHeader() is enabled. #5144
The Content-Length header isn't set anymore for the streaming response of a HEAD request. #4509 #4644