feat: add pool_maxsize parameter to connection managers #651
Conversation
Introduces the `pool_maxsize` parameter to `KeycloakOpenID` and `KeycloakAdmin` classes, allowing control over the underlying connection pool size in the `ConnectionManager`. Adds corresponding tests to verify the parameter is correctly passed and stored for both synchronous and asynchronous clients.
|
Note, the failed tests seem to be unrelated to this change and have been failing in CI for a while. |
ryshoooo
left a comment
ryshoooo
left a comment
There was a problem hiding this comment.
Thanks a lot for the changes! Overall looks good to me, I can't spot anything breaking. I've only added a comment about the tests, ideally we want to keep the fixtures as simple as possible, there is no need to set the pool size for each fixture.
There was a problem hiding this comment.
Can we keep the fixtures minimal and just delete the pool_maxsize in here? (i.e. let the defaults take place). This way we can be sure that minimal configuration will keep working for most operations.
There was a problem hiding this comment.
Similar here. There's no need to set the pool max size for all these cases. 1 time is enough.
2 participants
Description
This PR adds a
pool_maxsizeparameter to theKeycloakOpenIDandKeycloakAdminclasses. This parameter is passed to the internalConnectionManager, allowing users to configure the maximum number of connections to keep in the connection pool.Motivation/Context
Controlling the connection pool size is important for managing resource usage and improving performance in applications that make frequent calls to Keycloak. By exposing this parameter, users of the library can fine-tune the connection behaviour to better suit their environment and workload, potentially reducing overhead from establishing new connections.
Should resolve: #630
Testing Evidence
pool_maxsizeparameter to relevant test fixtures intests/conftest.pywith a non-default value (5).tests/test_keycloak_openid.py(test_keycloak_openid_initandtest_a_well_known) to verifypool_maxsizeis correctly set on theConnectionManagerforKeycloakOpenID.tests/test_keycloak_admin.py(test_keycloak_admin_initandtest_a_realms) to verifypool_maxsizeis correctly set on theConnectionManagerforKeycloakAdmin.