feat(client): expose sleeper option

fix(client): ensure single timer is created per client

Author: stainless-app[bot]

openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt

@@ -8,6 +8,7 @@ import com.openai.azure.AzureUrlPathMode
 import com.openai.client.OpenAIClient
 import com.openai.client.OpenAIClientImpl
 import com.openai.core.ClientOptions
+import com.openai.core.Sleeper
 import com.openai.core.Timeout
 import com.openai.core.http.AsyncStreamResponse
 import com.openai.core.http.Headers
@@ -135,6 +136,17 @@ class OpenAIOkHttpClient private constructor() {
             clientOptions.streamHandlerExecutor(streamHandlerExecutor)
         }
 
+        /**
+         * The interface to use for delaying execution, like during retries.
+         *
+         * This is primarily useful for using fake delays in tests.
+         *
+         * Defaults to real execution delays.
+         *
+         * This class takes ownership of the sleeper and closes it when closed.
+         */
+        fun sleeper(sleeper: Sleeper) = apply { clientOptions.sleeper(sleeper) }
+
         /**
          * The clock to use for operations that require timing, like retries.
          *

openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClientAsync.kt

@@ -8,6 +8,7 @@ import com.openai.azure.AzureUrlPathMode
 import com.openai.client.OpenAIClientAsync
 import com.openai.client.OpenAIClientAsyncImpl
 import com.openai.core.ClientOptions
+import com.openai.core.Sleeper
 import com.openai.core.Timeout
 import com.openai.core.http.AsyncStreamResponse
 import com.openai.core.http.Headers
@@ -135,6 +136,17 @@ class OpenAIOkHttpClientAsync private constructor() {
             clientOptions.streamHandlerExecutor(streamHandlerExecutor)
         }
 
+        /**
+         * The interface to use for delaying execution, like during retries.
+         *
+         * This is primarily useful for using fake delays in tests.
+         *
+         * Defaults to real execution delays.
+         *
+         * This class takes ownership of the sleeper and closes it when closed.
+         */
+        fun sleeper(sleeper: Sleeper) = apply { clientOptions.sleeper(sleeper) }
+
         /**
          * The clock to use for operations that require timing, like retries.
          *

openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt

@@ -60,6 +60,16 @@ private constructor(
      * This class takes ownership of the executor and shuts it down, if possible, when closed.
      */
     @get:JvmName("streamHandlerExecutor") val streamHandlerExecutor: Executor,
+    /**
+     * The interface to use for delaying execution, like during retries.
+     *
+     * This is primarily useful for using fake delays in tests.
+     *
+     * Defaults to real execution delays.
+     *
+     * This class takes ownership of the sleeper and closes it when closed.
+     */
+    @get:JvmName("sleeper") val sleeper: Sleeper,
     /**
      * The clock to use for operations that require timing, like retries.
      *
@@ -162,6 +172,7 @@ private constructor(
         private var checkJacksonVersionCompatibility: Boolean = true
         private var jsonMapper: JsonMapper = jsonMapper()
         private var streamHandlerExecutor: Executor? = null
+        private var sleeper: Sleeper? = null
         private var clock: Clock = Clock.systemUTC()
         private var baseUrl: String? = null
         private var headers: Headers.Builder = Headers.builder()
@@ -182,6 +193,7 @@ private constructor(
             checkJacksonVersionCompatibility = clientOptions.checkJacksonVersionCompatibility
             jsonMapper = clientOptions.jsonMapper
             streamHandlerExecutor = clientOptions.streamHandlerExecutor
+            sleeper = clientOptions.sleeper
             clock = clientOptions.clock
             baseUrl = clientOptions.baseUrl
             headers = clientOptions.headers.toBuilder()
@@ -241,6 +253,17 @@ private constructor(
                 else streamHandlerExecutor
         }
 
+        /**
+         * The interface to use for delaying execution, like during retries.
+         *
+         * This is primarily useful for using fake delays in tests.
+         *
+         * Defaults to real execution delays.
+         *
+         * This class takes ownership of the sleeper and closes it when closed.
+         */
+        fun sleeper(sleeper: Sleeper) = apply { this.sleeper = PhantomReachableSleeper(sleeper) }
+
         /**
          * The clock to use for operations that require timing, like retries.
          *
@@ -479,6 +502,25 @@ private constructor(
          */
         fun build(): ClientOptions {
             val httpClient = checkRequired("httpClient", httpClient)
+            val streamHandlerExecutor =
+                streamHandlerExecutor
+                    ?: PhantomReachableExecutorService(
+                        Executors.newCachedThreadPool(
+                            object : ThreadFactory {
+
+                                private val threadFactory: ThreadFactory =
+                                    Executors.defaultThreadFactory()
+                                private val count = AtomicLong(0)
+
+                                override fun newThread(runnable: Runnable): Thread =
+                                    threadFactory.newThread(runnable).also {
+                                        it.name =
+                                            "openai-stream-handler-thread-${count.getAndIncrement()}"
+                                    }
+                            }
+                        )
+                    )
+            val sleeper = sleeper ?: PhantomReachableSleeper(DefaultSleeper())
             val credential = checkRequired("credential", credential)
 
             val headers = Headers.builder()
@@ -530,26 +572,14 @@ private constructor(
                 httpClient,
                 RetryingHttpClient.builder()
                     .httpClient(httpClient)
+                    .sleeper(sleeper)
                     .clock(clock)
                     .maxRetries(maxRetries)
                     .build(),
                 checkJacksonVersionCompatibility,
                 jsonMapper,
-                streamHandlerExecutor
-                    ?: Executors.newCachedThreadPool(
-                        object : ThreadFactory {
-
-                            private val threadFactory: ThreadFactory =
-                                Executors.defaultThreadFactory()
-                            private val count = AtomicLong(0)
-
-                            override fun newThread(runnable: Runnable): Thread =
-                                threadFactory.newThread(runnable).also {
-                                    it.name =
-                                        "openai-stream-handler-thread-${count.getAndIncrement()}"
-                                }
-                        }
-                    ),
+                streamHandlerExecutor,
+                sleeper,
                 clock,
                 baseUrl,
                 headers.build(),
@@ -580,5 +610,6 @@ private constructor(
     fun close() {
         httpClient.close()
         (streamHandlerExecutor as? ExecutorService)?.shutdown()
+        sleeper.close()
     }
 }

openai-java-core/src/main/kotlin/com/openai/core/DefaultSleeper.kt

@@ -0,0 +1,28 @@
+package com.openai.core
+
+import java.time.Duration
+import java.util.Timer
+import java.util.TimerTask
+import java.util.concurrent.CompletableFuture
+
+class DefaultSleeper : Sleeper {
+
+    private val timer = Timer("DefaultSleeper", true)
+
+    override fun sleep(duration: Duration) = Thread.sleep(duration.toMillis())
+
+    override fun sleepAsync(duration: Duration): CompletableFuture<Void> {
+        val future = CompletableFuture<Void>()
+        timer.schedule(
+            object : TimerTask() {
+                override fun run() {
+                    future.complete(null)
+                }
+            },
+            duration.toMillis(),
+        )
+        return future
+    }
+
+    override fun close() = timer.cancel()
+}

openai-java-core/src/main/kotlin/com/openai/core/PhantomReachableSleeper.kt

@@ -0,0 +1,23 @@
+package com.openai.core
+
+import java.time.Duration
+import java.util.concurrent.CompletableFuture
+
+/**
+ * A delegating wrapper around a [Sleeper] that closes it once it's only phantom reachable.
+ *
+ * This class ensures the [Sleeper] is closed even if the user forgets to do it.
+ */
+internal class PhantomReachableSleeper(private val sleeper: Sleeper) : Sleeper {
+
+    init {
+        closeWhenPhantomReachable(this, sleeper)
+    }
+
+    override fun sleep(duration: Duration) = sleeper.sleep(duration)
+
+    override fun sleepAsync(duration: Duration): CompletableFuture<Void> =
+        sleeper.sleepAsync(duration)
+
+    override fun close() = sleeper.close()
+}

openai-java-core/src/main/kotlin/com/openai/core/Sleeper.kt

@@ -0,0 +1,21 @@
+package com.openai.core
+
+import java.time.Duration
+import java.util.concurrent.CompletableFuture
+
+/**
+ * An interface for delaying execution for a specified amount of time.
+ *
+ * Useful for testing and cleaning up resources.
+ */
+interface Sleeper : AutoCloseable {
+
+    /** Synchronously pauses execution for the given [duration]. */
+    fun sleep(duration: Duration)
+
+    /** Asynchronously pauses execution for the given [duration]. */
+    fun sleepAsync(duration: Duration): CompletableFuture<Void>
+
+    /** Overridden from [AutoCloseable] to not have a checked exception in its signature. */
+    override fun close()
+}

openai-java-core/src/main/kotlin/com/openai/core/http/RetryingHttpClient.kt

@@ -1,6 +1,8 @@
 package com.openai.core.http
 
+import com.openai.core.DefaultSleeper
 import com.openai.core.RequestOptions
+import com.openai.core.Sleeper
 import com.openai.core.checkRequired
 import com.openai.errors.OpenAIIoException
 import com.openai.errors.OpenAIRetryableException
@@ -11,8 +13,6 @@ import java.time.OffsetDateTime
 import java.time.format.DateTimeFormatter
 import java.time.format.DateTimeParseException
 import java.time.temporal.ChronoUnit
-import java.util.Timer
-import java.util.TimerTask
 import java.util.UUID
 import java.util.concurrent.CompletableFuture
 import java.util.concurrent.ThreadLocalRandom
@@ -130,7 +130,10 @@ private constructor(
         return executeWithRetries(modifiedRequest, requestOptions)
     }
 
-    override fun close() = httpClient.close()
+    override fun close() {
+        httpClient.close()
+        sleeper.close()
+    }
 
     private fun isRetryable(request: HttpRequest): Boolean =
         // Some requests, such as when a request body is being streamed, cannot be retried because
@@ -235,33 +238,14 @@ private constructor(
     class Builder internal constructor() {
 
         private var httpClient: HttpClient? = null
-        private var sleeper: Sleeper =
-            object : Sleeper {
-
-                private val timer = Timer("RetryingHttpClient", true)
-
-                override fun sleep(duration: Duration) = Thread.sleep(duration.toMillis())
-
-                override fun sleepAsync(duration: Duration): CompletableFuture<Void> {
-                    val future = CompletableFuture<Void>()
-                    timer.schedule(
-                        object : TimerTask() {
-                            override fun run() {
-                                future.complete(null)
-                            }
-                        },
-                        duration.toMillis(),
-                    )
-                    return future
-                }
-            }
+        private var sleeper: Sleeper? = null
         private var clock: Clock = Clock.systemUTC()
         private var maxRetries: Int = 2
         private var idempotencyHeader: String? = null
 
         fun httpClient(httpClient: HttpClient) = apply { this.httpClient = httpClient }
 
-        @JvmSynthetic internal fun sleeper(sleeper: Sleeper) = apply { this.sleeper = sleeper }
+        fun sleeper(sleeper: Sleeper) = apply { this.sleeper = sleeper }
 
         fun clock(clock: Clock) = apply { this.clock = clock }
 
@@ -272,17 +256,10 @@ private constructor(
         fun build(): HttpClient =
             RetryingHttpClient(
                 checkRequired("httpClient", httpClient),
-                sleeper,
+                sleeper ?: DefaultSleeper(),
                 clock,
                 maxRetries,
                 idempotencyHeader,
             )
     }
-
-    internal interface Sleeper {
-
-        fun sleep(duration: Duration)
-
-        fun sleepAsync(duration: Duration): CompletableFuture<Void>
-    }
 }

openai-java-core/src/test/kotlin/com/openai/core/http/RetryingHttpClientTest.kt

@@ -6,6 +6,7 @@ import com.github.tomakehurst.wiremock.junit5.WireMockTest
 import com.github.tomakehurst.wiremock.stubbing.Scenario
 import com.openai.client.okhttp.OkHttpClient
 import com.openai.core.RequestOptions
+import com.openai.core.Sleeper
 import com.openai.errors.OpenAIRetryableException
 import java.io.InputStream
 import java.time.Duration
@@ -294,12 +295,14 @@ internal class RetryingHttpClientTest {
                 .httpClient(failingHttpClient)
                 .maxRetries(2)
                 .sleeper(
-                    object : RetryingHttpClient.Sleeper {
+                    object : Sleeper {
 
                         override fun sleep(duration: Duration) {}
 
                         override fun sleepAsync(duration: Duration): CompletableFuture<Void> =
                             CompletableFuture.completedFuture(null)
+
+                        override fun close() {}
                     }
                 )
                 .build()
@@ -333,12 +336,14 @@ internal class RetryingHttpClientTest {
             .httpClient(httpClient)
             // Use a no-op `Sleeper` to make the test fast.
             .sleeper(
-                object : RetryingHttpClient.Sleeper {
+                object : Sleeper {
 
                     override fun sleep(duration: Duration) {}
 
                     override fun sleepAsync(duration: Duration): CompletableFuture<Void> =
                         CompletableFuture.completedFuture(null)
+
+                    override fun close() {}
                 }
             )