Support for query methods returning a Slice.

Built on the the just introduced RepresentationModelAssembler implementations based on Slice in Spring HATEOAS and Spring Data Commons we now support returning a SlicedModel from the controller backing search resources ultimately triggering repository query methods.

The introduction triggered the refactoring to introduce RepresentationModelAssemblers (RMA) to remove the need for controllers inheriting from AbstractRepositoryController to access RepresentationModel assembly functionality. RMA acts as a facade for both Paged-/SlicedResourceAssembler as well as PersistentEntityResourceAssembler.

Fixes #2235.

Author: odrotbohm

Diff for: spring-data-rest-tests/spring-data-rest-tests-jpa/src/test/java/org/springframework/data/rest/webmvc/RepositoryPropertyReferenceControllerIntegrationTests.java

@@ -16,10 +16,13 @@
 package org.springframework.data.rest.webmvc;
 
 import static org.assertj.core.api.Assertions.*;
-import static org.mockito.Mockito.*;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Answers;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.rest.tests.AbstractControllerIntegrationTests;
 import org.springframework.data.rest.webmvc.jpa.Book;
@@ -33,6 +36,7 @@
 /**
  * @author Oliver Gierke
  */
+@ExtendWith(MockitoExtension.class)
 @ContextConfiguration(classes = JpaRepositoryConfig.class)
 @Transactional
 class RepositoryPropertyReferenceControllerIntegrationTests extends AbstractControllerIntegrationTests {
@@ -41,13 +45,11 @@ class RepositoryPropertyReferenceControllerIntegrationTests extends AbstractCont
 	@Autowired TestDataPopulator populator;
 	@Autowired BookRepository books;
 
-	PersistentEntityResourceAssembler assembler;
+	@Mock(answer = Answers.RETURNS_MOCKS) RepresentationModelAssemblers assembler;
 	RootResourceInformation information;
 
 	@BeforeEach
 	void setUp() {
-
-		this.assembler = mock(PersistentEntityResourceAssembler.class);
 		this.information = getResourceInformation(Book.class);
 		this.populator.populateRepositories();
 	}

Diff for: spring-data-rest-tests/spring-data-rest-tests-jpa/src/test/java/org/springframework/data/rest/webmvc/RepositorySearchControllerIntegrationTests.java

@@ -16,11 +16,17 @@
 package org.springframework.data.rest.webmvc;
 
 import static org.assertj.core.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.*;
+import static org.mockito.Mockito.*;
 import static org.springframework.data.rest.tests.TestMvcClient.*;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.mockito.Answers;
+import org.mockito.invocation.InvocationOnMock;
+import org.mockito.stubbing.Answer;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.rest.core.mapping.ResourceMetadata;
@@ -35,6 +41,7 @@
 import org.springframework.data.rest.webmvc.jpa.Person;
 import org.springframework.data.rest.webmvc.jpa.TestDataPopulator;
 import org.springframework.data.rest.webmvc.support.DefaultedPageable;
+import org.springframework.data.web.PagedResourcesAssembler;
 import org.springframework.hateoas.CollectionModel;
 import org.springframework.hateoas.PagedModel;
 import org.springframework.hateoas.RepresentationModel;
@@ -61,11 +68,16 @@ class RepositorySearchControllerIntegrationTests extends AbstractControllerInteg
 
 	@Autowired TestDataPopulator loader;
 	@Autowired RepositorySearchController controller;
-	@Autowired PersistentEntityResourceAssembler assembler;
+	@Autowired PagedResourcesAssembler<Object> pagedResourcesAssembler;
+	@Autowired PersistentEntityResourceAssembler entityResourceAssembler;
+
+	RepresentationModelAssemblers assembler;
 
 	@BeforeEach
 	void setUp() {
 		loader.populateRepositories();
+
+		this.assembler = mock(RepresentationModelAssemblers.class, Answers.RETURNS_SMART_NULLS);
 	}
 
 	@Test
@@ -76,7 +88,8 @@ void rendersCorrectSearchLinksForPersons() throws Exception {
 
 		ResourceTester tester = ResourceTester.of(resource);
 		tester.assertNumberOfLinks(7); // Self link included
-		tester.assertHasLinkEndingWith("findFirstPersonByFirstName", "findFirstPersonByFirstName{?firstname,projection}");
+		tester.assertHasLinkEndingWith("findFirstPersonByFirstName",
+				"findFirstPersonByFirstName{?firstname,projection}");
 		tester.assertHasLinkEndingWith("firstname", "firstname{?firstname,page,size,sort,projection}");
 		tester.assertHasLinkEndingWith("lastname", "lastname{?lastname,sort,projection}");
 		tester.assertHasLinkEndingWith("findByCreatedUsingISO8601Date",
@@ -107,8 +120,19 @@ void executesSearchAgainstRepository() {
 		MultiValueMap<String, Object> parameters = new LinkedMultiValueMap<String, Object>(1);
 		parameters.add("firstname", "John");
 
+		doAnswer(new Answer<CollectionModel<?>>() {
+
+			@Override
+			public CollectionModel<?> answer(InvocationOnMock invocation) throws Throwable {
+
+				var page = (Page<Object>) invocation.getArgument(0);
+
+				return pagedResourcesAssembler.toModel(page, entityResourceAssembler);
+			}
+		}).when(assembler).toCollectionModel(any(), any());
+
 		ResponseEntity<?> response = controller.executeSearch(resourceInformation, parameters, "firstname", PAGEABLE,
-				Sort.unsorted(), assembler, new HttpHeaders());
+				Sort.unsorted(), new HttpHeaders(), assembler);
 
 		ResourceTester tester = ResourceTester.of(response.getBody());
 		PagedModel<Object> pagedResources = tester.assertIsPage();
@@ -173,13 +197,22 @@ void queryMethodResourceSupportsGetOnly() {
 	@Test // DATAREST-502
 	void interpretsUriAsReferenceToRelatedEntity() {
 
-		MultiValueMap<String, Object> parameters = new LinkedMultiValueMap<String, Object>(1);
+		var parameters = new LinkedMultiValueMap<String, Object>(1);
 		parameters.add("author", "/author/1");
 
-		RootResourceInformation resourceInformation = getResourceInformation(Book.class);
+		var resourceInformation = getResourceInformation(Book.class);
+
+		when(assembler.toCollectionModel(any(), any()))
+				.thenAnswer(new Answer<CollectionModel<?>>() {
+
+					@Override
+					public CollectionModel<?> answer(InvocationOnMock invocation) throws Throwable {
+						return CollectionModel.of(invocation.getArgument(0));
+					}
+				});
 
-		ResponseEntity<?> result = controller.executeSearch(resourceInformation, parameters, "findByAuthorsContains",
-				PAGEABLE, Sort.unsorted(), assembler, new HttpHeaders());
+		var result = controller.executeSearch(resourceInformation, parameters, "findByAuthorsContains", PAGEABLE,
+				Sort.unsorted(), new HttpHeaders(), assembler);
 
 		assertThat(result.getBody()).isInstanceOf(CollectionModel.class);
 	}
@@ -199,7 +232,7 @@ void returnsSimpleResponseEntityForQueryMethod() {
 		parameters.add("lastname", "Thornton");
 
 		ResponseEntity<?> entity = controller.executeSearch(getResourceInformation(Person.class), parameters,
-				"findCreatedDateByLastName", PAGEABLE, Sort.unsorted(), assembler, new HttpHeaders());
+				"findCreatedDateByLastName", PAGEABLE, Sort.unsorted(), new HttpHeaders(), assembler);
 
 		assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
 		assertThat(entity.getHeaders()).isEmpty();

Diff for: spring-data-rest-tests/spring-data-rest-tests-jpa/src/test/java/org/springframework/data/rest/webmvc/jpa/JpaWebTests.java

@@ -53,7 +53,6 @@
 import org.springframework.http.MediaType;
 import org.springframework.mock.web.MockHttpServletResponse;
 import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.util.LinkedMultiValueMap;
 import org.springframework.util.MultiValueMap;
@@ -556,7 +555,6 @@ void exectuesSearchThatTakesASort() throws Exception {
 
 		// Assert results returned as specified
 		client.follow(findBySortedLink.expand(Arrays.asList("title", "desc"))).//
-				andDo(MockMvcResultHandlers.print()).//
 				andExpect(jsonPath("$._embedded.books[0].title").value("Spring Data (Second Edition)")).//
 				andExpect(jsonPath("$._embedded.books[1].title").value("Spring Data")).//
 				andExpect(client.hasLinkWithRel(IanaLinkRelations.SELF));

Diff for: spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/AbstractRepositoryRestController.java

@@ -16,6 +16,7 @@
 package org.springframework.data.rest.webmvc;
 
 import static org.springframework.core.annotation.AnnotatedElementUtils.*;
+
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletRequestWrapper;
 
@@ -27,9 +28,6 @@
 import java.util.List;
 import java.util.Set;
 
-import jakarta.servlet.http.HttpServletRequest;
-import jakarta.servlet.http.HttpServletRequestWrapper;
-
 import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.data.util.ProxyUtils;
@@ -115,7 +113,7 @@ protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handler
 		String[] customPrefixes = getBasePathedPrefixes(handlerType);
 		Builder builder = info.mutate();
 
-		if ((customPrefixes.length != 0) || StringUtils.hasText(baseUri)) {
+		if (customPrefixes.length != 0 || StringUtils.hasText(baseUri)) {
 			builder = builder.paths(resolveEmbeddedValuesInPatterns(customPrefixes));
 		}
 
@@ -219,17 +217,15 @@ public CustomAcceptHeaderHttpServletRequest(HttpServletRequest request, List<Med
 		@Override
 		public String getHeader(String name) {
 
-			return HttpHeaders.ACCEPT.equalsIgnoreCase(name) && (acceptMediaTypes != null //
-			)
+			return HttpHeaders.ACCEPT.equalsIgnoreCase(name) && acceptMediaTypes != null
 					? StringUtils.collectionToCommaDelimitedString(acceptMediaTypes) //
 					: super.getHeader(name);
 		}
 
 		@Override
 		public Enumeration<String> getHeaders(String name) {
 
-			return HttpHeaders.ACCEPT.equalsIgnoreCase(name) && (acceptMediaTypes != null //
-			)
+			return HttpHeaders.ACCEPT.equalsIgnoreCase(name) && acceptMediaTypes != null
 					? Collections.enumeration(acceptMediaTypeStrings) //
 					: super.getHeaders(name);
 		}

Diff for: spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/BasePathAwareHandlerMapping.java

@@ -17,11 +17,13 @@
 
 import java.util.Optional;
 
+import org.springframework.hateoas.Link;
 import org.springframework.hateoas.RepresentationModel;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.Assert;
+import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
 
 /**
  * @author Oliver Gierke
@@ -80,4 +82,8 @@ public static ResponseEntity<RepresentationModel<?>> toEmptyResponse(HttpStatus
 	public static ResponseEntity<RepresentationModel<?>> toEmptyResponse(HttpStatus status, HttpHeaders headers) {
 		return toResponseEntity(status, headers, Optional.empty());
 	}
+
+	static Link getDefaultSelfLink() {
+		return Link.of(ServletUriComponentsBuilder.fromCurrentRequest().build().toUriString());
+	}
 }

Diff for: spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/ControllerUtils.java

@@ -58,7 +58,6 @@ public class PersistentEntityResource extends EntityModel<Object> {
 	 * @param links must not be {@literal null}.
 	 * @param embeddeds can be {@literal null}.
 	 */
-	@SuppressWarnings("deprecation")
 	private PersistentEntityResource(PersistentEntity<?, ?> entity, Object content, Iterable<Link> links,
 			Iterable<EmbeddedWrapper> embeddeds, boolean isNew, boolean nested) {