feat: add support for lazy refresh #606
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alloydb-jdbc-connector/src/main/java/com/google/cloud/alloydb/ConnectorConfig.java
Show resolved
Hide resolved
...jdbc-connector/src/main/java/com/google/cloud/alloydb/DefaultConnectionInfoCacheFactory.java
Show resolved
Hide resolved
| @@ -30,7 +31,8 @@ public class AlloyDbJdbcNamedConnectorDataSourceFactory { | |||
| static HikariDataSource createDataSource() { | |||
|
|
|||
| // Register a named Connector | |||
| ConnectorConfig namedConnectorConfig = new ConnectorConfig.Builder().build(); | |||
| ConnectorConfig namedConnectorConfig = | |||
| new ConnectorConfig.Builder().withRefreshStrategy(RefreshStrategy.LAZY).build(); | |||
There was a problem hiding this comment.
Why are we changing this to use a lazy cache?
There was a problem hiding this comment.
+1, it'd be interesting to know. I see this is only used in the ITPscTest.java test
There was a problem hiding this comment.
We should have one integration test covering lazy refresh. While we could introduce yet another integration test, there are already a handful of integration tests that aren't so different from each other. So rather than make our test suite a little slower with another duplicate test, I opted to just ensure one of our existing integration tests uses lazy refresh.
nancynh
reviewed
Jan 16, 2025
alloydb-jdbc-connector/src/main/java/com/google/cloud/alloydb/LazyConnectionInfoCache.java
Show resolved
Hide resolved
| @@ -30,7 +31,8 @@ public class AlloyDbJdbcNamedConnectorDataSourceFactory { | |||
| static HikariDataSource createDataSource() { | |||
|
|
|||
| // Register a named Connector | |||
| ConnectorConfig namedConnectorConfig = new ConnectorConfig.Builder().build(); | |||
| ConnectorConfig namedConnectorConfig = | |||
| new ConnectorConfig.Builder().withRefreshStrategy(RefreshStrategy.LAZY).build(); | |||
There was a problem hiding this comment.
+1, it'd be interesting to know. I see this is only used in the ITPscTest.java test
By default the connector will continue to use a refresh ahead strategy, where client certificates are refreshed by a background thread. The lazy strategy by comparison is useful for when the Connector runs in serverless environments and background threads may not run reliably, e.g., when the CPU is throttled. This commit adds the lazy refresh strategy and updates the configuration documentation to demonstrate how to use the feature. Fixes #565
rhatgadkar-goog
approved these changes
Jan 17, 2025
nancynh
approved these changes
Jan 17, 2025
alloydb-jdbc-connector/src/main/java/com/google/cloud/alloydb/LazyConnectionInfoCache.java
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By default the connector will continue to use a refresh ahead strategy, where client certificates are refreshed by a background thread. The lazy strategy by comparison is useful for when the Connector runs in serverless environments and background threads may not run reliably, e.g., when the CPU is throttled.
This commit adds the lazy refresh strategy and updates the configuration documentation to demonstrate how to use the feature.
Fixes #565