Skip to content

Commit 76bb479

Browse files
chengzeyiclaude
andcommitted
Remove default overall timeout cap; bound per-request reads separately
Default Config.api.timeout is now null: the SDK waits until a task reaches a terminal status. An explicit timeout (or WAVESPEED_TIMEOUT) still bounds the wait and each request as before. Async submit and result GET default to a 120s read/call timeout (Config.api.readTimeout, WAVESPEED_READ_TIMEOUT); sync-mode submit has none unless a timeout is given. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
1 parent 677c756 commit 76bb479

8 files changed

Lines changed: 231 additions & 43 deletions

File tree

‎CLAUDE.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ Global configuration via `Config.api`:
8080
- `apiKey` - WaveSpeed API key
8181
- `baseUrl` - API base URL (default: https://api.wavespeed.ai)
8282
- `connectionTimeout` - Connection timeout in seconds (default: 10.0)
83-
- `timeout` - Total API call timeout in seconds (default: 36000.0)
83+
- `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)
8485
- `maxRetries` - Task-level retries (default: 0)
8586
- `maxConnectionRetries` - HTTP connection retries (default: 5)
8687
- `retryInterval` - Base retry delay in seconds (default: 1.0)
@@ -102,7 +103,8 @@ Client client = new Client(
102103
- `WAVESPEED_API_KEY` - API key
103104
- `WAVESPEED_BASE_URL` - Base URL (default: https://api.wavespeed.ai)
104105
- `WAVESPEED_CONNECTION_TIMEOUT` - Connection timeout (default: 10.0)
105-
- `WAVESPEED_TIMEOUT` - Total timeout (default: 36000.0)
106+
- `WAVESPEED_TIMEOUT` - Overall wait limit (default: unset = no limit)
107+
- `WAVESPEED_READ_TIMEOUT` - Per-request read timeout (default: 120.0)
106108
- `WAVESPEED_MAX_RETRIES` - Task-level retries (default: 0)
107109
- `WAVESPEED_MAX_CONNECTION_RETRIES` - HTTP retries (default: 5)
108110
- `WAVESPEED_RETRY_INTERVAL` - Retry interval (default: 1.0)

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Map<String, Object> output = client.run(
7979
Map<String, Object> output = Wavespeed.run(
8080
"wavespeed-ai/z-image/turbo",
8181
Map.of("prompt", "Cat"),
82-
36000.0, // timeout - Max wait time in seconds (default: 36000.0)
82+
null, // timeout - Max wait time in seconds (default: null = wait until the task finishes, no limit)
8383
1.0, // pollInterval - Status check interval (default: 1.0)
8484
false, // enableSyncMode - Best-effort sync result attempt (default: false)
8585
null // maxRetries - Task re-runs after a reported failure; each is a new paid task (default: 0)

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

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,20 @@ public static class Api {
4242
public double connectionTimeout;
4343

4444
/**
45-
* Total API call timeout in seconds.
46-
* Default: 36000.0 (10 hours)
45+
* Overall time limit in seconds for waiting on a task.
46+
* Default: null (no limit; the SDK waits until the task reaches a
47+
* terminal status). Set it, or WAVESPEED_TIMEOUT, to bound the wait.
48+
* A configured value also bounds each individual HTTP request.
4749
*/
48-
public double timeout;
50+
public Double timeout;
51+
52+
/**
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)
57+
*/
58+
public double readTimeout;
4959

5060
/**
5161
* Maximum number of retries for the entire operation (task-level retries).
@@ -73,7 +83,8 @@ public Api() {
7383
this.apiKey = System.getenv("WAVESPEED_API_KEY");
7484
this.baseUrl = getEnv("WAVESPEED_BASE_URL", "https://api.wavespeed.ai");
7585
this.connectionTimeout = getEnvDouble("WAVESPEED_CONNECTION_TIMEOUT", 10.0);
76-
this.timeout = getEnvDouble("WAVESPEED_TIMEOUT", 36000.0);
86+
this.timeout = getEnvDoubleOrNull("WAVESPEED_TIMEOUT");
87+
this.readTimeout = getEnvDouble("WAVESPEED_READ_TIMEOUT", 120.0);
7788
this.maxRetries = getEnvInt("WAVESPEED_MAX_RETRIES", 0);
7889
this.maxConnectionRetries = getEnvInt("WAVESPEED_MAX_CONNECTION_RETRIES", 5);
7990
this.retryInterval = getEnvDouble("WAVESPEED_RETRY_INTERVAL", 1.0);
@@ -96,6 +107,18 @@ private static double getEnvDouble(String key, double defaultValue) {
96107
return defaultValue;
97108
}
98109

110+
private static Double getEnvDoubleOrNull(String key) {
111+
String value = System.getenv(key);
112+
if (value != null) {
113+
try {
114+
return Double.parseDouble(value);
115+
} catch (NumberFormatException e) {
116+
return null;
117+
}
118+
}
119+
return null;
120+
}
121+
99122
private static int getEnvInt(String key, int defaultValue) {
100123
String value = System.getenv(key);
101124
if (value != null) {

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

Lines changed: 52 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ public Client(
8686
this.baseUrl = (baseUrl != null ? baseUrl : Config.api.baseUrl).replaceAll("/$", "");
8787

8888
double connTimeout = connectionTimeout != null ? connectionTimeout : Config.api.connectionTimeout;
89-
double totalTimeout = Config.api.timeout;
9089

9190
// Build HTTP client. OkHttp's retryOnConnectionFailure defaults to true and
9291
// can silently re-send a request (including the submission POST) after a
@@ -95,7 +94,7 @@ public Client(
9594
this.httpClient = new OkHttpClient.Builder()
9695
.retryOnConnectionFailure(false)
9796
.connectTimeout((long) (connTimeout * 1000), TimeUnit.MILLISECONDS)
98-
.readTimeout((long) (totalTimeout * 1000), TimeUnit.MILLISECONDS)
97+
.readTimeout((long) (Config.api.readTimeout * 1000), TimeUnit.MILLISECONDS)
9998
.build();
10099

101100
this.gson = new Gson();
@@ -254,15 +253,9 @@ private SubmitResult submit(
254253
body.put("enable_sync_mode", true);
255254
}
256255

257-
double requestTimeout = timeout != null ? timeout : Config.api.timeout;
258-
double connectTimeout = Math.min(
259-
this.httpClient.connectTimeoutMillis() / 1000.0,
260-
requestTimeout
261-
);
262-
263-
// Per-call timeouts: connect uses the smaller of the client connect
264-
// timeout and the request timeout; read/call enforce the request timeout.
265-
OkHttpClient callClient = perCallClient(connectTimeout, requestTimeout);
256+
// 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);
266259

267260
Request request = addClientHeaders(new Request.Builder()
268261
.url(url)
@@ -329,6 +322,40 @@ private OkHttpClient perCallClient(double connectTimeout, double requestTimeout)
329322
.build();
330323
}
331324

325+
/**
326+
* Effective configured timeout: the explicit argument, else
327+
* Config.api.timeout (WAVESPEED_TIMEOUT). Null means no limit.
328+
*/
329+
static Double configuredTimeout(Double explicit) {
330+
return explicit != null ? explicit : Config.api.timeout;
331+
}
332+
333+
/**
334+
* 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).
338+
*/
339+
OkHttpClient requestClient(Double explicit, boolean boundedByDefault) {
340+
Double configured = configuredTimeout(explicit);
341+
if (configured != null) {
342+
double connect = Math.min(httpClient.connectTimeoutMillis() / 1000.0, configured);
343+
return perCallClient(connect, configured);
344+
}
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+
}
350+
return httpClient.newBuilder()
351+
.readTimeout(0, TimeUnit.MILLISECONDS)
352+
.callTimeout(0, TimeUnit.MILLISECONDS)
353+
.build();
354+
}
355+
356+
/** Clock for the wait loop's overall cap (replaceable in tests). */
357+
java.util.function.LongSupplier nowMillis = System::currentTimeMillis;
358+
332359
private static boolean isRetryableStatus(int code) {
333360
return code == 429 || code == 500 || code == 502 || code == 503 || code == 504;
334361
}
@@ -343,12 +370,7 @@ private static boolean isRetryableStatus(int code) {
343370
*/
344371
private Map<String, Object> getResult(String requestId, Double timeout) {
345372
String url = this.baseUrl + "/api/v3/predictions/" + requestId + "/result";
346-
double requestTimeout = timeout != null ? timeout : Config.api.timeout;
347-
double connectTimeout = Math.min(
348-
this.httpClient.connectTimeoutMillis() / 1000.0,
349-
requestTimeout
350-
);
351-
OkHttpClient callClient = perCallClient(connectTimeout, requestTimeout);
373+
OkHttpClient callClient = requestClient(timeout, true);
352374

353375
for (int retry = 0; retry <= maxConnectionRetries; retry++) {
354376
try {
@@ -414,7 +436,7 @@ private Map<String, Object> getResult(String requestId, Double timeout) {
414436
* Wait for prediction to complete.
415437
*
416438
* @param requestId The prediction request ID
417-
* @param timeout Maximum wait time in seconds (null = no timeout)
439+
* @param timeout Maximum wait time in seconds (null = Config.api.timeout, which defaults to no limit)
418440
* @param pollInterval Time between polls in seconds
419441
* @return Map with "outputs" array
420442
* @throws RuntimeException if prediction fails
@@ -425,15 +447,17 @@ private Map<String, Object> wait(
425447
Double timeout,
426448
double pollInterval
427449
) {
428-
long startTime = System.currentTimeMillis();
450+
// Overall cap: explicit timeout, else Config.api.timeout; null = wait until terminal status.
451+
Double cap = configuredTimeout(timeout);
452+
long startTime = nowMillis.getAsLong();
429453

430454
while (true) {
431455
// Check timeout
432-
if (timeout != null) {
433-
double elapsed = (System.currentTimeMillis() - startTime) / 1000.0;
434-
if (elapsed >= timeout) {
456+
if (cap != null) {
457+
double elapsed = (nowMillis.getAsLong() - startTime) / 1000.0;
458+
if (elapsed >= cap) {
435459
throw new RuntimeException(
436-
"Prediction timed out after " + timeout + " seconds (task_id: " + requestId + ")"
460+
"Prediction timed out after " + cap + " seconds (task_id: " + requestId + ")"
437461
);
438462
}
439463
}
@@ -544,7 +568,7 @@ private String syncModeErrorMessage(Map<String, Object> data) {
544568
*
545569
* @param model Model identifier (e.g., "wavespeed-ai/z-image/turbo")
546570
* @param input Input parameters for the model
547-
* @param timeout Maximum time to wait for completion (null = no timeout)
571+
* @param timeout Maximum time to wait for completion (null = Config.api.timeout; default no limit)
548572
* @param pollInterval Interval between status checks in seconds (null = 1.0)
549573
* @param enableSyncMode If true, use synchronous mode (best-effort single request) (null = false)
550574
* @param maxRetries Maximum task-level retries (null = use client setting)
@@ -657,7 +681,7 @@ public Map<String, Object> run(String model, Map<String, Object> input, double t
657681
* Upload a file to WaveSpeed.
658682
*
659683
* @param file File path string to upload
660-
* @param timeout Total API call timeout in seconds (null = use default)
684+
* @param timeout Request timeout in seconds (null = Config.api.timeout; default no call limit)
661685
* @return URL of the uploaded file
662686
* @throws IllegalArgumentException if API key is not configured
663687
* @throws IllegalArgumentException if file path does not exist
@@ -689,12 +713,8 @@ public String upload(String file, Double timeout) {
689713
payload.put("content_type", contentType);
690714
}
691715

692-
double requestTimeout = timeout != null ? timeout : Config.api.timeout;
693-
double connectTimeout = Math.min(
694-
this.httpClient.connectTimeoutMillis() / 1000.0,
695-
requestTimeout
696-
);
697-
OkHttpClient callClient = perCallClient(connectTimeout, requestTimeout);
716+
// Uploads can legitimately take long: only a configured timeout bounds the call.
717+
OkHttpClient callClient = requestClient(timeout, false);
698718

699719
Request request = addClientHeaders(new Request.Builder()
700720
.url(this.baseUrl + "/api/v3/media/uploads")
@@ -858,7 +878,7 @@ public RunNoThrowResult(Object outputs, RunDetail detail) {
858878
*
859879
* @param model Model identifier
860880
* @param input Input parameters
861-
* @param timeout Maximum time to wait for completion (null = no timeout)
881+
* @param timeout Maximum time to wait for completion (null = Config.api.timeout; default no limit)
862882
* @param pollInterval Interval between status checks in seconds (null = 1.0)
863883
* @param enableSyncMode If true, use synchronous mode (best-effort single request) (null = false)
864884
* @param maxRetries Maximum task-level retries (null = use client setting)

‎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.timeout (36000s); only a
293+
// Shared-client read timeout is Config.api.readTimeout (120s); 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: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ void testApiConfigHasExpectedAttributes() {
1818
assertTrue(Config.api.apiKey == null || Config.api.apiKey instanceof String);
1919
assertInstanceOf(String.class, Config.api.baseUrl);
2020
assertTrue(Config.api.connectionTimeout > 0);
21-
assertTrue(Config.api.timeout > 0);
21+
assertTrue(Config.api.timeout == null || Config.api.timeout > 0);
22+
assertTrue(Config.api.readTimeout > 0);
2223
assertTrue(Config.api.maxRetries >= 0);
2324
assertTrue(Config.api.maxConnectionRetries >= 0);
2425
assertTrue(Config.api.retryInterval > 0);
@@ -29,7 +30,8 @@ void testApiConfigDefaultValues() {
2930
// Test that API config has correct default values
3031
assertEquals("https://api.wavespeed.ai", Config.api.baseUrl);
3132
assertEquals(10.0, Config.api.connectionTimeout);
32-
assertEquals(36000.0, Config.api.timeout);
33+
assertNull(Config.api.timeout); // no overall cap by default
34+
assertEquals(120.0, Config.api.readTimeout);
3335
assertEquals(0, Config.api.maxRetries);
3436
assertEquals(5, Config.api.maxConnectionRetries);
3537
assertEquals(1.0, Config.api.retryInterval);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ void setUp() {
2121
Config.api.apiKey = "test-key";
2222
Config.api.baseUrl = "https://api.wavespeed.ai";
2323
Config.api.connectionTimeout = 10.0;
24-
Config.api.timeout = 36000.0;
24+
Config.api.timeout = null;
2525
Config.api.maxRetries = 0;
2626
Config.api.maxConnectionRetries = 5;
2727
Config.api.retryInterval = 1.0;

0 commit comments

Comments
 (0)