Skip to content

Commit 9484c52

Browse files
chengzeyiclaude
andcommitted
Per-request-type read timeouts: GET 30s, submit 60s, upload 120s
Config.api.readTimeoutGet/Submit/Upload (env WAVESPEED_READ_TIMEOUT_GET/ _SUBMIT/_UPLOAD) replace the single 120s default. Config.api.readTimeout (WAVESPEED_READ_TIMEOUT, null default) overrides the three but never sync submit, which keeps no default timeout. The file PUT still has no call timeout. Explicit timeout semantics are unchanged. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
1 parent 4692655 commit 9484c52

6 files changed

Lines changed: 122 additions & 57 deletions

File tree

‎CLAUDE.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,10 @@ Global configuration via `Config.api`:
8181
- `baseUrl` - API base URL (default: https://api.wavespeed.ai)
8282
- `connectionTimeout` - Connection timeout in seconds (default: 10.0)
8383
- `timeout` - Overall wait limit in seconds (default: null = no limit; tasks may run for hours). When set, it also bounds each request
84-
- `readTimeout` - Read/call timeout of one async submit or result request when `timeout` is unset (default: 120.0; sync-mode submit has none). File upload requests use the same read timeout (the file PUT has no total-transfer deadline)
84+
- `readTimeoutGet` - Read/call timeout of one result query/GET when `timeout` is unset (default: 30.0)
85+
- `readTimeoutSubmit` - Same for the async submit POST (default: 60.0; a submit timeout is ambiguous, so more headroom)
86+
- `readTimeoutUpload` - Read timeout of each upload request, ticket and file PUT (default: 120.0; the file PUT has no total-transfer deadline)
87+
- `readTimeout` - Optional single override (default: null) replacing the three above; never applies to sync-mode submit, which has no default timeout
8588
- `maxRetries` - Task-level retries (default: 0)
8689
- `maxConnectionRetries` - HTTP connection retries (default: 5)
8790
- `retryInterval` - Base retry delay in seconds (default: 1.0)
@@ -104,7 +107,8 @@ Client client = new Client(
104107
- `WAVESPEED_BASE_URL` - Base URL (default: https://api.wavespeed.ai)
105108
- `WAVESPEED_CONNECTION_TIMEOUT` - Connection timeout (default: 10.0)
106109
- `WAVESPEED_TIMEOUT` - Overall wait limit (default: unset = no limit)
107-
- `WAVESPEED_READ_TIMEOUT` - Per-request read timeout (default: 120.0)
110+
- `WAVESPEED_READ_TIMEOUT` - Override for all per-request read timeouts except sync submit (default: unset)
111+
- `WAVESPEED_READ_TIMEOUT_GET` / `_SUBMIT` / `_UPLOAD` - Per-type defaults (30.0 / 60.0 / 120.0)
108112
- `WAVESPEED_MAX_RETRIES` - Task-level retries (default: 0)
109113
- `WAVESPEED_MAX_CONNECTION_RETRIES` - HTTP retries (default: 5)
110114
- `WAVESPEED_RETRY_INTERVAL` - Retry interval (default: 1.0)

‎src/main/java/ai/wavespeed/Config.java‎

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,33 @@ public static class Api {
5050
public Double timeout;
5151

5252
/**
53-
* Read and call timeout in seconds for a single async submit or
54-
* result-query request when no timeout is configured, so a hung
55-
* request fails on its own. Sync-mode submit is not subject to it.
56-
* Default: 120.0 (WAVESPEED_READ_TIMEOUT)
53+
* Optional single override for the per-request read timeout in seconds.
54+
* When set (or WAVESPEED_READ_TIMEOUT), it replaces the per-type defaults
55+
* below for result/GET queries, async submit and uploads. It never
56+
* applies to sync-mode submit. Default: null.
5757
*/
58-
public double readTimeout;
58+
public Double readTimeout;
59+
60+
/**
61+
* Read and call timeout in seconds of one result query or other
62+
* read-only GET when no timeout is configured.
63+
* Default: 30.0 (WAVESPEED_READ_TIMEOUT_GET)
64+
*/
65+
public double readTimeoutGet;
66+
67+
/**
68+
* Read and call timeout in seconds of the async submit POST when no
69+
* timeout is configured. A submit timeout is an ambiguous outcome, so it
70+
* gets more headroom. Default: 60.0 (WAVESPEED_READ_TIMEOUT_SUBMIT)
71+
*/
72+
public double readTimeoutSubmit;
73+
74+
/**
75+
* Read timeout in seconds for each upload request (ticket and file PUT)
76+
* when no timeout is configured. The file PUT has no total-transfer
77+
* deadline. Default: 120.0 (WAVESPEED_READ_TIMEOUT_UPLOAD)
78+
*/
79+
public double readTimeoutUpload;
5980

6081
/**
6182
* Maximum number of retries for the entire operation (task-level retries).
@@ -84,7 +105,10 @@ public Api() {
84105
this.baseUrl = getEnv("WAVESPEED_BASE_URL", "https://api.wavespeed.ai");
85106
this.connectionTimeout = getEnvDouble("WAVESPEED_CONNECTION_TIMEOUT", 10.0);
86107
this.timeout = getEnvDoubleOrNull("WAVESPEED_TIMEOUT");
87-
this.readTimeout = getEnvDouble("WAVESPEED_READ_TIMEOUT", 120.0);
108+
this.readTimeout = getEnvDoubleOrNull("WAVESPEED_READ_TIMEOUT");
109+
this.readTimeoutGet = getEnvDouble("WAVESPEED_READ_TIMEOUT_GET", 30.0);
110+
this.readTimeoutSubmit = getEnvDouble("WAVESPEED_READ_TIMEOUT_SUBMIT", 60.0);
111+
this.readTimeoutUpload = getEnvDouble("WAVESPEED_READ_TIMEOUT_UPLOAD", 120.0);
88112
this.maxRetries = getEnvInt("WAVESPEED_MAX_RETRIES", 0);
89113
this.maxConnectionRetries = getEnvInt("WAVESPEED_MAX_CONNECTION_RETRIES", 5);
90114
this.retryInterval = getEnvDouble("WAVESPEED_RETRY_INTERVAL", 1.0);

‎src/main/java/ai/wavespeed/api/Client.java‎

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public Client(
9494
this.httpClient = new OkHttpClient.Builder()
9595
.retryOnConnectionFailure(false)
9696
.connectTimeout((long) (connTimeout * 1000), TimeUnit.MILLISECONDS)
97-
.readTimeout((long) (Config.api.readTimeout * 1000), TimeUnit.MILLISECONDS)
97+
.readTimeout((long) (readSeconds(Kind.GET) * 1000), TimeUnit.MILLISECONDS)
9898
.build();
9999

100100
this.gson = new Gson();
@@ -254,8 +254,8 @@ private SubmitResult submit(
254254
}
255255

256256
// Sync mode keeps this POST open until the task finishes, so it only has
257-
// a timeout when one is configured; async submit falls back to readTimeout.
258-
OkHttpClient callClient = requestClient(timeout, !enableSyncMode);
257+
// a timeout when one is configured; async submit falls back to its per-type read timeout.
258+
OkHttpClient callClient = requestClient(timeout, enableSyncMode ? Kind.SYNC_SUBMIT : Kind.SUBMIT);
259259

260260
Request request = addClientHeaders(new Request.Builder()
261261
.url(url)
@@ -330,23 +330,37 @@ static Double configuredTimeout(Double explicit) {
330330
return explicit != null ? explicit : Config.api.timeout;
331331
}
332332

333+
/** Request types with their own default read timeout. */
334+
enum Kind { GET, SUBMIT, UPLOAD, SYNC_SUBMIT }
335+
336+
/**
337+
* Default read timeout in seconds for a request type, or null for none.
338+
* Config.api.readTimeout (when set) overrides GET, SUBMIT and UPLOAD, never
339+
* SYNC_SUBMIT, which stays open until the task finishes.
340+
*/
341+
static Double readSeconds(Kind kind) {
342+
switch (kind) {
343+
case SYNC_SUBMIT: return null;
344+
case GET: return Config.api.readTimeout != null ? Config.api.readTimeout : Config.api.readTimeoutGet;
345+
case SUBMIT: return Config.api.readTimeout != null ? Config.api.readTimeout : Config.api.readTimeoutSubmit;
346+
default: return Config.api.readTimeout != null ? Config.api.readTimeout : Config.api.readTimeoutUpload;
347+
}
348+
}
349+
333350
/**
334351
* Per-request client. A configured timeout applies as connect (capped),
335-
* read and call timeout, as before. Without one, requests that are bounded
336-
* by default use Config.api.readTimeout for read and call; the others
337-
* (sync submit) have no read/call timeout (OkHttp 0 = none).
352+
* read and call timeout, as before. Without one, the type's default read
353+
* timeout applies as read and call; sync submit has none (OkHttp 0 = none).
338354
*/
339-
OkHttpClient requestClient(Double explicit, boolean boundedByDefault) {
355+
OkHttpClient requestClient(Double explicit, Kind kind) {
340356
Double configured = configuredTimeout(explicit);
357+
if (configured == null) {
358+
configured = readSeconds(kind);
359+
}
341360
if (configured != null) {
342361
double connect = Math.min(httpClient.connectTimeoutMillis() / 1000.0, configured);
343362
return perCallClient(connect, configured);
344363
}
345-
if (boundedByDefault) {
346-
double rt = Config.api.readTimeout;
347-
double connect = Math.min(httpClient.connectTimeoutMillis() / 1000.0, rt);
348-
return perCallClient(connect, rt);
349-
}
350364
return httpClient.newBuilder()
351365
.readTimeout(0, TimeUnit.MILLISECONDS)
352366
.callTimeout(0, TimeUnit.MILLISECONDS)
@@ -355,15 +369,15 @@ OkHttpClient requestClient(Double explicit, boolean boundedByDefault) {
355369

356370
/**
357371
* Client for the upload file PUT. A configured timeout behaves as for other
358-
* requests. By default read and write timeouts are Config.api.readTimeout
372+
* requests. By default read and write timeouts are the upload read timeout
359373
* (socket inactivity) and there is no call timeout, since callTimeout is a
360374
* total deadline that would abort a large upload that is still progressing.
361375
*/
362376
OkHttpClient uploadPutClient(Double explicit) {
363377
if (configuredTimeout(explicit) != null) {
364-
return requestClient(explicit, true);
378+
return requestClient(explicit, Kind.UPLOAD);
365379
}
366-
long ms = (long) (Config.api.readTimeout * 1000);
380+
long ms = (long) (readSeconds(Kind.UPLOAD) * 1000);
367381
return httpClient.newBuilder()
368382
.readTimeout(ms, TimeUnit.MILLISECONDS)
369383
.writeTimeout(ms, TimeUnit.MILLISECONDS)
@@ -388,7 +402,7 @@ private static boolean isRetryableStatus(int code) {
388402
*/
389403
private Map<String, Object> getResult(String requestId, Double timeout) {
390404
String url = this.baseUrl + "/api/v3/predictions/" + requestId + "/result";
391-
OkHttpClient callClient = requestClient(timeout, true);
405+
OkHttpClient callClient = requestClient(timeout, Kind.GET);
392406

393407
for (int retry = 0; retry <= maxConnectionRetries; retry++) {
394408
try {
@@ -699,7 +713,7 @@ public Map<String, Object> run(String model, Map<String, Object> input, double t
699713
* Upload a file to WaveSpeed.
700714
*
701715
* @param file File path string to upload
702-
* @param timeout Request timeout in seconds (null = Config.api.timeout; default: 120s read timeout per request, no total-transfer limit on the file PUT)
716+
* @param timeout Request timeout in seconds (null = Config.api.timeout; default: per-type read timeout, 120s for uploads with no total-transfer limit on the file PUT)
703717
* @return URL of the uploaded file
704718
* @throws IllegalArgumentException if API key is not configured
705719
* @throws IllegalArgumentException if file path does not exist
@@ -734,7 +748,7 @@ public String upload(String file, Double timeout) {
734748
// Ticket request: same bounded single-request timeouts as other requests.
735749
// The file PUT uses uploadPutClient(): an inactivity (read/write) timeout
736750
// without a total-transfer deadline, so a large progressing upload is not aborted.
737-
OkHttpClient callClient = requestClient(timeout, true);
751+
OkHttpClient callClient = requestClient(timeout, Kind.UPLOAD);
738752
OkHttpClient putClient = uploadPutClient(timeout);
739753

740754
Request request = addClientHeaders(new Request.Builder()

‎src/test/java/ai/wavespeed/ClientTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ void testPerCallTimeoutIsApplied() throws Exception {
290290
);
291291
long elapsedMs = System.currentTimeMillis() - start;
292292

293-
// Shared-client read timeout is Config.api.readTimeout (120s); only a
293+
// Shared-client read timeout is Config.api.readTimeoutGet (30s); only a
294294
// per-call timeout can fail this fast.
295295
assertTrue(elapsedMs < 10000,
296296
"per-call timeout not applied; call took " + elapsedMs + "ms");

‎src/test/java/ai/wavespeed/ConfigTest.java‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ void testApiConfigHasExpectedAttributes() {
1919
assertInstanceOf(String.class, Config.api.baseUrl);
2020
assertTrue(Config.api.connectionTimeout > 0);
2121
assertTrue(Config.api.timeout == null || Config.api.timeout > 0);
22-
assertTrue(Config.api.readTimeout > 0);
22+
assertTrue(Config.api.readTimeout == null || Config.api.readTimeout > 0);
23+
assertTrue(Config.api.readTimeoutGet > 0 && Config.api.readTimeoutSubmit > 0 && Config.api.readTimeoutUpload > 0);
2324
assertTrue(Config.api.maxRetries >= 0);
2425
assertTrue(Config.api.maxConnectionRetries >= 0);
2526
assertTrue(Config.api.retryInterval > 0);
@@ -31,7 +32,10 @@ void testApiConfigDefaultValues() {
3132
assertEquals("https://api.wavespeed.ai", Config.api.baseUrl);
3233
assertEquals(10.0, Config.api.connectionTimeout);
3334
assertNull(Config.api.timeout); // no overall cap by default
34-
assertEquals(120.0, Config.api.readTimeout);
35+
assertNull(Config.api.readTimeout);
36+
assertEquals(30.0, Config.api.readTimeoutGet);
37+
assertEquals(60.0, Config.api.readTimeoutSubmit);
38+
assertEquals(120.0, Config.api.readTimeoutUpload);
3539
assertEquals(0, Config.api.maxRetries);
3640
assertEquals(5, Config.api.maxConnectionRetries);
3741
assertEquals(1.0, Config.api.retryInterval);

‎src/test/java/ai/wavespeed/api/ClientTimeoutTest.java‎

Lines changed: 47 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,21 @@
1616
/** Timeout semantics: no default overall cap; bounded per-request defaults. */
1717
class ClientTimeoutTest {
1818
private Double savedTimeout;
19-
private double savedRead;
19+
private Double savedRead;
20+
private double sg, ss, su;
2021

2122
@BeforeEach
2223
void save() {
2324
savedTimeout = Config.api.timeout;
24-
savedRead = Config.api.readTimeout;
25+
savedRead = Config.api.readTimeout; sg = Config.api.readTimeoutGet; ss = Config.api.readTimeoutSubmit; su = Config.api.readTimeoutUpload;
2526
Config.api.timeout = null;
26-
Config.api.readTimeout = 120.0;
27+
Config.api.readTimeout = null;
2728
}
2829

2930
@AfterEach
3031
void restore() {
3132
Config.api.timeout = savedTimeout;
32-
Config.api.readTimeout = savedRead;
33+
Config.api.readTimeout = savedRead; Config.api.readTimeoutGet = sg; Config.api.readTimeoutSubmit = ss; Config.api.readTimeoutUpload = su;
3334
}
3435

3536
private static MockResponse submitOk() {
@@ -48,7 +49,10 @@ private Client client(MockWebServer server) {
4849
@Test
4950
void defaultConfigHasNoOverallCap() {
5051
assertNull(new ai.wavespeed.Config.Api().timeout); // fresh default (env unset)
51-
assertEquals(120.0, new Config.Api().readTimeout);
52+
assertNull(new Config.Api().readTimeout);
53+
assertEquals(30.0, new Config.Api().readTimeoutGet);
54+
assertEquals(60.0, new Config.Api().readTimeoutSubmit);
55+
assertEquals(120.0, new Config.Api().readTimeoutUpload);
5256
}
5357

5458
@Test
@@ -95,31 +99,58 @@ void configTimeoutAlsoBoundsOverallWait() throws Exception {
9599
}
96100

97101
@Test
98-
void asyncSubmitAndResultGetUseReadTimeoutDefault() {
102+
void perTypeDefaults() {
99103
Client c = new Client("k");
100-
OkHttpClient r = c.requestClient(null, true);
101-
assertEquals(120_000, r.readTimeoutMillis());
102-
assertEquals(120_000, r.callTimeoutMillis());
103-
assertEquals(120_000, c.requestClient(null, true).callTimeoutMillis());
104-
// base client read timeout is the bounded default, not infinite
105-
Config.api.readTimeout = 30.0;
106-
assertEquals(30_000, c.requestClient(null, true).readTimeoutMillis());
104+
OkHttpClient get = c.requestClient(null, Client.Kind.GET);
105+
assertEquals(30_000, get.readTimeoutMillis());
106+
assertEquals(30_000, get.callTimeoutMillis());
107+
OkHttpClient submit = c.requestClient(null, Client.Kind.SUBMIT);
108+
assertEquals(60_000, submit.readTimeoutMillis());
109+
assertEquals(60_000, submit.callTimeoutMillis());
110+
OkHttpClient ticket = c.requestClient(null, Client.Kind.UPLOAD);
111+
assertEquals(120_000, ticket.readTimeoutMillis());
112+
OkHttpClient put = c.uploadPutClient(null);
113+
assertEquals(120_000, put.readTimeoutMillis());
114+
assertEquals(0, put.callTimeoutMillis());
115+
assertEquals(0, c.requestClient(null, Client.Kind.SYNC_SUBMIT).readTimeoutMillis());
116+
}
117+
118+
@Test
119+
void overrideAppliesToGetSubmitUploadButNotSync() {
120+
Config.api.readTimeout = 5.0;
121+
Client c = new Client("k");
122+
for (Client.Kind k : new Client.Kind[]{Client.Kind.GET, Client.Kind.SUBMIT, Client.Kind.UPLOAD}) {
123+
assertEquals(5_000, c.requestClient(null, k).readTimeoutMillis(), k.name());
124+
assertEquals(5_000, c.requestClient(null, k).callTimeoutMillis(), k.name());
125+
}
126+
OkHttpClient put = c.uploadPutClient(null);
127+
assertEquals(5_000, put.readTimeoutMillis());
128+
assertEquals(0, put.callTimeoutMillis());
129+
assertEquals(0, c.requestClient(null, Client.Kind.SYNC_SUBMIT).readTimeoutMillis());
130+
assertEquals(0, c.requestClient(null, Client.Kind.SYNC_SUBMIT).callTimeoutMillis());
131+
}
132+
133+
@Test
134+
void baseClientReadTimeoutIsTheGetDefaultNotInfinite() throws Exception {
135+
java.lang.reflect.Field f = Client.class.getDeclaredField("httpClient");
136+
f.setAccessible(true);
137+
assertEquals(30_000, ((OkHttpClient) f.get(new Client("k"))).readTimeoutMillis());
107138
}
108139

109140
@Test
110141
void syncSubmitHasNoTimeoutByDefaultAndExplicitWhenGiven() {
111142
Client c = new Client("k");
112-
OkHttpClient none = c.requestClient(null, false);
143+
OkHttpClient none = c.requestClient(null, Client.Kind.SYNC_SUBMIT);
113144
assertEquals(0, none.readTimeoutMillis());
114145
assertEquals(0, none.callTimeoutMillis());
115-
OkHttpClient explicit = c.requestClient(7.0, false);
146+
OkHttpClient explicit = c.requestClient(7.0, Client.Kind.SYNC_SUBMIT);
116147
assertEquals(7_000, explicit.readTimeoutMillis());
117148
assertEquals(7_000, explicit.callTimeoutMillis());
118149
}
119150

120151
@Test
121152
void explicitTimeoutKeepsPerRequestBehaviorForAsync() {
122-
OkHttpClient r = new Client("k").requestClient(7.0, true);
153+
OkHttpClient r = new Client("k").requestClient(7.0, Client.Kind.SUBMIT);
123154
assertEquals(7_000, r.readTimeoutMillis());
124155
assertEquals(7_000, r.callTimeoutMillis());
125156
assertEquals(7_000, r.connectTimeoutMillis()); // min(10s, 7s)
@@ -139,18 +170,6 @@ void hungResultGetFailsAloneAndIsRetried() throws Exception {
139170
}
140171
}
141172

142-
@Test
143-
void uploadTicketAndPutDefaultTimeouts() {
144-
Client c = new Client("k");
145-
OkHttpClient ticket = c.requestClient(null, true);
146-
assertEquals(120_000, ticket.readTimeoutMillis());
147-
assertEquals(120_000, ticket.callTimeoutMillis());
148-
OkHttpClient put = c.uploadPutClient(null);
149-
assertEquals(120_000, put.readTimeoutMillis());
150-
assertEquals(120_000, put.writeTimeoutMillis());
151-
assertEquals(0, put.callTimeoutMillis()); // no total-transfer deadline
152-
}
153-
154173
@Test
155174
void uploadExplicitTimeoutKeepsTodaysBehavior() {
156175
OkHttpClient put = new Client("k").uploadPutClient(7.0);

0 commit comments

Comments
 (0)