chore: refactor code to comply with Checkstyle method length limit (max 25 lines) (#869)

Closes: MSEARCH-1110

Author: psmagin

NEWS.md

@@ -72,6 +72,7 @@
 * Update contributors.name search option type to full-text in documentation ([MSEARCH-814](https://folio-org.atlassian.net/browse/MSEARCH-814))
 * Process item/instance in batches, add stale sub-resource lock release logic ([MSEARCH-1097](https://folio-org.atlassian.net/browse/MSEARCH-1097))
 * Refactor system user handling and update dependencies in ModuleDescriptor ([MSEARCH-1111](https://folio-org.atlassian.net/browse/MSEARCH-1111))
+* Refactor code to comply with Checkstyle method length limit (max 25 lines) ([MSEARCH-1110](https://folio-org.atlassian.net/browse/MSEARCH-1110))
 
 ### Dependencies
 * Bump `LIB_NAME` from `OLD_VERSION` to `NEW_VERSION`

pom.xml

@@ -459,9 +459,6 @@
           <logViolationsToConsole>true</logViolationsToConsole>
           <configLocation>folio-checkstyle/checkstyle.xml</configLocation>
           <cacheFile>${basedir}/target/cachefile</cacheFile>
-          <propertyExpansion>
-            checkstyle.method-length.max=300
-          </propertyExpansion>
         </configuration>
       </plugin>
 

src/main/java/org/folio/search/cql/CqlTermQueryConverter.java

@@ -85,11 +85,7 @@ public QueryBuilder getQuery(CQLTermNode termNode, ResourceType resource) {
     var searchTerm = getSearchTerm(termNode.getTerm(), optionalPlainFieldByPath);
     var comparator = isWildcardQuery(searchTerm) ? WILDCARD_OPERATOR : lowerCase(termNode.getRelation().getBase());
 
-    var termQueryBuilder = termQueryBuilders.get(comparator);
-    if (termQueryBuilder == null) {
-      throw new UnsupportedOperationException(String.format(
-        "Failed to parse CQL query. Comparator '%s' is not supported.", comparator));
-    }
+    var termQueryBuilder = getTermQueryBuilderOrFail(comparator);
 
     var modifiers = termNode.getRelation().getModifiers().stream()
       .map(Modifier::getType)
@@ -109,6 +105,15 @@ public QueryBuilder getQuery(CQLTermNode termNode, ResourceType resource) {
            : termQueryBuilder.getTermLevelQuery(searchTerm, fieldName, resource, index);
   }
 
+  private TermQueryBuilder getTermQueryBuilderOrFail(String comparator) {
+    var termQueryBuilder = termQueryBuilders.get(comparator);
+    if (termQueryBuilder == null) {
+      throw new UnsupportedOperationException(String.format(
+        "Failed to parse CQL query. Comparator '%s' is not supported.", comparator));
+    }
+    return termQueryBuilder;
+  }
+
   private Object getSearchTerm(String term, Optional<PlainFieldDescription> plainFieldDescription) {
     var normalizedTerm = term.replace("\\\\", "\\");
     return plainFieldDescription
@@ -139,17 +144,21 @@ private static Map<String, TermQueryBuilder> getTermQueryProvidersAsMap(List<Ter
       }
     }
 
+    throwIfErrorsExist(errors);
+
+    return unmodifiableMap(queryBuildersMap);
+  }
+
+  private static void throwIfErrorsExist(LinkedHashMap<String, List<TermQueryBuilder>> errors) {
     if (MapUtils.isNotEmpty(errors)) {
       var stringJoiner = new StringJoiner(", ");
       errors.forEach((c, v) -> {
         var buildersAsString = v.stream().map(e -> e.getClass().getSimpleName()).collect(joining(", "));
         stringJoiner.add(String.format("comparator '%s': %s", c, buildersAsString));
       });
       throw new IllegalStateException(String.format("Multiple TermQueryBuilder objects cannot be responsible "
-        + "for the same comparator. Found issues: [%s]", stringJoiner));
+                                                    + "for the same comparator. Found issues: [%s]", stringJoiner));
     }
-
-    return unmodifiableMap(queryBuildersMap);
   }
 
   private void validateIndexFormat(String index, CQLTermNode termNode) {

src/main/java/org/folio/search/cql/FacetQueryBuilder.java

@@ -118,13 +118,7 @@ private static Pair<BoolQueryBuilder, List<String>> getFilterQueryAndFacetTerms(
     var facetTerms = new ArrayList<String>();
 
     List<QueryBuilder> filters = new ArrayList<>(((BoolQueryBuilder) query).filter());
-    var musts = ((BoolQueryBuilder) query).must();
-    for (var must : musts) {
-      if (must instanceof NestedQueryBuilder nestedQueryBuilder
-          && nestedQueryBuilder.query() instanceof BoolQueryBuilder boolQueryBuilder) {
-        filters.addAll(boolQueryBuilder.filter());
-      }
-    }
+    addNestedQueryFilters(((BoolQueryBuilder) query).must(), filters);
     for (var filterQuery : filters) {
       if (isFilterQuery(filterQuery, field::equals)) {
         getValueFromFilerQuery(filterQuery).ifPresent(facetTerms::add);
@@ -142,6 +136,15 @@ private static Pair<BoolQueryBuilder, List<String>> getFilterQueryAndFacetTerms(
     return isNotEmpty(facetFilterQuery.filter()) ? Pair.of(facetFilterQuery, facetTerms) : Pair.of(null, facetTerms);
   }
 
+  private static void addNestedQueryFilters(List<QueryBuilder> musts, List<QueryBuilder> filters) {
+    for (var must : musts) {
+      if (must instanceof NestedQueryBuilder nestedQueryBuilder
+          && nestedQueryBuilder.query() instanceof BoolQueryBuilder boolQueryBuilder) {
+        filters.addAll(boolQueryBuilder.filter());
+      }
+    }
+  }
+
   private static AggregationBuilder getFilterAggregation(
     Pair<BoolQueryBuilder, List<String>> filterAndTerms, Facet facet) {
     var filterAggregation = filter(facet.aggregationName(), filterAndTerms.getFirst());

src/main/java/org/folio/search/model/context/FolioExecutionContextBuilder.java

@@ -50,6 +50,7 @@ public Builder(FolioModuleMetadata moduleMetadata) {
       this.okapiHeaders = new HashMap<>();
     }
 
+    @SuppressWarnings("checkstyle:MethodLength")
     public FolioExecutionContext build() {
       return new FolioExecutionContext() {
         @Override

src/main/java/org/folio/search/service/browse/AbstractShelvingOrderBrowseServiceBySearchAfter.java

@@ -11,6 +11,8 @@
 import static org.opensearch.search.sort.SortOrder.ASC;
 import static org.opensearch.search.sort.SortOrder.DESC;
 
+import java.util.List;
+import java.util.UUID;
 import lombok.extern.log4j.Log4j2;
 import org.apache.commons.collections4.CollectionUtils;
 import org.folio.search.domain.dto.BrowseConfig;
@@ -20,6 +22,7 @@
 import org.folio.search.service.consortium.BrowseConfigServiceDecorator;
 import org.folio.search.service.consortium.ConsortiumSearchHelper;
 import org.folio.search.utils.ShelvingOrderCalculationHelper;
+import org.opensearch.index.query.BoolQueryBuilder;
 import org.opensearch.index.query.QueryBuilder;
 import org.opensearch.index.query.TermQueryBuilder;
 import org.opensearch.search.builder.SearchSourceBuilder;
@@ -88,21 +91,14 @@ protected SearchSourceBuilder getSearchQuery(BrowseRequest req, BrowseContext ct
 
   private QueryBuilder getQuery(BrowseContext ctx, BrowseConfig config, TermQueryBuilder anchorQuery) {
     var typeIds = config.getTypeIds();
-    var typeIdsEmpty = CollectionUtils.isEmpty(config.getTypeIds());
-    if (typeIdsEmpty && ctx.getFilters().isEmpty()) {
+    if (CollectionUtils.isEmpty(typeIds) && ctx.getFilters().isEmpty()) {
       if (anchorQuery != null) {
         return anchorQuery;
       }
       return matchAllQuery();
     } else {
       var boolQueryMain = boolQuery();
-      if (!typeIdsEmpty) {
-        var boolQuery = boolQuery();
-        for (var typeId : typeIds) {
-          boolQuery.should(termQuery(getTypeIdField(), typeId.toString()));
-        }
-        boolQueryMain.must(boolQuery);
-      }
+      includeTypeIdConditions(typeIds, boolQueryMain);
       if (!ctx.getFilters().isEmpty()) {
         ctx.getFilters().forEach(boolQueryMain::filter);
       }
@@ -113,6 +109,18 @@ private QueryBuilder getQuery(BrowseContext ctx, BrowseConfig config, TermQueryB
     }
   }
 
+  private void includeTypeIdConditions(List<UUID> typeIds, BoolQueryBuilder boolQueryMain) {
+    if (CollectionUtils.isNotEmpty(typeIds)) {
+      var boolQuery = boolQuery();
+      for (var typeId : typeIds) {
+        if (typeId != null) {
+          boolQuery.should(termQuery(getTypeIdField(), typeId.toString()));
+        }
+      }
+      boolQueryMain.must(boolQuery);
+    }
+  }
+
   private static String getBrowseField(BrowseConfig config) {
     return BROWSE_FIELDS_MAP.getOrDefault(config.getShelvingAlgorithm(), DEFAULT_SHELVING_ORDER_BROWSING_FIELD);
   }