v1.24.0

June 15, 2023

🌟 New features

Unix Domain Socket Support: You can now use Unix domain socket to serve and send requests which is useful for configuring a service mesh to communicate with a sidecar. #1837 #4846

import com.linecorp.armeria.common.util.DomainSocketAddress;

DomainSocketAddress domainSocketAddress =
  DomainSocketAddress.of(Paths.get("/tmp/armeria.sock"));

Server
  .builder()
  .http(domainSocketAddress)
  ...
  .build();

WebClient
  .builder("http://" + domainSocketAddress.authority())
  ...
  .build();

WebSocket Support: You can now send and receive data over WebSocket using WebSocketService. #1076 #3904

Server
  .builder()
  .service("/chat", WebSocketService.of((ctx, messages) -> {
      WebSocketWriter webSocketWriter = WebSocket.streaming();
      // Write frames using back pressure.
      return webSocketWriter;
   }));

Customizable Logging: You can now use LogFormatter and LogWriter to customize the log format and consumer. #3918 #4267 #4943

// Convert RequestLog to JSON.
LogFormatter logFormatter = LogFormatter.ofJson();
LogWriter logWriter =
  LogWriter
    .builder() // Use SLF4J logger for logging.
    .logFormatter(logFormatter)
    .logger(logger)
    .build();

LoggingClient
  .builder()
  .logWriter(logWriter)
  .newDecorator();

BlockHound Integrations: Armeria now provides BlockHound integrations, offering enhanced support for detecting with blocking calls in event loops. #4493

Delayed Request Abortion: You can now delay aborting the HttpRequest when the HttpResponse completes. This may be useful when you want to send additional data even after the response is complete. #4913

Server
  .builder()
  .requestAutoAbortDelayMillis(2000) // Delay aborting the request for 2 second.
  ...
  .build();

WebClient
  .builder()
  .requestAutoAbortDelayMillis(1000) // Delay aborting the request for 1 second.
  ...
  .build();

Circuit Breaker and Retry Rule for timeout: You can now use RetryRule.onTimeoutException() and CircuitBreakerRule.onTimeoutException() to open the circuit or retry the request when the response is timed out. #4876 #4882

Customizable ExecutionId for GraphQL-Java: You can now customize ExecutionId of GraphQL-Java using GraphqlServiceBuilder.executionIdGenerator(). #4867 #4877

GraphqlService
  .builder()
  .executionIdGenerator((requestCtx, query, operation, graphqlCtx) -> {
     return ExecutionId.from(requestContext.headers.get("traceparent"));
  })
  ...
  .build();

Custom CoroutineContext for gRPC-Kotlin: You can now inject a custom CoroutineContext for gRPC-Kotlin with CoroutineContextProvider. #4842 #4866
```
class CustomCoroutineContextProvider : CoroutineContextProvider {
  override fun provide(ctx: ServiceRequestContext): CoroutineContext {
    return ... // A custom CoroutineContext
  }
}
```
tip
Note that a custom CoroutineContextProvider should be registered via Java SPI to META-INF/services/com.linecorp.armeria.common.kotlin.CoroutineContextProvider.

Retrieving CallOptions with GrpcCallOptions: With GrpcCallOptions in Armeria, you can now easily retrieve CallOptions from a given RequestContext. #4776 #4822

GrpcClients
  .builder(grpcServerUri)
  .decorator((delegate, ctx, req) -> {
    CallOptions options = GrpcCallOptions.get(ctx);
    MyOption myOption = options.getOption(myOptionKey);
    // act on myOption if needed
    ...

    return delegate.execute(ctx, req);
  })
  .build(MyGrpcStub.class);

Fallback Strategy for CircuitBreakerClient: You can now easily set a fallback strategy to CircuitBreakerClient when a CircuitBreaker is open. #4800 #4818

CircuitBreakerClient
  .builder(...)
  .recover((ctx, req) -> {
    // A fallback response when the circuit is open.
    return HttpResponse.of(...);
  });

Netty ChannelPipeline Customizer: You can now customize the Netty ChannelPipeline for the server side #4710 #4813

Server
  .builder()
  .childChannelPipelineCustomizer(pipeline -> {
    // Add a custom handler to the pipeline.
  })
  .build();

HTTP/2 over TLS without ALPN: Armeria now supports using HTTP/2 over TLS without the need for ALPN. #4702 #4704
```
ClientFactory
  .builder()
  .useHttp2WithoutAlpn(true)
  ...
  .build();
```
Armeria with Jetty: Armeria is now compatible with Jetty 10 and Jetty 11. #4845
Armeria with Thrift: Armeria is now compatible with Thrift 0.18.1. #4812

📈 Improvements

RequestContext.makeContextAware() now returns instances of ContextAwareRunnable, ContextAwareCallable, ContextAwareFunction, ContextAwareBiFunction, ContextAwareConsumer and ContextAwareBiConsumer. #4878 #4890
Annotated services now perform as fast as functional-style services under the following conditions: #4888
- The annotated method returns an HttpResponse.
- The annotated method is run on the event loop (i.e. not annotated with @Blocking).
You can now use the following features with Spring Boot Actuator integration. #4874 #4880
- management.endpoints.web.exposure.*
- management.endpoints.web.path-mapping.*
- management.endpoints.web.discovery.*
- management.endpoint.health.status.http-mapping.*
- application/vnd.spring-boot.actuator.v3+json, application/vnd.spring-boot.actuator.v2+json and application/json
Armeria client now exports metrics for RetryingClient with the following metric name: #3350 #4707
- armeria.client.actual.requests.attempts
You can now set the default log name for VirtualHost via VirtualHostBuilder.defaultLogName() #4817
Synchronized blocks in core/common have been migrated to ReentrantLock for improved compatibility with virtual threads. #4578
We did groundwork for supporting PKCS#12 and JKS keystore formats when configuring TLS in a future release. #4801

🛠️ Bug fixes

WebClient no longer decodes a percent-encoded ? (%3F) in a request path. #4907
Search domains are no longer used in DNS resolution when an authority ends with a trailing dot. #4538 #4875
FailFastException is now correctly converted to Status.UNAVAILABLE in gRPC clients. #4805 #4924
DocService now correctly makes the link to StructInfo even when a protobuf Message is used in both gRPC services and annotated services. #4885
ConcurrencyLimitingClient used with RetryingClient or CircuitBreakerClient now doesn't produce a deadlock. #4826 #4834
connection: close is set correctly in the response when an HTTP/1.1 request contains connection: close. #4864
You no longer see NullPointerException when using StreamMessage.mapError() #4852 #4859
DocService now correctly generates specifications for Thrift services compiled with java:fullcamel option. #4858
DocService with relative paths now correctly provides autocompletion. #4840
The unhandled exception reporter no longer reports ignorable exceptions. #4861 #4922
Fixed an issue where @Param annotation swallows exceptions raised from RequestConverterFunction. #4826 #4834
armeria-logback is now compatible with Logback 1.3.x. #4855 #4856
CoroutineServerInterceptor now correctly propagates the coroutine context. #4889 #4894
Armeria gRPC client now respects CallOptions.getExecutor(). #4850 #4851
GraphQlService now creates DataLoaderRegistry for each request. #4237 #4455
Fixed a regression where "Copy as a cURL command" and "Copy response" in debug page did not work. #4929
THttpService no longer exposes field information in the response when failing to deserialize a request. #4953

📃 Documentation

Added documentation for setting request timeouts at the server side. #4595 #4860
Added documentation for Kotlin integration with Armeria. #4866
Mentioned http4s-armeria as a part of the Scala integration. #4919 #4920