googleapis / googleapis/google-api-java-client

Exponential backoff can't be enabled for clients with credentials

Open
#2,512 1 comment 0 reactions 0 assignees View on GitHub
priority: p3 type: feature request
Dominant language
Java
Stars
1.5k
Forks
772
Avg merge
1h 44m
Merged PRs (30d)
1

Description

Hello,

I've got a service which recently ran into issues. One of the AIs from the postmortem is that we should make sure that API client users use exponential backoff by default.

Currently, in order to enable exponential backoff you need to explicitly configure the HttpRequestInitializer object when creating the client interface. For example (from one of my tests):

```
var RETRYABLE_ERROR_CODES = ImmutableSet.of(403, 429);

return new Calendar.Builder(
transport,
GsonFactory.getDefaultInstance(),
/* httpRequestInitializer= */ request ->
request.setUnsuccessfulResponseHandler(
new HttpBackOffUnsuccessfulResponseHandler(new ExponentialBackOff())
.setBackOffRequired(
r -> RETRYABLE_ERROR_CODES.contains(r.getStatusCode()))))
[...elided...]
.build();
```

Except, in real life you're passing a GoogleAccountCredential object as the HttpRequestInitializer. This sets its own unsuccessful response handler (set in https://github.com/googleapis/google-api-java-client/blob/dd333371990ced9c76faba443bdb1b3738915410/google-api-client-android/src/main/java/com/google/api/client/googleapis/extensions/android/gms/auth/GoogleAccountCredential.java#L152, with the request handler at the bottom of the same class). While this does have its own backoff configuration, this is used only for the Oauth token fetch, and the unsuccessful response handler can't be configured.

This all seems extremely wrong. I don't see a way in which a client can use a credential _and_ configure exponential backoff, let alone by default. Our examples (e.g. https://developers.google.com/api-client-library/java) don't include any form of exponential backoff; I had to debug my way through the client code to find out it was supported at all.

Am I missing anything here?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.