You're seeing the release note of an old version. Check out the latest release note.

1.0.0 release notes

21st August 2020

🌟 New features

You can now check whether a RequestContext contains an attribute or not conveniently using RequestContext.hasAttr() and RequestContext.hasOwnAttr(). #3014
You can now specify the default service and log name programmatically for an annotated service. #2979
- It was previously only possible to specify a service name with @ServiceName annotation.
```
Server.builder()
      .annotatedService().defaultServiceName("my-service")
                         .build(myAnnotatedService);
```

Annotated services now support Kotlin coroutines. #2983 #3010 #3011

See Kotlin coroutines support for more information.

class MyAnnotatedService {
    @Get("/users/{name}")
    suspend fun getUserToken(@Param name: String): String {
        val user = myReactiveRepository.findByName(name).await()
        return user.token
    }
}

You can now get the current ServiceRequestContext from the Kotlin coroutine context when using grpc-kotlin. #3001

You can now use GrpcMeterIdPrefixFunction to create meters with a grpc-status tag for gRPC clients and servers. #2762 #2971

Server.builder()
      .route().defaultServiceName("my-grpc-services")
              .build(GrpcService.builder()
                                .addService(serviceFoo)
                                .addService(serviceBar)
                                .build()
                                .decorate(MetricCollectingService.newDecorator(
                                    GrpcMeterIdPrefixFunction.of("my.grpc.svcs"))))
                                //  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      .build();

Added a new module armeria-reactor3 that provides automatic RequestContext propagation for Project Reactor. #2999

See the complete example for more information.

// Enable the hooks.
RequestContextHooks.enable();

RequestContext ctx = ...;
Flux<String> flux;
try (SafeCloseable ignored = ctx.push()) {
    // The callbacks of the 'flux' will have thread-local RequestContext set.
    flux = Flux.just("foo").publishOn(Schedulers.single());
}

StepVerifier.create(flux)
            .expectSubscriptionMatches(s -> RequestContext.current() == ctx)
            .expectNextMatches(s -> RequestContext.current() == ctx &&
                                    "foo".equals(s))
            .verifyComplete();

📈 Improvements

RequestContext.setAttr() now returns an old value being replaced. #2997 #3004

static final AttributeKey<String> ATTR_KEY =
    AttributeKey.valueOf(MyClass.class, "KEY");

RequestContext ctx = ...;
ctx.setAttr(ATTR_KEY, "foo");
String oldValue = ctx.setAttr(ATTR_KEY, "bar");
assert "foo".equals(oldValue);

You can now bind a ServiceWithRoutes (e.g. GrpcService) using the fluent builder API. #2996

HttpService myGrpcService =
    GrpcService.builder()
               .addService(serviceFoo)
               .addService(serviceBar)
               .build()
               .decorate(LoggingService.newDecorator())
               .decorate(MetricCollectingService.newDecorator(...))

Server.builder()
      .route().defaultServiceName("my-grpc-service")
              // Note that we didn't specify any paths.
              .build(myGrpcService)
      .build();

localAddress() and remoteAddress() builder methods in ServiceRequestContextBuilder and ClientRequestContextBuilder now accept SocketAddress instead of InetSocketAddress, so we have more freedom in the future when we add support for UNIX domain sockets. #2996

🛠️ Bug fixes

Fixed some of our Publisher implementations so they do not raise an AssertionError when its Subscriber attempts to request elements after the subscription is cancelled. #3003
The default MeterIdPrefixFunction now always sets the service tag so that it doesn't violate the constraints enforced by some monitoring systems, e.g. Prometheus. #2977
TimeoutMode.SET_FROM_START now schedules a timeout correctly. #2968
HAProxy protocol server doesn't raise a NullPointerException anymore when it receives a request with AF_UNSPEC socket family. #2984 #2985
Fixed a bug that prevented you from overriding the service name of a gRPC or Thrift service. #2994
The content-type header of a trailer-only gRPC response is now set correctly. #2969
Fixed a bug where a Retrofit call is sometimes left unfinished. #3006 #3008
A Spring WebFlux integration doesn't leave noisy error logs anymore for a HEAD route that produces content. #2965
Fixed a bug where a Spring WebFlux server fails to start if the management.server.port property is specified. #2980

☢️ Breaking changes

Removed all deprecated classes, fields and methods from the public API.
- The -Dcom.linecorp.armeria.useLegacyMeterNames flag does not work anymore.
Removed HTTP_ or Http from various fields and methods.
- ClientOptions:
  - HTTP_HEADERS → HEADERS
  - httpHeaders() → headers()
- Clients:
  - withHttpHeader() → withHeader()
  - withHttpHeaders() → withHeaders()
- AbstractClientOptionsBuilder and all its subtypes
  - setHttpHeader() → setHeader()
  - setHttpHeaders() → setHeaders()
  - addHttpHeader() → addHeader()
  - addHttpHeaders() → addHeaders()
Removed redundant add prefix to some builder methods.
- RequestContextExporterBuilder
  - addBuiltIn() → builtIn()
  - addAttribute() → attr()
  - addRequestHeader() → requestHeader()
  - addResponseHeader() → responseHeader()
  - addKeyPattern() → keyPattern()
- KeyStoreCredentialResolverBuilder
  - addKeyPassword() → keyPassword()
  - addKeyPasswords() → keyPasswords()
Renamed the methods in DocService, DocServiceBuilder and their related classes.
- exampleHttpHeaders → exampleHeaders
- exampleRequest() → exampleRequests()
- exampleRequestForMethod() → exampleRequests()
  - Removed exampleRequests(Object...) to avoid ambiguity.
- injectedScript() → injectedScripts()
- Removed http_ from all query parameters
  - http_headers → headers
  - http_headers_sticky → sticky_headers
Renamed the methods in ServerListenerBuilder.
- addStartingCallback() → whenStarting()
- addStartedCallback() → whenStarted()
- addStopingCallback() → whenStoping()
- addStopedCallback() → whenStoped()
- Removed all methods that accept Runnable in favor of those that accept Consumer.
- Fixed the type parameters of Iterables.
Renamed the methods in EncodingServiceBuilder.
- encodableContentTypePredicate() → encodableContentTypes()
- encodableRequestHeadersPredicate() → encodableRequestHeaders()
Renamed the methods in TokenBucketThrottlingStrategyBuilder.
- Removed the with from the builder methods.
  - withMinimumBackoff() → minimumBackoff()
  - withHeadersScheme() → headersScheme()
BasicToken.toHeaderValue(), OAuth1aToken.toHeaderValue() and OAuth2Token.toHeaderValue() have been renamed to asHeaderValue() for consistency. #3012
RequestLogProperty.NAME is not always available for annotated service methods anymore. #2979
- Use RequestLog.whenComplete() as usual.
RequestContext.setAttrIfAbsent() and computeAttrIfAbsent() have been removed. #2997 #3004
- Use RequestContext.setAttr() guarded by RequestContext.hasOwnAttr().

⛓ Dependencies