Expose RestController all handlers iterator. #11876

dblock · 2024-01-12T19:43:14Z

Description

Coming from #11843, expose just enough methods to be able to move that plugin implementation out of OpenSearch core.

Adds PathTrie#retrieveAll, an lazy-ish exhaustive iterator traversing the trie structure.
Make public MethodHandlers#getPath and getValidMethods.
Adds RestController#getAllHandlers() returning a method handlers iterator.

Related Issues

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
Commits are signed per the DCO using --signoff
Commit changes are listed out in CHANGELOG.md file (See: Changelog)
Public documentation issue/PR created

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 · 2024-01-12T19:58:16Z

Compatibility status:

Checks if related components are compatible with change 80063d9

Incompatible components

Incompatible components: [https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/performance-analyzer.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/cross-cluster-replication.git]

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/alerting.git]

github-actions · 2024-01-12T20:30:22Z

❕ Gradle check result for 7f5349b: UNSTABLE

TEST FAILURES:

      2 org.opensearch.cluster.routing.allocation.decider.DiskThresholdDeciderIT.testIndexCreateBlockIsRemovedWhenAnyNodesNotExceedHighWatermarkWithAutoReleaseEnabled
      1 org.opensearch.remotestore.RemoteIndexPrimaryRelocationIT.testPrimaryRelocationWhileIndexing

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

codecov · 2024-01-12T20:31:45Z

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Comparison is base (2f81c57) 71.33% compared to head (80063d9) 71.47%.
Report is 3 commits behind head on main.

Files	Patch %	Lines
...main/java/org/opensearch/common/path/PathTrie.java	78.94%	2 Missing and 2 partials ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #11876      +/-   ##
============================================
+ Coverage     71.33%   71.47%   +0.13%     
- Complexity    59362    59433      +71     
============================================
  Files          4923     4923              
  Lines        279189   279212      +23     
  Branches      40591    40595       +4     
============================================
+ Hits         199169   199560     +391     
+ Misses        63449    63032     -417     
- Partials      16571    16620      +49

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dblock · 2024-01-18T18:36:04Z

❌ Gradle check result for cc5133a: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

org.opensearch.search.sort.FieldSortIT.testSimpleSorts {p0={"search.concurrent_segment_search.enabled":"true"}}

#11929

Signed-off-by: dblock <dblock@amazon.com>

github-actions · 2024-01-18T19:05:57Z

❌ Gradle check result for 80063d9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

dblock · 2024-01-18T19:10:39Z

❌ Gradle check result for 80063d9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

#8947

github-actions · 2024-01-18T20:11:24Z

❌ Gradle check result for 80063d9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

dblock · 2024-01-18T20:17:40Z

❌ Gradle check result for 80063d9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

#11933

github-actions · 2024-01-18T20:38:54Z

❌ Gradle check result for 80063d9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

dblock · 2024-01-18T20:43:57Z

❌ Gradle check result for 80063d9: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?


> Task :plugins:transport-reactor-netty4:test
WARNING: Using incubator modules: jdk.incubator.vector

WARNING: A terminally deprecated method in java.lang.System has been called
WARNING: System::setSecurityManager has been called by org.gradle.api.internal.tasks.testing.worker.TestWorker (file:/home/ubuntu/.gradle/wrapper/dists/gradle-8.5-all/3zlzzgtsutfj0pbojr50n2l7z/gradle-8.5/lib/plugins/gradle-testing-****-8.5.jar)
WARNING: Please consider reporting this to the maintainers of org.gradle.api.internal.tasks.testing.worker.TestWorker
WARNING: System::setSecurityManager will be removed in a future release
Jan 18, 2024 8:27:54 PM sun.util.locale.provider.LocaleProviderAdapter <clinit>
WARNING: COMPAT locale provider will be removed in a future release

> Task :client:rest-high-level:asyncIntegTest
WARNING: Using incubator modules: jdk.incubator.vector

org.gradle.internal.remote.internal.ConnectException: Could not connect to server [ab4b7ead-95e2-434b-9d3f-1593704e0499 port:39181, addresses:[/127.0.0.1]]. Tried addresses: [/127.0.0.1].
	at org.gradle.internal.remote.internal.inet.TcpOutgoingConnector.connect(TcpOutgoingConnector.java:67)
	at org.gradle.internal.remote.internal.hub.MessageHubBackedClient.getConnection(MessageHubBackedClient.java:36)
	at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:103)
	at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:65)
	at worker.org.gradle.process.internal.worker.GradleWorkerMain.run(GradleWorkerMain.java:69)
	at worker.org.gradle.process.internal.worker.GradleWorkerMain.main(GradleWorkerMain.java:74)
Caused by: java.net.ConnectException: Connection refused
	at java.****/sun.nio.ch.Net.pollConnect(Native Method)
	at java.****/sun.nio.ch.Net.pollConnectNow(Net.java:682)
	at java.****/sun.nio.ch.SocketChannelImpl.finishTimedConnect(SocketChannelImpl.java:1191)
	at java.****/sun.nio.ch.SocketChannelImpl.blockingConnect(SocketChannelImpl.java:1233)
	at java.****/sun.nio.ch.SocketAdaptor.connect(SocketAdaptor.java:102)
	at org.gradle.internal.remote.internal.inet.TcpOutgoingConnector.tryConnect(TcpOutgoingConnector.java:81)
	at org.gradle.internal.remote.internal.inet.TcpOutgoingConnector.connect(TcpOutgoingConnector.java:54)
	... 5 more

#11935

github-actions · 2024-01-18T21:31:32Z

❕ Gradle check result for 80063d9: UNSTABLE

TEST FAILURES:

      3 org.opensearch.cluster.routing.allocation.decider.DiskThresholdDeciderIT.testIndexCreateBlockIsRemovedWhenAnyNodesNotExceedHighWatermarkWithAutoReleaseEnabled

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

dblock · 2024-01-18T22:01:12Z

Not sure why "Minimum approval count" is still yellow. @reta @andrross care to re-approve?

andrross · 2024-01-18T22:11:43Z

Not sure why "Minimum approval count" is still yellow. @reta @andrross care to re-approve?

@dblock This approval mechanism is reset when you push a new commit, so you need to have approval on the latest commit in the PR to pass the check.

opensearch-trigger-bot · 2024-01-18T22:13:43Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-11876-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 6ccb46ba04b5d295af4c4da884068f1a5cf6cfba
# Push it to GitHub
git push --set-upstream origin backport/backport-11876-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-11876-to-2.x.

* Expose RestController all handlers iterator. Signed-off-by: dblock <dblock@amazon.com> * Extract MethodHandlers interface. Signed-off-by: dblock <dblock@amazon.com> * Added CHANGELOG. Signed-off-by: dblock <dblock@amazon.com> --------- Signed-off-by: dblock <dblock@amazon.com> (cherry picked from commit 6ccb46b)

…ch#11876. Signed-off-by: dblock <dblock@amazon.com>

* Expose RestController all handlers iterator. Signed-off-by: dblock <dblock@amazon.com> * Extract MethodHandlers interface. Signed-off-by: dblock <dblock@amazon.com> * Added CHANGELOG. Signed-off-by: dblock <dblock@amazon.com> --------- Signed-off-by: dblock <dblock@amazon.com>

* Expose RestController all handlers iterator. Signed-off-by: dblock <dblock@amazon.com> * Extract MethodHandlers interface. Signed-off-by: dblock <dblock@amazon.com> * Added CHANGELOG. Signed-off-by: dblock <dblock@amazon.com> --------- Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: Shivansh Arora <hishiv@amazon.com>

dblock added skip-changelog backport 2.x Backport to 2.x branch labels Jan 12, 2024

dblock mentioned this pull request Jan 12, 2024

[Draft] A plugin that dynamically generates an OpenAPI spec #11843

Closed

8 tasks

dblock added 3 commits January 18, 2024 13:36

Expose RestController all handlers iterator.

af14293

Signed-off-by: dblock <dblock@amazon.com>

Extract MethodHandlers interface.

c1ea9cc

Signed-off-by: dblock <dblock@amazon.com>

Added CHANGELOG.

80063d9

Signed-off-by: dblock <dblock@amazon.com>

dblock force-pushed the api-plugin-rest-methods branch from cc5133a to 80063d9 Compare January 18, 2024 18:37

dblock requested review from andrross and reta January 18, 2024 22:01

andrross approved these changes Jan 18, 2024

View reviewed changes

andrross merged commit 6ccb46b into opensearch-project:main Jan 18, 2024
42 checks passed

opensearch-trigger-bot bot added the backport-failed label Jan 18, 2024

dblock mentioned this pull request Jan 18, 2024

[Backport 2.x] Expose RestController all handlers iterator. (#11876) #11940

Merged

8 tasks

dblock added a commit to dblock/opensearch-api that referenced this pull request Jan 19, 2024

Rebased to use public interfaces added in opensearch-project/OpenSear…

5adec70

…ch#11876. Signed-off-by: dblock <dblock@amazon.com>

BrewTestBot mentioned this pull request Feb 21, 2024

opensearch 2.12.0 Homebrew/homebrew-core#163463

Merged

dblock mentioned this pull request Mar 6, 2024

Add methods to RestController to test Rest Paths and unregister them #6395

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose RestController all handlers iterator. #11876

Expose RestController all handlers iterator. #11876

dblock commented Jan 12, 2024 •

edited

Loading

github-actions bot commented Jan 12, 2024 •

edited

Loading

github-actions bot commented Jan 12, 2024

codecov bot commented Jan 12, 2024 •

edited

Loading

dblock commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

dblock commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

dblock commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

dblock commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

dblock commented Jan 18, 2024

andrross commented Jan 18, 2024

opensearch-trigger-bot bot commented Jan 18, 2024

Expose RestController all handlers iterator. #11876

Expose RestController all handlers iterator. #11876

Conversation

dblock commented Jan 12, 2024 • edited Loading

Description

Related Issues

Check List

github-actions bot commented Jan 12, 2024 • edited Loading

Compatibility status:

Incompatible components

Skipped components

Compatible components

github-actions bot commented Jan 12, 2024

codecov bot commented Jan 12, 2024 • edited Loading

Codecov Report

dblock commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

dblock commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

dblock commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

dblock commented Jan 18, 2024

github-actions bot commented Jan 18, 2024

dblock commented Jan 18, 2024

andrross commented Jan 18, 2024

opensearch-trigger-bot bot commented Jan 18, 2024

dblock commented Jan 12, 2024 •

edited

Loading

github-actions bot commented Jan 12, 2024 •

edited

Loading

codecov bot commented Jan 12, 2024 •

edited

Loading