[Backport 1.x] Register new routes via SDK as named routes (#827) and Makes route prefix setting routeNamePrefix optional #868 #866
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* WIP on Handler naming and SSL Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add concept of extension shortname via settings Signed-off-by: Craig Perkins <cwperx@amazon.com> * WIP on extension ssl Signed-off-by: Craig Perkins <cwperx@amazon.com> * Get registry from runner Signed-off-by: Craig Perkins <cwperx@amazon.com> * Read settings from extension config file Signed-off-by: Craig Perkins <cwperx@amazon.com> * Update license headers Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Update cert generation documents Signed-off-by: Craig Perkins <cwperx@amazon.com> * Re-add authz changes for sample Hello world extension Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add ssl.transport.enabled in ExtensionsRunner Signed-off-by: Craig Perkins <cwperx@amazon.com> * Name all HelloWorld extension routes Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Merge main into branch Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add instructions for running in SSL only mode Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add all SSL settings to extension settings Signed-off-by: Craig Perkins <cwperx@amazon.com> * Update TestExtensionsRunner Signed-off-by: Craig Perkins <cwperx@amazon.com> * Set default enforce_hostname_verification Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Respond to code review feedback Signed-off-by: Craig Perkins <cwperx@amazon.com> * fix merge conflicts Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix typos in debug messages Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add docstrings Signed-off-by: Craig Perkins <cwperx@amazon.com> * Address code review feedback Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove duplicate Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove duplicate Signed-off-by: Craig Perkins <cwperx@amazon.com> * Create ExtensionRouteHandlerFactory Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove extension: from action naming Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add javadoc Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix test compilation errors Signed-off-by: Craig Perkins <cwperx@amazon.com> * Consolidate registerHandler Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix missed registerHandler usage Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix javadoc Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add method to check if class is initialized Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix failing tests Signed-off-by: Craig Perkins <cwperx@amazon.com> * Update helloworld-settings Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add shortExtensionName to BaseExtensionRouteHandler Signed-off-by: Craig Perkins <cwperx@amazon.com> * Adds support for legacy action names while registering extension routes on extension start up Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Modifies sample hello extension to conform to the new registration scheme Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Renames route handlers Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Adds certificate generation script Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes spotless errors Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes Javadoc Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Cleans up route handlers to be more readable and adds an interface Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates test to reflect changes in route handler signatures Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes slf4j gradle build issue Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes replaced named route tests Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Changes the way named routes are serialized to conform to core and fixes tests Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Removes mention of shortNames and uses extensionName as permission prefix Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Used builder for named routes Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes broken changes Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates dev guide to state to use credentials when registering extension while security is enabled Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Replaces NamedRouteHandler and update logic to map route handlers for Rest request Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes typos Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Removes references to ReplaceNamedRouteHandlers and DeprecatedNamedRouteHandlers Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Addresses PR feedback Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Refactors ReplacedRoute and deprecated route handlers to use RestResponse Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Forces httpcore5 to 5.2.2 Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates documentation Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Addresses PR feedback Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes broken reference due to changes in core 52a5e3f6e0ca599e3193807134ea42660ecdd195 Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Removes extra resolutionStrategy Signed-off-by: Darshit Chanpura <dchanp@amazon.com> --------- Signed-off-by: Craig Perkins <cwperx@amazon.com> Signed-off-by: Darshit Chanpura <dchanp@amazon.com> Co-authored-by: Craig Perkins <cwperx@amazon.com> (cherry picked from commit 09c22b0)
DarshitChanpura
requested review from
dbwiddis,
joshpalis,
owaiskazi19,
ryanbogan and
saratvemulapalli
as code owners
Member
|
Looks like the Integ Test fix from original doesn't work on backport.... |
Member
Author
|
I've created the backport for the integ test fix: opensearch-project/OpenSearch#8588 |
dbwiddis
approved these changes
Jul 10, 2023
owaiskazi19
approved these changes
Jul 10, 2023
Member
|
Before we merge this backport : #827 (comment) |
Member
Author
Addressed in a separate PR to main: #868 Will cherry-pick the changes into this branch once that PR is merged |
DarshitChanpura
force-pushed
the
backport/backport-827-to-1.x
branch
from
a076730 to
ebd13ad
Compare
Member
|
@DarshitChanpura #868 has been merged |
…ject#868) * Renames demo extension to `helloWorld` Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates uniqueId to not reflect the change Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Adds a validation check for setting extension name Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes checkstyle errors Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Adds routePrefix as an optional setting in .yml Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates dev guide to add documentation for the optional setting `routePrefix` Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Renames `routePrefix` to `routeNamePrefix` Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Renames erroneous instance of `hello-world` Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Addresses PR feedback Signed-off-by: Darshit Chanpura <dchanp@amazon.com> (cherry picked from commit 0103ada30250693c7b986a9667fd0060b414a66e) * Changes allowed route name prefixes Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes error message and removes hyphen from allowed characters in route name prefix Signed-off-by: Darshit Chanpura <dchanp@amazon.com> --------- Signed-off-by: Darshit Chanpura <dchanp@amazon.com> (cherry picked from commit 9e31418)
DarshitChanpura
changed the title
Member
Author
|
@joshpalis @dbwiddis @owaiskazi19 @saratvemulapalli All relevant changes from |
joshpalis
approved these changes
Jul 11, 2023
dbwiddis
approved these changes
Jul 11, 2023
DarshitChanpura
added a commit
to DarshitChanpura/opensearch-sdk-java
that referenced
this pull request
Jul 11, 2023
…pensearch-project#827) and Makes route prefix setting routeNamePrefix optional opensearch-project#868 (opensearch-project#866)" This reverts commit 32d6567.
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 <dchanp@amazon.com>
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 <dchanp@amazon.com> * Updates extension() method call in build.gradle Signed-off-by: Darshit Chanpura <dchanp@amazon.com> --------- Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
caokyhieu
pushed a commit
to caokyhieu/opensearch-sdk-java
that referenced
this pull request
Aug 15, 2025
…h-project#827) and Makes route prefix setting routeNamePrefix optional opensearch-project#868 (opensearch-project#866) * Register new routes via SDK as named routes (opensearch-project#827) * WIP on Handler naming and SSL Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add concept of extension shortname via settings Signed-off-by: Craig Perkins <cwperx@amazon.com> * WIP on extension ssl Signed-off-by: Craig Perkins <cwperx@amazon.com> * Get registry from runner Signed-off-by: Craig Perkins <cwperx@amazon.com> * Read settings from extension config file Signed-off-by: Craig Perkins <cwperx@amazon.com> * Update license headers Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove authz changes and only keep TLS Signed-off-by: Craig Perkins <cwperx@amazon.com> * Update cert generation documents Signed-off-by: Craig Perkins <cwperx@amazon.com> * Re-add authz changes for sample Hello world extension Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add ssl.transport.enabled in ExtensionsRunner Signed-off-by: Craig Perkins <cwperx@amazon.com> * Name all HelloWorld extension routes Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Merge main into branch Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add instructions for running in SSL only mode Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add all SSL settings to extension settings Signed-off-by: Craig Perkins <cwperx@amazon.com> * Update TestExtensionsRunner Signed-off-by: Craig Perkins <cwperx@amazon.com> * Set default enforce_hostname_verification Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Respond to code review feedback Signed-off-by: Craig Perkins <cwperx@amazon.com> * fix merge conflicts Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix typos in debug messages Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add docstrings Signed-off-by: Craig Perkins <cwperx@amazon.com> * Address code review feedback Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove duplicate Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove duplicate Signed-off-by: Craig Perkins <cwperx@amazon.com> * Create ExtensionRouteHandlerFactory Signed-off-by: Craig Perkins <cwperx@amazon.com> * Remove extension: from action naming Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add javadoc Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix test compilation errors Signed-off-by: Craig Perkins <cwperx@amazon.com> * Consolidate registerHandler Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix missed registerHandler usage Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix javadoc Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add method to check if class is initialized Signed-off-by: Craig Perkins <cwperx@amazon.com> * Fix failing tests Signed-off-by: Craig Perkins <cwperx@amazon.com> * Update helloworld-settings Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Run spotlessApply Signed-off-by: Craig Perkins <cwperx@amazon.com> * Add shortExtensionName to BaseExtensionRouteHandler Signed-off-by: Craig Perkins <cwperx@amazon.com> * Adds support for legacy action names while registering extension routes on extension start up Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Modifies sample hello extension to conform to the new registration scheme Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Renames route handlers Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Adds certificate generation script Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes spotless errors Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes Javadoc Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Cleans up route handlers to be more readable and adds an interface Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates test to reflect changes in route handler signatures Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes slf4j gradle build issue Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes replaced named route tests Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Changes the way named routes are serialized to conform to core and fixes tests Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Removes mention of shortNames and uses extensionName as permission prefix Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Used builder for named routes Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes broken changes Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates dev guide to state to use credentials when registering extension while security is enabled Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Replaces NamedRouteHandler and update logic to map route handlers for Rest request Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes typos Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Removes references to ReplaceNamedRouteHandlers and DeprecatedNamedRouteHandlers Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Addresses PR feedback Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Refactors ReplacedRoute and deprecated route handlers to use RestResponse Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Forces httpcore5 to 5.2.2 Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates documentation Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Addresses PR feedback Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes broken reference due to changes in core 52a5e3f6e0ca599e3193807134ea42660ecdd195 Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Removes extra resolutionStrategy Signed-off-by: Darshit Chanpura <dchanp@amazon.com> --------- Signed-off-by: Craig Perkins <cwperx@amazon.com> Signed-off-by: Darshit Chanpura <dchanp@amazon.com> Co-authored-by: Craig Perkins <cwperx@amazon.com> (cherry picked from commit 09c22b0) * Makes route prefix setting `routeNamePrefix` optional (opensearch-project#868) * Renames demo extension to `helloWorld` Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates uniqueId to not reflect the change Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Adds a validation check for setting extension name Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes checkstyle errors Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Adds routePrefix as an optional setting in .yml Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates dev guide to add documentation for the optional setting `routePrefix` Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Renames `routePrefix` to `routeNamePrefix` Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Renames erroneous instance of `hello-world` Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Addresses PR feedback Signed-off-by: Darshit Chanpura <dchanp@amazon.com> (cherry picked from commit 0103ada30250693c7b986a9667fd0060b414a66e) * Changes allowed route name prefixes Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Fixes error message and removes hyphen from allowed characters in route name prefix Signed-off-by: Darshit Chanpura <dchanp@amazon.com> --------- Signed-off-by: Darshit Chanpura <dchanp@amazon.com> (cherry picked from commit 9e31418)
caokyhieu
pushed a commit
to caokyhieu/opensearch-sdk-java
that referenced
this pull request
Aug 15, 2025
…pensearch-project#827) and Makes route prefix setting routeNamePrefix optional opensearch-project#868" (opensearch-project#877) * Revert "[Backport 1.x] Register new routes via SDK as named routes (opensearch-project#827) and Makes route prefix setting routeNamePrefix optional opensearch-project#868 (opensearch-project#866)" This reverts commit 32d6567. Signed-off-by: Darshit Chanpura <dchanp@amazon.com> * Updates extension() method call in build.gradle Signed-off-by: Darshit Chanpura <dchanp@amazon.com> --------- Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.