Add changes for Create PIT and Delete PIT rest layer and rest high level client

[bharath-techie]

Signed-off-by: Bharathwaj G bharath78910@gmail.com

Description

This change contains create PIT and delete PIT rest layer and rest high level client changes

Create pit service layer changes - #3921
Delete pit service layer changes - #3949

Issues Resolved

#1147

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1177/
• CommitID: b52da57ed9b4d49508e018186f689834ffbd30f3

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1178/
• CommitID: b0be14c70e562fe8366cabfca137b46896b4f10e

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1181/
• CommitID: 930b763e901f1c69760cff4f780f5c8d036f0da5

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1185/
• CommitID: 855106d4d1cfe7593b012a140924e8703dd5c78e

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1186/
• CommitID: dea4a4f1670f92900c7dd8369c2475eb37e622c7

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1242/
• CommitID: 49b3f01

[reta]

It seems to be not needed, the next line does params.withIndicesOptions(searchRequest.indicesOptions()); unconditionally

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1617/
• CommitID: 9fc600e9d21589dbe7f6f825515841c0e8d03181

[Bukhtawar]

What happens is the client connection gets closed before PIT can be returned back? Although the client can do a list maybe to verify but most clients use the default retry strategy that wouldn't do a list, will we end up retaining PITs espl if keep alive was sufficiently long

[bharath-techie]

Yes, PIT will get created in the backend. I looked at other rest actions, don't see any specific handling for such scenarios - are we looking for any specific implementation ?

[Bukhtawar]

Should we cleanup created PIT if client connection closes before it receives the PIT id
cc: @reta for thoughts

[reta]

That's an interesting one, we need a pit_id to cleanup, but as you said, if client closes the connection before PIT id is received, not much we can do. However, we could follow other APIs (fe RestSearchScrollAction) and support POST "/{index}/_search/point_in_time/${pit_id}") - in this case the pit_id is coming from client and could be managed in idempotent way, what do you think @Bukhtawar ?

[Bukhtawar]

@reta Not sure if I understood it correctly. In the current context, first a PIT needs to be created using this API and then used in subsequent search APIs. If the client closes the connection, just like search cancellation cleans up ongoing searches, I was thinking if we could clean up(delete) the PIT or release the underlying Searcher. Thoughts?

[reta]

@Bukhtawar oh got it, you mean on the server, right? Deleting PIT would probably be too agressive (if client reconnects and try to use it again), but releasing underlying Searcher would make sense (since client won't be able to fetch the results anyway).

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1654/
• CommitID: 1626cfb

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1655/
• CommitID: e0087a9c5cc32258a4a810d739c1f1468f2aa935

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/1656/
• CommitID: 3bdf1cc

[pranikum]

no use of param deletePitRequest

[bharath-techie]

i tried a commit which removes the param but facing issues in tests / api naming conventions check test which requires request to be part of method signature (deleteAllPitsAsync) etc. so keeping it the same for now.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/2172/
• CommitID: 7796ace

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: null ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/2179/
• CommitID: 40ac831

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/2236/
• CommitID: 379797b2d48c9f9e6ac5ba26fa4c1a48e9f5d346

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: ABORTED ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/2242/
• CommitID: fab586c

[Bukhtawar]

Can we use a copy constructor and change pitInfos instead?

[Bukhtawar]

can we set ListPitInfo instead?

[bharath-techie]

We can also set failures as part of response which will be left out if we just set ListPitInfo

[Bukhtawar]

Ensure we handle cases for non-null but empty cases and handle them appropriately at security plugin

[bharath-techie]

Yes I have tested them locally, all are working as expected, will push the changes and share the final security plugin pr.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/2326/
• CommitID: 56bba1c9afe6a2dcb529fc75fbb25994a541362c

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/2329/
• CommitID: 905bce2

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: SUCCESS ✅
• URL: https://build.ci.opensearch.org/job/gradle-check/2333/
• CommitID: 6412c08