ld-eventsource 2.6.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d455374db2a30af5cf5c6c94d94566eb8100e5598d013c519f098721cfba0f0
-  data.tar.gz: 7276a718d9faa59da461f3d958f802b26c377cb51fea06eec0334c42e2721562
+  metadata.gz: 8b9f8e00c1bed855a376158eb3a77bb6b72192d6bb432a231df00be8c5576712
+  data.tar.gz: 697c406733e7590e591632493d3ff30a2f239ad3600382cf862063e2c8cf39ae
 SHA512:
-  metadata.gz: 2b5eefef27e96b7179a5a92f71d5edeb141397a11d3c00867f4280c3e8db629714cd7cd29a1fa2365fcf5de3c5fa6240ca1890625efc95908b838d7471ff3223
-  data.tar.gz: 932d97eb452aec82bc79e5b3a08ed43192540968e6f07c2b301437cc453e3a3baf1f662d37c24cdde9763060d8e7ec97f826378e22f1370a66250c6819bb96af
+  metadata.gz: 7c9a9d34b776c35cdd2f54bad3abbc53b658669996878267f375e5e36e4160f6aafad06e1275b67ce9667d81e71917f5c6b01e5daf214f9b29f8ad4f96b73c6c
+  data.tar.gz: 4561ccd51021a0eeb33a82528e45738d8cda462060a05a9fa17df010485d32e98817740c12611164ff7ebeb4935a12027ce11be13d98ced17864e73828e779a9

data/lib/ld-eventsource/client.rb

@@ -123,7 +123,7 @@ module SSE
           retry_enabled: true,
           http_client_options: nil)
       @uri = URI(uri)
-      @stopped = Concurrent::AtomicBoolean.new(false)
+      @stop_event = Concurrent::Event.new
       @retry_enabled = retry_enabled
 
       @headers = headers.clone
@@ -278,7 +278,7 @@ module SSE
     # has no effect if called a second time.
     #
     def close
-      if @stopped.make_true
+      if @stop_event.try?
         reset_http
       end
     end
@@ -289,7 +289,7 @@ module SSE
     # @return [Boolean]  true if the client has been shut down
     #
     def closed?
-      @stopped.value
+      @stop_event.set?
     end
 
     private
@@ -314,8 +314,9 @@ module SSE
     end
 
     def run_stream
-      until @stopped.value
-        close_connection
+      until @stop_event.set?
+        log_close_errors { close_connection }
+        error = nil
         begin
           resp = connect
           @lock.synchronize do
@@ -323,36 +324,42 @@ module SSE
           end
           # There's a potential race if close was called in the middle of the previous line, i.e. after we
           # connected but before @cxn was set. Checking the variable again is a bit clunky but avoids that.
-          return if @stopped.value
+          if @stop_event.set?
+            # close did not see this connection, so close it here.
+            reset_http
+            return
+          end
           read_stream(resp) unless resp.nil?
         rescue => e
+          error = e
+        end
+        # Close the connection before the error handler runs, because the handler can block for a long time.
+        log_close_errors { reset_http }
+        unless error.nil?
           # When we deliberately close the connection, it will usually trigger an exception. The exact type
-          # of exception depends on the specific Ruby runtime. But @stopped will always be set in this case.
-          if @stopped.value
+          # of exception depends on the specific Ruby runtime. But the client will always be closed in this case.
+          if @stop_event.set?
             @logger.info { "Stream connection closed" }
           else
-            log_and_dispatch_error(e, "Unexpected error from event source")
+            log_and_dispatch_error(error, "Unexpected error from event source")
           end
         end
-        begin
-          reset_http
-        rescue StandardError => e
-          log_and_dispatch_error(e, "Unexpected error while closing stream")
-        end
 
         return close unless @retry_enabled
       end
     end
 
-    # Try to establish a streaming connection. Returns the StreamingHTTPConnection object if successful.
+    # Try to establish a streaming connection. Returns the HTTP::Response object if successful.
     def connect
       loop do
-        return if @stopped.value
+        return if @stop_event.set?
         interval = @first_attempt ? 0 : @backoff.next_interval
         @first_attempt = false
         if interval > 0
           @logger.info { "Will retry connection after #{'%.3f' % interval} seconds" }
-          sleep(interval)
+          # This wait ends early when close sets the event.
+          @stop_event.wait(interval)
+          return if @stop_event.set?
         end
         cxn = nil
         begin
@@ -386,8 +393,7 @@ module SSE
       end
     end
 
-    # Pipe the output of the StreamingHTTPConnection into the EventParser, and dispatch events as
-    # they arrive.
+    # Pipe the output of the HTTP::Response into the EventParser, and dispatch events as they arrive.
     def read_stream(cxn)
       # Tell the Backoff object that the connection is now in a valid state. It uses that information so
       # it can automatically reset itself if enough time passes between failures.
@@ -395,7 +401,7 @@ module SSE
 
       chunks = Enumerator.new do |gen|
         loop do
-          if @stopped.value
+          if @stop_event.set?
             break
           else
             begin
@@ -407,9 +413,9 @@ module SSE
               # For historical reasons, we rethrow this as our own type
               raise Errors::ReadTimeoutError.new(@read_timeout)
             rescue EOFError
-              break
+              raise Errors::StreamClosedByServerError
             end
-            break if data.nil?  # keep for v5 compat
+            raise Errors::StreamClosedByServerError if data.nil?  # keep for v5 compat
             gen.yield data
           end
         end
@@ -417,7 +423,7 @@ module SSE
       event_parser = Impl::EventParser.new(Impl::BufferedLineReader.lines_from(chunks), @last_id)
 
       event_parser.items.each do |item|
-        return if @stopped.value
+        return if @stop_event.set?
         case item
           when StreamEvent
             dispatch_event(item)
@@ -447,6 +453,15 @@ module SSE
       end
     end
 
+    # A failure to close is logged but not dispatched, so each connection attempt gives the error
+    # handler at most one error, and the worker thread continues.
+    def log_close_errors
+      yield
+    rescue StandardError => e
+      @logger.warn { "Unexpected error while closing stream: #{e.inspect}" }
+      @logger.debug { "Exception trace: #{e.backtrace}" }
+    end
+
     def build_headers
       h = {
         'Accept' => 'text/event-stream',

data/lib/ld-eventsource/errors.rb

@@ -79,5 +79,15 @@ module SSE
         super("no data received in #{interval} seconds")
       end
     end
+
+    #
+    # An exception class indicating that the server ended the stream without an error. This is
+    # passed to the error handler specified in {Client#on_error}, and the client then reconnects.
+    #
+    class StreamClosedByServerError < StandardError
+      def initialize
+        super("stream closed by server")
+      end
+    end
   end
 end

data/lib/ld-eventsource/impl/backoff.rb

@@ -39,13 +39,13 @@ module SSE
           @attempts = 0 if good_duration >= @reconnect_reset_interval
         end
         @last_good_time = nil
+        # A zero base must not be multiplied: 0.0 * Infinity is NaN. Also, rand(0) is not permitted.
+        return 0 if @base_interval <= 0 || @max_interval <= 0
+
         target = [@base_interval * (2 ** @attempts), @max_interval].min.to_f
-        @attempts += 1
-        if target == 0
-          0  # in some Ruby versions it's illegal to call rand(0)
-        else
-          (target / 2) + @jitter_rand.rand(target / 2)
-        end
+        # Stop at the ceiling, so that the power of 2 cannot grow without limit.
+        @attempts += 1 if target < @max_interval
+        (target / 2) + @jitter_rand.rand(target / 2)
       end
 
       #

data/lib/ld-eventsource/version.rb

@@ -1,3 +1,3 @@
 module SSE
-  VERSION = "2.6.0" # x-release-please-version
+  VERSION = "3.0.1" # x-release-please-version
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ld-eventsource
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 3.0.1
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-26 00:00:00.000000000 Z
+date: 2026-10-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +114,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 description: LaunchDarkly SSE client for Ruby
 email:
 - team@launchdarkly.com