ACS-5487 - Track Total Hits on ES (#2041)

SearchParameters - added trackTotalHits (int) attribute
SearchRequest - Added trackTotalHitsLimit (int) to the Limits attribute and mapped it to the SearchParameters
Changed the SearchRequest model in TAS to include a new RestRequestLimitsModel that has the new trackTotalHitsLimit attribute
SearchMapperTests to test the changes in the SearchParameters

data-model/src/main/java/org/alfresco/service/cmr/search/SearchParameters.java

@@ -201,6 +201,11 @@ public class SearchParameters implements BasicSearchParameters
 
     private String timezone;
     
+    /**
+     * Configure the limit to track the total hits on search results
+     */
+    private int trackTotalHits;
+
     /**
      * Default constructor
      */
@@ -251,6 +256,7 @@ public class SearchParameters implements BasicSearchParameters
         sp.stats = this.stats;
         sp.ranges = this.ranges;
         sp.timezone = this.timezone;
+        sp.trackTotalHits = this.trackTotalHits;
         return sp;
     }
     
@@ -1641,6 +1647,21 @@ public class SearchParameters implements BasicSearchParameters
     {
         this.includeMetadata = includeMetadata;
     }
-    
+
+    public int getTrackTotalHits()
+    {
+        return trackTotalHits;
+    }
+
+    /**
+     * Set a maximum value for the report of total hits. The reported number of hits will never exceed this limit even
+     * if more are found. If unset, the engine’s default tracking limit is applied. To remove any limit, set to -1.
+     *
+     * @param trackTotalHits int
+     */
+    public void setTrackTotalHits(int trackTotalHits)
+    {
+        this.trackTotalHits = trackTotalHits;
+    }
 
 }

packaging/tests/tas-restapi/src/main/java/org/alfresco/rest/search/RestRequestLimitsModel.java

@@ -0,0 +1,82 @@
+/*-
+ * #%L
+ * alfresco-tas-restapi
+ * %%
+ * Copyright (C) 2005 - 2023 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.search;
+
+import org.alfresco.rest.core.IRestModel;
+import org.alfresco.utility.model.TestModel;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class RestRequestLimitsModel extends TestModel implements IRestModel<RestRequestLimitsModel>
+{
+    @JsonProperty
+    RestRequestLimitsModel model;
+
+    private Integer permissionEvaluationTime;
+    private Integer permissionEvaluationCount;
+    private Integer trackTotalHitsLimit;
+
+    @Override
+    public RestRequestLimitsModel onModel()
+    {
+        return model;
+    }
+    
+    public RestRequestLimitsModel(Integer permissionEvaluationTime, Integer permissionEvaluationCount,
+            Integer trackTotalHitsLimit)
+    {
+        super();
+        this.permissionEvaluationTime = permissionEvaluationTime;
+        this.permissionEvaluationCount = permissionEvaluationCount;
+        this.trackTotalHitsLimit = trackTotalHitsLimit;
+    }
+
+    public Integer getPermissionEvaluationTime()
+    {
+        return permissionEvaluationTime;
+    }
+    public void setPermissionEvaluationTime(Integer permissionEvaluationTime)
+    {
+        this.permissionEvaluationTime = permissionEvaluationTime;
+    }
+    public Integer getPermissionEvaluationCount()
+    {
+        return permissionEvaluationCount;
+    }
+    public void setPermissionEvaluationCount(Integer permissionEvaluationCount)
+    {
+        this.permissionEvaluationCount = permissionEvaluationCount;
+    }
+    public Integer getTrackTotalHitsLimit()
+    {
+        return trackTotalHitsLimit;
+    }
+    public void setTrackTotalHitsLimit(Integer trackTotalHitsLimit)
+    {
+        this.trackTotalHitsLimit = trackTotalHitsLimit;
+    }
+}
+ 

packaging/tests/tas-restapi/src/main/java/org/alfresco/rest/search/SearchRequest.java

@@ -79,6 +79,7 @@ public class SearchRequest extends TestModel
     List<SortClause> sort;
     RestRequestDefaultsModel defaults;
     List<RestRequestTemplatesModel> templates;
+    RestRequestLimitsModel limits;
 
     public SearchRequest()
     {
@@ -302,4 +303,15 @@ public class SearchRequest extends TestModel
 
         return this;
     }
+
+    public RestRequestLimitsModel getLimits()
+    {
+        return limits;
+    }
+
+    public void setLimits(RestRequestLimitsModel limits)
+    {
+        this.limits = limits;
+    }
+
 }

remote-api/src/main/java/org/alfresco/rest/api/search/impl/SearchMapper.java

@@ -823,6 +823,11 @@ public class SearchMapper
                 sp.setLimitBy(LimitBy.NUMBER_OF_PERMISSION_EVALUATIONS);
                 sp.setMaxPermissionCheckTimeMillis(limits.getPermissionEvaluationTime());
             }
+
+            if(limits.getTrackTotalHitsLimit() != null)
+            {
+                sp.setTrackTotalHits(limits.getTrackTotalHitsLimit());
+            }
         }
     }
 

remote-api/src/main/java/org/alfresco/rest/api/search/model/Limits.java

@@ -37,13 +37,16 @@ public class Limits
 
     private final Integer permissionEvaluationTime;
     private final Integer permissionEvaluationCount;
+    private final Integer trackTotalHitsLimit;
 
     @JsonCreator
     public Limits(@JsonProperty("permissionEvaluationTime") Integer permissionEvaluationTime,
-                  @JsonProperty("permissionEvaluationCount") Integer permissionEvaluationCount)
+                  @JsonProperty("permissionEvaluationCount") Integer permissionEvaluationCount,
+                  @JsonProperty("trackTotalHitsLimit") Integer trackTotalHitsLimit)
     {
         this.permissionEvaluationTime = permissionEvaluationTime;
         this.permissionEvaluationCount = permissionEvaluationCount;
+        this.trackTotalHitsLimit = trackTotalHitsLimit;
     }
 
     public Integer getPermissionEvaluationTime()
@@ -55,4 +58,9 @@ public class Limits
     {
         return permissionEvaluationCount;
     }
+
+    public Integer getTrackTotalHitsLimit()
+    {
+        return trackTotalHitsLimit;
+    }
 }

remote-api/src/test/java/org/alfresco/rest/api/search/SearchMapperTests.java

@@ -745,33 +745,56 @@ public class SearchMapperTests
     }
 
     @Test
-    public void fromLimits() throws Exception
+    public void fromLimits_setNull() throws Exception
     {
         SearchParameters searchParameters = new SearchParameters();
         searchMapper.setDefaults(searchParameters);
-
-        //Doesn't error
         searchMapper.fromLimits(searchParameters, null);
-        assertEquals(500, searchParameters.getLimit());
+        assertEquals("LimitBy default value should be unlimited", LimitBy.UNLIMITED, searchParameters.getLimitBy());
-        assertEquals(LimitBy.UNLIMITED, searchParameters.getLimitBy());
+        assertEquals("Limit default value should be 500", 500, searchParameters.getLimit());
+    }
 
-        searchMapper.fromLimits(searchParameters, new Limits(null, null));
+    @Test
-        assertEquals(LimitBy.UNLIMITED, searchParameters.getLimitBy());
+    public void fromLimits_setAllLimitsAsNull() throws Exception
-        assertEquals(500, searchParameters.getLimit());
+    {
-
+        SearchParameters searchParameters = new SearchParameters();
-        searchMapper.fromLimits(searchParameters, new Limits(null, 34));
-        assertEquals(LimitBy.NUMBER_OF_PERMISSION_EVALUATIONS, searchParameters.getLimitBy());
-        assertEquals(34, searchParameters.getMaxPermissionChecks());
-        assertEquals(-1, searchParameters.getLimit());
-        assertEquals(-1, searchParameters.getMaxPermissionCheckTimeMillis());
-
-        searchParameters = new SearchParameters();
         searchMapper.setDefaults(searchParameters);
-        searchMapper.fromLimits(searchParameters, new Limits(1000, null));
+        searchMapper.fromLimits(searchParameters, new Limits(null, null, null));
+        assertEquals("LimitBy default value should be unlimited", LimitBy.UNLIMITED, searchParameters.getLimitBy());
+        assertEquals("Limit default value should be 500", 500, searchParameters.getLimit());
+    }
+
+    @Test
+    public void fromLimits_setPermissionEvaluationCount() throws Exception
+    {
+        SearchParameters searchParameters = new SearchParameters();
+        searchMapper.setDefaults(searchParameters);
+        searchMapper.fromLimits(searchParameters, new Limits(null, 34, null));
         assertEquals(LimitBy.NUMBER_OF_PERMISSION_EVALUATIONS, searchParameters.getLimitBy());
-        assertEquals(1000, searchParameters.getMaxPermissionCheckTimeMillis());
+        assertEquals("MaxPermissionChecks should be set", 34, searchParameters.getMaxPermissionChecks());
-        assertEquals(-1, searchParameters.getLimit());
+        assertEquals("Limit should be -1", -1, searchParameters.getLimit());
-        assertEquals(-1, searchParameters.getMaxPermissionChecks());
+        assertEquals("MaxPermissionCheckTimeMillis should be -1", -1, searchParameters.getMaxPermissionCheckTimeMillis());
+    }
+
+    @Test
+    public void fromLimits_setPermissionEvaluationTime() throws Exception
+    {
+        SearchParameters searchParameters = new SearchParameters();
+        searchMapper.setDefaults(searchParameters);
+        searchMapper.fromLimits(searchParameters, new Limits(1000, null, null));
+        assertEquals(LimitBy.NUMBER_OF_PERMISSION_EVALUATIONS, searchParameters.getLimitBy());
+        assertEquals("MaxPermissionCheckTimeMillis should be set", 1000, searchParameters.getMaxPermissionCheckTimeMillis());
+        assertEquals("Limit should be -1", -1, searchParameters.getLimit());
+        assertEquals("MaxPermissionChecks should be -1", -1, searchParameters.getMaxPermissionChecks());
+    }
+
+    @Test
+    public void fromLimits_setTrackTotalHitsLimit() throws Exception
+    {
+        SearchParameters searchParameters = new SearchParameters();
+        searchMapper.setDefaults(searchParameters);
+        searchMapper.fromLimits(searchParameters, new Limits(null, null, 10));
+        assertEquals("TrackTotalHits should be set", 10, searchParameters.getTrackTotalHits());
     }
 
     @Test