Skip to content

Commit c7338c7

Browse files
rstoyanchevrstoyanchev
committed
Support async wrappers for Principal and WebSession
Issue: SPR-15494
1 parent 1292bb2 commit c7338c7

File tree

4 files changed

+190
-9
lines changed

4 files changed

+190
-9
lines changed

‎spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/PrincipalArgumentResolver.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
import reactor.core.publisher.Mono;
2222

2323
import org.springframework.core.MethodParameter;
24+
import org.springframework.core.ReactiveAdapter;
2425
import org.springframework.core.ReactiveAdapterRegistry;
25-
import org.springframework.util.Assert;
2626
import org.springframework.web.reactive.BindingContext;
2727
import org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport;
2828
import org.springframework.web.server.ServerWebExchange;
@@ -36,22 +36,24 @@
3636
*/
3737
public class PrincipalArgumentResolver extends HandlerMethodArgumentResolverSupport {
3838

39+
3940
public PrincipalArgumentResolver(ReactiveAdapterRegistry adapterRegistry) {
4041
super(adapterRegistry);
4142
}
4243

4344

4445
@Override
4546
public boolean supportsParameter(MethodParameter parameter) {
46-
return checkParameterTypeNoReactiveWrapper(parameter, Principal.class::isAssignableFrom);
47+
return checkParameterType(parameter, Principal.class::isAssignableFrom);
4748
}
4849

4950
@Override
5051
public Mono<Object> resolveArgument(MethodParameter parameter, BindingContext context,
5152
ServerWebExchange exchange) {
5253

53-
Assert.isAssignable(Principal.class, parameter.getParameterType());
54-
return exchange.getPrincipal().cast(Object.class);
54+
Mono<Principal> principal = exchange.getPrincipal();
55+
ReactiveAdapter adapter = getAdapterRegistry().getAdapter(parameter.getParameterType());
56+
return adapter != null ? Mono.just(adapter.fromPublisher(principal)) : Mono.from(principal);
5557
}
5658

5759
}

‎spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/WebSessionArgumentResolver.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,9 @@
1919
import reactor.core.publisher.Mono;
2020

2121
import org.springframework.core.MethodParameter;
22+
import org.springframework.core.ReactiveAdapter;
2223
import org.springframework.core.ReactiveAdapterRegistry;
23-
import org.springframework.util.Assert;
2424
import org.springframework.web.reactive.BindingContext;
25-
import org.springframework.web.reactive.result.method.HandlerMethodArgumentResolver;
2625
import org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport;
2726
import org.springframework.web.server.ServerWebExchange;
2827
import org.springframework.web.server.WebSession;
@@ -36,22 +35,24 @@
3635
*/
3736
public class WebSessionArgumentResolver extends HandlerMethodArgumentResolverSupport {
3837

38+
3939
public WebSessionArgumentResolver(ReactiveAdapterRegistry adapterRegistry) {
4040
super(adapterRegistry);
4141
}
4242

4343

4444
@Override
4545
public boolean supportsParameter(MethodParameter parameter) {
46-
return checkParameterTypeNoReactiveWrapper(parameter, WebSession.class::isAssignableFrom);
46+
return checkParameterType(parameter, WebSession.class::isAssignableFrom);
4747
}
4848

4949
@Override
5050
public Mono<Object> resolveArgument(
5151
MethodParameter parameter, BindingContext context, ServerWebExchange exchange) {
5252

53-
Assert.isAssignable(WebSession.class, parameter.getParameterType());
54-
return exchange.getSession().cast(Object.class);
53+
Mono<WebSession> session = exchange.getSession();
54+
ReactiveAdapter adapter = getAdapterRegistry().getAdapter(parameter.getParameterType());
55+
return adapter != null ? Mono.just(adapter.fromPublisher(session)) : Mono.from(session);
5556
}
5657

5758
}

‎spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/PrincipalArgumentResolverTests.java

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
/*
2+
* Copyright 2002-2017 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package org.springframework.web.reactive.result.method.annotation;
17+
18+
import java.security.Principal;
19+
20+
import io.reactivex.Single;
21+
import org.junit.Test;
22+
import reactor.core.publisher.Mono;
23+
24+
import org.springframework.core.MethodParameter;
25+
import org.springframework.core.ReactiveAdapterRegistry;
26+
import org.springframework.mock.http.server.reactive.test.MockServerHttpRequest;
27+
import org.springframework.web.method.ResolvableMethod;
28+
import org.springframework.web.reactive.BindingContext;
29+
import org.springframework.web.server.ServerWebExchange;
30+
31+
import static org.junit.Assert.assertSame;
32+
import static org.junit.Assert.assertTrue;
33+
34+
/**
35+
* Unit tests for {@link PrincipalArgumentResolver}.
36+
* @author Rossen Stoyanchev
37+
*/
38+
public class PrincipalArgumentResolverTests {
39+
40+
private final PrincipalArgumentResolver resolver =
41+
new PrincipalArgumentResolver(new ReactiveAdapterRegistry());
42+
43+
private ResolvableMethod testMethod = ResolvableMethod.on(getClass()).named("handle").build();
44+
45+
46+
@Test
47+
public void supportsParameter() throws Exception {
48+
assertTrue(this.resolver.supportsParameter(this.testMethod.arg(Principal.class)));
49+
assertTrue(this.resolver.supportsParameter(this.testMethod.arg(Mono.class, Principal.class)));
50+
assertTrue(this.resolver.supportsParameter(this.testMethod.arg(Single.class, Principal.class)));
51+
}
52+
53+
54+
@Test
55+
public void resolverArgument() throws Exception {
56+
57+
BindingContext context = new BindingContext();
58+
Principal user = () -> "Joe";
59+
ServerWebExchange exchange = MockServerHttpRequest.get("/").build().toExchange()
60+
.mutate().principal(Mono.just(user)).build();
61+
62+
MethodParameter param = this.testMethod.arg(Principal.class);
63+
Object actual = this.resolver.resolveArgument(param, context, exchange).block();
64+
assertSame(user, actual);
65+
66+
param = this.testMethod.arg(Mono.class, Principal.class);
67+
actual = this.resolver.resolveArgument(param, context, exchange).block();
68+
assertTrue(Mono.class.isAssignableFrom(actual.getClass()));
69+
assertSame(user, ((Mono<?>) actual).block());
70+
71+
param = this.testMethod.arg(Single.class, Principal.class);
72+
actual = this.resolver.resolveArgument(param, context, exchange).block();
73+
assertTrue(Single.class.isAssignableFrom(actual.getClass()));
74+
assertSame(user, ((Single<?>) actual).blockingGet());
75+
}
76+
77+
78+
@SuppressWarnings("unused")
79+
void handle(
80+
Principal user,
81+
Mono<Principal> userMono,
82+
Single<Principal> singleUser) {
83+
}
84+
85+
}

‎spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/WebSessionArgumentResolverTests.java

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
/*
2+
* Copyright 2002-2017 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package org.springframework.web.reactive.result.method.annotation;
17+
18+
import java.time.Clock;
19+
20+
import io.reactivex.Single;
21+
import org.junit.Test;
22+
import reactor.core.publisher.Mono;
23+
24+
import org.springframework.core.MethodParameter;
25+
import org.springframework.core.ReactiveAdapterRegistry;
26+
import org.springframework.http.codec.ServerCodecConfigurer;
27+
import org.springframework.mock.http.server.reactive.test.MockServerHttpRequest;
28+
import org.springframework.mock.http.server.reactive.test.MockServerHttpResponse;
29+
import org.springframework.web.method.ResolvableMethod;
30+
import org.springframework.web.reactive.BindingContext;
31+
import org.springframework.web.server.ServerWebExchange;
32+
import org.springframework.web.server.WebSession;
33+
import org.springframework.web.server.adapter.DefaultServerWebExchange;
34+
import org.springframework.web.server.session.DefaultWebSession;
35+
import org.springframework.web.server.session.WebSessionManager;
36+
37+
import static org.junit.Assert.assertSame;
38+
import static org.junit.Assert.assertTrue;
39+
40+
/**
41+
* Unit tests for {@link WebSessionArgumentResolver}.
42+
* @author Rossen Stoyanchev
43+
*/
44+
public class WebSessionArgumentResolverTests {
45+
46+
private final WebSessionArgumentResolver resolver =
47+
new WebSessionArgumentResolver(new ReactiveAdapterRegistry());
48+
49+
private ResolvableMethod testMethod = ResolvableMethod.on(getClass()).named("handle").build();
50+
51+
52+
@Test
53+
public void supportsParameter() throws Exception {
54+
assertTrue(this.resolver.supportsParameter(this.testMethod.arg(WebSession.class)));
55+
assertTrue(this.resolver.supportsParameter(this.testMethod.arg(Mono.class, WebSession.class)));
56+
assertTrue(this.resolver.supportsParameter(this.testMethod.arg(Single.class, WebSession.class)));
57+
}
58+
59+
60+
@Test
61+
public void resolverArgument() throws Exception {
62+
63+
BindingContext context = new BindingContext();
64+
WebSession session = new DefaultWebSession("id", Clock.systemDefaultZone());
65+
WebSessionManager manager = exchange -> Mono.just(session);
66+
MockServerHttpRequest request = MockServerHttpRequest.get("/").build();
67+
ServerWebExchange exchange = new DefaultServerWebExchange(request, new MockServerHttpResponse(),
68+
manager, ServerCodecConfigurer.create());
69+
70+
MethodParameter param = this.testMethod.arg(WebSession.class);
71+
Object actual = this.resolver.resolveArgument(param, context, exchange).block();
72+
assertSame(session, actual);
73+
74+
param = this.testMethod.arg(Mono.class, WebSession.class);
75+
actual = this.resolver.resolveArgument(param, context, exchange).block();
76+
assertTrue(Mono.class.isAssignableFrom(actual.getClass()));
77+
assertSame(session, ((Mono<?>) actual).block());
78+
79+
param = this.testMethod.arg(Single.class, WebSession.class);
80+
actual = this.resolver.resolveArgument(param, context, exchange).block();
81+
assertTrue(Single.class.isAssignableFrom(actual.getClass()));
82+
assertSame(session, ((Single<?>) actual).blockingGet());
83+
}
84+
85+
86+
@SuppressWarnings("unused")
87+
void handle(
88+
WebSession user,
89+
Mono<WebSession> userMono,
90+
Single<WebSession> singleUser) {
91+
}
92+
93+
}

0 commit comments

Comments
 (0)