Clean up verbose comments

Author: Atri Sharma

server/src/main/java/org/opensearch/action/search/QueryPhaseResultConsumer.java

@@ -35,7 +35,6 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.lucene.search.TopDocs;
-import org.apache.lucene.search.TotalHits;
 import org.opensearch.common.lease.Releasable;
 import org.opensearch.common.lease.Releasables;
 import org.opensearch.common.lucene.search.TopDocsAndMaxScore;

server/src/main/java/org/opensearch/action/search/SearchResponse.java

@@ -355,7 +355,7 @@ public XContentBuilder innerToXContent(XContentBuilder builder, Params params) t
         if (getNumReducePhases() != 1) {
             builder.field(NUM_REDUCE_PHASES.getPreferredName(), getNumReducePhases());
         }
-        
+
         RestActions.buildBroadcastShardsHeader(
             builder,
             params,

server/src/main/java/org/opensearch/action/search/StreamQueryPhaseResultConsumer.java

@@ -16,14 +16,11 @@
 
 /**
  * Query phase result consumer for streaming search.
- * Supports progressive batch reduction with a fixed batch policy suitable for unsorted streaming.
  *
  * @opensearch.internal
  */
 public class StreamQueryPhaseResultConsumer extends QueryPhaseResultConsumer {
 
-
-
     /**
      * Creates a streaming query phase result consumer.
      */
@@ -49,18 +46,9 @@ public StreamQueryPhaseResultConsumer(
         );
     }
 
-    /**
-     * Controls partial reduction frequency.
-     * With NO_SCORING streaming, we reduce immediately for fastest TTFB.
-     *
-     * @param requestBatchedReduceSize request batch size
-     * @param minBatchReduceSize       minimum batch size
-     */
     @Override
     int getBatchReduceSize(int requestBatchedReduceSize, int minBatchReduceSize) {
         // Reduce immediately for fastest TTFB
         return Math.min(requestBatchedReduceSize, 1);
     }
 }
-
-

server/src/main/java/org/opensearch/action/search/StreamSearchQueryThenFetchAsyncAction.java

@@ -73,10 +73,6 @@ public class StreamSearchQueryThenFetchAsyncAction extends SearchQueryThenFetchA
         this.logger = logger;
     }
 
-    /**
-     * Override the extension point to create streaming listeners instead of regular
-     * listeners
-     */
     @Override
     SearchActionListener<SearchPhaseResult> createShardActionListener(
         final SearchShardTarget shard,
@@ -145,11 +141,6 @@ protected void onStreamResult(SearchPhaseResult result, SearchShardIterator shar
         results.consumeResult(result, next);
     }
 
-    /**
-     * Override onShardResult to handle streaming search results safely.
-     * This prevents the "topDocs already consumed" error when processing
-     * multiple streaming results from the same shard.
-     */
     @Override
     protected void onShardResult(SearchPhaseResult result, SearchShardIterator shardIt) {
         // Trace final shard responses to diagnose coordinator sequencing.
@@ -162,14 +153,9 @@ protected void onShardResult(SearchPhaseResult result, SearchShardIterator shard
                 expectedTotalOps
             );
         }
-        // Always delegate to the parent to ensure shard accounting and phase
-        // transitions.
         super.onShardResult(result, shardIt);
     }
 
-    /**
-     * Override successful shard execution to handle stream result synchronization
-     */
     @Override
     void successfulShardExecution(SearchShardIterator shardsIt) {
         final int remainingOpsOnIterator;
@@ -194,11 +180,6 @@ void successfulShardExecution(SearchShardIterator shardsIt) {
         }
     }
 
-    /**
-     * Handle successful stream execution callback
-     * Partials are not fed into the reducer, so coordinator completion is driven
-     * by {@link #successfulShardExecution(SearchShardIterator)}.
-     */
     private void successfulStreamExecution() {
         // No-op.
     }

server/src/main/java/org/opensearch/rest/action/search/RestSearchAction.java

@@ -39,7 +39,6 @@
 import org.opensearch.action.search.SearchAction;
 import org.opensearch.action.search.SearchContextId;
 import org.opensearch.action.search.SearchRequest;
-import org.opensearch.action.search.SearchResponse;
 import org.opensearch.action.search.StreamSearchAction;
 import org.opensearch.action.support.IndicesOptions;
 import org.opensearch.common.Booleans;

server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StreamNumericTermsAggregator.java

@@ -32,8 +32,8 @@
 import org.opensearch.search.aggregations.bucket.LocalBucketCountThresholds;
 import org.opensearch.search.aggregations.support.ValuesSource;
 import org.opensearch.search.internal.SearchContext;
-import org.opensearch.search.streaming.StreamingCostMetrics;
 import org.opensearch.search.streaming.StreamingCostEstimable;
+import org.opensearch.search.streaming.StreamingCostMetrics;
 
 import java.io.IOException;
 import java.util.ArrayList;

server/src/main/java/org/opensearch/search/aggregations/metrics/StreamCardinalityAggregator.java

@@ -16,8 +16,8 @@
 import org.opensearch.search.aggregations.support.ValuesSource;
 import org.opensearch.search.aggregations.support.ValuesSourceConfig;
 import org.opensearch.search.internal.SearchContext;
-import org.opensearch.search.streaming.StreamingCostMetrics;
 import org.opensearch.search.streaming.StreamingCostEstimable;
+import org.opensearch.search.streaming.StreamingCostMetrics;
 
 import java.io.IOException;
 import java.util.List;

server/src/main/java/org/opensearch/search/query/StreamingSearchMode.java

@@ -58,7 +58,6 @@ public static StreamingSearchMode fromString(String mode) {
             return NO_SCORING; // Default
         }
 
-        // Backward compatibility: coerce older scored modes into NO_SCORING
         if ("SCORED_UNSORTED".equalsIgnoreCase(mode) || "SCORED_SORTED".equalsIgnoreCase(mode) || "NO_SCORING".equalsIgnoreCase(mode)) {
             return NO_SCORING;
         }
@@ -68,7 +67,7 @@ public static StreamingSearchMode fromString(String mode) {
                 return m;
             }
         }
-        
+
         throw new IllegalArgumentException("Unknown StreamingSearchMode: " + mode);
     }
 

server/src/main/java/org/opensearch/search/query/StreamingUnsortedCollectorContext.java

@@ -29,19 +29,6 @@
 /**
  * Streaming collector context for NO_SCORING mode.
  * Collects documents without scoring for fastest emission.
- *
- * Implements memory-bounded collection using a "firstK" pattern where only the first K
- * documents are retained for the final result. Documents are collected in batches
- * controlled by search.streaming.batch_size setting (default: 10, max: 100).
- *
- * Memory footprint: O(K + batchSize) where K is the requested number of hits.
- *
- * Circuit Breaker Policy:
- * - Batch buffers: No CB checks as they're strictly bounded (10-100 docs) and cleared after emission
- * - FirstK list: Protected by parent QueryPhaseResultConsumer's circuit breaker during final reduction
- * - Max memory per collector: ~8KB for batch (100 docs * 16 bytes) + ~80KB for firstK (10000 docs * 16 bytes)
- * - Decision rationale: The overhead of CB checks (atomic operations) would exceed the memory saved
- *   for such small, bounded allocations that are immediately released
  */
 public class StreamingUnsortedCollectorContext extends TopDocsCollectorContext {
 

server/src/main/java/org/opensearch/search/streaming/FlushModeResolver.java

@@ -22,8 +22,8 @@
 import org.opensearch.search.aggregations.metrics.MaxAggregationBuilder;
 import org.opensearch.search.aggregations.metrics.MinAggregationBuilder;
 import org.opensearch.search.aggregations.metrics.SumAggregationBuilder;
-import org.opensearch.search.profile.aggregation.ProfilingAggregator;
 import org.opensearch.search.internal.SearchContext;
+import org.opensearch.search.profile.aggregation.ProfilingAggregator;
 
 import java.util.Collection;