Enhance Point In Time support with APIs to list active point-in-time searches (opensearch-project#218)

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

Author: reta

spring-data-opensearch/src/main/java/org/opensearch/data/client/orhlc/OpenSearchRestTemplate.java

@@ -45,6 +45,7 @@
 import org.opensearch.client.RequestOptions;
 import org.opensearch.client.RestHighLevelClient;
 import org.opensearch.common.unit.TimeValue;
+import org.opensearch.data.core.OpenSearchOperations;
 import org.opensearch.index.query.MoreLikeThisQueryBuilder;
 import org.opensearch.index.query.QueryBuilders;
 import org.opensearch.index.reindex.BulkByScrollResponse;
@@ -80,7 +81,7 @@
  * OpenSearchRestTemplate
  * @since 0.1
  */
-public class OpenSearchRestTemplate extends AbstractElasticsearchTemplate {
+public class OpenSearchRestTemplate extends AbstractElasticsearchTemplate implements OpenSearchOperations {
 
     private static final Log LOGGER = LogFactory.getLog(OpenSearchRestTemplate.class);
 
@@ -468,6 +469,13 @@ public Boolean closePointInTime(String pit) {
         return false;
     }
 
+    @Override
+    public List<PitInfo> listPointInTime() {
+        return execute(client -> client.getAllPits(RequestOptions.DEFAULT))
+                .getPitInfos().stream().map(pit -> new PitInfo(pit.getPitId(), pit.getCreationTime(), null))
+                .toList();
+    }
+
     public SearchResponse suggest(SuggestBuilder suggestion, IndexCoordinates index) {
         SearchRequest searchRequest = requestFactory.searchRequest(suggestion, index);
         return execute(client -> client.search(searchRequest, RequestOptions.DEFAULT));

spring-data-opensearch/src/main/java/org/opensearch/data/client/osc/OpenSearchTemplate.java

@@ -37,6 +37,7 @@
 import org.opensearch.client.opensearch.core.pit.DeletePitRequest;
 import org.opensearch.client.opensearch.core.search.SearchResult;
 import org.opensearch.client.transport.Version;
+import org.opensearch.data.core.OpenSearchOperations;
 import org.springframework.data.elasticsearch.BulkFailureException;
 import org.springframework.data.elasticsearch.client.UnsupportedBackendOperation;
 import org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate;
@@ -75,7 +76,7 @@
  * @author Haibo Liu
  * @since 4.4
  */
-public class OpenSearchTemplate extends AbstractElasticsearchTemplate {
+public class OpenSearchTemplate extends AbstractElasticsearchTemplate implements OpenSearchOperations {
 
     private static final Log LOGGER = LogFactory.getLog(OpenSearchTemplate.class);
 
@@ -615,6 +616,14 @@ public Boolean closePointInTime(String pit) {
         return !response.pits().isEmpty();
     }
 
+    @Override
+    public List<PitInfo> listPointInTime() {
+        return execute(client -> client.listAllPit()).pits()
+            .stream()
+            .map(pit -> new PitInfo(pit.pitId(), pit.creationTime(), pit.keepAlive() == null ? null : Duration.ofMillis(pit.keepAlive())))
+            .toList();
+    }
+
     // endregion
 
     // region script methods
@@ -719,5 +728,4 @@ protected List<IndexedObjectInformation> checkForBulkOperationFailure(BulkRespon
 
     }
     // endregion
-
 }

spring-data-opensearch/src/main/java/org/opensearch/data/core/OpenSearchOperations.java

@@ -0,0 +1,26 @@
+package org.opensearch.data.core;
+
+import java.time.Duration;
+import java.util.List;
+import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
+
+/**
+ * The extension over {@link ElasticsearchOperations} with OpenSearch specific operations.
+ */
+public interface OpenSearchOperations extends ElasticsearchOperations {
+    /**
+     * Return all active point in time searches
+     * @return all active point in time searches
+     */
+    List<PitInfo> listPointInTime();
+
+    /**
+     * Describes the point in time entry
+     *
+     * @param id the point in time id
+     * @param creationTime the time this point in time was created
+     * @param keepAlive the new keep alive value for this point in time
+     */
+    record PitInfo(String id, long creationTime, Duration keepAlive) {
+    }
+}

spring-data-opensearch/src/test/java/org/opensearch/data/client/orhlc/OpenSearchORHLCSpecificIntegrationTests.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.data.client.orhlc;
+
+import static org.opensearch.index.query.QueryBuilders.matchAllQuery;
+
+import org.junit.jupiter.api.DisplayName;
+import org.opensearch.data.client.junit.jupiter.OpenSearchRestTemplateConfiguration;
+import org.opensearch.data.core.OpenSearchSpecificIntegrationTests;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.data.elasticsearch.core.query.BaseQueryBuilder;
+import org.springframework.data.elasticsearch.utils.IndexNameProvider;
+import org.springframework.test.context.ContextConfiguration;
+
+@ContextConfiguration(classes = {OpenSearchORHLCSpecificIntegrationTests.Config.class})
+@DisplayName("Using OpenSearch RestHighLevelClient")
+public class OpenSearchORHLCSpecificIntegrationTests extends OpenSearchSpecificIntegrationTests {
+
+    @Configuration
+    @Import({OpenSearchRestTemplateConfiguration.class})
+    static class Config {
+        @Bean
+        IndexNameProvider indexNameProvider() {
+            return new IndexNameProvider("integration-specific-os");
+        }
+    }
+    @Override
+    protected BaseQueryBuilder<?, ?> getBuilderWithMatchAllQuery() {
+        return new NativeSearchQueryBuilder().withQuery(matchAllQuery());
+    }
+}

spring-data-opensearch/src/test/java/org/opensearch/data/client/osc/OpenSearchOSCSpecificIntegrationTests.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2022-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.opensearch.data.client.osc;
+
+import org.junit.jupiter.api.DisplayName;
+import org.opensearch.data.client.junit.jupiter.OpenSearchTemplateConfiguration;
+import org.opensearch.data.core.OpenSearchSpecificIntegrationTests;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.data.elasticsearch.core.query.BaseQueryBuilder;
+import org.springframework.data.elasticsearch.utils.IndexNameProvider;
+import org.springframework.test.context.ContextConfiguration;
+
+/**
+ * @author Farid Faoudi
+ * @author Sascha Woo
+ * @since 4.4
+ */
+@ContextConfiguration(classes = { OpenSearchOSCSpecificIntegrationTests.Config.class })
+@DisplayName("Using OpenSearch Client")
+public class OpenSearchOSCSpecificIntegrationTests extends OpenSearchSpecificIntegrationTests {
+
+    @Configuration
+    @Import({ OpenSearchTemplateConfiguration.class })
+    static class Config {
+        @Bean
+        IndexNameProvider indexNameProvider() {
+            return new IndexNameProvider("integration-specific-os");
+        }
+    }
+
+    @Override
+    protected BaseQueryBuilder<?, ?> getBuilderWithMatchAllQuery() {
+        return Queries.getBuilderWithMatchAllQuery();
+    }
+}