refactor: Return first page and total count when searching for Confluence spaces, pages and attachments.

vogoltsov · vogoltsov · commit 3c766f59b55a · 2019-02-01T14:15:02.000+03:00
diff --git a/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/client/ConfluenceAttachmentRepository.java b/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/client/ConfluenceAttachmentRepository.java
@@ -2,13 +2,12 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.github.vogoltsov.vp.plugins.confluence.client.dto.CreateAttachmentResponse;
+import com.github.vogoltsov.vp.plugins.confluence.client.dto.DataPage;
 import com.github.vogoltsov.vp.plugins.confluence.client.dto.ListAttachmentsResponse;
 import com.github.vogoltsov.vp.plugins.confluence.client.model.Attachment;
 
 import java.io.ByteArrayInputStream;
-import java.util.Collections;
 import java.util.Comparator;
-import java.util.List;
 import java.util.Objects;
 import java.util.stream.Collectors;
 
@@ -25,13 +24,16 @@ public static ConfluenceAttachmentRepository getInstance() {
     /**
      * Searches attachments by content id and text.
      */
-    public List<Attachment> search(String pageId, String text) {
+    public DataPage<Attachment> search(String pageId, String text) {
         String lowerCaseText = text.toLowerCase();
-        return findAllAttachments(pageId)
-                .stream()
-                .filter(attachment -> attachment.getTitle().toLowerCase().contains(lowerCaseText))
-                .sorted(Comparator.comparing(Attachment::getTitle))
-                .collect(Collectors.toList());
+        return DataPage.of(
+                findAllAttachments(pageId)
+                        .getResults()
+                        .stream()
+                        .filter(attachment -> attachment.getTitle().toLowerCase().contains(lowerCaseText))
+                        .sorted(Comparator.comparing(Attachment::getTitle))
+                        .collect(Collectors.toList())
+        );
     }
 
     /**
@@ -42,6 +44,7 @@ public Attachment findByPageIdAndAttachmentId(String pageId, String attachmentId
             return null;
         }
         return findAllAttachments(pageId)
+                .getResults()
                 .stream()
                 .filter(attachment -> Objects.equals(attachment.getId(), attachmentId))
                 .findAny()
@@ -53,19 +56,17 @@ public Attachment findByPageIdAndAttachmentId(String pageId, String attachmentId
      * Returns all attachments for content.
      * This method has a soft limit of {@code 100} attachments returned.
      */
-    private List<Attachment> findAllAttachments(String pageId) {
+    private DataPage<Attachment> findAllAttachments(String pageId) {
         if (pageId == null) {
-            return Collections.emptyList();
+            return DataPage.empty();
         }
         return ConfluenceClient.getInstance().get("/rest/api/content/{pageId}/child/attachment")
                 .routeParam("pageId", pageId)
                 .queryString("expand", "container,container.space")
-                .queryString("limit", "100")
+                .queryString("limit", Integer.MAX_VALUE)
                 .asObject(JsonNode.class)
                 .ifFailure(ConfluenceClient.getInstance()::handleFailureResponse)
-                .mapBody(ConfluenceClient.getInstance().map(ListAttachmentsResponse.class).andThen(
-                        ListAttachmentsResponse::getResults
-                ));
+                .mapBody(ConfluenceClient.getInstance().map(ListAttachmentsResponse.class));
     }
 
 
diff --git a/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/client/ConfluencePageRepository.java b/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/client/ConfluencePageRepository.java
@@ -1,15 +1,13 @@
 package com.github.vogoltsov.vp.plugins.confluence.client;
 
 import com.fasterxml.jackson.databind.JsonNode;
+import com.github.vogoltsov.vp.plugins.confluence.client.dto.DataPage;
 import com.github.vogoltsov.vp.plugins.confluence.client.dto.SearchResult;
 import com.github.vogoltsov.vp.plugins.confluence.client.dto.SearchResults;
 import com.github.vogoltsov.vp.plugins.confluence.client.model.Page;
 import com.github.vogoltsov.vp.plugins.confluence.util.cql.CQL;
 import com.github.vogoltsov.vp.plugins.confluence.util.cql.CQLQuery;
 
-import java.util.List;
-import java.util.stream.Collectors;
-
 /**
  * @author Vitaly Ogoltsov &lt;vitaly.ogoltsov@me.com&gt;
  */
@@ -23,7 +21,7 @@ public static ConfluencePageRepository getInstance() {
     /**
      * Searches space pages by title.
      */
-    public List<Page> findBySpaceKeyAndText(String spaceKey, String text) {
+    public DataPage<Page> findBySpaceKeyAndText(String spaceKey, String text) {
         CQLQuery cql = CQL.query(CQL.eq("type", "page"));
         if (spaceKey != null && !spaceKey.isEmpty()) {
             cql.and(CQL.eq("space.key", spaceKey));
@@ -50,23 +48,20 @@ public Page findById(String pageId) {
                         CQL.eq("type", "page"),
                         CQL.eq("id", pageId)
                 ))
-        ).stream().findAny().orElse(null);
+        ).getResults().stream().findAny().orElse(null);
     }
 
 
-    private List<Page> search(CQLQuery cql) {
+    private DataPage<Page> search(CQLQuery cql) {
         // always expand content space
         cql.expand("content.space");
         return ConfluenceClient.getInstance().search(cql)
                 .asObject(JsonNode.class)
                 .ifFailure(ConfluenceClient.getInstance()::handleFailureResponse)
                 .mapBody(ConfluenceClient.getInstance().map(SearchResults.class).andThen(
-                        searchResults -> searchResults.getResults().stream()
-                                .filter(SearchResult.ContentSearchResult.class::isInstance)
-                                .map(searchResult -> ((SearchResult.ContentSearchResult) searchResult).getContent())
-                                .filter(Page.class::isInstance)
-                                .map(content -> (Page) content)
-                                .collect(Collectors.toList())
+                        searchResults -> searchResults.map(
+                                searchResult -> (Page) ((SearchResult.ContentSearchResult) searchResult).getContent()
+                        )
                 ));
     }
 
diff --git a/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/client/ConfluenceSpaceRepository.java b/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/client/ConfluenceSpaceRepository.java
@@ -1,17 +1,15 @@
 package com.github.vogoltsov.vp.plugins.confluence.client;
 
 import com.fasterxml.jackson.databind.JsonNode;
+import com.github.vogoltsov.vp.plugins.confluence.client.dto.DataPage;
 import com.github.vogoltsov.vp.plugins.confluence.client.dto.SearchResult;
 import com.github.vogoltsov.vp.plugins.confluence.client.dto.SearchResults;
 import com.github.vogoltsov.vp.plugins.confluence.client.model.Space;
 import com.github.vogoltsov.vp.plugins.confluence.util.RemoteAPIException;
 import com.github.vogoltsov.vp.plugins.confluence.util.cql.CQL;
 import com.github.vogoltsov.vp.plugins.confluence.util.cql.CQLQuery;
 
-import java.util.Collections;
-import java.util.List;
 import java.util.Objects;
-import java.util.stream.Collectors;
 
 /**
  * @author Vitaly Ogoltsov &lt;vitaly.ogoltsov@me.com&gt;
@@ -26,7 +24,7 @@ public static ConfluenceSpaceRepository getInstance() {
     /**
      * Searches all spaces by title and key.
      */
-    public List<Space> search(String text) {
+    public DataPage<Space> search(String text) {
         CQLQuery cql = CQL.query(
                 CQL.eq("type", "space")
         );
@@ -53,26 +51,25 @@ public Space findByKey(String spaceKey) {
                         CQL.eq("type", "space"),
                         CQL.eq("space.key", spaceKey)
                 ))
-        ).stream().findAny().orElse(null);
+        ).getResults().stream().findAny().orElse(null);
     }
 
 
-    private List<Space> search(CQLQuery cql) {
+    private DataPage<Space> search(CQLQuery cql) {
         try {
             return ConfluenceClient.getInstance().search(cql)
                     .asObject(JsonNode.class)
                     .ifFailure(ConfluenceClient.getInstance()::handleFailureResponse)
                     .mapBody(ConfluenceClient.getInstance().map(SearchResults.class).andThen(
-                            searchResults -> searchResults.getResults().stream()
-                                    .filter(SearchResult.SpaceSearchResult.class::isInstance)
-                                    .map(searchResult -> ((SearchResult.SpaceSearchResult) searchResult).getSpace())
-                                    .collect(Collectors.toList())
+                            searchResults -> searchResults.map(
+                                    searchResult -> ((SearchResult.SpaceSearchResult) searchResult).getSpace()
+                            )
                     ));
         } catch (RemoteAPIException e) {
             // this is a special case to mitigate bug in Confluence REST API
             // see https://jira.atlassian.com/browse/CONFSERVER-55445
             if (Objects.equals(e.getApiMessage(), "java.lang.IllegalArgumentException: parameters should not be empty")) {
-                return Collections.emptyList();
+                return DataPage.empty();
             }
             throw e;
         }
diff --git a/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/client/dto/DataPage.java b/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/client/dto/DataPage.java
@@ -1,14 +1,32 @@
 package com.github.vogoltsov.vp.plugins.confluence.client.dto;
 
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
 import lombok.Data;
+import lombok.NoArgsConstructor;
 
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
+import java.util.function.Function;
+import java.util.stream.Collectors;
 
 /**
  * @author Vitaly Ogoltsov &lt;vitaly.ogoltsov@me.com&gt;
  */
 @Data
-public abstract class DataPage<T> {
+@NoArgsConstructor
+@AllArgsConstructor(access = AccessLevel.PRIVATE)
+public class DataPage<T> {
+
+    public static <T> DataPage<T> empty() {
+        return new DataPage<>(Collections.emptyList(), 0, Integer.MAX_VALUE, 0, 0);
+    }
+
+    public static <T> DataPage<T> of(List<T> results) {
+        return new DataPage<>(new ArrayList<>(results), 0, results.size(), results.size(), results.size());
+    }
+
 
     private List<T> results;
 
@@ -17,4 +35,13 @@ public abstract class DataPage<T> {
     private int size;
     private int totalSize;
 
+
+    public List<T> getResults() {
+        return Collections.unmodifiableList(results);
+    }
+
+    public <V> DataPage<V> map(Function<T, V> mapper) {
+        return new DataPage<>(results.stream().map(mapper).collect(Collectors.toList()), start, limit, size, totalSize);
+    }
+
 }
diff --git a/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/dialog/ConfluenceAttachmentChooserDialog.java b/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/dialog/ConfluenceAttachmentChooserDialog.java
@@ -2,13 +2,13 @@
 
 import com.github.vogoltsov.vp.plugins.common.swing.ListTableModel;
 import com.github.vogoltsov.vp.plugins.confluence.client.ConfluenceAttachmentRepository;
+import com.github.vogoltsov.vp.plugins.confluence.client.dto.DataPage;
 import com.github.vogoltsov.vp.plugins.confluence.client.model.Attachment;
 import com.github.vogoltsov.vp.plugins.confluence.client.model.Page;
 import com.github.vogoltsov.vp.plugins.confluence.util.swing.SearchChooserDialog;
 import lombok.RequiredArgsConstructor;
 
 import java.util.Collections;
-import java.util.List;
 
 /**
  * @author Vitaly Ogoltsov &lt;vitaly.ogoltsov@me.com&gt;
@@ -42,7 +42,7 @@ protected ListTableModel<Attachment> getResultsDataModel() {
 
 
     @Override
-    protected List<Attachment> doSearch(String text) {
+    protected DataPage<Attachment> doSearch(String text) {
         return ConfluenceAttachmentRepository.getInstance().search(
                 this.page != null ? this.page.getId() : null,
                 text
diff --git a/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/dialog/ConfluencePageChooserDialog.java b/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/dialog/ConfluencePageChooserDialog.java
@@ -2,13 +2,13 @@
 
 import com.github.vogoltsov.vp.plugins.common.swing.ListTableModel;
 import com.github.vogoltsov.vp.plugins.confluence.client.ConfluencePageRepository;
+import com.github.vogoltsov.vp.plugins.confluence.client.dto.DataPage;
 import com.github.vogoltsov.vp.plugins.confluence.client.model.Page;
 import com.github.vogoltsov.vp.plugins.confluence.client.model.Space;
 import com.github.vogoltsov.vp.plugins.confluence.util.swing.SearchChooserDialog;
 import lombok.RequiredArgsConstructor;
 
 import java.util.Collections;
-import java.util.List;
 
 /**
  * @author Vitaly Ogoltsov &lt;vitaly.ogoltsov@me.com&gt;
@@ -42,7 +42,7 @@ protected ListTableModel<Page> getResultsDataModel() {
 
 
     @Override
-    protected List<Page> doSearch(String text) {
+    protected DataPage<Page> doSearch(String text) {
         return ConfluencePageRepository.getInstance().findBySpaceKeyAndText(
                 this.space != null ? this.space.getKey() : null,
                 text
diff --git a/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/dialog/ConfluenceSpaceChooserDialog.java b/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/dialog/ConfluenceSpaceChooserDialog.java
@@ -3,11 +3,11 @@
 import com.github.vogoltsov.vp.plugins.common.swing.HelpPanel;
 import com.github.vogoltsov.vp.plugins.common.swing.ListTableModel;
 import com.github.vogoltsov.vp.plugins.confluence.client.ConfluenceSpaceRepository;
+import com.github.vogoltsov.vp.plugins.confluence.client.dto.DataPage;
 import com.github.vogoltsov.vp.plugins.confluence.client.model.Space;
 import com.github.vogoltsov.vp.plugins.confluence.util.swing.SearchChooserDialog;
 
 import java.util.Arrays;
-import java.util.List;
 
 /**
  * @author Vitaly Ogoltsov &lt;vitaly.ogoltsov@me.com&gt;
@@ -47,7 +47,7 @@ protected ListTableModel<Space> getResultsDataModel() {
 
 
     @Override
-    protected List<Space> doSearch(String text) {
+    protected DataPage<Space> doSearch(String text) {
         return ConfluenceSpaceRepository.getInstance().search(text);
     }
 
diff --git a/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/util/swing/SearchChooserDialog.java b/plugins/confluence/src/main/java/com/github/vogoltsov/vp/plugins/confluence/util/swing/SearchChooserDialog.java
