Fix point in time toXContent impl (#62080)

PointInTimeBuilder is a ToXContentObject yet it does not print out a whole object (it is rather a fragment). Also, when it is printed out as part of SearchSourceBuilder, an error is thrown because pit should be wrapped into its own object.

This commit fixes this and adds tests for it.

Author: javanna

server/src/main/java/org/elasticsearch/search/builder/SearchSourceBuilder.java

@@ -1422,7 +1422,7 @@ public XContentBuilder innerToXContent(XContentBuilder builder, Params params) t
             builder.field(COLLAPSE.getPreferredName(), collapse);
         }
         if (pointInTimeBuilder != null) {
-            builder.field(POINT_IN_TIME.getPreferredName(), pointInTimeBuilder);
+            pointInTimeBuilder.toXContent(builder, params);
         }
         return builder;
     }
@@ -1735,8 +1735,10 @@ public void writeTo(StreamOutput out) throws IOException {
 
         @Override
         public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
+            builder.startObject(POINT_IN_TIME.getPreferredName());
             builder.field(ID_FIELD.getPreferredName(), id);
             builder.field(KEEP_ALIVE_FIELD.getPreferredName(), keepAlive);
+            builder.endObject();
             return builder;
         }
 

server/src/test/java/org/elasticsearch/action/search/TransportSearchActionTests.java

@@ -828,6 +828,9 @@ public void testShouldMinimizeRoundtrips() throws Exception {
             searchRequestTests.setUp();
             SearchRequest searchRequest = searchRequestTests.createSearchRequest();
             searchRequest.scroll((Scroll)null);
+            if (searchRequest.source() != null) {
+                searchRequest.source().pointInTimeBuilder(null);
+            }
             searchRequest.searchType(SearchType.QUERY_THEN_FETCH);
             SearchSourceBuilder source = searchRequest.source();
             if (source != null) {

server/src/test/java/org/elasticsearch/search/builder/SearchSourceBuilderTests.java

@@ -360,7 +360,7 @@ public void testTimeoutWithoutUnits() throws IOException {
         }
     }
 
-    public void testToXContent() throws  IOException {
+    public void testToXContent() throws IOException {
         //verify that only what is set gets printed out through toXContent
         XContentType xContentType = randomFrom(XContentType.values());
         {
@@ -383,6 +383,22 @@ public void testToXContent() throws  IOException {
         }
     }
 
+    public void testToXContentWithPointInTime() throws IOException {
+        XContentType xContentType = randomFrom(XContentType.values());
+        SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();
+        searchSourceBuilder.pointInTimeBuilder(new SearchSourceBuilder.PointInTimeBuilder("id", TimeValue.timeValueHours(1)));
+        XContentBuilder builder = XContentFactory.contentBuilder(xContentType);
+        searchSourceBuilder.toXContent(builder, ToXContent.EMPTY_PARAMS);
+        BytesReference bytes = BytesReference.bytes(builder);
+        Map<String, Object> sourceAsMap = XContentHelper.convertToMap(bytes, false, xContentType).v2();
+        assertEquals(1, sourceAsMap.size());
+        @SuppressWarnings("unchecked")
+        Map<String, Object> pit = (Map<String, Object>) sourceAsMap.get("pit");
+        assertEquals(2, pit.size());
+        assertEquals("id", pit.get("id"));
+        assertEquals("1h", pit.get("keep_alive"));
+    }
+
     public void testParseIndicesBoost() throws IOException {
         {
             String restContent = " { \"indices_boost\": {\"foo\": 1.0, \"bar\": 2.0}}";

server/src/test/java/org/elasticsearch/search/internal/ShardSearchRequestTests.java

@@ -52,7 +52,7 @@
 import static org.hamcrest.Matchers.nullValue;
 
 public class ShardSearchRequestTests extends AbstractSearchTestCase {
-    private IndexMetadata baseMetadata = IndexMetadata.builder("test").settings(Settings.builder()
+    private static final IndexMetadata BASE_METADATA = IndexMetadata.builder("test").settings(Settings.builder()
         .put(IndexMetadata.SETTING_VERSION_CREATED, Version.CURRENT).build())
         .numberOfShards(1).numberOfReplicas(1).build();
 
@@ -105,7 +105,7 @@ private ShardSearchRequest createShardSearchRequest() throws IOException {
     }
 
     public void testFilteringAliases() throws Exception {
-        IndexMetadata indexMetadata = baseMetadata;
+        IndexMetadata indexMetadata = BASE_METADATA;
         indexMetadata = add(indexMetadata, "cats", filter(termQuery("animal", "cat")));
         indexMetadata = add(indexMetadata, "dogs", filter(termQuery("animal", "dog")));
         indexMetadata = add(indexMetadata, "all", null);
@@ -131,7 +131,7 @@ public void testFilteringAliases() throws Exception {
     }
 
     public void testRemovedAliasFilter() throws Exception {
-        IndexMetadata indexMetadata = baseMetadata;
+        IndexMetadata indexMetadata = BASE_METADATA;
         indexMetadata = add(indexMetadata, "cats", filter(termQuery("animal", "cat")));
         indexMetadata = remove(indexMetadata, "cats");
         try {
@@ -143,7 +143,7 @@ public void testRemovedAliasFilter() throws Exception {
     }
 
     public void testUnknownAliasFilter() throws Exception {
-        IndexMetadata indexMetadata = baseMetadata;
+        IndexMetadata indexMetadata = BASE_METADATA;
         indexMetadata = add(indexMetadata, "cats", filter(termQuery("animal", "cat")));
         indexMetadata = add(indexMetadata, "dogs", filter(termQuery("animal", "dog")));
         IndexMetadata finalIndexMetadata = indexMetadata;

test/framework/src/main/java/org/elasticsearch/search/RandomSearchRequestGenerator.java

@@ -373,6 +373,10 @@ public static SearchSourceBuilder randomSearchSourceBuilder(
         if (randomBoolean()) {
             builder.collapse(randomCollapseBuilder.get());
         }
+        if (randomBoolean()) {
+            builder.pointInTimeBuilder(new SearchSourceBuilder.PointInTimeBuilder(randomAlphaOfLengthBetween(3, 10),
+                TimeValue.timeValueMinutes(randomIntBetween(1, 60))));
+        }
         return builder;
     }
 }