Skip to content

Map version from @HttpExchange to RequestMappingInfo #36602

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

Open
renatomameli wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Map version from @HttpExchange to RequestMappingInfo #36602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion ...g/springframework/web/reactive/result/method/annotation/RequestMappingHandlerMapping.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@ protected RequestMappingInfo createRequestMappingInfo(
.methods(toMethodArray(httpExchange.method()))
.consumes(toStringArray(httpExchange.contentType()))
.produces(httpExchange.accept())
.headers(httpExchange.headers());
.headers(httpExchange.headers())
.version(httpExchange.version());

if (customCondition != null) {
builder.customCondition(customCondition);
Expand Down
34 changes: 34 additions & 0 deletions ...ingframework/web/reactive/result/method/annotation/RequestMappingHandlerMappingTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
import org.springframework.web.reactive.result.condition.MediaTypeExpression;
import org.springframework.web.reactive.result.method.RequestMappingInfo;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.service.annotation.GetExchange;
import org.springframework.web.service.annotation.HttpExchange;
import org.springframework.web.service.annotation.PostExchange;
import org.springframework.web.service.annotation.PutExchange;
Expand Down Expand Up @@ -130,6 +131,34 @@ void versionInvalid() {
.verifyError(InvalidApiVersionException.class);
}

@Test
void httpExchangeWithVersion() {
DefaultApiVersionStrategy versionStrategy = new DefaultApiVersionStrategy(
List.of(new HeaderApiVersionResolver("API-Version")), new SemanticApiVersionParser(),
true, null, true, null, null);
this.handlerMapping.setApiVersionStrategy(versionStrategy);
this.handlerMapping.afterPropertiesSet();

Class<HttpExchangeController> clazz = HttpExchangeController.class;
Method method = ReflectionUtils.findMethod(clazz, "versionedExchange");
RequestMappingInfo mappingInfo = this.handlerMapping.getMappingForMethod(method, clazz);

assertThat(mappingInfo).isNotNull();
assertThat(mappingInfo.getVersionCondition().getVersion()).isEqualTo("1.1");
}

@Test
void httpExchangeWithoutVersionHasNoVersionCondition() {
this.handlerMapping.afterPropertiesSet();

Class<HttpExchangeController> clazz = HttpExchangeController.class;
Method method = ReflectionUtils.findMethod(clazz, "defaultValuesExchange");
RequestMappingInfo mappingInfo = this.handlerMapping.getMappingForMethod(method, clazz);

assertThat(mappingInfo).isNotNull();
assertThat(mappingInfo.getVersionCondition().getVersion()).isNull();
}

private ServerWebExchange initExchangeForVersionTest(String version) {

((StaticWebApplicationContext) this.handlerMapping.getApplicationContext())
Expand Down Expand Up @@ -640,6 +669,11 @@ public void customValuesExchange(){}
public String customHeadersExchange() {
return "info";
}

@GetExchange(version = "1.1")
public String versionedExchange() {
return "v1.1";
}
}

@HttpExchange("/exchange")
Expand Down
3 changes: 2 additions & 1 deletion ...a/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerMapping.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,8 @@ protected RequestMappingInfo createRequestMappingInfo(
.methods(toMethodArray(httpExchange.method()))
.consumes(toStringArray(httpExchange.contentType()))
.produces(httpExchange.accept())
.headers(httpExchange.headers());
.headers(httpExchange.headers())
.version(httpExchange.version());

if (customCondition != null) {
builder.customCondition(customCondition);
Expand Down
39 changes: 35 additions & 4 deletions .../springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerMappingTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
import org.springframework.web.context.support.StaticWebApplicationContext;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.method.HandlerTypePredicate;
import org.springframework.web.service.annotation.GetExchange;
import org.springframework.web.service.annotation.HttpExchange;
import org.springframework.web.service.annotation.PostExchange;
import org.springframework.web.service.annotation.PutExchange;
Expand Down Expand Up @@ -169,22 +170,36 @@ private void initRequestPath(RequestMappingHandlerMapping mapping, MockHttpServl

@PathPatternsParameterizedTest
void version(RequestMappingHandlerMapping mapping) throws Exception {
MockHttpServletRequest request = initRequestForVersionTest(mapping, "1.1");
MockHttpServletRequest request = initRequestForVersionTest(mapping, VersionController.class, "1.1");
HandlerMethod handlerMethod = (HandlerMethod) mapping.getHandler(request).getHandler();
assertThat(handlerMethod.getMethod().getName()).isEqualTo("foo1_1");
}

@PathPatternsParameterizedTest
void versionInvalid(RequestMappingHandlerMapping mapping) throws Exception {
MockHttpServletRequest request = initRequestForVersionTest(mapping, "99");
MockHttpServletRequest request = initRequestForVersionTest(mapping, VersionController.class, "99");
assertThatThrownBy(() -> mapping.getHandler(request)).isInstanceOf(InvalidApiVersionException.class);
}

@PathPatternsParameterizedTest
void versionWithHttpExchange(RequestMappingHandlerMapping mapping) throws Exception {
MockHttpServletRequest request = initRequestForVersionTest(mapping, VersionHttpExchangeController.class, "1.1");
HandlerMethod handlerMethod = (HandlerMethod) mapping.getHandler(request).getHandler();
assertThat(handlerMethod.getMethod().getName()).isEqualTo("foo1_1");
}

@PathPatternsParameterizedTest
void versionInvalidWithHttpExchange(RequestMappingHandlerMapping mapping) {
MockHttpServletRequest request = initRequestForVersionTest(mapping, VersionHttpExchangeController.class, "99");
assertThatThrownBy(() -> mapping.getHandler(request)).isInstanceOf(InvalidApiVersionException.class);
}


private static MockHttpServletRequest initRequestForVersionTest(
RequestMappingHandlerMapping mapping, String version) {
RequestMappingHandlerMapping mapping, Class<?> controllerClass, String version) {

((StaticWebApplicationContext) mapping.getApplicationContext())
.registerSingleton("controller", VersionController.class);
.registerSingleton("controller", controllerClass);

DefaultApiVersionStrategy versionStrategy = new DefaultApiVersionStrategy(
List.of(new HeaderApiVersionResolver("API-Version")), new SemanticApiVersionParser(),
Expand Down Expand Up @@ -679,6 +694,22 @@ public String foo1_1() {
}


@RestController
@HttpExchange("/foo")
static class VersionHttpExchangeController {

@GetExchange
public String foo() {
return "foo";
}

@GetExchange(version = "1.1")
public String foo1_1() {
return "foo1_1";
}
}


@RestController
@HttpExchange("/exchange")
static class HttpExchangeController {
Expand Down