refactor: Define dedicated PageNavigator for token based and cursor b…

…ased navigation. Logic about next page computation for cursor based is shared for all list using it
sinch · Nov 16, 2023 · 6b6e031 · 6b6e031
1 parent 5313997
commit 6b6e031
Show file tree

Hide file tree

Showing 22 changed files with 114 additions and 84 deletions.
diff --git a/client/src/main/com/sinch/sdk/domains/numbers/adapters/ActiveNumberService.java b/client/src/main/com/sinch/sdk/domains/numbers/adapters/ActiveNumberService.java
@@ -4,7 +4,7 @@
 import com.sinch.sdk.core.http.HttpClient;
 import com.sinch.sdk.core.http.HttpMapper;
 import com.sinch.sdk.core.models.pagination.Page;
-import com.sinch.sdk.core.models.pagination.PageToken;
+import com.sinch.sdk.core.models.pagination.TokenPageNavigator;
 import com.sinch.sdk.core.utils.EnumDynamic;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.numbers.adapters.api.v1.ActiveNumberApi;
@@ -84,7 +84,7 @@ public ActiveNumberListResponse list(ActiveNumberListRequestParameters parameter
                 pageSize,
                 pageToken,
                 orderBy);
-    Pair<Collection<ActiveNumber>, PageToken<String>> content =
+    Pair<Collection<ActiveNumber>, TokenPageNavigator> content =
         ActiveNumberDtoConverter.convert(response);
     return new ActiveNumberListResponse(
         this, new Page<>(parameters, content.getLeft(), content.getRight()));

diff --git a/.../src/main/com/sinch/sdk/domains/numbers/adapters/converters/ActiveNumberDtoConverter.java b/.../src/main/com/sinch/sdk/domains/numbers/adapters/converters/ActiveNumberDtoConverter.java
@@ -1,6 +1,6 @@
 package com.sinch.sdk.domains.numbers.adapters.converters;
 
-import com.sinch.sdk.core.models.pagination.PageToken;
+import com.sinch.sdk.core.models.pagination.TokenPageNavigator;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.numbers.models.ActiveNumber;
 import com.sinch.sdk.domains.numbers.models.Capability;
@@ -14,7 +14,7 @@
 
 public class ActiveNumberDtoConverter {
 
-  public static Pair<Collection<ActiveNumber>, PageToken<String>> convert(
+  public static Pair<Collection<ActiveNumber>, TokenPageNavigator> convert(
       ActiveNumbersResponseDto dto) {
     String nextPageToken = dto.getNextPageToken();
     List<ActiveNumberDto> list = dto.getActiveNumbers();
@@ -23,7 +23,7 @@ public static Pair<Collection<ActiveNumber>, PageToken<String>> convert(
       pageContent =
           list.stream().map(ActiveNumberDtoConverter::convert).collect(Collectors.toList());
     }
-    return new Pair<>(pageContent, new PageToken<>(nextPageToken));
+    return new Pair<>(pageContent, new TokenPageNavigator(nextPageToken));
   }
 
   public static ActiveNumber convert(ActiveNumberDto dto) {

diff --git a/client/src/main/com/sinch/sdk/domains/numbers/models/responses/ActiveNumberListResponse.java b/client/src/main/com/sinch/sdk/domains/numbers/models/responses/ActiveNumberListResponse.java
@@ -27,8 +27,7 @@ public ActiveNumberListResponse(
   }
 
   public boolean hasNextPage() {
-    return (null != page.getNextPageToken()
-        && !StringUtil.isEmpty(page.getNextPageToken().getToken()));
+    return (null != page.getNextPageToken() && !StringUtil.isEmpty(page.getNextPageToken()));
   }
 
   public ActiveNumberListResponse nextPage() {
@@ -37,8 +36,7 @@ public ActiveNumberListResponse nextPage() {
     }
     ActiveNumberListRequestParameters.Builder newParameters =
         new ActiveNumberListRequestParameters.Builder(page.getParameters());
-    String nextToken = page.getNextPageToken().getToken();
-    newParameters.setPageToken(nextToken);
+    newParameters.setPageToken(page.getNextPageToken());
     return service.list(newParameters.build());
   }
 

diff --git a/client/src/main/com/sinch/sdk/domains/sms/adapters/BatchesService.java b/client/src/main/com/sinch/sdk/domains/sms/adapters/BatchesService.java
@@ -3,8 +3,8 @@
 import com.sinch.sdk.core.exceptions.ApiException;
 import com.sinch.sdk.core.http.HttpClient;
 import com.sinch.sdk.core.http.HttpMapper;
+import com.sinch.sdk.core.models.pagination.CursorPageNavigator;
 import com.sinch.sdk.core.models.pagination.Page;
-import com.sinch.sdk.core.models.pagination.PageToken;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.sms.adapters.api.v1.BatchesApi;
 import com.sinch.sdk.domains.sms.adapters.converters.BatchDtoConverter;
@@ -76,7 +76,7 @@ public BatchesListResponse list(BatchesListRequestParameters parameters) throws
                 guardParameters.getEndDate().map(Instant::toString).orElse(null),
                 guardParameters.getClientReference().orElse(null));
 
-    Pair<Collection<Batch<?>>, PageToken<Integer>> content = BatchDtoConverter.convert(response);
+    Pair<Collection<Batch<?>>, CursorPageNavigator> content = BatchDtoConverter.convert(response);
 
     return new BatchesListResponse(
         this, new Page<>(guardParameters, content.getLeft(), content.getRight()));

diff --git a/client/src/main/com/sinch/sdk/domains/sms/adapters/DeliveryReportsService.java b/client/src/main/com/sinch/sdk/domains/sms/adapters/DeliveryReportsService.java
@@ -3,8 +3,8 @@
 import com.sinch.sdk.core.exceptions.ApiException;
 import com.sinch.sdk.core.http.HttpClient;
 import com.sinch.sdk.core.http.HttpMapper;
+import com.sinch.sdk.core.models.pagination.CursorPageNavigator;
 import com.sinch.sdk.core.models.pagination.Page;
-import com.sinch.sdk.core.models.pagination.PageToken;
 import com.sinch.sdk.core.utils.EnumDynamic;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.sms.adapters.api.v1.DeliveryReportsApi;
@@ -104,7 +104,7 @@ public DeliveryReportsListResponse list(DeliveryReportListRequestParameters para
                     .orElse(null),
                 guardParameters.getClientReference().orElse(null));
 
-    Pair<Collection<DeliveryReportRecipient>, PageToken<Integer>> content =
+    Pair<Collection<DeliveryReportRecipient>, CursorPageNavigator> content =
         DeliveryReportDtoConverter.convert(response);
 
     return new DeliveryReportsListResponse(

diff --git a/client/src/main/com/sinch/sdk/domains/sms/adapters/GroupsService.java b/client/src/main/com/sinch/sdk/domains/sms/adapters/GroupsService.java
@@ -3,8 +3,8 @@
 import com.sinch.sdk.core.exceptions.ApiException;
 import com.sinch.sdk.core.http.HttpClient;
 import com.sinch.sdk.core.http.HttpMapper;
+import com.sinch.sdk.core.models.pagination.CursorPageNavigator;
 import com.sinch.sdk.core.models.pagination.Page;
-import com.sinch.sdk.core.models.pagination.PageToken;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.sms.adapters.api.v1.GroupsApi;
 import com.sinch.sdk.domains.sms.adapters.converters.GroupsDtoConverter;
@@ -70,7 +70,7 @@ public GroupsListResponse list(GroupsListRequestParameters parameters) throws Ap
                 guardParameters.getPage().orElse(null),
                 guardParameters.getPageSize().orElse(null));
 
-    Pair<Collection<Group>, PageToken<Integer>> content = GroupsDtoConverter.convert(response);
+    Pair<Collection<Group>, CursorPageNavigator> content = GroupsDtoConverter.convert(response);
 
     return new GroupsListResponse(
         this, new Page<>(guardParameters, content.getLeft(), content.getRight()));

diff --git a/client/src/main/com/sinch/sdk/domains/sms/adapters/InboundsService.java b/client/src/main/com/sinch/sdk/domains/sms/adapters/InboundsService.java
@@ -3,8 +3,8 @@
 import com.sinch.sdk.core.exceptions.ApiException;
 import com.sinch.sdk.core.http.HttpClient;
 import com.sinch.sdk.core.http.HttpMapper;
+import com.sinch.sdk.core.models.pagination.CursorPageNavigator;
 import com.sinch.sdk.core.models.pagination.Page;
-import com.sinch.sdk.core.models.pagination.PageToken;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.sms.adapters.api.v1.InboundsApi;
 import com.sinch.sdk.domains.sms.adapters.converters.InboundsDtoConverter;
@@ -52,7 +52,7 @@ public InboundsListResponse list(InboundsListRequestParameters parameters) throw
                 guardParameters.getEndDate().map(Instant::toString).orElse(null),
                 guardParameters.getClientReference().orElse(null));
 
-    Pair<Collection<Inbound<?>>, PageToken<Integer>> content =
+    Pair<Collection<Inbound<?>>, CursorPageNavigator> content =
         InboundsDtoConverter.convert(response);
 
     return new InboundsListResponse(

diff --git a/client/src/main/com/sinch/sdk/domains/sms/adapters/converters/BatchDtoConverter.java b/client/src/main/com/sinch/sdk/domains/sms/adapters/converters/BatchDtoConverter.java
@@ -2,7 +2,7 @@
 
 import com.sinch.sdk.core.exceptions.ApiException;
 import com.sinch.sdk.core.models.AbstractOpenApiSchema;
-import com.sinch.sdk.core.models.pagination.PageToken;
+import com.sinch.sdk.core.models.pagination.CursorPageNavigator;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.sms.models.BaseBatch;
 import com.sinch.sdk.domains.sms.models.Batch;
@@ -269,14 +269,10 @@ private static MediaBodyDto convert(MediaBody value) {
     return new MediaBodyDto().url(value.getUrl()).message(value.getMessage().orElse(null));
   }
 
-  public static <T extends Batch<?>> Pair<Collection<T>, PageToken<Integer>> convert(
+  public static <T extends Batch<?>> Pair<Collection<T>, CursorPageNavigator> convert(
       ApiBatchListDto dto) {
-    // check end of pagination limit reached: (current page number * page size ) cannot be greater
-    // than "count" to be able to call next page
-    Integer nextPageToken =
-        ((dto.getPage() + 1) * Long.valueOf(dto.getPageSize())) >= dto.getCount()
-            ? null
-            : dto.getPage() + 1;
+    CursorPageNavigator navigator =
+        new CursorPageNavigator(dto.getPage(), dto.getPageSize(), dto.getCount());
     Collection<ApiBatchListBatchesInnerDto> collection = dto.getBatches();
     Collection<T> pageContent = new ArrayList<>();
     if (null != collection) {
@@ -285,7 +281,7 @@ public static <T extends Batch<?>> Pair<Collection<T>, PageToken<Integer>> conve
         pageContent.add(convert);
       }
     }
-    return new Pair<>(pageContent, new PageToken<>(nextPageToken));
+    return new Pair<>(pageContent, navigator);
   }
 
   public static ApiDeliveryFeedbackDto convert(Collection<String> recipients) {

diff --git a/...nt/src/main/com/sinch/sdk/domains/sms/adapters/converters/DeliveryReportDtoConverter.java b/...nt/src/main/com/sinch/sdk/domains/sms/adapters/converters/DeliveryReportDtoConverter.java
@@ -1,6 +1,6 @@
 package com.sinch.sdk.domains.sms.adapters.converters;
 
-import com.sinch.sdk.core.models.pagination.PageToken;
+import com.sinch.sdk.core.models.pagination.CursorPageNavigator;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.sms.models.DeliveryReportBatch;
 import com.sinch.sdk.domains.sms.models.DeliveryReportBatchMMS;
@@ -74,14 +74,10 @@ public static DeliveryReportRecipient convert(RecipientDeliveryReportDto dto) {
         .build();
   }
 
-  public static Pair<Collection<DeliveryReportRecipient>, PageToken<Integer>> convert(
+  public static Pair<Collection<DeliveryReportRecipient>, CursorPageNavigator> convert(
       DeliveryReportListDto dto) {
-    // check end of pagination limit reached: (current page number * page size ) cannot be greater
-    // than "count" to be able to call next page
-    Integer nextPageToken =
-        ((dto.getPage() + 1) * Long.valueOf(dto.getPageSize())) >= dto.getCount()
-            ? null
-            : dto.getPage() + 1;
+    CursorPageNavigator navigator =
+        new CursorPageNavigator(dto.getPage(), dto.getPageSize(), dto.getCount());
     Collection<RecipientDeliveryReportDto> collection = dto.getDeliveryReports();
     Collection<DeliveryReportRecipient> pageContent = new ArrayList<>();
     if (null != collection) {
@@ -90,7 +86,7 @@ public static Pair<Collection<DeliveryReportRecipient>, PageToken<Integer>> conv
         pageContent.add(convert);
       }
     }
-    return new Pair<>(pageContent, new PageToken<>(nextPageToken));
+    return new Pair<>(pageContent, navigator);
   }
 
   private static DeliveryReportStatusDetails convert(MessageDeliveryStatusDto dto) {

diff --git a/client/src/main/com/sinch/sdk/domains/sms/adapters/converters/GroupsDtoConverter.java b/client/src/main/com/sinch/sdk/domains/sms/adapters/converters/GroupsDtoConverter.java
@@ -1,6 +1,6 @@
 package com.sinch.sdk.domains.sms.adapters.converters;
 
-import com.sinch.sdk.core.models.pagination.PageToken;
+import com.sinch.sdk.core.models.pagination.CursorPageNavigator;
 import com.sinch.sdk.core.utils.DateUtil;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.sms.models.Group;
@@ -51,13 +51,9 @@ public static GroupObjectDto convert(GroupCreateRequestParameters client) {
         .autoUpdate(client.getAutoUpdate().map(GroupsDtoConverter::convert).orElse(null));
   }
 
-  public static Pair<Collection<Group>, PageToken<Integer>> convert(ApiGroupListDto dto) {
-    // check end of pagination limit reached: (current page number * page size ) cannot be greater
-    // than "count" to be able to call next page
-    Integer nextPageToken =
-        ((dto.getPage() + 1) * Long.valueOf(dto.getPageSize())) >= dto.getCount()
-            ? null
-            : dto.getPage() + 1;
+  public static Pair<Collection<Group>, CursorPageNavigator> convert(ApiGroupListDto dto) {
+    CursorPageNavigator navigator =
+        new CursorPageNavigator(dto.getPage(), dto.getPageSize(), dto.getCount());
     Collection<ApiGroupDto> collection = dto.getGroups();
     Collection<Group> pageContent = new ArrayList<>();
     if (null != collection) {
@@ -66,7 +62,7 @@ public static Pair<Collection<Group>, PageToken<Integer>> convert(ApiGroupListDt
         pageContent.add(convert);
       }
     }
-    return new Pair<>(pageContent, new PageToken<>(nextPageToken));
+    return new Pair<>(pageContent, navigator);
   }
 
   public static ReplaceGroupRequestDto convert(GroupReplaceRequestParameters client) {

diff --git a/client/src/main/com/sinch/sdk/domains/sms/adapters/converters/InboundsDtoConverter.java b/client/src/main/com/sinch/sdk/domains/sms/adapters/converters/InboundsDtoConverter.java
@@ -2,7 +2,7 @@
 
 import com.sinch.sdk.core.exceptions.ApiException;
 import com.sinch.sdk.core.models.AbstractOpenApiSchema;
-import com.sinch.sdk.core.models.pagination.PageToken;
+import com.sinch.sdk.core.models.pagination.CursorPageNavigator;
 import com.sinch.sdk.core.utils.Pair;
 import com.sinch.sdk.domains.sms.models.Inbound;
 import com.sinch.sdk.domains.sms.models.InboundBinary;
@@ -27,13 +27,9 @@ public static Inbound<?> convert(AbstractOpenApiSchema dto) {
     }
   }
 
-  public static Pair<Collection<Inbound<?>>, PageToken<Integer>> convert(ApiInboundListDto dto) {
-    // check end of pagination limit reached: (current page number * page size ) cannot be greater
-    // than "count" to be able to call next page
-    Integer nextPageToken =
-        ((dto.getPage() + 1) * Long.valueOf(dto.getPageSize())) >= dto.getCount()
-            ? null
-            : dto.getPage() + 1;
+  public static Pair<Collection<Inbound<?>>, CursorPageNavigator> convert(ApiInboundListDto dto) {
+    CursorPageNavigator navigator =
+        new CursorPageNavigator(dto.getPage(), dto.getPageSize(), dto.getCount());
     Collection<InboundDto> collection = dto.getInbounds();
     Collection<Inbound<?>> pageContent = new ArrayList<>();
     if (null != collection) {
@@ -42,7 +38,7 @@ public static Pair<Collection<Inbound<?>>, PageToken<Integer>> convert(ApiInboun
         pageContent.add(convert);
       }
     }
-    return new Pair<>(pageContent, new PageToken<>(nextPageToken));
+    return new Pair<>(pageContent, navigator);
   }
 
   public static InboundBinary convert(MOBinaryDto dto) {

diff --git a/client/src/main/com/sinch/sdk/domains/sms/models/responses/BatchesListResponse.java b/client/src/main/com/sinch/sdk/domains/sms/models/responses/BatchesListResponse.java
@@ -25,7 +25,7 @@ public BatchesListResponse(
   }
 
   public boolean hasNextPage() {
-    return (null != page.getNextPageToken() && null != page.getNextPageToken().getToken());
+    return (null != page.getNextPageToken());
   }
 
   public BatchesListResponse nextPage() {
@@ -34,8 +34,7 @@ public BatchesListResponse nextPage() {
     }
     BatchesListRequestParameters.Builder newParameters =
         BatchesListRequestParameters.builder(page.getParameters());
-    Integer nextToken = page.getNextPageToken().getToken();
-    newParameters.setPage(nextToken);
+    newParameters.setPage(page.getNextPageToken());
     return service.list(newParameters.build());
   }
 
@@ -45,6 +44,6 @@ public Collection<Batch<?>> getContent() {
 
   @Override
   public String toString() {
-    return "ActiveNumberListResponse{" + "page=" + page + '}';
+    return "BatchesListResponse{" + "page=" + page + '}';
   }
 }
diff --git a/client/src/main/com/sinch/sdk/domains/sms/models/responses/DeliveryReportsListResponse.java b/client/src/main/com/sinch/sdk/domains/sms/models/responses/DeliveryReportsListResponse.java
@@ -26,7 +26,7 @@ public DeliveryReportsListResponse(
   }
 
   public boolean hasNextPage() {
-    return (null != page.getNextPageToken() && null != page.getNextPageToken().getToken());
+    return (null != page.getNextPageToken());
   }
 
   public DeliveryReportsListResponse nextPage() {
@@ -35,8 +35,7 @@ public DeliveryReportsListResponse nextPage() {
     }
     DeliveryReportListRequestParameters.Builder newParameters =
         DeliveryReportListRequestParameters.builder(page.getParameters());
-    Integer nextToken = page.getNextPageToken().getToken();
-    newParameters.setPage(nextToken);
+    newParameters.setPage(page.getNextPageToken());
     return service.list(newParameters.build());
   }
 

diff --git a/client/src/main/com/sinch/sdk/domains/sms/models/responses/GroupsListResponse.java b/client/src/main/com/sinch/sdk/domains/sms/models/responses/GroupsListResponse.java
@@ -25,7 +25,7 @@ public GroupsListResponse(
   }
 
   public boolean hasNextPage() {
-    return (null != page.getNextPageToken() && null != page.getNextPageToken().getToken());
+    return (null != page.getNextPageToken());
   }
 
   public GroupsListResponse nextPage() {
@@ -34,8 +34,7 @@ public GroupsListResponse nextPage() {
     }
     GroupsListRequestParameters.Builder newParameters =
         GroupsListRequestParameters.builder(page.getParameters());
-    Integer nextToken = page.getNextPageToken().getToken();
-    newParameters.setPage(nextToken);
+    newParameters.setPage(page.getNextPageToken());
     return service.list(newParameters.build());
   }
 

diff --git a/client/src/main/com/sinch/sdk/domains/sms/models/responses/InboundsListResponse.java b/client/src/main/com/sinch/sdk/domains/sms/models/responses/InboundsListResponse.java
@@ -25,7 +25,7 @@ public InboundsListResponse(
   }
 
   public boolean hasNextPage() {
-    return (null != page.getNextPageToken() && null != page.getNextPageToken().getToken());
+    return (null != page.getNextPageToken());
   }
 
   public InboundsListResponse nextPage() {
@@ -34,8 +34,7 @@ public InboundsListResponse nextPage() {
     }
     InboundsListRequestParameters.Builder newParameters =
         InboundsListRequestParameters.builder(page.getParameters());
-    Integer nextToken = page.getNextPageToken().getToken();
-    newParameters.setPage(nextToken);
+    newParameters.setPage(page.getNextPageToken());
     return service.list(newParameters.build());
   }
 

diff --git a/client/src/test/java/com/sinch/sdk/domains/numbers/adapters/ActiveNumberServiceTest.java b/client/src/test/java/com/sinch/sdk/domains/numbers/adapters/ActiveNumberServiceTest.java
@@ -8,7 +8,7 @@
 import com.sinch.sdk.BaseTest;
 import com.sinch.sdk.core.exceptions.ApiException;
 import com.sinch.sdk.core.models.pagination.Page;
-import com.sinch.sdk.core.models.pagination.PageToken;
+import com.sinch.sdk.core.models.pagination.TokenPageNavigator;
 import com.sinch.sdk.domains.numbers.adapters.api.v1.ActiveNumberApi;
 import com.sinch.sdk.domains.numbers.adapters.converters.ActiveNumberUpdateRequestParametersDtoConverter;
 import com.sinch.sdk.domains.numbers.models.*;
@@ -89,7 +89,7 @@ void list() throws ApiException {
                     .setVoiceConfiguration(new VoiceConfiguration("app id", null, null))
                     .setCallbackUrl("")
                     .build()),
-            new PageToken<>(""));
+            new TokenPageNavigator(""));
     Assertions.assertThat(response.getContent())
         .usingRecursiveComparison()
         .isEqualTo(expected.getEntities());
@@ -172,7 +172,7 @@ void listWithParameters() throws ApiException {
                                 Instant.parse("2023-09-25T12:08:02.115Z"))))
                     .setCallbackUrl("foo callback")
                     .build()),
-            new PageToken<>("foo"));
+            new TokenPageNavigator("foo"));
 
     ActiveNumberListResponse response = service.list(parameters);