ALFREDAPI-544 fix Date range search

xenit-eu · May 13, 2024 · a480911 · a480911
1 parent b727159
commit a480911
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Alfred API - Changelog
 
+## 5.0.2 (2024-05-13)
+
+The artifact name of `apix-interface` has been changed to `alfred-api-interface`.
+
+### Added
+
+### Changed
+
+### Fixed
+* [ALFREDAPI-544](https://xenitsupport.jira.com/browse/ALFREDAPI-544): fix Date range search by dropping unprocessed facet labels
+
+### Removed
+
+
 ## 5.0.1 (2024-03-19)
 
 The artifact name of `apix-interface` has been changed to `alfred-api-interface`.

diff --git a/apix-impl/src/main/java/eu/xenit/apix/alfresco/search/SearchFacetsServiceImpl.java b/apix-impl/src/main/java/eu/xenit/apix/alfresco/search/SearchFacetsServiceImpl.java
@@ -248,7 +248,7 @@ private Map<String, List<ScriptFacetResult>> getFacetResults(SearchParameters sp
             // facetTokenName => @{http://www.alfresco.org/model/content/1.0}created
             // qName => {http://www.alfresco.org/model/content/1.0}created
             // 7 => {!afts}
-            key = key.replace("{!afts}","");
+            key = key.replace("{!afts}", "");
             String facetTokenName = key.substring(0, key.indexOf(":["));
             String qName = facetTokenToQname(facetTokenName);
 
@@ -260,13 +260,20 @@ private Map<String, List<ScriptFacetResult>> getFacetResults(SearchParameters sp
 
             // Get the handler for this qName
             FacetLabelDisplayHandler handler = facetLabelDisplayHandlerRegistry.getDisplayHandler(facetTokenName);
-            String val = key.substring( key.indexOf(":[") + 1);
+            String val = key.substring(key.indexOf(":[") + 1);
             FacetLabel facetLabel = (handler == null) ? new FacetLabel(val, val, -1) : handler.getDisplayLabel(key);
-
+            //facetHandler failed to find a valid facetLabel and returns key as label so skipping facet (bug with date range search)
+            if (facetLabel.getLabel().equals(key)) {
+                continue;
+            }
             // See if we have a nice textual version of this label
             String label = this.translationService.getMessageTranslation(facetLabel.getLabel());
-
-            fqs.add(new ScriptFacetResult(facetLabel.getValue(), label, facetLabel.getLabelIndex(), entry.getValue()));
+            fqs.add(
+                    new ScriptFacetResult(facetLabel.getValue(),
+                            label,
+                            facetLabel.getLabelIndex(),
+                            entry.getValue())
+            );
             result.put(qName, fqs);
         }
         return result;

diff --git a/apix-impl/src/test/java/eu/xenit/apix/tests/search/SearchFacetServiceUnitTest.java b/apix-impl/src/test/java/eu/xenit/apix/tests/search/SearchFacetServiceUnitTest.java
@@ -9,6 +9,9 @@
 import org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint;
 import org.alfresco.repo.search.impl.solr.facet.SolrFacetHelper;
 import org.alfresco.repo.search.impl.solr.facet.SolrFacetService;
+import org.alfresco.repo.search.impl.solr.facet.handler.AbstractFacetLabelDisplayHandler;
+import org.alfresco.repo.search.impl.solr.facet.handler.ContentSizeBucketsDisplayHandler;
+import org.alfresco.repo.search.impl.solr.facet.handler.DateBucketsDisplayHandler;
 import org.alfresco.repo.search.impl.solr.facet.handler.FacetLabelDisplayHandlerRegistry;
 import org.alfresco.service.ServiceRegistry;
 import org.alfresco.service.cmr.dictionary.ConstraintDefinition;
@@ -22,17 +25,22 @@
 import org.alfresco.service.namespace.QName;
 import org.alfresco.util.Pair;
 import org.junit.Test;
+import org.mockito.Mockito;
 import org.springframework.beans.factory.annotation.Autowired;
 
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 import static org.junit.Assert.assertEquals;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
 public class SearchFacetServiceUnitTest {
@@ -43,15 +51,16 @@ public class SearchFacetServiceUnitTest {
     FacetOptions facetOptionsMock;
     ResultSet resultSetMock;
     SearchParameters searchParametersMock;
+    ITranslationService translationServiceMock;
 
     public void initMocks() {
         ServiceRegistry serviceRegistryMock = mock(ServiceRegistry.class);
 
         SolrFacetHelper solrFacetHelperMock = mock(SolrFacetHelper.class);
+        translationServiceMock = mock(ITranslationService.class);
 
         FacetLabelDisplayHandlerRegistry facetLabelDisplayHandlerRegistryStub =
-                new FacetLabelDisplayHandlerRegistry();
-
+                initFacetLabelDisplayHandler(serviceRegistryMock);
         DataTypeDefinition textDataTypeDef = mock(DataTypeDefinition.class);
         when(textDataTypeDef.getName()).thenReturn(DataTypeDefinition.TEXT);
 
@@ -94,8 +103,7 @@ public void initMocks() {
         when(serviceRegistryMock.getDictionaryService()).thenReturn(dictionaryServiceMock);
         when(serviceRegistryMock.getSolrFacetHelper()).thenReturn(solrFacetHelperMock);
         when(serviceRegistryMock.getFacetLabelDisplayHandlerRegistry()).thenReturn(facetLabelDisplayHandlerRegistryStub);
-        searchFacetsService = new SearchFacetsServiceImpl(serviceRegistryMock, mock(SolrFacetService.class), mock(
-                ITranslationService.class));
+        searchFacetsService = new SearchFacetsServiceImpl(serviceRegistryMock, mock(SolrFacetService.class), translationServiceMock);
 
         facetOptionsMock = mock(FacetOptions.class);
         when(facetOptionsMock.isEnabled()).thenReturn(true);
@@ -126,8 +134,43 @@ public void initMocks() {
         when(fieldFacetMock_B.getField()).thenReturn("@{http://test.apix.xenit.eu/model/content}documentStatus");
         fieldFacets.add(fieldFacetMock_B);
         when(searchParametersMock.getFieldFacets()).thenReturn(fieldFacets);
+        when(translationServiceMock.getMessageTranslation("faceted-search.size.0-10KB.label")).thenReturn("0 to 10KB");
+        when(translationServiceMock.getMessageTranslation("faceted-search.date.one-year.label")).thenReturn("This year");
+    }
+
+    private FacetLabelDisplayHandlerRegistry initFacetLabelDisplayHandler(ServiceRegistry serviceRegistry) {
+        FacetLabelDisplayHandlerRegistry facetLabelDisplayHandlerRegistry = new FacetLabelDisplayHandlerRegistry();
+        List<AbstractFacetLabelDisplayHandler> displayHandlers = new ArrayList<>();
+        displayHandlers.add(new ContentSizeBucketsDisplayHandler(
+                Set.of("@{http://www.alfresco.org/model/content/1.0}content.size"),
+                new LinkedHashMap<>(Map.of(
+                        "[0 TO 10240]", "faceted-search.size.0-10KB.label",
+                        "[10240 TO 102400]", "faceted-search.size.10-100KB.label",
+                        "[102400 TO 1048576]", "faceted-search.size.100KB-1MB.label",
+                        "[1048576 TO 16777216]", "faceted-search.size.1-16MB.label",
+                        "[16777216 TO 134217728]", "faceted-search.size.16-128MB.label",
+                        "[134217728 TO MAX]", "faceted-search.size.over128.label"
+                )))
+        );
+        displayHandlers.add(new DateBucketsDisplayHandler(
+                Set.of("@{http://www.alfresco.org/model/content/1.0}created",
+                        "@{http://www.alfresco.org/model/content/1.0}modified"),
+                new LinkedHashMap<>(Map.of(
+                        "[NOW/DAY-1DAY TO NOW/DAY+1DAY]", "faceted-search.date.one-day.label",
+                        "[NOW/DAY-7DAYS TO NOW/DAY+1DAY]", "faceted-search.date.one-week.label",
+                        "[NOW/DAY-1MONTH TO NOW/DAY+1DAY]", "faceted-search.date.one-month.label",
+                        "[NOW/DAY-6MONTHS TO NOW/DAY+1DAY]", "faceted-search.date.six-months.label",
+                        "[NOW/DAY-1YEAR TO NOW/DAY+1DAY]", "faceted-search.date.one-year.label"
+                ))));
+        displayHandlers.forEach(displayHandler -> {
+            displayHandler.setRegistry(facetLabelDisplayHandlerRegistry);
+            displayHandler.setServiceRegistry(serviceRegistry);
+            displayHandler.register();
+        });
+        return facetLabelDisplayHandlerRegistry;
     }
 
+
     public List<FacetSearchResult> initExpectedResult_for_assertThat_getFacetResults_returnIncludes_translationsForListOfValueConstraints() {
         List<FacetSearchResult> expectedResult = new ArrayList<>();
         FacetSearchResult languageResult = new FacetSearchResult();
@@ -154,7 +197,8 @@ public List<FacetSearchResult> initExpectedResult_for_assertThat_getFacetResults
         contentResult.setName("{http://www.alfresco.org/model/content/1.0}content.size");
         List<FacetValue> contentValues = new ArrayList<>();
         FacetValue contentFacetValue = new FacetValue();
-        contentFacetValue.setValue("[0 TO 10240]");
+        contentFacetValue.setValue("0\"..\"10240");
+        contentFacetValue.setLabel("0 to 10KB");
         contentFacetValue.setCount(1);
         contentValues.add(contentFacetValue);
         contentResult.setValues(contentValues);
@@ -163,20 +207,12 @@ public List<FacetSearchResult> initExpectedResult_for_assertThat_getFacetResults
         modifiedResult.setName("{http://www.alfresco.org/model/content/1.0}modified");
         List<FacetValue> modifiedValues = new ArrayList<>();
         FacetValue modifiedFacetValue = new FacetValue();
-        modifiedFacetValue.setValue("[NOW/DAY-1YEAR TO NOW/DAY+1DAY]");
+        modifiedFacetValue.setValue("NOW/DAY-1YEAR\"..\"NOW/DAY+1DAY");
         modifiedFacetValue.setCount(2);
+        modifiedFacetValue.setLabel("This year");
         modifiedValues.add(modifiedFacetValue);
         modifiedResult.setValues(modifiedValues);
         expectedResult.add(modifiedResult);
-        FacetSearchResult createdResult = new FacetSearchResult();
-        createdResult.setName("{http://www.alfresco.org/model/content/1.0}created");
-        List<FacetValue> createdValues = new ArrayList<>();
-        FacetValue createdFacetValue = new FacetValue();
-        createdFacetValue.setValue("[2020-08-31T07:00:00.000Z TO 2023-09-02T10:01:00.000Z]");
-        createdFacetValue.setCount(1);
-        createdValues.add(createdFacetValue);
-        createdResult.setValues(createdValues);
-        expectedResult.add(createdResult);
         return expectedResult;
     }
 
@@ -187,6 +223,7 @@ public void assertThat_getFacetResults_returnIncludes_translationsForListOfValue
         List<FacetSearchResult> result = searchFacetsService.getFacetResults(facetOptionsMock, resultSetMock,
                 searchParametersMock);
         assertEquals(expectedResult, result);
+        verify(translationServiceMock, times(2)).getMessageTranslation(Mockito.anyString());
     }
 
 }
diff --git a/build.gradle b/build.gradle
@@ -16,7 +16,7 @@ def static getVersionQualifier(String branch_name) {
 }
 
 ext {
-    versionWithoutQualifier = '5.0.1'
+    versionWithoutQualifier = '5.0.2'
 
     de_version = '3.1.0' // Only used for integration testing
     mvc = '8.0.0'