Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 1.x] Register new routes via SDK as named routes (#827) and Makes route prefix setting routeNamePrefix optional #868 #866

Merged

Conversation

DarshitChanpura
Copy link
Member

@DarshitChanpura DarshitChanpura commented Jul 10, 2023

Description

Manually Backports #827 & #868

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.

* WIP on Handler naming and SSL

Signed-off-by: Craig Perkins <[email protected]>

* Add concept of extension shortname via settings

Signed-off-by: Craig Perkins <[email protected]>

* WIP on extension ssl

Signed-off-by: Craig Perkins <[email protected]>

* Get registry from runner

Signed-off-by: Craig Perkins <[email protected]>

* Read settings from extension config file

Signed-off-by: Craig Perkins <[email protected]>

* Update license headers

Signed-off-by: Craig Perkins <[email protected]>

* Run spotlessApply

Signed-off-by: Craig Perkins <[email protected]>

* Remove authz changes and only keep TLS

Signed-off-by: Craig Perkins <[email protected]>

* Remove authz changes and only keep TLS

Signed-off-by: Craig Perkins <[email protected]>

* Remove authz changes and only keep TLS

Signed-off-by: Craig Perkins <[email protected]>

* Remove authz changes and only keep TLS

Signed-off-by: Craig Perkins <[email protected]>

* Remove authz changes and only keep TLS

Signed-off-by: Craig Perkins <[email protected]>

* Update cert generation documents

Signed-off-by: Craig Perkins <[email protected]>

* Re-add authz changes for sample Hello world extension

Signed-off-by: Craig Perkins <[email protected]>

* Add ssl.transport.enabled in ExtensionsRunner

Signed-off-by: Craig Perkins <[email protected]>

* Name all HelloWorld extension routes

Signed-off-by: Craig Perkins <[email protected]>

* Run spotlessApply

Signed-off-by: Craig Perkins <[email protected]>

* Merge main into branch

Signed-off-by: Craig Perkins <[email protected]>

* Add instructions for running in SSL only mode

Signed-off-by: Craig Perkins <[email protected]>

* Add all SSL settings to extension settings

Signed-off-by: Craig Perkins <[email protected]>

* Update TestExtensionsRunner

Signed-off-by: Craig Perkins <[email protected]>

* Set default enforce_hostname_verification

Signed-off-by: Craig Perkins <[email protected]>

* Run spotlessApply

Signed-off-by: Craig Perkins <[email protected]>

* Respond to code review feedback

Signed-off-by: Craig Perkins <[email protected]>

* fix merge conflicts

Signed-off-by: Craig Perkins <[email protected]>

* Fix typos in debug messages

Signed-off-by: Craig Perkins <[email protected]>

* Add docstrings

Signed-off-by: Craig Perkins <[email protected]>

* Address code review feedback

Signed-off-by: Craig Perkins <[email protected]>

* Remove duplicate

Signed-off-by: Craig Perkins <[email protected]>

* Remove duplicate

Signed-off-by: Craig Perkins <[email protected]>

* Create ExtensionRouteHandlerFactory

Signed-off-by: Craig Perkins <[email protected]>

* Remove extension: from action naming

Signed-off-by: Craig Perkins <[email protected]>

* Add javadoc

Signed-off-by: Craig Perkins <[email protected]>

* Fix test compilation errors

Signed-off-by: Craig Perkins <[email protected]>

* Consolidate registerHandler

Signed-off-by: Craig Perkins <[email protected]>

* Fix missed registerHandler usage

Signed-off-by: Craig Perkins <[email protected]>

* Fix javadoc

Signed-off-by: Craig Perkins <[email protected]>

* Add method to check if class is initialized

Signed-off-by: Craig Perkins <[email protected]>

* Fix failing tests

Signed-off-by: Craig Perkins <[email protected]>

* Update helloworld-settings

Signed-off-by: Craig Perkins <[email protected]>

* Run spotlessApply

Signed-off-by: Craig Perkins <[email protected]>

* Run spotlessApply

Signed-off-by: Craig Perkins <[email protected]>

* Add shortExtensionName to BaseExtensionRouteHandler

Signed-off-by: Craig Perkins <[email protected]>

* Adds support for legacy action names while registering extension routes on extension start up

Signed-off-by: Darshit Chanpura <[email protected]>

* Modifies sample hello extension to conform to the new registration scheme

Signed-off-by: Darshit Chanpura <[email protected]>

* Renames route handlers

Signed-off-by: Darshit Chanpura <[email protected]>

* Adds certificate generation script

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes spotless errors

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes Javadoc

Signed-off-by: Darshit Chanpura <[email protected]>

* Cleans up route handlers to be more readable and adds an interface

Signed-off-by: Darshit Chanpura <[email protected]>

* Updates test to reflect changes in route handler signatures

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes slf4j gradle build issue

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes replaced named route tests

Signed-off-by: Darshit Chanpura <[email protected]>

* Changes the way named routes are serialized to conform to core and fixes tests

Signed-off-by: Darshit Chanpura <[email protected]>

* Removes mention of shortNames and uses extensionName as permission prefix

Signed-off-by: Darshit Chanpura <[email protected]>

* Used builder for named routes

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes broken changes

Signed-off-by: Darshit Chanpura <[email protected]>

* Updates dev guide to state to use credentials when registering extension while security is enabled

Signed-off-by: Darshit Chanpura <[email protected]>

* Replaces NamedRouteHandler and update logic to map route handlers for Rest request

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes typos

Signed-off-by: Darshit Chanpura <[email protected]>

* Removes references to ReplaceNamedRouteHandlers and DeprecatedNamedRouteHandlers

Signed-off-by: Darshit Chanpura <[email protected]>

* Addresses PR feedback

Signed-off-by: Darshit Chanpura <[email protected]>

* Refactors ReplacedRoute and deprecated route handlers to use RestResponse

Signed-off-by: Darshit Chanpura <[email protected]>

* Forces httpcore5 to 5.2.2

Signed-off-by: Darshit Chanpura <[email protected]>

* Updates documentation

Signed-off-by: Darshit Chanpura <[email protected]>

* Addresses PR feedback

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes broken reference due to changes in core 52a5e3f6e0ca599e3193807134ea42660ecdd195

Signed-off-by: Darshit Chanpura <[email protected]>

* Removes extra resolutionStrategy

Signed-off-by: Darshit Chanpura <[email protected]>

---------

Signed-off-by: Craig Perkins <[email protected]>
Signed-off-by: Darshit Chanpura <[email protected]>
Co-authored-by: Craig Perkins <[email protected]>
(cherry picked from commit 09c22b0)
@dbwiddis
Copy link
Member

Looks like the Integ Test fix from original doesn't work on backport....

@DarshitChanpura
Copy link
Member Author

I've created the backport for the integ test fix: opensearch-project/OpenSearch#8588

@joshpalis
Copy link
Member

Before we merge this backport : #827 (comment)

Copy link
Member

@dbwiddis dbwiddis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DarshitChanpura
Copy link
Member Author

DarshitChanpura commented Jul 10, 2023

See #827 (comment)

Addressed in a separate PR to main: #868

Will cherry-pick the changes into this branch once that PR is merged

@DarshitChanpura DarshitChanpura force-pushed the backport/backport-827-to-1.x branch from a076730 to ebd13ad Compare July 10, 2023 23:45
@joshpalis
Copy link
Member

@DarshitChanpura #868 has been merged

…ject#868)

* Renames demo extension to `helloWorld`

Signed-off-by: Darshit Chanpura <[email protected]>

* Updates uniqueId to not reflect the change

Signed-off-by: Darshit Chanpura <[email protected]>

* Adds a validation check for setting extension name

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes checkstyle errors

Signed-off-by: Darshit Chanpura <[email protected]>

* Adds routePrefix as an optional setting in .yml

Signed-off-by: Darshit Chanpura <[email protected]>

* Updates dev guide to add documentation for the optional setting `routePrefix`

Signed-off-by: Darshit Chanpura <[email protected]>

* Renames `routePrefix` to `routeNamePrefix`

Signed-off-by: Darshit Chanpura <[email protected]>

* Renames erroneous instance of `hello-world`

Signed-off-by: Darshit Chanpura <[email protected]>

* Addresses PR feedback

Signed-off-by: Darshit Chanpura <[email protected]>
(cherry picked from commit 0103ada30250693c7b986a9667fd0060b414a66e)

* Changes allowed route name prefixes

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes error message and removes hyphen from allowed characters in route name prefix

Signed-off-by: Darshit Chanpura <[email protected]>

---------

Signed-off-by: Darshit Chanpura <[email protected]>
(cherry picked from commit 9e31418)
@DarshitChanpura DarshitChanpura changed the title [Backport 1.x] Register new routes via SDK as named routes (#827) [Backport 1.x] Register new routes via SDK as named routes (#827) and Makes route prefix setting routeNamePrefix optional #868 Jul 11, 2023
@DarshitChanpura
Copy link
Member Author

DarshitChanpura commented Jul 11, 2023

@joshpalis @dbwiddis @owaiskazi19 @saratvemulapalli All relevant changes from main branch have now been cherry-picked into this branch.

@DarshitChanpura DarshitChanpura requested a review from dbwiddis July 11, 2023 17:36
@dbwiddis dbwiddis merged commit 32d6567 into opensearch-project:1.x Jul 11, 2023
DarshitChanpura added a commit to DarshitChanpura/opensearch-sdk-java that referenced this pull request Jul 11, 2023
DarshitChanpura added a commit to DarshitChanpura/opensearch-sdk-java that referenced this pull request Jul 12, 2023
…pensearch-project#827) and Makes route prefix setting routeNamePrefix optional opensearch-project#868 (opensearch-project#866)"

This reverts commit 32d6567.

Signed-off-by: Darshit Chanpura <[email protected]>
owaiskazi19 pushed a commit that referenced this pull request Jul 12, 2023
) and Makes route prefix setting routeNamePrefix optional #868" (#877)

* Revert "[Backport 1.x] Register new routes via SDK as named routes (#827) and Makes route prefix setting routeNamePrefix optional #868 (#866)"

This reverts commit 32d6567.

Signed-off-by: Darshit Chanpura <[email protected]>

* Updates extension() method call in build.gradle

Signed-off-by: Darshit Chanpura <[email protected]>

---------

Signed-off-by: Darshit Chanpura <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants