chore: attempt to clean up underlying transport when streams are GC'd (#117)

Author: stainless-app[bot]

lib/openai/internal/type/base_stream.rb

@@ -11,6 +11,21 @@ module Type
       module BaseStream
         include Enumerable
 
+        class << self
+          # Attempt to close the underlying transport when the stream itself is garbage
+          # collected.
+          #
+          # This should not be relied upon for resource clean up, as the garbage collector
+          # is not guaranteed to run.
+          #
+          # @param stream [Enumerable<Object>]
+          #
+          # @return [Proc]
+          #
+          # @see https://rubyapi.org/3.1/o/objectspace#method-c-define_finalizer
+          def defer_closing(stream) = ->(_id) { OpenAI::Internal::Util.close_fused!(stream) }
+        end
+
         # @return [void]
         def close = OpenAI::Internal::Util.close_fused!(@iterator)
 
@@ -49,6 +64,8 @@ def initialize(model:, url:, status:, response:, stream:)
           @response = response
           @stream = stream
           @iterator = iterator
+
+          ObjectSpace.define_finalizer(self, OpenAI::Internal::Type::BaseStream.defer_closing(@stream))
         end
       end
     end

rbi/lib/openai/internal/type/base_stream.rbi

@@ -10,6 +10,16 @@ module OpenAI
         Message = type_member(:in)
         Elem = type_member(:out)
 
+        class << self
+          # Attempt to close the underlying transport when the stream itself is garbage
+          # collected.
+          #
+          # This should not be relied upon for resource clean up, as the garbage collector
+          # is not guaranteed to run.
+          sig { params(stream: T::Enumerable[T.anything]).returns(T.proc.params(arg0: Integer).void) }
+          def defer_closing(stream); end
+        end
+
         sig { void }
         def close; end
 

sig/openai/internal/type/base_stream.rbs

@@ -4,6 +4,10 @@ module OpenAI
       module BaseStream[Message, Elem]
         include Enumerable[Elem]
 
+        def self.defer_closing: (
+          Enumerable[top] stream
+        ) -> (^(Integer arg0) -> void)
+
         def close: -> void
 
         private def iterator: -> Enumerable[Elem]