v1.10.0

August 19, 2021

🌟 New features

A new module armeria-sangria that integrates with Sangria GraphQL is introduced to let you serve a GraphQL request in Scala. #3703 #3704

val schema: Schema[CharacterRepo, Unit] = Schema(Query)
Server.builder()
      .service("/graphql",
          SangriaGraphqlService.builder(schema, new CharacterRepo)
                               .enableTracing(true)
                               .maxQueryDepth(10)
                               .build())

You can now configure WebClient to automatically follow redirections. #2489 #3641

WebClient.builder()
         .followRedirects()
         .build();
// Customize redirection policy
RedirectConfig config = RedirectConfig.builder()
                                      .maxRedirects(10)
                                      .allownDomains("foo.com", "bar.com")
                                      .build();
WebClient.builder("https://example.com")
         .followRedirects(config)
         .build();

You can now recover a failed HttpResponse with a fallback HttpResponse. It would be useful for handling an error of HttpResponse in a decorator. #3674

HttpResponse response =
    HttpResponse.ofFailure(new IllegalStateException("Oops..."));
// The failed HttpResponse will be recovered by the fallback function.
HttpResponse recovered =
    response.recover(cause -> HttpResponse.of("Fallback"));
assert recovered.aggregate().join().contentUtf8().equals("Fallback");

You can now resume a failed StreamMessage with a fallback StreamMessage. #3674

DefaultStreamMessage<Integer> stream = new DefaultStreamMessage<>();
stream.write(1);
stream.write(2);
stream.close(new IllegalStateException("Oops..."));
StreamMessage<Integer> resumed =
    stream.recoverAndResume(cause -> StreamMessage.of(3, 4));
assert resumed.collect().join().equals(List.of(1, 2, 3, 4));

You can now transform an error of StreamMessage into another using StreamMessage.mapError(). #3668

StreamMessage stream =
    StreamMessage.aborted(ClosedStreamException.get());
StreamMessage transformed = stream.mapError(ex -> {
  if (ex instanceof ClosedStreamException) {
    return new IllegalStateException(ex);
  } else {
    return ex;
  }
});

You can now automatically encode an object into JSON for a response payload using HttpResponse.ofJson(). #3662

MyObject myObject = ...;
HttpResponse.ofJson(myObject);
MyError myError = ...;
HttpResponse.ofJson(HttpStatus.INTERNAL_SERVER_ERROR, myError);

You can now fluently inject io.grpc.ServerInterceptors using GrpcServiceBuilder.intercept().

GrpcService.builder()
           .addService(myService)
           .intercept(myInterceptror)
           .build();

You can now easily add Accept headers with RequestHeadersBuilder.accept(). #3704

RequestHeaders.builder()
              .accept(MediaType.JSON)
              .accept(MediaType.PLAIN_TEXT);

You can now initiate graceful connection shutdown using ServiceRequestContext.initiateConnectionShutdown(). #3516 #3715

You can now specify the default ObjectMapper using JacksonObjectMapperProvider. #3728

public class MyObjectMapperProvider
    implements JacksonObjectMapperProvider {

  @Override
  public ObjectMapper newObjectMapper() {
    return JsonMapper
       .builder()
       .addModules(new KotlinModule())
       .enable(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES)
       .build();
  }
}

You can now serve application/grpc-web+proto and application/grpc-web-text+proto protocols using AbstractUnaryGrpcService. #3638 #3716

gRPC trailers are available in the RequestContext for unary gRPC server and client. #3724 #3739

UnaryGrpcClient client = ...;
try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
    client.execute("/com.example.MyService/UnaryCall", request);
    ClientRequestContext ctx = captor.get();
    HttpHeaders trailers = GrpcWebTrailers.get(ctx); // 👈👈👈
}

You can now compress and decompress content with Brotli when using EncodingService, DecodingService and DecodingClient. #3544 #3686
You can now create an HttpResponseException with a cause. #3674
You can now easily capture ServiceRequestContexts using ServerExtension in tests. #3648
You can now suppress the inconsistent Netty version warning by specifying -Dcom.linecorp.armeria.warnNettyVersions=false. #3572 #3766

📃 Documentation

You can now learn how to write a REST service with Armeria by walking through the brand-new tutorials. #3420
- Special thanks to @freevie who volunteered for this.

📈 Improvements

HttpHeaders now properly caches well-known HTTP headers' value objects. #3711 #3714
ConcurrencyLimitTimeoutException is now raised when a request times out in ConcurrencyLimitingClient. #3681
OAuth2AuthorizationGrant no longer uses locks for better performance. #3571 #3618

🛠️ Bug fixes

You no longer see an IllegalArgumentException when HttpRequest.aggregate() and HttpResponse.aggregate() fail with an exception. #3676 #3684 #3687
You no longer see an incomplete RequestLog when an HttpStatusException is raised. #3719 #3674
You no longer see a NullPointerException when an HTTP/1 connection of a client is closed. #3729 #3747
You no longer see a NullPointerException when a StreamMessage is aborted. #3731
No more unintended leakage of sensitive information when logging a RequestLog. #3758
A request is now correctly reset when ServiceRequestContext.cancel() is called. #3674
You no longer see a ClassNotFoundException in the shaded fastutil. #3713
Armeria now accepts harmless yet illegal characters in a request path for HTTP/1 connections, like it did for HTTP/2. #3778
You no longer see an EmptyEndpointGroupException when Endpoints are completely switched to new Endpoints in HealthCheckedEndpointGroup. #3637
You can now correctly monitor a BlockingTaskExecutor with Micrometer. #3710 #3718
BlockingTaskExecutor's idle threads are now properly terminated after timeout. #3718
You no longer see a ClassNotFoundException when a TransportType is initialized. #3717
The second RetryRuleWithContent is now properly applied to decide to retry or not when using RetryingClient. #3720
requestDurationNanos, responseDurationNanos and totalDurationNanos of a child log are properly calculated. #3749
An IllegalArgumentException raised in annotated service will be correctly logged by LoggingService. #3674
You no longer see ClosedSessionException when a large content is sent to an invalid path. #3674
ServerBuilder.localPort() correctly binds both IPv4 and IPv6 loopback addresses. #3725 #3726
A Publisher or a CompletableFuture returned by a service now properly gets a cancellation signal when the request is cancelled. #3690 #3691
Brave's ScopeDecorators now correctly propagates a decorated Scope context when using BraveService and BraveClient. #3408 #3430
A Server in Spring integration is now automatically started by SmartLifecycle. #3759 #3762
You no longer see CancelledSubscriptionException when a WebFlux's WebClient receives an unexpected Content-Type header. #3730 #3750
TomcatService now properly handles an exception with Spring Web's ExceptionHandlers. #3447 #3732
ErrorWebExceptionHandler in WebFlux converts an exception to the response correctly. #3779
JettyService doesn't raise an EofException anymore. #3688
Kotlin jsr305=strict option no longer raises a false positive error when a null value is returned from where nulls are allowed to return. #3751
You no longer see null values when a case class is decoded from a JSON when using annotated services with Scala. 400 Bad Request will be returned instead. #3728

🏚️ Deprecations

-Dcom.linecorp.armeria.annotatedServiceExceptionVerbosity and ExceptionVerbosity has been deprecated. #3674
- You can use LoggingService that automatically logs exceptions using for your convenience; or manually log exceptions using ServerBuilder.exceptionHandler().
ObservableResponseConverterFunction.<init>(ResponseConverterFunction,ExceptionHandlerFunction) has been deprecated in favor of ObservableResponseConverterFunction.<init>(ResponseConverterFunction). #3674
HttpResponseException.of(HttpStatus) and HttpResponseException.of(int) has been deprecated in favor of HttpStatusException. #3674

☢️ Breaking changes

ExceptionHandler now returns HttpResponse instead of AggregatedHttpResponse. #3674

// Before:
ExceptionHandler handler = (ctx, cause) -> {
    if (cause instanceof IllegalArgumentException) {
        return AggregatedHttpResponse.of(HttpStatus.BAD_REQUEST);
    }
    return null;
}

// After:
ExceptionHandler handler = (ctx, cause) -> {
    if (cause instanceof IllegalArgumentException) {
        return HttpResponse.of(HttpStatus.BAD_REQUEST); // 👈👈👈
    }
    return null;
}

RequestContext is added as the first parameter of GrpcStatusFunction. #3692 #3693

// Before:
GrpcService.builder()
           .exceptionMapping((throwable, metadata) -> {
               if (throwable instanceof IllegalArgumentException) {
                   return Status.INVALID_ARGUMENT;
               }
               return null;
           });

// After:
GrpcService.builder()
           .exceptionMapping((ctx, throwable, metadata) -> { // 👈👈👈
               if (throwable instanceof IllegalArgumentException) {
                   return Status.INVALID_ARGUMENT;
               }
               return null;
            });

JacksonModuleProvider has been removed in favor of JacksonObjectMapperProvider.
ResponseConverterFunctionProvider.createResponseConverterFunction(Type,ResponseConverterFunction,ExceptionHandlerFunction) has been removed in favor of ResponseConverterFunctionProvider.createResponseConverterFunction()?full . #3674
OAuth2AuthorizationGrant.withAuthorization() has been removed. #3618