Annotated query paging and sorting (Azure#19527)

* eliminate duplicate class PageableAddress

* add support for paging when using @query

* add support for sorting when using @query

* add support for pageable sort when using @query

* preserve backwards compatibility

* add reactive support for sorting when using @query

* fixed broken test

* use nextPageable to get next page

* fixed javadoc

* fixed checkstyle issues

* fixed spotbugs issue

Author: Blackbaud-MikeLueders

sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/common/PageTestUtils.java

@@ -18,6 +18,7 @@ public static void validateLastPage(Page<?> page, int pageSize) {
         assertThat(pageable).isInstanceOf(CosmosPageRequest.class);
         assertTrue(continuationTokenIsNull((CosmosPageRequest) pageable));
         assertThat(pageable.getPageSize()).isEqualTo(pageSize);
+        assertThat(page.hasNext()).isFalse();
     }
 
     public static void validateNonLastPage(Page<?> page, int pageSize) {
@@ -27,6 +28,7 @@ public static void validateNonLastPage(Page<?> page, int pageSize) {
         assertThat(((CosmosPageRequest) pageable).getRequestContinuation()).isNotNull();
         assertThat(((CosmosPageRequest) pageable).getRequestContinuation()).isNotBlank();
         assertThat(pageable.getPageSize()).isEqualTo(pageSize);
+        assertThat(page.hasNext()).isTrue();
     }
 
     private static boolean continuationTokenIsNull(CosmosPageRequest pageRequest) {

sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplateIT.java

@@ -395,7 +395,7 @@ public void testFindAllPageableMultiPages() {
         assertThat(responseDiagnosticsTestUtils.getCosmosResponseStatistics()).isNotNull();
         assertThat(responseDiagnosticsTestUtils.getCosmosResponseStatistics().getRequestCharge()).isGreaterThan(0);
 
-        final Page<Person> page2 = cosmosTemplate.findAll(page1.getPageable(), Person.class,
+        final Page<Person> page2 = cosmosTemplate.findAll(page1.nextPageable(), Person.class,
             containerName);
         assertThat(page2.getContent().size()).isEqualTo(1);
         PageTestUtils.validateLastPage(page2, PAGE_SIZE_1);
@@ -520,7 +520,7 @@ public void testFindAllWithTwoPagesAndVerifySortOrder() {
         assertThat(firstPageResults.get(1).getFirstName()).isEqualTo(FIRST_NAME);
         assertThat(firstPageResults.get(2).getFirstName()).isEqualTo(testPerson5.getFirstName());
 
-        final Page<Person> secondPage = cosmosTemplate.findAll(firstPage.getPageable(), Person.class,
+        final Page<Person> secondPage = cosmosTemplate.findAll(firstPage.nextPageable(), Person.class,
             containerName);
 
         assertThat(secondPage.getContent().size()).isEqualTo(2);

sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/core/CosmosTemplatePartitionIT.java

@@ -271,7 +271,7 @@ public void testPartitionedFindAllPageableMultiPages() {
         assertThat(page1.getContent().size()).isEqualTo(PAGE_SIZE_1);
         PageTestUtils.validateNonLastPage(page1, PAGE_SIZE_1);
 
-        final Page<PartitionPerson> page2 = cosmosTemplate.findAll(page1.getPageable(),
+        final Page<PartitionPerson> page2 = cosmosTemplate.findAll(page1.nextPageable(),
             PartitionPerson.class, containerName);
         assertThat(page2.getContent().size()).isEqualTo(1);
         PageTestUtils.validateLastPage(page2, PAGE_SIZE_1);

sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/domain/Address.java

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 package com.azure.spring.data.cosmos.domain;
 
+import com.azure.spring.data.cosmos.common.TestConstants;
 import com.azure.spring.data.cosmos.core.mapping.Container;
 import com.azure.spring.data.cosmos.core.mapping.PartitionKey;
 import org.springframework.data.annotation.Id;
@@ -10,6 +11,16 @@
 
 @Container()
 public class Address {
+
+    public static final Address TEST_ADDRESS1_PARTITION1 = new Address(
+        TestConstants.POSTAL_CODE, TestConstants.STREET, TestConstants.CITY);
+    public static final Address TEST_ADDRESS2_PARTITION1 = new Address(
+        TestConstants.POSTAL_CODE_0, TestConstants.STREET_0, TestConstants.CITY);
+    public static final Address TEST_ADDRESS1_PARTITION2 = new Address(
+        TestConstants.POSTAL_CODE_1, TestConstants.STREET_1, TestConstants.CITY_0);
+    public static final Address TEST_ADDRESS4_PARTITION3 = new Address(
+        TestConstants.POSTAL_CODE, TestConstants.STREET_2, TestConstants.CITY_1);
+
     @Id
     String postalCode;
     String street;

sdk/cosmos/azure-spring-data-cosmos-test/src/test/java/com/azure/spring/data/cosmos/domain/Book.java

@@ -28,22 +28,17 @@
 import java.util.List;
 import java.util.Optional;
 
+import static com.azure.spring.data.cosmos.domain.Address.TEST_ADDRESS1_PARTITION1;
+import static com.azure.spring.data.cosmos.domain.Address.TEST_ADDRESS1_PARTITION2;
+import static com.azure.spring.data.cosmos.domain.Address.TEST_ADDRESS2_PARTITION1;
+import static com.azure.spring.data.cosmos.domain.Address.TEST_ADDRESS4_PARTITION3;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.fail;
 
 @RunWith(SpringJUnit4ClassRunner.class)
 @ContextConfiguration(classes = TestRepositoryConfig.class)
 public class AddressRepositoryIT {
 
-    private static final Address TEST_ADDRESS1_PARTITION1 = new Address(
-        TestConstants.POSTAL_CODE, TestConstants.STREET, TestConstants.CITY);
-    private static final Address TEST_ADDRESS2_PARTITION1 = new Address(
-        TestConstants.POSTAL_CODE_0, TestConstants.STREET_0, TestConstants.CITY);
-    private static final Address TEST_ADDRESS1_PARTITION2 = new Address(
-        TestConstants.POSTAL_CODE_1, TestConstants.STREET_1, TestConstants.CITY_0);
-    private static final Address TEST_ADDRESS4_PARTITION3 = new Address(
-        TestConstants.POSTAL_CODE, TestConstants.STREET_2, TestConstants.CITY_1);
-
     private static final CosmosEntityInformation<Address, String> entityInformation
         = new CosmosEntityInformation<>(Address.class);