v1.14.0

January 27, 2022

🌟 New features

You can now use Scala 3 for armeria-scala and armeria-scalapb. #3614 #4036

tip
Scala 3 modules are currently experimental. We're looking forward to your feedback.

You can now fluently convert an HttpResponse into a desired type using WebClient. #4021

WebClient client = WebClient.of("https://api.example.com");
CompletableFuture<ResponseEntity<MyObject>> response =
  client.prepare()
        .get("/v1/items/1")
        .asJson(MyObject.class)
        .execute();

You can now use BlockingWebClient to wait for an HttpResponse to be completed. #4021

BlockingWebClient client = BlockingWebClient.of("https://api.example.com");
ResponseEntity<MyObject> response =
  client.prepare()
        .get("/v1/items/1")
        .asJson(MyObject.class)
        .execute();

tip

Note that you should never use this client in an EventLoop thread. Use it from a non-EventLoop thread such as BlockingTaskExecutor.

You can now fluently build a gRPC client with various options using GrpcClientBuilder. #3981 #3999 #3964 #3975

GrpcClients
  .builder(...)
  .decorator(myDecorators)
  .maxResponseMessageLength(MAX_MESSAGE_SIZE)
  .jsonMarshallerFactory(descriptor -> {
    ...
  })
  .intercept(myInterceptors)
  .build(MyStub.class);

You can now fluently build an HttpResponse by using HttpResponseBuilder. #3398 #3941

HttpResponse
  .builder()
  .ok()
  .header(HttpHeaderNames.USER_AGENT, "Armeria")
  .content(content)
  .build();

You can now use StreamMessage.mapAsync() to transform a StreamMessage using an async operation. #3916 #3962

StreamMessage<Integer> userIds = StreamMessage.of(...);
StreamMessage<UserInfo> userInfos = userIds.mapAsync(this::getUserInfo);

CompletableFuture<UserInfo> getUserInfo(int userId) {
  ...
}

You can now use HttpResponse.peekHeaders(), HttpMessage.peekData(), HttpMessage.peekTrailers() and StreamMessage.peekError() operators on HttpRequest and HttpResponse. #3097 #3988 #3949

HttpRequest request =
  HttpRequest.of(RequestHeaders.of(HttpMethod.POST, "/items"),
                 HttpData.ofUtf8("data1,data2"))
                 HttpHeaders.of("trailer", "foo"));
HttpRequest peeked =
  request.peekData(data -> {
    assert data.toStringUtf8().equals("data1,data2");
  }).peekTrailers(trailers -> {
    assert trailers.get("trailer").equals("foo");
  });

HttpRequest failed =
  HttpRequest.ofFailure(new IllegalStateException("Something went wrong."));
HttpRequest peeked = failed.peekError(cause -> {
  assert cause instanceof IllegalStateException;
});

You can now generate an error response differently in ServerErrorHandler depending on the RequestHeaders. #4037

You can now use {*var} and :*var path patterns to capture rest paths of a request. #3031 #3997

Server
  .builder()
  .service("/api/{item}/route/{*contents}", (ctx, req) -> {
    // If a request path is "/api/123/route/foo/bar/baz",
    // '*contents' should be foo/bar/baz
    assert ctx.pathParam("contents").equals("foo/bar/baz");
  });

You can now use ServiceRequestContext.queryParams() to get the decoded query parameters. #3955 #3960

You can now send query parameters using QueryParams with WebClient. #3915 #3921

QueryParams params = QueryParams.of("foo", "bar");
WebClient client = ...;
// Sends 'GET /api/items/1?foo=bar'
client.get("/api/items/1", params);
// Sends 'POST /api/items?foo=bar' with body '...'
client.post("/api/items", params, content);

You can now write a StreamMessage<HttpData> into a file using StreamMessages.writeTo(). #3870 #3874

StreamMessage<HttpData> stream = ...;
Path destination = ...;
StreamMessages.writeTo(stream, destination);

You can now force a state transition of a CircuitBreaker by using CircuitBreaker.enterState(). #4010 #4022

CircuitBreaker circuitBreaker = CircuitBreaker.of(...);
circuitBreaker.enterState(CircuitState.FORCED_OPEN);

You can now conveniently create a RetryRule and RetryRuleWithContent by specifying a Backoff. #3875 #2899 #3895
```
RetryRule.failsafe(Backoff.fixed(1000));
RetryRuleWithContent.onException(Backoff.fixed(2000));
```

You can now dynamically change the maximum number of concurrent active requests of a ConcurrencyLimitingClient. #3842 #3985

ConcurrencyLimitingClient.newDecorator(new DynamicLimit());

class DynamicLimit implements IntSupplier {
  @Override
  public int getAsInt() {
    // Dynamically returns the current limitation.
    ...
  }
}

You can now split an HttpRequest into RequestHeaders, StreamMessage<HttpData> and trailers using HttpRequest.split(). #3924 #3953

HttpRequest request = HttpRequest.of(...);
SplitHttpRequest splitRequest = request.split();

RequestHeaders headers = splitRequest.headers();
StreamMessage<HttpData> body = splitRequest.body();
CompletableFuture<HttpHeaders> trailers = splitRequest.trailers();

Added more well-known MIME type constants to MediaType. #4040

You can now customize the MediaType of a file when using FileService. #4001 #4009

FileService
  .builder(resource)
  .mediaTypeResolver((path, contentEncoding) -> {
    if (path.endsWith(".proto")) {
      return MediaType.PROTOBUF;
    }
    if (path.endsWith(".csv")) {
      return MediaType.CSV_UTF_8;
    }
    // Pass to the default resolver.
    return null;
  })
  .build();

You can now send requests to a test server by using ServerExtension.webClient() or ServerRule.webClient(). #3761 #3890

 @RegisterExtension
 static ServerExtension server = new ServerExtension() {
   @Override
   protected void configure(ServerBuilder sb) {
     ...
   }
 };

 @Test
 void test() {
   WebClient client = server.webClient(cb -> {  // 👈👈👈
     cb.decorator(LoggingClient.newDecorator());
   });
   client.get("/foo").aggregate().join();
 }

You can now export metrics as OpenMetrics format using PrometheusExpositionService. #3926 #3928

You can now use UnframedGrpcStatusMappingFunction to customize how a gRPC status is mapped to an HttpStatus when using an unframed gRPC service. #3683 #3948

UnframedGrpcStatusMappingFunction mappingFunction =
  (ctx, grpcStatus, cause) -> {
    if (grpcStatus.getCode() == DEADLINE_EXCEEDED) {
      return INTERNAL_SERVER_ERROR;
    }
    // Pass to the default mapping function.
    return null;
  };

UnframedGrpcErrorHandler errorHandler =
  UnframedGrpcErrorHandler.ofJson(mappingFunction);

GrpcService
  .builder()
  .unframedGrpcErrorHandler(errorHandler);

You can now expose WebOperations of Actuator to a port of internal services. #3919 #3946

armeria:
  ...
  internal-services:
    # Actuator will be exposed to 18080 port.
    include: actuator, health
    port: 18080

Added JettyServiceBuilder.tlsReverseDnsLookup() that makes JettyService perform a reverse DNS lookup for each TLS connection, which may be useful for servlets that assume ServletRequest.getRemoteHost() will return a remote host name rather than a remote IP address.
Added JettyServiceBuilder.httpConfiguration() that allows a user to set Jetty HttpConfiguration in a type-safe manner.

📈 Improvements

You can now distinguish services, messages and enums with the same name by their package names from DocService UI. #3979
Improved the memory footprint of PrometheusExpositionService by removing large byte array allocations. #3929
Meters created by MoreMeters are now using more accurate percentiles. #4047

🛠️ Bug fixes

You no longer see ClassCastException when duplicating an HttpRequest or an HttpResponse. #4030 #4032
You no longer see IllegalArgumentException if an upper-bounded wildcard type with @Param is used in annotated services. #4007 #4008
You can now properly get SameSite attribute from Cookie.sameSite(). #3968 #3984
You no longer see an EmptyEndpointGroupException when an EndpointGroup is successfully resolved with the initial Endpoints. #3978
HttpRequestBuilder.header() does not overwrite an old header value anymore. #3932 #3941
- A new header value will be appended to the old value.
You no longer see 413 Request Entity Too Large when a server receives a cleartext (h2c) upgrade request larger than 16384 bytes. #3859 #3913
- The maximum allowed length of an upgrade request will respect ServerBuilder.maxRequestLength() or VirtualHost.maxRequestLength().
Fixed Multipart decoder to correctly publish chunks one by one when streaming a large BodyPart. #3774 #3783
You can now use google.protobuf.{Struct, Value, ListValue, Any} messages from your proto files when using gRPC-JSON transcoder. #3986 #3992
GrpcService now automatically disables gRPC-JSON serialization for Protobuf 2 services rather than throwing an exception. #4020 #4033
FileService now keeps query parameters when redirecting to a directory. #4049 #4050
You no longer see InvocationTargetException with a Kotlin method whose return type is Nothing in an annotated service. #3961 #4005
Actuator now correctly shows Liveness and Readiness of a Kubernetes instance. #3031 #3997