Add HttpClient based implementation of HttpTransportFactory #1015
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
An implementation of the GCP SDK API `HttpTransportFactory` is added that internally uses the default Micronaut `HttpClient`. This API is used by the GCP `GoogleCredentials` for refreshing OAuth tokens for use in API calls. This implementation adds enhanced logging of token refresh requests that is useful in debugging misconfigured credentials. Using the default `HttpClient` also allows the potential for setting timeouts and other such properties via typical Micronaut configuration. The implementation uses the blocking version of the `HttpClient` API. This is safe to use in this case as the GCP library is already executing these tasks using its own managed threads, so these requests should not block the main Micronaut event loop. The implementation is only activated if `HttpClient` is found to be on the classpath. If it is not, the default implementation provided by the SDK will be used instead.
timyates
suggested changes
Jan 12, 2024
gcp-common/src/test/groovy/io/micronaut/gcp/credentials/GoogleCredentialsFactorySpec.groovy
Outdated
Show resolved
Hide resolved
Co-authored-by: Tim Yates <tim.yates@gmail.com>
timyates
approved these changes
Jan 12, 2024
sdelamo
requested changes
Jan 13, 2024
|
@jeremyg484 can you merge master into this? |
Done. |
sdelamo
approved these changes
Jan 25, 2024
| @@ -111,4 +119,11 @@ public void close() throws Exception { | |||
| } | |||
| } | |||
| } | |||
|
|
|||
| boolean isRunning(ProjectSubscriptionName subscriptionName) { | |||
There was a problem hiding this comment.
It is weird to expose a method only to be used in a test.
gcp-common/src/main/java/io/micronaut/gcp/credentials/GoogleCredentialsFactory.java
Show resolved
Hide resolved
gcp-common/src/main/java/io/micronaut/gcp/credentials/GoogleCredentialsConfiguration.java
Show resolved
Hide resolved
gcp-common/src/main/java/io/micronaut/gcp/credentials/DefaultOAuth2HttpTransportFactory.java
Show resolved
Hide resolved
gcp-common/src/main/java/io/micronaut/gcp/credentials/OAuth2MessageBodyWriter.java
Show resolved
Hide resolved
sdelamo
approved these changes
Jan 25, 2024
|
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.
An implementation of the GCP SDK API
HttpTransportFactoryis added that internally uses the default MicronautHttpClient. This API is used by the GCPGoogleCredentialsfor refreshing OAuth tokens for use in API calls. Thisimplementation adds enhanced logging of token refresh requests that is useful in debugging misconfigured
credentials. Using the default
HttpClientalso allows the potential for setting timeouts and other such propertiesvia typical Micronaut configuration.
The implementation uses the blocking version of the
HttpClientAPI. This is safe to use in this case as the GCPlibrary is already executing these tasks using its own managed threads, so these requests should not block the main
Micronaut event loop.
The implementation is only activated if
HttpClientis found to be on the classpath. If it is not, the defaultimplementation provided by the SDK will be used instead.
This is initially most useful as a replacement for the enhanced logging that was being done in the problematic
AuthenticationLoggingInterceptor. As the tests show, this approach allows theGoogleCredentialsAPI to still be used to its full extent by end users as needed.