From 96eecc6ea58a35061b3b2b90183421fd4df00628 Mon Sep 17 00:00:00 2001
From: Viktor Lofgren <vlofgren@marginalia.nu>
Date: Thu, 6 Jul 2023 19:50:13 +0200
Subject: [PATCH] Minor: Readability.

---
 .../index/svc/IndexQueryService.java          | 23 +++++++++++++++----
 .../search/svc/SearchQueryIndexService.java   |  4 +++-
 2 files changed, 21 insertions(+), 6 deletions(-)

diff --git a/code/services-core/index-service/src/main/java/nu/marginalia/index/svc/IndexQueryService.java b/code/services-core/index-service/src/main/java/nu/marginalia/index/svc/IndexQueryService.java
index 5c0d715b..37e7bf62 100644
--- a/code/services-core/index-service/src/main/java/nu/marginalia/index/svc/IndexQueryService.java
+++ b/code/services-core/index-service/src/main/java/nu/marginalia/index/svc/IndexQueryService.java
@@ -16,6 +16,7 @@ import nu.marginalia.index.client.model.results.SearchResultSet;
 import nu.marginalia.index.client.model.query.SearchSpecification;
 import nu.marginalia.index.index.SearchIndex;
 import nu.marginalia.index.index.SearchIndexSearchTerms;
+import nu.marginalia.index.query.IndexQueryPriority;
 import nu.marginalia.index.results.IndexMetadataService;
 import nu.marginalia.index.searchset.SearchSet;
 import nu.marginalia.index.results.IndexResultValuator;
@@ -40,6 +41,8 @@ public class IndexQueryService {
 
     private final Logger logger = LoggerFactory.getLogger(getClass());
 
+    // This marker is used to mark sensitive log messages that are related to queries
+    // so that they can be filtered out in the production logging configuration
     private final Marker queryMarker = MarkerFactory.getMarker("QUERY");
 
     private static final Counter wmsa_edge_index_query_timeouts = Counter.build().name("wmsa_edge_index_query_timeouts").help("-").register();
@@ -151,6 +154,11 @@ public class IndexQueryService {
                 prioFrequencies);
     }
 
+    /** Execute subqueries and return a list of document ids.  The index is queried for each subquery,
+     * at different priorty depths until timeout is reached or the results are all visited.
+     * <br>
+     * Then the results are combined.
+     * */
     private TLongList evaluateSubqueries(SearchParameters params) {
         final TLongArrayList results = new TLongArrayList(params.fetchSize);
 
@@ -167,7 +175,6 @@ public class IndexQueryService {
 
             final SearchIndexSearchTerms searchTerms = searchTermsSvc.getSearchTerms(subquery);
 
-
             if (searchTerms.isEmpty()) {
                 logger.info(queryMarker, "empty");
                 continue;
@@ -179,16 +186,16 @@ public class IndexQueryService {
             List<IndexQuery> queries = params.createIndexQueries(index, searchTerms);
             for (var query : queries) {
 
-                if (!params.hasTimeLeft()) {
+                if (!params.hasTimeLeft())
                     break;
-                }
 
-                if (omitQuery(params, query, results.size())) {
+                if (shouldOmitQuery(params, query, results.size())) {
                     logger.info(queryMarker, "Omitting {}", query);
                     continue;
                 }
 
                 int cnt = queryExecutor.executeQuery(query, results, params);
+
                 logger.info(queryMarker, "{} from {}", cnt, query);
             }
         }
@@ -196,7 +203,9 @@ public class IndexQueryService {
         return results;
     }
 
-    private boolean omitQuery(SearchParameters params, IndexQuery query, int resultCount) {
+    /** @see IndexQueryPriority */
+    private boolean shouldOmitQuery(SearchParameters params, IndexQuery query, int resultCount) {
+
         var priority = query.queryPriority;
 
         return switch (priority) {
@@ -208,6 +217,9 @@ public class IndexQueryService {
 
     private void logSearchTerms(SearchSubquery subquery, SearchIndexSearchTerms searchTerms) {
 
+        // This logging should only be enabled in testing, as it is very verbose
+        // and contains sensitive information
+
         if (!logger.isInfoEnabled(queryMarker)) {
             return;
         }
@@ -242,6 +254,7 @@ public class IndexQueryService {
         // Sort the ids for more favorable access patterns on disk
         resultIds.sort();
 
+        // Parallel stream to calculate scores is a minor performance boost
         return Arrays.stream(resultIds.toArray())
                 .parallel()
                 .mapToObj(evaluator::calculatePreliminaryScore)
diff --git a/code/services-core/search-service/src/main/java/nu/marginalia/search/svc/SearchQueryIndexService.java b/code/services-core/search-service/src/main/java/nu/marginalia/search/svc/SearchQueryIndexService.java
index 6b2ed7a1..4355793b 100644
--- a/code/services-core/search-service/src/main/java/nu/marginalia/search/svc/SearchQueryIndexService.java
+++ b/code/services-core/search-service/src/main/java/nu/marginalia/search/svc/SearchQueryIndexService.java
@@ -43,12 +43,14 @@ public class SearchQueryIndexService {
     }
 
     public List<UrlDetails> executeQuery(Context ctx, SearchQuery processedQuery) {
+        // Send the query
         final SearchResultSet results = indexClient.query(ctx, processedQuery.specs);
 
+        // Update the query count (this is what you see on the front page)
         searchVisitorCount.registerQuery();
 
+        // Decorate and sort the results
         List<UrlDetails> urlDetails = resultDecorator.getAllUrlDetails(results);
-
         urlDetails.sort(resultListComparator);
 
         return limitAndDeduplicateResults(processedQuery, urlDetails);