Skip to content

HTTP interface client should not have blockingTimeout set and leave it to the underlying client by default #30403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

HTTP interface client should not have blockingTimeout set and leave it to the underlying client by default #30403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66c1848
Remove default blocking timeout on ResponseFunction.
OlgaMaciaszek Apr 28, 2023
9f1b711
Remove default blocking timeout on RSocketServiceMethod.
OlgaMaciaszek Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions framework-docs/src/docs/asciidoc/integration/rest-clients.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,11 @@ Annotated, HTTP exchange methods support the following return values:
TIP: You can also use any other async or reactive types registered in the
`ReactiveAdapterRegistry`.

TIP: For non-reactive types, blocking from a reactive publisher is performed
under the hood by the framework. By default, it is done without a timeout.
You can set a timeout for blocking by calling `blockTimeout(Duration blockTimeout)`
on `HttpServiceProxyFactory.Builder`.


[[rest-http-interface-exceptions]]
=== Exception Handling
Expand Down
5 changes: 5 additions & 0 deletions framework-docs/src/docs/asciidoc/rsocket.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -979,3 +979,8 @@ method parameters:
Annotated, RSocket exchange methods support return values that are concrete value(s), or
any producer of value(s) that can be adapted to a Reactive Streams `Publisher` via
`ReactiveAdapterRegistry`.

TIP: For non-reactive types, blocking from a reactive publisher is performed
under the hood by the framework. By default, it is done without a timeout.
You can set a timeout for blocking by calling `blockTimeout(Duration blockTimeout)`
on `RSocketServiceProxyFactory.Builder`.
10 changes: 6 additions & 4 deletions ...ing/src/main/java/org/springframework/messaging/rsocket/service/RSocketServiceMethod.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ final class RSocketServiceMethod {
RSocketServiceMethod(
Method method, Class<?> containingClass, List<RSocketServiceArgumentResolver> argumentResolvers,
RSocketRequester rsocketRequester, @Nullable StringValueResolver embeddedValueResolver,
ReactiveAdapterRegistry reactiveRegistry, Duration blockTimeout) {
ReactiveAdapterRegistry reactiveRegistry, @Nullable Duration blockTimeout) {

this.method = method;
this.parameters = initMethodParameters(method);
Expand Down Expand Up @@ -125,7 +125,7 @@ private static String initRoute(

private static Function<RSocketRequestValues, Object> initResponseFunction(
RSocketRequester requester, Method method,
ReactiveAdapterRegistry reactiveRegistry, Duration blockTimeout) {
ReactiveAdapterRegistry reactiveRegistry, @Nullable Duration blockTimeout) {

MethodParameter returnParam = new MethodParameter(method, -1);
Class<?> returnType = returnParam.getParameterType();
Expand Down Expand Up @@ -164,8 +164,10 @@ else if (reactiveAdapter == null) {
return reactiveAdapter.fromPublisher(responsePublisher);
}
return (blockForOptional ?
((Mono<?>) responsePublisher).blockOptional(blockTimeout) :
((Mono<?>) responsePublisher).block(blockTimeout));
(blockTimeout != null ? ((Mono<?>) responsePublisher).blockOptional(blockTimeout) :
((Mono<?>) responsePublisher).blockOptional()) :
(blockTimeout != null ? ((Mono<?>) responsePublisher).block(blockTimeout) :
((Mono<?>) responsePublisher).block()));
});
}

Expand Down
10 changes: 6 additions & 4 deletions ...c/main/java/org/springframework/messaging/rsocket/service/RSocketServiceProxyFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,14 @@ public final class RSocketServiceProxyFactory {

private final ReactiveAdapterRegistry reactiveAdapterRegistry;

@Nullable
private final Duration blockTimeout;


private RSocketServiceProxyFactory(
RSocketRequester rsocketRequester, List<RSocketServiceArgumentResolver> argumentResolvers,
@Nullable StringValueResolver embeddedValueResolver,
ReactiveAdapterRegistry reactiveAdapterRegistry, Duration blockTimeout) {
ReactiveAdapterRegistry reactiveAdapterRegistry, @Nullable Duration blockTimeout) {

this.rsocketRequester = rsocketRequester;
this.argumentResolvers = argumentResolvers;
Expand Down Expand Up @@ -139,7 +140,7 @@ public static final class Builder {
private ReactiveAdapterRegistry reactiveAdapterRegistry = ReactiveAdapterRegistry.getSharedInstance();

@Nullable
private Duration blockTimeout = Duration.ofSeconds(5);
private Duration blockTimeout;

private Builder() {
}
Expand Down Expand Up @@ -189,7 +190,8 @@ public Builder reactiveAdapterRegistry(ReactiveAdapterRegistry registry) {
/**
* Configure how long to wait for a response for an HTTP service method
* with a synchronous (blocking) method signature.
* <p>By default this is 5 seconds.
* <p>By default this is {@code null},
* in which case means blocking on publishers is done without a timeout.
* @param blockTimeout the timeout value
* @return this same builder instance
*/
Expand All @@ -207,7 +209,7 @@ public RSocketServiceProxyFactory build() {
return new RSocketServiceProxyFactory(
this.rsocketRequester, initArgumentResolvers(),
this.embeddedValueResolver, this.reactiveAdapterRegistry,
(this.blockTimeout != null ? this.blockTimeout : Duration.ofSeconds(5)));
this.blockTimeout);
}

private List<RSocketServiceArgumentResolver> initArgumentResolvers() {
Expand Down
10 changes: 6 additions & 4 deletions spring-web/src/main/java/org/springframework/web/service/invoker/HttpServiceMethod.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ final class HttpServiceMethod {
HttpServiceMethod(
Method method, Class<?> containingClass, List<HttpServiceArgumentResolver> argumentResolvers,
HttpClientAdapter client, @Nullable StringValueResolver embeddedValueResolver,
ReactiveAdapterRegistry reactiveRegistry, Duration blockTimeout) {
ReactiveAdapterRegistry reactiveRegistry, @Nullable Duration blockTimeout) {

this.method = method;
this.parameters = initMethodParameters(method);
Expand Down Expand Up @@ -275,7 +275,7 @@ private static List<MediaType> initAccept(@Nullable HttpExchange typeAnnot, Http
private record ResponseFunction(
Function<HttpRequestValues, Publisher<?>> responseFunction,
@Nullable ReactiveAdapter returnTypeAdapter,
boolean blockForOptional, Duration blockTimeout) {
boolean blockForOptional, @Nullable Duration blockTimeout) {

private ResponseFunction(
Function<HttpRequestValues, Publisher<?>> responseFunction,
Expand All @@ -298,8 +298,10 @@ public Object execute(HttpRequestValues requestValues) {
}

return (this.blockForOptional ?
((Mono<?>) responsePublisher).blockOptional(this.blockTimeout) :
((Mono<?>) responsePublisher).block(this.blockTimeout));
(this.blockTimeout != null ? ((Mono<?>) responsePublisher).blockOptional(this.blockTimeout) :
((Mono<?>) responsePublisher).blockOptional()) :
(this.blockTimeout != null ? ((Mono<?>) responsePublisher).block(this.blockTimeout) :
((Mono<?>) responsePublisher).block()));
}


Expand Down
8 changes: 5 additions & 3 deletions ...ng-web/src/main/java/org/springframework/web/service/invoker/HttpServiceProxyFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,14 @@ public final class HttpServiceProxyFactory {

private final ReactiveAdapterRegistry reactiveAdapterRegistry;

@Nullable
private final Duration blockTimeout;


private HttpServiceProxyFactory(
HttpClientAdapter clientAdapter, List<HttpServiceArgumentResolver> argumentResolvers,
@Nullable StringValueResolver embeddedValueResolver,
ReactiveAdapterRegistry reactiveAdapterRegistry, Duration blockTimeout) {
ReactiveAdapterRegistry reactiveAdapterRegistry, @Nullable Duration blockTimeout) {

this.clientAdapter = clientAdapter;
this.argumentResolvers = argumentResolvers;
Expand Down Expand Up @@ -208,7 +209,8 @@ public Builder reactiveAdapterRegistry(ReactiveAdapterRegistry registry) {
/**
* Configure how long to wait for a response for an HTTP service method
* with a synchronous (blocking) method signature.
* <p>By default this is 5 seconds.
* <p>By default this is {@code null},
* in which case means blocking on publishers is done without a timeout.
* @param blockTimeout the timeout value
* @return this same builder instance
*/
Expand All @@ -226,7 +228,7 @@ public HttpServiceProxyFactory build() {
return new HttpServiceProxyFactory(
this.clientAdapter, initArgumentResolvers(),
this.embeddedValueResolver, this.reactiveAdapterRegistry,
(this.blockTimeout != null ? this.blockTimeout : Duration.ofSeconds(5)));
this.blockTimeout);
}

private List<HttpServiceArgumentResolver> initArgumentResolvers() {
Expand Down