Skip to content

Harmonize naming of Elasticsearch auto-configuration classes #20857

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

Closed
wants to merge 1 commit into from

Conversation

vpavic
Copy link
Contributor

@vpavic vpavic commented Apr 6, 2020

This PR harmonizes the naming of Elasticsearch auto-configuration components by including Elasticsearch in class names.

I've found the current naming to be very inconvenient to work with, since searching for Elasticsearch related auto-configuration components by entering ElasticsearchConfiguration or ElasticsearchProperties in IDEA's doesn't return some of vital components like RestClientAutoConfiguration and RestClientProperties - those two are especially harder to find this way since they're not in the same package as components that currently do have Elasticsearch in their name (org.springframework.boot.autoconfigure.elasticsearch.rest vs org.springframework.boot.autoconfigure.data.elasticsearch).

A good example of well-named (and therefore easily discoverable) auto-configuration components is org.springframework.boot.autoconfigure.session, where all components contain Session in their names.

Additionally, one further point of harmonization (that I didn't apply to this PR yet) could be to move components from org.springframework.boot.autoconfigure.elasticsearch.rest to simply org.springframework.boot.autoconfigure.elasticsearch - as reactive client components in org.springframework.boot.autoconfigure.data.elasticsearch aren't nested in rest subpackage.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Apr 6, 2020
@bclozel bclozel added the for: team-attention An issue we'd like other members of the team to review label Apr 7, 2020
@philwebb philwebb added type: enhancement A general enhancement and removed for: team-attention An issue we'd like other members of the team to review status: waiting-for-triage An issue we've not yet triaged labels Apr 8, 2020
@philwebb philwebb added this to the 2.3.x milestone Apr 8, 2020
@philwebb
Copy link
Member

philwebb commented Apr 8, 2020

Dropping the rest package at the same time seems like a good idea, we can do that when we merge this one.

@vpavic vpavic force-pushed the improve-es-config branch from 96ce07c to f6bd108 Compare April 8, 2020 15:38
@vpavic
Copy link
Contributor Author

vpavic commented Apr 8, 2020

Thanks for the feedback - I've applied the drop of rest package, the branch had conflicts from other things that landed to the master in the meantime so I was to update it anyway.

@bclozel bclozel self-assigned this Apr 10, 2020
@bclozel bclozel modified the milestones: 2.3.x, 2.3.0.RC1 Apr 11, 2020
@bclozel bclozel closed this in 8ad1b18 Apr 11, 2020
@vpavic vpavic deleted the improve-es-config branch April 11, 2020 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement A general enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants