Merge Search - Sort by options Meeds-io/MIPs#212 (#1950)

Author: sofyenne

portlets/src/main/webapp/WEB-INF/conf/gamification/search-configuration.xml

@@ -39,7 +39,7 @@
               <string>rules</string>
             </field>
             <field name="uri">
-              <string><![CDATA[/portal/rest/gamification/rules?status=ENABLED&programStatus=ENABLED&type=ALL&dateFilter=STARTED&sortBy=title&sortDescending=false&expand=countRealizations,favorites&limit={limit}&term={keyword}]]></string>
+              <string><![CDATA[/portal/rest/gamification/rules?status=ENABLED&programStatus=ENABLED&type=ALL&dateFilter=STARTED&expand=countRealizations,favorites&limit={limit}&term={keyword}&sortBy={sortField}&sortDescending={sortDescending}]]></string>
             </field>
             <field name="enabled">
               <boolean>${search.rule.enabled:true}</boolean>

portlets/src/main/webapp/WEB-INF/conf/gamification/search/rule-search-query.json

@@ -7,5 +7,8 @@
         @search_filtering@
       ]
     }
-  }
+  },
+  "sort": [
+    @sortQuery@
+  ]
 }

services/src/main/java/io/meeds/gamification/dao/RuleDAO.java

@@ -274,7 +274,7 @@ private String getSortFieldName(String sortField) {
     case "id", "createdDate": {
       yield "r.id";
     }
-    case "modifiedDate": {
+    case "date", "modifiedDate": {
       yield "r.lastModifiedDate";
     }
     case "startDate": {

services/src/main/java/io/meeds/gamification/search/RuleSearchConnector.java

@@ -86,6 +86,25 @@ public class RuleSearchConnector {
 
   private static final String          ILLEGAL_SEARCH_CHARACTERS    = "\\!?^()+-=<>{}[]:\"*~&|#%@";
 
+  private static final String          DEFAULT_SORTING_QUERY        = """
+      {
+        "_score": {
+          "order": "desc"
+        }
+      }
+      """;
+
+  private static final String          SORTING_QUERY                = """
+      {
+        "@sortField@": {
+          "order": "@sortOrder@"
+        }
+      },
+      "_score"
+      """;
+
+  private static final String          SORT_REPLACEMENT             = "@sortQuery@";
+
   private final ConfigurationManager   configurationManager;
 
   private final ElasticSearchingClient client;
@@ -135,10 +154,12 @@ public List<Long> search(RuleFilter filter, long offset, long limit) {
   private String buildQueryStatement(RuleFilter filter, long offset, long limit) {
     String queryTemplate = retrieveSearchQuery();
     String filterQuery = computeFilterQuery(filter);
+    String sortQuery = buildSortQuery(filter);
     return queryTemplate.replace(LANG, filter.getLocale().toLanguageTag())
                         .replace("@search_filtering@", filterQuery)
                         .replace("@offset@", String.valueOf(offset))
-                        .replace("@limit@", String.valueOf(limit));
+                        .replace("@limit@", String.valueOf(limit))
+                        .replace(SORT_REPLACEMENT, sortQuery);
   }
 
   private String computeFilterQuery(RuleFilter filter) {
@@ -274,4 +295,16 @@ private String retrieveSearchQuery() {
     }
     return this.searchQuery;
   }
+
+  private String buildSortQuery(RuleFilter filter) {
+    if (StringUtils.isBlank(filter.getSortBy())) {
+      return DEFAULT_SORTING_QUERY;
+    }
+    String sortFiled = filter.getSortBy();
+    String sortDirection = filter.isSortDescending() ? "desc" : "asc";
+    return switch (sortFiled) {
+    case "date" -> SORTING_QUERY.replace("@sortField@", "lastUpdatedDate").replace("@sortOrder@", sortDirection);
+    default -> DEFAULT_SORTING_QUERY;
+    };
+  }
 }