[Feature request] - Whole operation timeout

[fededonna]

Hi, I'm working on an application that needs to check the entire request-response cycle time spent and set a max for that. It could be a good thing to add a timeout for the complete operation instead of one for connection, one for read and one for right.

Thanks in advance.

[swankjesse]

Yep. Let's do something for this.

[JakeWharton]

If you happen to be using Retrofit with its RxJava call adapter you can already get this for free:

interface MyService {
  @GET("/user")
  Observable<User> getUser();
}

MyService service = // ...
service.getUser()
  .timeout(2, SECONDS) // covers sending the request and waiting for the response
  .subscribe(..);

[fededonna]

I'm no using retrofit. I just want to create a client with a timeout for the whole operation.

[tobinibot]

I’d also be interested in a whole operation timeout.

[ericcj]

We successfully implemented a deadline for both the request and response body reading by subclassing Call in our application in production: https://gist.github.com/ericcj/49118c877f471b3d8d53db545160e4ac

Looks like there have been a couple related implementations, one inside the HTTP codecs (#2729) and a simple solution for just the body reading (#1130).

Much of it could also be implemented in an interceptor, except that we would have to close the socket instead of calling the more precise cancel method and it wouldn't cover the seemingly infinite retries on IOExceptions getting a connection in RetryAndFollowUpInterceptor which does while (true) until if (canceled) throw.

Note that we also have a separate interceptor to timeout DNS (https://gist.github.com/ericcj/a4e5c99982d36d3348ff3c732fa51038) since even our deadline doesn't cover that as per #95 although now using the new Dns interface would be preferable.

[robbiepl]

Will this functionality be implemented?

[robbiepl]

we waiting ... :))

[fededonna]

@swankjesse any update regarding this issue? Thanks in advance.

[swankjesse]

We can probably just hook up AsyncTimeout to call Call.cancel(). Heck, we could even make Call work like Source and Sink so it can be adjusted independent of the client.

  /** Returns the timeout for this call */
  Timeout timeout();

[swankjesse]

Next steps:

• Pick a default value (none? 60 seconds?)
• Configuration on OkHttpClient.Builder
• Confirm it does something reasonable for web sockets and SSE

[swankjesse]

Our initial timeout needs to be no-timeout. Otherwise upgrading is made very difficult when the code-being-upgraded doesn’t expose its OkHttpClient instance to be configured. For example, if the use of OkHttp is an implementation detail of a 3rd party SDK.

[swankjesse]

#4369

[swankjesse]

Fixed!