Spring/spring-graphql
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Support Optional<Sort> method argument

Browse Source 
See gh-620
This commit is contained in:
rstoyanchev
2023-03-20 07:02:10 +00:00
parent 9c53c59d23
commit da00c8beaa
2 changed files with 35 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
spring-graphql/src/main/java/org/springframework/graphql/data/method/annotation/support/SortMethodArgumentResolver.java
View File

@@ -17,6 +17,8 @@
package org.springframework.graphql.data.method.annotation.support;
import java.util.Optional;
import graphql.schema.DataFetchingEnvironment;
import org.springframework.core.MethodParameter;
@@ -45,12 +47,15 @@ public class SortMethodArgumentResolver implements HandlerMethodArgumentResolver
@Override
public boolean supportsParameter(MethodParameter parameter) {
return parameter.getParameterType().equals(Sort.class);
return parameter.nestedIfOptional().getNestedParameterType().equals(Sort.class);
}
@Override
public Object resolveArgument(MethodParameter parameter, DataFetchingEnvironment environment) {
Sort sort = this.sortStrategy.extract(environment);
if (parameter.isOptional()) {
return Optional.ofNullable(sort);
}
return (sort != null ? sort : Sort.unsorted());
}

46
spring-graphql/src/test/java/org/springframework/graphql/data/method/annotation/support/SortMethodArgumentResolverTests.java
View File

@@ -17,6 +17,8 @@
package org.springframework.graphql.data.method.annotation.support;
import java.util.List;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;
import graphql.schema.DataFetchingEnvironment;
@@ -28,7 +30,6 @@ import org.springframework.graphql.Book;
import org.springframework.graphql.BookCriteria;
import org.springframework.graphql.data.method.annotation.QueryMapping;
import org.springframework.graphql.data.query.AbstractSortStrategy;
import org.springframework.graphql.data.query.SortStrategy;
import static org.assertj.core.api.Assertions.assertThat;
@@ -39,25 +40,35 @@ import static org.assertj.core.api.Assertions.assertThat;
*/
public class SortMethodArgumentResolverTests extends ArgumentResolverTestSupport {
private final SortMethodArgumentResolver resolver = new SortMethodArgumentResolver(new MySortStrategy());
private final MethodParameter param = methodParam(BookController.class, "getBooks", Sort.class);
private final MethodParameter paramOptional = methodParam(BookController.class, "getBooksOptional", Optional.class);
@Test
void supports() {
SortMethodArgumentResolver resolver = resolver(new SimpleSortStrategy());
assertThat(resolver.supportsParameter(this.param)).isTrue();
assertThat(this.resolver.supportsParameter(this.param)).isTrue();
assertThat(this.resolver.supportsParameter(this.paramOptional)).isTrue();
MethodParameter param = methodParam(BookController.class, "getBooksByCriteria", BookCriteria.class);
assertThat(resolver.supportsParameter(param)).isFalse();
assertThat(this.resolver.supportsParameter(param)).isFalse();
}
@SuppressWarnings({"unchecked", "DataFlowIssue", "OptionalGetWithoutIsPresent"})
@Test
void resolve() throws Exception {
testResolver(env -> (Sort) this.resolver.resolveArgument(this.param, env));
testResolver(env -> ((Optional<Sort>) this.resolver.resolveArgument(this.paramOptional, env)).get());
}
private void testResolver(Function<DataFetchingEnvironment, Sort> resolveFunction) throws Exception {
DataFetchingEnvironment environment = environment("""
{ "sortFields": ["firstName", "lastName", "id"], "sortDirection": "DESC"}"
""");
Sort sort = (Sort) resolver(new SimpleSortStrategy()).resolveArgument(param, environment);
Sort sort = resolveFunction.apply(environment);
assertThat(sort.stream().collect(Collectors.toList()))
.hasSize(3)
@@ -67,12 +78,8 @@ public class SortMethodArgumentResolverTests extends ArgumentResolverTestSupport
new Sort.Order(Sort.Direction.DESC, "id"));
}
private SortMethodArgumentResolver resolver(SortStrategy sortStrategy) {
return new SortMethodArgumentResolver(sortStrategy);
}
@SuppressWarnings({"DataFlowIssue", "unused"})
@SuppressWarnings({"unused", "DataFlowIssue", "OptionalUsedAsFieldOrParameterType"})
private static class BookController {
@QueryMapping
@@ -80,6 +87,11 @@ public class SortMethodArgumentResolverTests extends ArgumentResolverTestSupport
return null;
}
@QueryMapping
public List<Book> getBooksOptional(Optional<Sort> sort) {
return null;
}
@QueryMapping
public List<Book> getBooksByCriteria(BookCriteria criteria) {
return null;
@@ -88,17 +100,17 @@ public class SortMethodArgumentResolverTests extends ArgumentResolverTestSupport
}
private static class SimpleSortStrategy extends AbstractSortStrategy {
private static class MySortStrategy extends AbstractSortStrategy {
@Override
protected List<String> getProperties(DataFetchingEnvironment environment) {
return environment.getArgument("sortFields");
protected List<String> getProperties(DataFetchingEnvironment env) {
return env.getArgument("sortFields");
}
@Override
protected Sort.Direction getDirection(DataFetchingEnvironment environment) {
return (environment.containsArgument("sortDirection") ?
Sort.Direction.valueOf(environment.getArgument("sortDirection")) : null);
protected Sort.Direction getDirection(DataFetchingEnvironment env) {
String direction = env.getArgument("sortDirection");
return (direction != null ? Sort.Direction.valueOf(direction) : null);
}
}