v1.17.0

July 6, 2022

🌟 New features

You can now easily send and receive RESTful APIs using RestClient. #4263

Java

RestClient restClient = RestClient.of("...");
CompletableFuture<ResponseEntity<Customer>> response =
    restClient.get("/api/v1/customers/{customerId}")
              .pathParam("customerId", "0000001")
              .execute(Customer.class);

Kotlin

val restClient: RestClient = RestClient.of("...");
val response: ResponseEntity<Customer> =
   restClient
     .get("/api/v1/customers/{customerId}")
     .pathParam("customerId", "0000001")
     .execute<Customer>()  // a suspend function

Scala

val restClient: ScalaRestClient = ScalaRestClient("...")
val response: Future[ResponseEntity[Result]] =
  restClient.post("/api/v1/customers")
            .contentJson(new Customer(...))
            .execute[Result]()

You can now configure a timeout for an Endpoint selection of an DynamicEndpointGroup. #4246

DnsAddressEndpointGroup delegate = DnsAddressEndpointGroup.of(...);
HealthCheckedEndpointGroup healthGroup =
  HealthCheckedEndpointGroup
    .builder(delegate, "/health")
    .selectionTimeout(Duration.ofSeconds(10)) // 👈👈👈
    .build();

You can now inject dependencies in an annotation using DependencyInjector. #4006 #4202

// Inject authClient that is needed to create the AuthDecorator.
WebClient authClient = ...
DependencyInjector injector =
    DependencyInjector.ofSingletons(new AuthDecorator(authClient));
serverBuilder.dependencyInjector(dependencyInjector, true);

// An annotated service that uses AuthDecorator.
@Get("/foo")
@Decorator(AuthDecorator.class)
public FooResponse foo(FooRequest req) {
    // Authrorized request.
    ...
}

// authClient is injected.
class AuthDecorator implements DecoratingHttpServiceFunction {
    AuthDecorator(WebClient authClient) { ... }

    @Override
    public HttpResponse serve(HttpService delegate,
                              ServiceRequestContext ctx,
                              HttpRequest req)
            throws Exception {
        // Authorize the request.
        ...
    }
}

Set armeria.enable-auto-injection to true to apply SpringDependencyInjector automatically when using Spring Boot integration.
```
// in application.yml
armeria:
  ports:
    ...
  enable-auto-injection: true  // 👈👈👈
```

You can now customize the length of string fields or container fields of Thrift messages using THttpServiceBuilder or ThriftClientBuilder. #4024 #4226

THttpService.builder()
            .addService(new MyThriftService())
            .maxRequestStringLength(MAX_STRING_LENGTH)
            .maxRequestContainerLength(MAX_CONTAINER_LENGTH)
            .build();
ThriftClients.builder("https://my.server.com")
             .path("/thrift")
             .maxResponseStringLength(MAX_STRING_LENGTH)
             .maxResponseContainerLength(MAX_CONTAINER_LENGTH)
             .build(HelloService.AsyncIface.class);

You can now set attributes to an Endpoint using Attributes and AttributesBuilder. #4241

AttributeKey<String> region = AttributeKey.valueOf(MyAttrs.class, "region");
Attributes attrs =
  Attributes
    .builder()
    .set(region, "us-west-1")
    .build();

Endpoint endpointA = ...;
Endpoint endpointB = endpointA.withAttrs(attrs);
assert endpointB.attr(region).equals("us-west-1");
assert !endpointA.equals(endpointB)

You can now use MultipartFile to get the actual filename of an uploaded file through multipart/form-data. #4262

@Consumes(MediaTypeNames.MULTIPART_FORM_DATA)
@Post("/upload")
public HttpResponse upload(MultipartFile multipartFile) {
  // The name parameter of the "content-disposition" header
  String name = multipartFile.name();
  // The filename parameter of the "content-disposition" header
  String filename = multipartFile.filename();
  // The file that stores the multipart content.
  File file = multipartFile.file();
  ...
}

You can now read a range of bytes using ByteStreamMessage. #4058

Path path = ...;
// Fluently build a `StreamMessage` for a `Path`.
ByteStreamMessage pathContent =
    StreamMessage.builder(path)
                 .bufferSize(1024)
                 .alloc(alloc)
                 .executor(executor)
                 .build();
// Slice a range of a file data
ByteStreamMessage partialContent = pathContent.range(100, 200);

You can now map a specific exception to a LogLevel in LoggingService and LoggingClient. #3400 #4090

LoggingService.builder()
              .responseLogLevel(IllegalStateException.class,
                                LogLevel.WARN)
              .responseLogLevel(IllegalArgumentException.class,
                                LogLevel.ERROR)
              ...

You can now map a specific exception to an HttpResponse. #4279 #4283

HttpResponse recovered =
    response.recover(IllegalStateException.class,
                     cause -> HttpResponse.of("Fallback"));

You can now enable automatic compression for a gRPC response. #4258 #4266
```
GrpcService.builder()
           .addService(new MyGrpcService())
           .autoCompression(true)
           .build();
```
- This only works when the client sends a grpc-accept-encoding header and the CompressorRegistry has the compressor.

You can now add a hook to Server and ClientFactory that is called when the JVM shuts down. #4015 #4043

server.closeOnJvmShutdown(() -> {
  System.err.println("Server is stopping soon.");
}).thenRun(() -> {
  System.err.println("Server has stopped.");
});

You can now customize internal Netty ChannelPipeline using ClientFactoryOptions.CHANNEL_PIPELINE_CUSTOMIZER. #3907 #4260
- This is an advanced feature and not recommended to use if you are not familiar with Armeria and Netty internals.

Kotlin

You can now use the Kotlin nullable type (?) to indicate a nullable parameter in an annotated service. #4144 #4225

serverBuilder.apply {
  annotatedService(object {
    // Both `/foo` and `/foo?a=bar` are allowed.
    @Get("/foo")
    fun foo(@Param a: String?) = // 👈👈👈
      HttpResponse.of("a: $a")
  })
}

📈 Improvements

The EndpointSelectionTimeoutException is thrown if timeout occurred when selecting an Endpoint from an EndpointGroup. #4269
You can now set multiple AccessLogWriters to ServerBuilder and ServiceBindingBuilder. #4280
You can now give a performance optimization hint to a client by setting an ExchangeType to a RequestOptions. The ExchangeType is configured automatically for:
- A gRPC client
- A Thrift client
- A WebClient when it's used with ResponseAs. #4236
Better performance for unary gRPC call. #4192
Annotated services perform better on unary responses. #4177

🛠️ Bug fixes

You can now run ServerInterceptors in a blocking task executor when GrpcServiceBuilder.useBlockingTaskExecutor() is enabled. #4275 #4331
Multiparts.getBoundary() now throws an IllegalStateException instead of NullPointerException when a boundary is missing. #4193 #4325
Armeria retrofit streaming mode now requests data to upstream when it does not have one. #4319
You no longer see deep recursive calls in PublisherBasedStreamMessage. #4298
You no longer see IllegalArgumentException indicating the prohibited character of a header name in an environment where Spring integration module and Netty client are used together. (e.g. Spring Cloud Gateway) #4293
ServerCacheControl.DISABLED and ServerCacheControl.REVALIDATED now have max-age set to 0 for better compatibility with old browsers. #4290 #4291
You no longer see a NullPointerException from Flags when RequestContextExportingAppender is used. #4285
You no longer see the InputStream returned by StreamMessage.toInputStream() blocks indefinitely in a certain situation. #4268 #4271
A WriteTimeoutException is now thrown when a header only request times out. #4255 #4259
The request now completes even when the content sanitizer throws an exception. #4248
A proxy client doesn't resolve a hostname anymore. #4244 #4245
The Spring Boot integration module doesn't create a new WebClient anymore every time it's injected. #4240
Armeria server sends now 400 Bad Request when an HTTP/2 upgrade request contains invalid headers. #4016 #4224
EurekaUpdatingListener now registers itself with the instanceId which is hostname:appname:port, so it doesn't cause a conflict when more than one app with the same name are running in the same host. #4223
A ramping up EndpointSelectionStrategy now works correctly in combination with HealthCheckedEndpointGroup. #4221
The information of a thrown exception in gRPC service is now propagated to the client via the grpc-status-details-bin header. #4203 #4204