Skip to content

Exponential backoff can't be enabled for clients with credentials #2512

Open
@dtrg

Description

@dtrg

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

, 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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: p3Desirable enhancement or fix. May not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions