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

Add a "builder" (chained setters) API to the ConnectionFactory class #1139

Open
doukhahmed opened this issue Oct 20, 2023 · 2 comments
Open
Assignees

Comments

@doukhahmed
Copy link

Is your feature request related to a problem? Please describe.

Add a builder() method to the ConnectionFactory class in the RabbitMQ client library to make it easier to create instances of the ConnectionFactory class with custom configurations.

Describe the solution you'd like

The RabbitMQ client library does not provide a builder() method for the ConnectionFactory class, which can make it difficult to create instances of the ConnectionFactory class with custom configurations. This feature request is to add a builder() method to the ConnectionFactory class that provides a more concise and readable way to configure the ConnectionFactory instance with custom settings.

Describe alternatives you've considered

No response

Additional context

No response

@lukebakken
Copy link
Contributor

@doukhahmed feel free to submit a pull request to implement this feature. Be sure to include tests. Thanks.

@lukebakken lukebakken self-assigned this Oct 22, 2023
@acogoluegnes
Copy link
Contributor

I think we could indeed make the configuration of ConnectionFactory easier. Using the builder terminology would be a bit awkward to me (a builder for a factory), so another term like Configuration could be more appropriate, even though we follow a builder pattern.

It could be fluent and have sub-components for different parts of the configuration, like TLS, this way related settings are not scattered in a large class.

It could be an addition to the library that does not change ConnectionFactory, to avoid breaking changes.

acogoluegnes added a commit that referenced this issue Jan 29, 2024
The ConnectionFactory class has dozens of parameters.
It can be overwhelming to configure, especially
for tricky topics like TLS where the parameters are among
the other dozens, without clear way to find them.

This commit introduces an API to simplify the configuration
of ConnectionFactory. It is fluent, uses modern API (e.g. Duration
for timeout), and groups common settings in sub-API.

The configuration API will be introduced in 5.x, marked as experimental,
and refined in minor releases.

The traditional setter-based API will be marked deprecated 6.x and
removed in 7.x.

Benefits of the new configuration API:
* fluent, the method calls can be chained and formatted in a logical
way (it does not have to be 1 line = 1 parameter).
* the different timeout settings use the Duration type, instead of
int. It is no longer necessary to know the unit (seconds or
milliseconds).
* parameters for the same topic are grouped into dedicated configuration
API (TLS, NIO, OAuth2, recovery, etc). It makes it much easier to
configure those parts, as available settings will show up automatically
in the IDE auto-completion, and not among the other dozens of settings.
* more opinionated but easier configuration. OAuth2 is an example:
no need to use builder classes with very long names, the refresh service
part is also in the #oauth2() sub-configuration, whereas it's a
separate setter in ConnectionFactory.

References #608, #1139
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants