ld-eventsource 2.5.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c00daae667f29637ba82d85e504df0492d94f364b09bf1f2082dbf2eafae697
-  data.tar.gz: 1fe8ad53f9c4329df7e93f96347f306a5e1f78798910e45206c5378bdd5160a6
+  metadata.gz: dcf2b9358b588b57f4bba285ed1a91bd399fe04c74622a0d944fd3fa0c56e9bb
+  data.tar.gz: 22514811554b69e1225aebebb18bb531b65daf27c8f0d2284717791f21aeb771
 SHA512:
-  metadata.gz: 4aa8fcac3a6f23d04dcd865954af486711c45fcc6dcfe0158458c8729efa9d37ab8bd9e9b6820db68ccf86ea3f4b6bc51eeb29155e568df697a4842c58ab5fdb
-  data.tar.gz: f55c144c992d34190bfc68e59f3b42bf9af80692a82cf1ce847391eb3ae2adfeb7be7500a0f671a5d9efa62f44ce595cdc3b30a12b6f69ea7db6c06dad35789e
+  metadata.gz: b20450c7187809e03706778149944c6268782c0b307b58874f569af2c6eb635ec125c65ed2d1c3077438f63a95e1dc86411743deb432f7da71aa4945bbfc12c1
+  data.tar.gz: 06dc4097880991e04e3ad8a8c3c3f0d01488849d84f0cc98444cbb8cb558b7a9949fc56169e3b18e569b2fe18b1900cd25404bf882f114c9816f0a715b1f9480

data/lib/ld-eventsource/client.rb

@@ -52,6 +52,15 @@ module SSE
     # The default HTTP method for requests.
     DEFAULT_HTTP_METHOD = "GET"
 
+    # TODO(breaking): Remove this filtering once we have updated to the next major breaking version.
+    # HTTP v6 requires keyword arguments instead of an options hash, so we filter to only known valid
+    # arguments to avoid passing unsupported options.
+    VALID_HTTP_CLIENT_OPTIONS = %i[
+      base_uri body encoding features follow form headers json keep_alive_timeout
+      nodelay params persistent proxy response retriable socket_class ssl_context
+      ssl ssl_socket_class timeout_class timeout_options
+    ].freeze
+
     #
     # Creates a new SSE client.
     #
@@ -114,19 +123,19 @@ 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
-      @connect_timeout = connect_timeout
-      @read_timeout = read_timeout
+      @connect_timeout = connect_timeout&.to_f
+      @read_timeout = read_timeout&.to_f
       @method = method.to_s.upcase
       @payload = payload
       @logger = logger || default_logger
 
       base_http_client_options = {}
       if socket_factory
-        base_http_client_options["socket_class"] = socket_factory
+        base_http_client_options[:socket_class] = socket_factory
       end
 
       if proxy
@@ -139,22 +148,29 @@ module SSE
       end
 
       if @proxy
-        base_http_client_options["proxy"] = {
+        base_http_client_options[:proxy] = {
           :proxy_address => @proxy.host,
           :proxy_port => @proxy.port,
         }
-        base_http_client_options["proxy"][:proxy_username] = @proxy.user unless @proxy.user.nil?
-        base_http_client_options["proxy"][:proxy_password] = @proxy.password unless @proxy.password.nil?
+        base_http_client_options[:proxy][:proxy_username] = @proxy.user unless @proxy.user.nil?
+        base_http_client_options[:proxy][:proxy_password] = @proxy.password unless @proxy.password.nil?
       end
 
       options = http_client_options.is_a?(Hash) ? base_http_client_options.merge(http_client_options) : base_http_client_options
+      options = options.transform_keys(&:to_sym)
+      options = options.select do |key, _|
+        included = VALID_HTTP_CLIENT_OPTIONS.include?(key)
+        @logger.warn { "Ignoring unsupported HTTP client option: #{key}" } unless included
+        included
+      end
+
+      timeout_options = {}
+      timeout_options[:connect] = @connect_timeout if @connect_timeout
+      timeout_options[:read] = @read_timeout if @read_timeout
 
-      @http_client = HTTP::Client.new(options)
+      @http_client = HTTP::Client.new(**options)
         .follow
-        .timeout({
-          read: read_timeout,
-          connect: connect_timeout,
-        })
+      @http_client = @http_client.timeout(timeout_options) unless timeout_options.empty?
       @cxn = nil
       @lock = Mutex.new
 
@@ -262,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
@@ -273,7 +289,7 @@ module SSE
     # @return [Boolean]  true if the client has been shut down
     #
     def closed?
-      @stopped.value
+      @stop_event.set?
     end
 
     private
@@ -298,7 +314,7 @@ module SSE
     end
 
     def run_stream
-      until @stopped.value
+      until @stop_event.set?
         close_connection
         begin
           resp = connect
@@ -307,12 +323,16 @@ 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
           # 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")
@@ -331,18 +351,20 @@ module SSE
     # Try to establish a streaming connection. Returns the StreamingHTTPConnection 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
           uri = build_uri_with_query_params
           @logger.info { "Connecting to event stream at #{uri}" }
-          cxn = @http_client.request(@method, uri, build_opts)
+          cxn = @http_client.request(@method, uri, **build_opts)
           headers = cxn.headers
           if cxn.status.code == 200
             content_type = cxn.content_type.mime_type
@@ -379,7 +401,7 @@ module SSE
 
       chunks = Enumerator.new do |gen|
         loop do
-          if @stopped.value
+          if @stop_event.set?
             break
           else
             begin
@@ -390,8 +412,10 @@ module SSE
             rescue HTTP::TimeoutError
               # For historical reasons, we rethrow this as our own type
               raise Errors::ReadTimeoutError.new(@read_timeout)
+            rescue EOFError
+              raise Errors::StreamClosedByServerError
             end
-            break if data.nil?
+            raise Errors::StreamClosedByServerError if data.nil?  # keep for v5 compat
             gen.yield data
           end
         end
@@ -399,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)

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/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ld-eventsource
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 3.0.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-02 00:00:00.000000000 Z
+date: 2026-09-28 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
@@ -117,7 +103,7 @@ dependencies:
         version: 4.4.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -127,7 +113,21 @@ dependencies:
         version: 4.4.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        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