HSEARCH-5464 Pluggable rest clients in the elasticsearch backend #4798

marko-bekhta · 2025-09-09T12:16:18Z

https://hibernate.atlassian.net/browse/HSEARCH-5464

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.

marko-bekhta

Hey @yrodiere @lucamolteni 🙂 👋🏻

I've added some comments here and there in this PR in places that may be of interest.
Otherwise there's a lot of "noise", from moving packages and renaming.

This PR doesn't include the docs+migration guide updates. I was thinking about sending that separately, as this already has a lot of changes 🙂.

...java/org/hibernate/search/backend/elasticsearch/client/common/spi/ElasticsearchResponse.java

...ain/java/org/hibernate/search/backend/elasticsearch/client/common/gson/spi/GsonProvider.java

...bernate/search/backend/elasticsearch/client/ElasticsearchHttpClientConfigurationContext.java

...tiontest/backend/elasticsearch/client/ElasticsearchClientFactoryImplElasticsearchJavaIT.java

...te/search/backend/elasticsearch/client/java/ElasticsearchHttpClientConfigurationContext.java

...search/backend/elasticsearch/client/common/cfg/ElasticsearchBackendClientCommonSettings.java

...e/search/backend/elasticsearch/client/common/spi/ElasticsearchRequestInterceptorContext.java

...ernate/search/backend/elasticsearch/client/rest5/impl/ClientRest5HttpRequestInterceptor.java

...a/org/hibernate/search/backend/elasticsearch/client/opensearch/rest/impl/GsonHttpEntity.java

...ava/org/hibernate/search/backend/elasticsearch/client/ElasticsearchHttpClientConfigurer.java

yrodiere

I can't review it all but I went through your comments and a bit more, here's what I have to say :)

It's really a shame we can't have a dependency from clients to backend...

This PR doesn't include the docs+migration guide updates. I was thinking about sending that separately, as this already has a lot of changes 🙂.

Since the docs changes would be in very isolated files, you might as well add these changes here :)

...ain/java/org/hibernate/search/backend/elasticsearch/client/common/gson/spi/GsonProvider.java

backend/elasticsearch-client/elasticsearch-java-client/pom.xml

...te/search/backend/elasticsearch/client/java/ElasticsearchHttpClientConfigurationContext.java

backend/elasticsearch-client/elasticsearch-rest-client/pom.xml

...java/org/hibernate/search/backend/elasticsearch/client/common/spi/ElasticsearchResponse.java

...c/main/java/org/hibernate/search/backend/elasticsearch/impl/ElasticsearchBackendFactory.java

...search/backend/elasticsearch/client/common/cfg/ElasticsearchBackendClientCommonSettings.java

backend/elasticsearch-client/opensearch-rest-client/pom.xml

backend/elasticsearch-client/common/pom.xml

marko-bekhta · 2025-10-23T13:42:20Z

Thanks for having a look!

Since the docs changes would be in very isolated files, you might as well add these changes here :)

ohh I already did 🫣 🙂 here:
2e6dca2

at the time I didn't want to prevent anyone from looking at the PR waiting for the docs, but as I had some "free time" since then 😁 I managed to push the change here 😄

yrodiere · 2025-10-23T13:53:03Z

I had some "free time"

I envy your time management skills. Honestly.

yrodiere

Some more comments on the docs. Looks great :)

documentation/src/main/asciidoc/migration/index.adoc

documentation/src/main/asciidoc/public/reference/_backend-elasticsearch.adoc

documentation/src/main/asciidoc/migration/index.adoc

since the behavior of this client is slightly different

…plement the clients as dependencies

…he backend and remove the client-common

…ackend

sonarqubecloud · 2025-11-12T22:52:03Z

Quality Gate failed

Failed conditions
73.9% Coverage on New Code (required ≥ 80%)
16.1% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

marko-bekhta force-pushed the feat/HSEARCH-5464-Groundwork-for-pluggable-rest-clients-in-the-Elasticsearch-backend branch 7 times, most recently from aac26ce to 1d41060 Compare September 10, 2025 14:31

marko-bekhta force-pushed the feat/HSEARCH-5464-Groundwork-for-pluggable-rest-clients-in-the-Elasticsearch-backend branch 3 times, most recently from 3da3726 to 610c554 Compare September 16, 2025 21:10

marko-bekhta force-pushed the feat/HSEARCH-5464-Groundwork-for-pluggable-rest-clients-in-the-Elasticsearch-backend branch 3 times, most recently from e91fd98 to ae10272 Compare October 16, 2025 08:29

marko-bekhta commented Oct 16, 2025

View reviewed changes

marko-bekhta force-pushed the feat/HSEARCH-5464-Groundwork-for-pluggable-rest-clients-in-the-Elasticsearch-backend branch from e347a5f to 2e6dca2 Compare October 16, 2025 20:30

yrodiere reviewed Oct 23, 2025

View reviewed changes

marko-bekhta force-pushed the feat/HSEARCH-5464-Groundwork-for-pluggable-rest-clients-in-the-Elasticsearch-backend branch 8 times, most recently from d4e3fce to b805101 Compare October 25, 2025 21:07

marko-bekhta added 3 commits November 12, 2025 10:14

HSEARCH-5464 Remove the apache host from ElasticsearchResponse

12df7fa

HSEARCH-5464 Move out client common classes

8a2f651

HSEARCH-5464 Remove dependency on ES version class in the client code

b55cdae

marko-bekhta added 21 commits November 12, 2025 10:14

HSEARCH-5464 Continue factoring out the Client

2b8a46b

HSEARCH-5464 OpenSearch client

98be8f2

HSEARCH-5464 Elasticsearch-java client

b233d76

HSEARCH-5464 Test different clients

99829f7

HSEARCH-5464 Rename the clients

46dcd5e

HSEARCH-5464 Adjust elasticsearch-java tests

0265ffe

since the behavior of this client is slightly different

HSEARCH-5464 Fix aggregated javadocs and dependency alignment

7bbd391

HSEARCH-5464 More renames to address JQAssistant rules

9fa1417

HSEARCH-5464 Explicitly list the apache http client libs we use to im…

ae517ef

…plement the clients as dependencies

HSEARCH-5464 Push client specific settings to client modules

4f34aea

HSEARCH-5464 Make AWS signing compatible with other client impls

76dfab4

HSEARCH-5464 Adjust search-util-common exports

5bb0448

HSEARCH-5464 Add missing platform dependencies

40e92a8

HSEARCH-5464 Add a few notes on the new pluggable clients

0576d04

HSEARCH-5464 Move (most of) the elasticsearch-client-rest back into t…

64fbea2

…he backend and remove the client-common

HSEARCH-5464 Address some of the review comments

8e5cec1

HSEARCH-5464 Switch to the new elasticsearch-rest5-client

7cc3d5a

HSEARCH-5464 Rename Elasticsearch clients and their packages

d00fa96

HSEARCH-5464 Clarify a few points in the docs

65d49d3

HSEARCH-5464 Mark rest5 and opensearch clients as incubating

29e679a

HSEARCH-5464 Finish with renaming and JQAssistant

c399484

marko-bekhta force-pushed the feat/HSEARCH-5464-Groundwork-for-pluggable-rest-clients-in-the-Elasticsearch-backend branch from 3152541 to 20de88e Compare November 12, 2025 09:16

marko-bekhta marked this pull request as ready for review November 12, 2025 09:17

marko-bekhta added 2 commits November 12, 2025 21:50

HSEARCH-5464 Move around gson entity to keep the common code in the b…

d5f37ba

…ackend

HSEARCH-5464 Change how non-default JDK tests are executed

d32db4d

marko-bekhta force-pushed the feat/HSEARCH-5464-Groundwork-for-pluggable-rest-clients-in-the-Elasticsearch-backend branch from 203a90a to d32db4d Compare November 12, 2025 20:50

marko-bekhta merged commit 7770bd2 into hibernate:main Nov 13, 2025
7 of 8 checks passed

Uh oh!

HSEARCH-5464 Pluggable rest clients in the elasticsearch backend #4798

HSEARCH-5464 Pluggable rest clients in the elasticsearch backend #4798

Uh oh!

Conversation

marko-bekhta commented Sep 9, 2025

Uh oh!

marko-bekhta left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yrodiere left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marko-bekhta commented Oct 23, 2025

Uh oh!

yrodiere commented Oct 23, 2025

Uh oh!

yrodiere left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Nov 12, 2025

Quality Gate failed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants