Included shareddoc sorting in the validate sort

Author: mridula-s109

x-pack/plugin/search-business-rules/src/main/java/org/elasticsearch/xpack/searchbusinessrules/retriever/PinnedRetrieverBuilder.java

@@ -17,7 +17,9 @@
 import org.elasticsearch.search.retriever.RetrieverBuilder;
 import org.elasticsearch.search.retriever.RetrieverBuilderWrapper;
 import org.elasticsearch.search.retriever.RetrieverParserContext;
+import org.elasticsearch.search.sort.FieldSortBuilder;
 import org.elasticsearch.search.sort.ScoreSortBuilder;
+import org.elasticsearch.search.sort.ShardDocSortField;
 import org.elasticsearch.search.sort.SortBuilder;
 import org.elasticsearch.xcontent.ConstructingObjectParser;
 import org.elasticsearch.xcontent.ParseField;
@@ -90,11 +92,22 @@ private void validateIdsAndDocs(List<String> ids, List<SpecifiedDocument> docs)
 
     private void validateSort(SearchSourceBuilder source) {
         List<SortBuilder<?>> sorts = source.sorts();
-        if (sorts != null && sorts.isEmpty() == false) {
+        if (sorts == null || sorts.isEmpty()) {
             return;
         }
-        if (sorts.stream().anyMatch(sort -> sort instanceof ScoreSortBuilder == false)) {
-            throw new IllegalArgumentException("Pinned retriever only supports sorting by score. Custom sorting is not allowed.");
+        for (SortBuilder<?> sort : sorts) {
+            if (sort instanceof ScoreSortBuilder) {
+                continue;
+            }
+            if (sort instanceof FieldSortBuilder) {
+                 FieldSortBuilder fieldSort = (FieldSortBuilder) sort;
+                 if (ShardDocSortField.NAME.equals(fieldSort.getFieldName())) {
+                     continue;
+                 }
+            }
+            throw new IllegalArgumentException(
+                "Pinned retriever only supports sorting by score. Custom sorting is not allowed."
+            );
         }
     }
 

x-pack/plugin/search-business-rules/src/yamlRestTest/resources/rest-api-spec/test/search-business-rules/10_pinned_retriever.yml

@@ -172,6 +172,9 @@ setup:
   - match: { hits.total.value: 5 }
   - match: { hits.hits.0._id: doc1 }
   - match: { hits.hits.1._id: doc2 }
+  - is_true: hits.hits.0._score
+  - is_true: hits.hits.1._score
+  - is_true: hits.hits.0._score >= hits.hits.1._score
 
 ---
 "pinned retriever with pagination":
@@ -326,3 +329,96 @@ setup:
   - match: { hits.hits.2._id: doc3 }
   - match: { hits.hits.3._id: doc4 }
   - match: { hits.hits.4._id: doc5 }
+
+---
+"pinned retriever error case - both ids and docs":
+  - do:
+      # Expect a bad_request error with this message
+      catch: /Both 'ids' and 'docs' cannot be specified at the same time/
+      search:
+        index: test-index1
+        body:
+          retriever:
+            pinned:
+              ids: ["doc1"] # Provide some IDs
+              docs: # Provide some docs
+                - _index: test-index1
+                  _id: doc2
+              retriever:
+                standard:
+                  query:
+                    match_all: {}
+
+---
+"pinned retriever error case - invalid sort":
+  - do:
+      # Expect the earlier validation error
+      catch: /cannot specify \[retriever\] and \[sort\]/
+      search:
+        index: test-index1
+        body:
+          sort: [ "text" ]
+          retriever:
+            pinned:
+              ids: ["doc1"]
+              retriever:
+                standard:
+                  query:
+                    match_all: {}
+
+---
+"pinned retriever error case - duplicate id":
+  - do:
+      # Catch duplicate ID error
+      catch: /duplicate id found/
+      search:
+        index: test-index1
+        body:
+          retriever:
+            pinned:
+              ids: ["doc1", "doc1"]
+              retriever:
+                standard:
+                  query:
+                    match_all: {}
+
+---
+"pinned retriever with empty docs array":
+  - do:
+      search:
+        index: test-index1
+        body:
+          retriever:
+            pinned:
+              docs: [] # Empty docs array
+              retriever:
+                standard:
+                  query:
+                    match_all: {}
+  # Expect regular match_all results, no pinning effect
+  - match: { hits.total.value: 5 }
+  - match: { hits.hits.0._id: doc1 }
+  - match: { hits.hits.1._id: doc2 }
+  - match: { hits.hits.2._id: doc3 }
+  - match: { hits.hits.3._id: doc4 }
+  - match: { hits.hits.4._id: doc5 }
+
+---
+"pinned retriever with ids and empty docs array":
+  - do:
+      search:
+        index: test-index1
+        body:
+          retriever:
+            pinned:
+              ids: ["doc1"] # Provide IDs
+              docs: []      # Provide empty docs array
+              retriever:
+                standard:
+                  query:
+                    match_all: {}
+  # Expect pinning based on "ids", empty "docs" is ignored
+  - match: { hits.total.value: 5 }
+  - match: { hits.hits.0._id: doc1 } # doc1 should be pinned
+  - match: { hits.hits.1._id: doc2 } # Rest follow
+  - match: { hits.hits.2._id: doc3 }