Provide Extension API to OpenSearch by dbwiddis · Pull Request #74 · opensearch-project/opensearch-sdk-java

dbwiddis · 2022-08-02T21:56:06Z

Signed-off-by: Daniel Widdis widdis@gmail.com

Description

Companion PR: opensearch-project/OpenSearch#4100

Extensions will report their APIs to the ExtensionsOrchestrator upon initial registration and potentially later in the Extension's lifecycle. These APIs will be registered and mapped so that when Users submit API requests they can be forwarded to the appropriate extensions.

This PR handles the communication of the REST API from the Extension to OpenSearch. Future PRs will complete the process of registering the REST Handlers and redirecting inbound requests.

Issues Resolved

Fixes #68

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.

Signed-off-by: Daniel Widdis <widdis@gmail.com>

dbwiddis · 2022-08-04T16:24:19Z

On extension orchestrator log:

[2022-08-04T16:20:43,929][INFO ][o.o.e.ExtensionsOrchestrator] [dev-dsk-widdisd-2a-8f5e7316.us-west-2.amazon.com] Initialized extension: sample-extension
[2022-08-04T16:20:43,930][INFO ][o.o.e.ExtensionsOrchestrator] [dev-dsk-widdisd-2a-8f5e7316.us-west-2.amazon.com] Registering: GET /_extensions/sample-extension/api_1
[2022-08-04T16:20:43,930][INFO ][o.o.e.ExtensionsOrchestrator] [dev-dsk-widdisd-2a-8f5e7316.us-west-2.amazon.com] Registering: PUT /_extensions/sample-extension/api_2
[2022-08-04T16:20:43,930][INFO ][o.o.e.ExtensionsOrchestrator] [dev-dsk-widdisd-2a-8f5e7316.us-west-2.amazon.com] Registering: POST /_extensions/sample-extension/api_3

On extension runner log:

MESSAGE RECEIVED:E-ǣ�pRegistered node opensearch-sdk-1, extension sample-extension to handle API [GET /api_1, PUT /api_2, POST /api_3]

joshpalis

LGTM! Just a small suggestion regarding missing javadocs

src/main/java/org/opensearch/sdk/ExtensionsRunner.java

src/main/java/org/opensearch/sdk/ExtensionApi.java

src/main/java/org/opensearch/sdk/ExtensionsRunner.java

Signed-off-by: Daniel Widdis <widdis@gmail.com>

…ce setter in ExtensionsRunner for testing purporses Signed-off-by: Joshua Palis <jpalis@amazon.com>

Signed-off-by: Daniel Widdis <widdis@gmail.com>

Fixed testHandleExtensionInitRequest

Signed-off-by: Daniel Widdis <widdis@gmail.com>

saratvemulapalli

Thanks @dbwiddis. This is a great start for RestAPIs.
Could you update the DESIGN.md.

dbwiddis · 2022-08-17T23:31:39Z

Thanks @dbwiddis. This is a great start for RestAPIs. Could you update the DESIGN.md.

I can do that as part of the follow-on PR to address #69 (based a lot on the comment discussing my plan there) to avoid delaying this PR any further.

Any other changes needed before this and the companion PR is merged?

peternied

Thanks for the updates, looks good for my perspective

saratvemulapalli

Thanks @dbwiddis.
Gradle check is failing probably because of the PR pending in OpenSearch.

dbwiddis · 2022-08-18T18:54:44Z

Thanks @dbwiddis.

Gradle check is failing probably because of the PR pending in OpenSearch.

Indeed as it passes locally when they branch is published to maven local.

What will it take to get that companion PR approved? I'd like to continue work on both branches.

src/test/java/org/opensearch/sdk/TestExtensionRestApi.java

owaiskazi19

One small ask :) Rest LGTM!

* Provide Extension API to OpenSearch Signed-off-by: Daniel Widdis <widdis@gmail.com> * Fix newline, add test Signed-off-by: Daniel Widdis <widdis@gmail.com> * Clarify Valid API format Signed-off-by: Daniel Widdis <widdis@gmail.com> * Store uniqueID of extensions Signed-off-by: Daniel Widdis <widdis@gmail.com> * Fix errors in merge commit Signed-off-by: Daniel Widdis <widdis@gmail.com> * Rename Api to RestApi Signed-off-by: Daniel Widdis <widdis@gmail.com> * Delay sending REST API until after responding to initialization Signed-off-by: Daniel Widdis <widdis@gmail.com> * Move YAML file to classpath Signed-off-by: Daniel Widdis <widdis@gmail.com> * Temporarily disable failing test for debug Signed-off-by: Daniel Widdis <widdis@gmail.com> * fixed testHandleExtensionInitRequest, added protected transport service setter in ExtensionsRunner for testing purporses Signed-off-by: Joshua Palis <jpalis@amazon.com> * Change transport service setter to package privage Signed-off-by: Daniel Widdis <widdis@gmail.com> * Rename RestApi to RestActions or RestPaths Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: Joshua Palis <jpalis@amazon.com> Co-authored-by: Joshua Palis <jpalis@amazon.com>

Provide Extension API to OpenSearch

98be7a8

Signed-off-by: Daniel Widdis <widdis@gmail.com>

dbwiddis requested a review from a team August 2, 2022 21:56

dbwiddis mentioned this pull request Aug 2, 2022

[Feature/extensions] Provide Extension API to OpenSearch opensearch-project/OpenSearch#4100

Merged

5 tasks

dbwiddis requested review from owaiskazi19 and saratvemulapalli August 2, 2022 22:03

Fix newline, add test

17a509b

Signed-off-by: Daniel Widdis <widdis@gmail.com>

dbwiddis requested a review from ryanbogan August 3, 2022 05:17

dbwiddis added 2 commits August 3, 2022 21:00

Clarify Valid API format

8de2af7

Signed-off-by: Daniel Widdis <widdis@gmail.com>

Store uniqueID of extensions

2e17d96

Signed-off-by: Daniel Widdis <widdis@gmail.com>

dbwiddis marked this pull request as draft August 4, 2022 17:29

dbwiddis marked this pull request as ready for review August 4, 2022 19:50

dbwiddis requested a review from joshpalis August 4, 2022 21:00

joshpalis previously approved these changes Aug 4, 2022

View reviewed changes

src/main/java/org/opensearch/sdk/ExtensionsRunner.java Show resolved Hide resolved

Merge branch 'main' into registerApi

49ba520

dbwiddis dismissed joshpalis’s stale review via 49ba520 August 9, 2022 13:28

dbwiddis requested a review from joshpalis August 9, 2022 13:29

joshpalis previously approved these changes Aug 9, 2022

View reviewed changes

Merge branch 'main' into registerApi

87b5950

dbwiddis dismissed joshpalis’s stale review via 87b5950 August 13, 2022 18:55

dbwiddis requested a review from joshpalis August 13, 2022 18:57

saratvemulapalli reviewed Aug 15, 2022

View reviewed changes

dbwiddis added 3 commits August 15, 2022 14:01

Fix errors in merge commit

0e4a903

Signed-off-by: Daniel Widdis <widdis@gmail.com>

Rename Api to RestApi

9a3feab

Signed-off-by: Daniel Widdis <widdis@gmail.com>

Delay sending REST API until after responding to initialization

0dd6519

Signed-off-by: Daniel Widdis <widdis@gmail.com>

dbwiddis requested a review from saratvemulapalli August 16, 2022 01:23

This was referenced Aug 16, 2022

[FEATURE] Only send one extension's information in InitializeExtensionsRequest #93

Closed

[PROPOSAL] Align on meaning of a successfully initialized extension #94

Closed

dbwiddis added 2 commits August 16, 2022 00:45

Move YAML file to classpath

821d27f

Signed-off-by: Daniel Widdis <widdis@gmail.com>

Temporarily disable failing test for debug

4dd6306

Signed-off-by: Daniel Widdis <widdis@gmail.com>

This was referenced Aug 16, 2022

Rename this project to opensearch-extensions or opensearch-extensions-java #13

Closed

[FEATURE] Register REST API and map to associated extension in ExtensionsOrchestrator #69

Closed

joshpalis and others added 4 commits August 16, 2022 17:14

fixed testHandleExtensionInitRequest, added protected transport servi…

c6e2d0b

…ce setter in ExtensionsRunner for testing purporses Signed-off-by: Joshua Palis <jpalis@amazon.com>

Change transport service setter to package privage

2602177

Signed-off-by: Daniel Widdis <widdis@gmail.com>

Merge pull request #1 from joshpalis/fix-test

8a2e556

Fixed testHandleExtensionInitRequest

Rename RestApi to RestActions or RestPaths

1376493

Signed-off-by: Daniel Widdis <widdis@gmail.com>

saratvemulapalli reviewed Aug 17, 2022

View reviewed changes

dbwiddis mentioned this pull request Aug 17, 2022

Rename everything from opensearch-sdk to opensearch-sdk-java #96

Merged

peternied approved these changes Aug 18, 2022

View reviewed changes

dbwiddis requested a review from saratvemulapalli August 18, 2022 03:34

saratvemulapalli approved these changes Aug 18, 2022

View reviewed changes

owaiskazi19 reviewed Aug 18, 2022

View reviewed changes

src/test/java/org/opensearch/sdk/TestExtensionRestApi.java Show resolved Hide resolved

owaiskazi19 approved these changes Aug 18, 2022

View reviewed changes

dbwiddis merged commit 1fe933f into opensearch-project:main Aug 20, 2022

dbwiddis deleted the registerApi branch August 20, 2022 00:03

This was referenced Aug 23, 2022

[Feature/extensions] Register REST API and forward REST requests to associated extension opensearch-project/OpenSearch#4282

Merged

Register REST API and forward REST requests to associated extension #101

Merged

owaiskazi19 mentioned this pull request Sep 7, 2022

Adding dbwiddis@ to opensearch-sdk-java as a maintainer #124

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provide Extension API to OpenSearch#74

Provide Extension API to OpenSearch#74
dbwiddis merged 15 commits intoopensearch-project:mainfrom
dbwiddis:registerApi

dbwiddis commented Aug 2, 2022

Uh oh!

dbwiddis commented Aug 4, 2022

Uh oh!

joshpalis left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

saratvemulapalli left a comment

Uh oh!

dbwiddis commented Aug 17, 2022

Uh oh!

peternied left a comment

Uh oh!

saratvemulapalli left a comment

Uh oh!

dbwiddis commented Aug 18, 2022

Uh oh!

Uh oh!

owaiskazi19 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

dbwiddis commented Aug 2, 2022

Description

Issues Resolved

Uh oh!

dbwiddis commented Aug 4, 2022

Uh oh!

joshpalis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

saratvemulapalli left a comment

Choose a reason for hiding this comment

Uh oh!

dbwiddis commented Aug 17, 2022

Uh oh!

peternied left a comment

Choose a reason for hiding this comment

Uh oh!

saratvemulapalli left a comment

Choose a reason for hiding this comment

Uh oh!

dbwiddis commented Aug 18, 2022

Uh oh!

Uh oh!

owaiskazi19 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants