chore(client): refactor closing / shutdown

Author: stainless-app[bot]

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

@@ -128,6 +128,8 @@ class OpenAIOkHttpClient private constructor() {
          * The executor to use for running [AsyncStreamResponse.Handler] callbacks.
          *
          * Defaults to a dedicated cached thread pool.
+         *
+         * This class takes ownership of the executor and shuts it down, if possible, when closed.
          */
         fun streamHandlerExecutor(streamHandlerExecutor: Executor) = apply {
             clientOptions.streamHandlerExecutor(streamHandlerExecutor)

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

@@ -128,6 +128,8 @@ class OpenAIOkHttpClientAsync private constructor() {
          * The executor to use for running [AsyncStreamResponse.Handler] callbacks.
          *
          * Defaults to a dedicated cached thread pool.
+         *
+         * This class takes ownership of the executor and shuts it down, if possible, when closed.
          */
         fun streamHandlerExecutor(streamHandlerExecutor: Executor) = apply {
             clientOptions.streamHandlerExecutor(streamHandlerExecutor)

openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientAsyncImpl.kt

@@ -166,7 +166,7 @@ class OpenAIClientAsyncImpl(private val clientOptions: ClientOptions) : OpenAICl
 
     override fun containers(): ContainerServiceAsync = containers
 
-    override fun close() = clientOptions.httpClient.close()
+    override fun close() = clientOptions.close()
 
     class WithRawResponseImpl internal constructor(private val clientOptions: ClientOptions) :
         OpenAIClientAsync.WithRawResponse {

openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientImpl.kt

@@ -152,7 +152,7 @@ class OpenAIClientImpl(private val clientOptions: ClientOptions) : OpenAIClient
 
     override fun containers(): ContainerService = containers
 
-    override fun close() = clientOptions.httpClient.close()
+    override fun close() = clientOptions.close()
 
     class WithRawResponseImpl internal constructor(private val clientOptions: ClientOptions) :
         OpenAIClient.WithRawResponse {

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

@@ -19,6 +19,7 @@ import java.time.Clock
 import java.time.Duration
 import java.util.Optional
 import java.util.concurrent.Executor
+import java.util.concurrent.ExecutorService
 import java.util.concurrent.Executors
 import java.util.concurrent.ThreadFactory
 import java.util.concurrent.atomic.AtomicLong
@@ -32,6 +33,8 @@ private constructor(
      * The HTTP client to use in the SDK.
      *
      * Use the one published in `openai-java-client-okhttp` or implement your own.
+     *
+     * This class takes ownership of the client and closes it when closed.
      */
     @get:JvmName("httpClient") val httpClient: HttpClient,
     /**
@@ -53,6 +56,8 @@ private constructor(
      * The executor to use for running [AsyncStreamResponse.Handler] callbacks.
      *
      * Defaults to a dedicated cached thread pool.
+     *
+     * This class takes ownership of the executor and shuts it down, if possible, when closed.
      */
     @get:JvmName("streamHandlerExecutor") val streamHandlerExecutor: Executor,
     /**
@@ -196,6 +201,8 @@ private constructor(
          * The HTTP client to use in the SDK.
          *
          * Use the one published in `openai-java-client-okhttp` or implement your own.
+         *
+         * This class takes ownership of the client and closes it when closed.
          */
         fun httpClient(httpClient: HttpClient) = apply {
             this.httpClient = PhantomReachableClosingHttpClient(httpClient)
@@ -224,9 +231,14 @@ private constructor(
          * The executor to use for running [AsyncStreamResponse.Handler] callbacks.
          *
          * Defaults to a dedicated cached thread pool.
+         *
+         * This class takes ownership of the executor and shuts it down, if possible, when closed.
          */
         fun streamHandlerExecutor(streamHandlerExecutor: Executor) = apply {
-            this.streamHandlerExecutor = streamHandlerExecutor
+            this.streamHandlerExecutor =
+                if (streamHandlerExecutor is ExecutorService)
+                    PhantomReachableExecutorService(streamHandlerExecutor)
+                else streamHandlerExecutor
         }
 
         /**
@@ -554,4 +566,19 @@ private constructor(
             )
         }
     }
+
+    /**
+     * Closes these client options, relinquishing any underlying resources.
+     *
+     * This is purposefully not inherited from [AutoCloseable] because the client options are
+     * long-lived and usually should not be synchronously closed via try-with-resources.
+     *
+     * It's also usually not necessary to call this method at all. the default client automatically
+     * releases threads and connections if they remain idle, but if you are writing an application
+     * that needs to aggressively release unused resources, then you may call this method.
+     */
+    fun close() {
+        httpClient.close()
+        (streamHandlerExecutor as? ExecutorService)?.shutdown()
+    }
 }

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

@@ -0,0 +1,58 @@
+package com.openai.core
+
+import java.util.concurrent.Callable
+import java.util.concurrent.ExecutorService
+import java.util.concurrent.Future
+import java.util.concurrent.TimeUnit
+
+/**
+ * A delegating wrapper around an [ExecutorService] that shuts it down once it's only phantom
+ * reachable.
+ *
+ * This class ensures the [ExecutorService] is shut down even if the user forgets to do it.
+ */
+internal class PhantomReachableExecutorService(private val executorService: ExecutorService) :
+    ExecutorService {
+    init {
+        closeWhenPhantomReachable(this) { executorService.shutdown() }
+    }
+
+    override fun execute(command: Runnable) = executorService.execute(command)
+
+    override fun shutdown() = executorService.shutdown()
+
+    override fun shutdownNow(): MutableList<Runnable> = executorService.shutdownNow()
+
+    override fun isShutdown(): Boolean = executorService.isShutdown
+
+    override fun isTerminated(): Boolean = executorService.isTerminated
+
+    override fun awaitTermination(timeout: Long, unit: TimeUnit): Boolean =
+        executorService.awaitTermination(timeout, unit)
+
+    override fun <T : Any?> submit(task: Callable<T>): Future<T> = executorService.submit(task)
+
+    override fun <T : Any?> submit(task: Runnable, result: T): Future<T> =
+        executorService.submit(task, result)
+
+    override fun submit(task: Runnable): Future<*> = executorService.submit(task)
+
+    override fun <T : Any?> invokeAll(
+        tasks: MutableCollection<out Callable<T>>
+    ): MutableList<Future<T>> = executorService.invokeAll(tasks)
+
+    override fun <T : Any?> invokeAll(
+        tasks: MutableCollection<out Callable<T>>,
+        timeout: Long,
+        unit: TimeUnit,
+    ): MutableList<Future<T>> = executorService.invokeAll(tasks, timeout, unit)
+
+    override fun <T : Any?> invokeAny(tasks: MutableCollection<out Callable<T>>): T =
+        executorService.invokeAny(tasks)
+
+    override fun <T : Any?> invokeAny(
+        tasks: MutableCollection<out Callable<T>>,
+        timeout: Long,
+        unit: TimeUnit,
+    ): T = executorService.invokeAny(tasks, timeout, unit)
+}