List all PITs API

.github/workflows/code-hygiene.yml

@@ -1,6 +1,6 @@
 name: Code Hygiene
 
-on: [push, pull_request]
+on: [pull_request]
 
 jobs:
   linelint:

.github/workflows/gradle-check.yml

@@ -0,0 +1,89 @@
+name: Gradle Check (Jenkins)
+on:
+  push:
+    branches-ignore:
+      - 'backport/*'
+      - 'create-pull-request/*'
+      - 'dependabot/*'
+  pull_request_target:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  gradle-check:
+    runs-on: ubuntu-latest
+    timeout-minutes: 130
+    steps:
+      - name: Checkout OpenSearch repo
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Setup environment variables (PR)
+        if: github.event_name == 'pull_request_target'
+        run: |
+            echo "pr_from_sha=$(jq --raw-output .pull_request.head.sha $GITHUB_EVENT_PATH)" >> $GITHUB_ENV
+            echo "pr_from_clone_url=$(jq --raw-output .pull_request.head.repo.clone_url $GITHUB_EVENT_PATH)" >> $GITHUB_ENV
+            echo "pr_to_clone_url=$(jq --raw-output .pull_request.base.repo.clone_url $GITHUB_EVENT_PATH)" >> $GITHUB_ENV
+            echo "pr_title=$(jq --raw-output .pull_request.title $GITHUB_EVENT_PATH)" >> $GITHUB_ENV
+            echo "pr_number=$(jq --raw-output .pull_request.number $GITHUB_EVENT_PATH)" >> $GITHUB_ENV
+
+      - name: Setup environment variables (Push)
+        if: github.event_name == 'push'
+        run: |
+            repo_url="https://github.com/opensearch-project/OpenSearch"
+            ref_id=$(git rev-parse HEAD)
+            branch_name=$(git rev-parse --abbrev-ref HEAD)
+            echo "pr_from_sha=$ref_id" >> $GITHUB_ENV
+            echo "pr_from_clone_url=$repo_url" >> $GITHUB_ENV
+            echo "pr_to_clone_url=$repo_url" >> $GITHUB_ENV
+            echo "pr_title=Push trigger $branch_name $ref_id $repo_url" >> $GITHUB_ENV
+            echo "pr_number=Null" >> $GITHUB_ENV
+
+      - name: Checkout opensearch-build repo
+        uses: actions/checkout@v2
+        with:
+          repository: opensearch-project/opensearch-build
+          ref: main
+          path: opensearch-build
+
+      - name: Trigger jenkins workflow to run gradle check
+        run: |
+            set -e
+            set -o pipefail
+            bash opensearch-build/scripts/gradle/gradle-check.sh ${{ secrets.JENKINS_GRADLE_CHECK_GENERIC_WEBHOOK_TOKEN }} | tee -a gradle-check.log
+
+      - name: Setup Result Status
+        if: always()
+        run: |
+            WORKFLOW_URL=`cat gradle-check.log | grep 'WORKFLOW_URL' | awk '{print $2}'`
+            RESULT=`cat gradle-check.log | grep 'Result:' | awk '{print $2}'`
+            echo "workflow_url=$WORKFLOW_URL" >> $GITHUB_ENV
+            echo "result=$RESULT" >> $GITHUB_ENV
+
+      - name: Upload Coverage Report
+        if: success()
+        uses: codecov/codecov-action@v2
+        with:
+          files: ./codeCoverage.xml
+
+      - name: Create Comment Success
+        if: ${{ github.event_name == 'pull_request_target' && success() }}
+        uses: peter-evans/create-or-update-comment@v2
+        with:
+          issue-number: ${{ env.pr_number }}
+          body: |
+              ### Gradle Check (Jenkins) Run Completed with:
+              * **RESULT:** ${{ env.result }} :white_check_mark:
+              * **URL:** ${{ env.workflow_url }}
+              * **CommitID:** ${{ env.pr_from_sha }}
+
+      - name: Create Comment Failure
+        if: ${{ github.event_name == 'pull_request_target' && failure() }}
+        uses: peter-evans/create-or-update-comment@v2
+        with:
+          issue-number: ${{ env.pr_number }}
+          body: |
+              ### Gradle Check (Jenkins) Run Completed with:
+              * **RESULT:** ${{ env.result }} :x:
+              * **URL:** ${{ env.workflow_url }}
+              * **CommitID:** ${{ env.pr_from_sha }}

.github/workflows/wrapper.yml

@@ -1,5 +1,5 @@
 name: Validate Gradle Wrapper
-on: [push, pull_request]
+on: [pull_request]
 
 jobs:
   validate:

client/rest-high-level/src/test/java/org/opensearch/client/RestHighLevelClientTests.java

@@ -885,7 +885,8 @@ public void testApiNamingConventions() throws Exception {
             "nodes.hot_threads",
             "nodes.usage",
             "nodes.reload_secure_settings",
-            "search_shards", };
+            "search_shards",
+            "get_all_pits" };
         List<String> booleanReturnMethods = Arrays.asList("security.enable_user", "security.disable_user", "security.change_password");
         Set<String> deprecatedMethods = new HashSet<>();
         deprecatedMethods.add("indices.force_merge");

rest-api-spec/src/main/resources/rest-api-spec/api/create_pit.json

@@ -2,7 +2,7 @@
   "create_pit":{
     "documentation":{
       "url":"https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time/",
-      "description":"Creates point in time context."
+      "description":"Creates point in time search context."
     },
     "stability":"experimental",
     "url":{

rest-api-spec/src/main/resources/rest-api-spec/api/get_all_pits.json

@@ -0,0 +1,19 @@
+{
+  "get_all_pits":{
+    "documentation":{
+      "url":"https://opensearch.org/docs/latest/opensearch/rest-api/point_in_time/",
+      "description":"Get all active point in time searches."
+    },
+    "stability":"experimental",
+    "url":{
+      "paths":[
+        {
+          "path":"/_search/point_in_time/all",
+          "methods":[
+            "GET"
+          ]
+        }
+      ]
+    }
+  }
+}

rest-api-spec/src/main/resources/rest-api-spec/test/pit/10_basic.yml

@@ -27,9 +27,18 @@
         keep_alive: 23h
 
   - set: {id: pit_id}
+  - set: {creation_time: create_time}
   - match:   { _shards.total: 1}
   - match:   { _shards.successful: 1}
   - match:   { _shards.failed: 0}
+
+  - do:
+      get_all_pits: {}
+
+  - match: {pits.0.pitId: $pit_id}
+  - match: {pits.0.creationTime: $create_time}
+  - match: {pits.0.keepAlive: 82800000}
+
   - do:
       search:
         rest_total_hits_as_int: true
@@ -87,7 +96,7 @@
           "pit_id": [$pit_id]
 
   - match: {pits.0.pitId: $pit_id}
-  - match: {pits.0.succeeded: true }
+  - match: {pits.0.successful: true }
 
 ---
 "Delete all":
@@ -127,7 +136,7 @@
       delete_all_pits: {}
 
   - match: {pits.0.pitId: $pit_id}
-  - match: {pits.0.succeeded: true }
+  - match: {pits.0.successful: true }
 
   - do:
       catch: missing

server/src/main/java/org/opensearch/action/ActionModule.java

@@ -234,12 +234,14 @@
 import org.opensearch.action.search.ClearScrollAction;
 import org.opensearch.action.search.CreatePitAction;
 import org.opensearch.action.search.DeletePitAction;
+import org.opensearch.action.search.GetAllPitsAction;
 import org.opensearch.action.search.MultiSearchAction;
 import org.opensearch.action.search.SearchAction;
 import org.opensearch.action.search.SearchScrollAction;
 import org.opensearch.action.search.TransportClearScrollAction;
 import org.opensearch.action.search.TransportCreatePitAction;
 import org.opensearch.action.search.TransportDeletePitAction;
+import org.opensearch.action.search.TransportGetAllPitsAction;
 import org.opensearch.action.search.TransportMultiSearchAction;
 import org.opensearch.action.search.TransportSearchAction;
 import org.opensearch.action.search.TransportSearchScrollAction;
@@ -403,6 +405,7 @@
 import org.opensearch.rest.action.search.RestCreatePitAction;
 import org.opensearch.rest.action.search.RestDeletePitAction;
 import org.opensearch.rest.action.search.RestExplainAction;
+import org.opensearch.rest.action.search.RestGetAllPitsAction;
 import org.opensearch.rest.action.search.RestMultiSearchAction;
 import org.opensearch.rest.action.search.RestSearchAction;
 import org.opensearch.rest.action.search.RestSearchScrollAction;
@@ -664,6 +667,7 @@ public <Request extends ActionRequest, Response extends ActionResponse> void reg
         actions.register(FindDanglingIndexAction.INSTANCE, TransportFindDanglingIndexAction.class);
         actions.register(CreatePitAction.INSTANCE, TransportCreatePitAction.class);
         actions.register(DeletePitAction.INSTANCE, TransportDeletePitAction.class);
+        actions.register(GetAllPitsAction.INSTANCE, TransportGetAllPitsAction.class);
 
         return unmodifiableMap(actions.getRegistry());
     }
@@ -840,6 +844,7 @@ public void initRestHandlers(Supplier<DiscoveryNodes> nodesInCluster) {
         // Point in time API
         registerHandler.accept(new RestCreatePitAction());
         registerHandler.accept(new RestDeletePitAction());
+        registerHandler.accept(new RestGetAllPitsAction());
 
         for (ActionPlugin plugin : actionPlugins) {
             for (RestHandler handler : plugin.getRestHandlers(

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

@@ -15,7 +15,7 @@
  */
 public class CreatePitAction extends ActionType<CreatePitResponse> {
     public static final CreatePitAction INSTANCE = new CreatePitAction();
-    public static final String NAME = "indices:data/read/point_in_time";
+    public static final String NAME = "indices:data/read/point_in_time/create";
 
     private CreatePitAction() {
         super(NAME, CreatePitResponse::new);

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

@@ -17,7 +17,7 @@
 public class DeletePitAction extends ActionType<DeletePitResponse> {
 
     public static final DeletePitAction INSTANCE = new DeletePitAction();
-    public static final String NAME = "indices:admin/read/pit/delete";
+    public static final String NAME = "indices:data/read/point_in_time/delete";
 
     private DeletePitAction() {
         super(NAME, DeletePitResponse::new);

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

@@ -0,0 +1,39 @@
+/*
+ * 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.action.search;
+
+import org.opensearch.action.support.nodes.BaseNodeRequest;
+import org.opensearch.common.inject.Inject;
+import org.opensearch.common.io.stream.StreamInput;
+import org.opensearch.common.io.stream.StreamOutput;
+
+import java.io.IOException;
+
+/**
+ * Inner node get all pits request
+ */
+public class GetAllPitNodeRequest extends BaseNodeRequest {
+    GetAllPitNodesRequest request;
+
+    @Inject
+    public GetAllPitNodeRequest(GetAllPitNodesRequest request) {
+        this.request = request;
+    }
+
+    public GetAllPitNodeRequest(StreamInput in) throws IOException {
+        super(in);
+        request = new GetAllPitNodesRequest(in);
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
+        request.writeTo(out);
+    }
+}

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

@@ -0,0 +1,70 @@
+/*
+ * 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.action.search;
+
+import org.opensearch.action.support.nodes.BaseNodeResponse;
+import org.opensearch.cluster.node.DiscoveryNode;
+import org.opensearch.common.inject.Inject;
+import org.opensearch.common.io.stream.StreamInput;
+import org.opensearch.common.io.stream.StreamOutput;
+import org.opensearch.common.xcontent.ToXContentFragment;
+import org.opensearch.common.xcontent.XContentBuilder;
+
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Inner node get all pits response
+ */
+public class GetAllPitNodeResponse extends BaseNodeResponse implements ToXContentFragment {
+
+    private List<ListPitInfo> pitsInfo;
+
+    @Inject
+    public GetAllPitNodeResponse(StreamInput in, List<ListPitInfo> pitsInfo) throws IOException {
+        super(in);
+        this.pitsInfo = pitsInfo;
+    }
+
+    public GetAllPitNodeResponse(DiscoveryNode node, List<ListPitInfo> pitsInfo) {
+        super(node);
+        this.pitsInfo = pitsInfo;
+    }
+
+    public GetAllPitNodeResponse(StreamInput in) throws IOException {
+        super(in);
+        this.pitsInfo = Collections.unmodifiableList(in.readList(ListPitInfo::new));
+    }
+
+    public List<ListPitInfo> getPitsInfo() {
+        return pitsInfo;
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
+        out.writeList(pitsInfo);
+    }
+
+    @Override
+    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
+        builder.startObject();
+        builder.field("node", this.getNode().getName());
+        builder.startArray("pitsInfo");
+        for (ListPitInfo pit : pitsInfo) {
+            pit.toXContent(builder, params);
+        }
+
+        builder.endArray();
+        builder.endObject();
+        return builder;
+    }
+
+}

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

@@ -0,0 +1,45 @@
+/*
+ * 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.action.search;
+
+import org.opensearch.action.support.nodes.BaseNodesRequest;
+import org.opensearch.cluster.node.DiscoveryNode;
+import org.opensearch.common.inject.Inject;
+import org.opensearch.common.io.stream.StreamInput;
+import org.opensearch.common.io.stream.StreamOutput;
+
+import java.io.IOException;
+
+/**
+ * Request to get all active PIT IDs from all nodes of cluster
+ */
+public class GetAllPitNodesRequest extends BaseNodesRequest<GetAllPitNodesRequest> {
+
+    boolean includeAll;
+
+    @Inject
+    public GetAllPitNodesRequest(boolean includeAll, DiscoveryNode... concreteNodes) {
+        super(concreteNodes);
+        this.includeAll = includeAll;
+
+    }
+
+    public GetAllPitNodesRequest(StreamInput in) throws IOException {
+        super(in);
+        this.includeAll = in.readBoolean();
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
+        out.writeBoolean(includeAll);
+    }
+
+    public boolean getIncludeAll() { return includeAll; }
+}