ld-eventsource 2.2.6 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1011203906e4edf8d237499d75edc29f0c4eb4917189941fd02e9953492e5f77
-  data.tar.gz: e2f0bfa715c896259f51c70f84f8bd3640959f7821228813c304222292a50445
+  metadata.gz: 5199039ee9ec2f9b9843d5bbb79dbc12ca2a625cc0d79cb99b97bb41de729a6c
+  data.tar.gz: 37b524d87e083d857ab4202749f6f2aac649cb0b31c04401ecfe4dfa68d082ca
 SHA512:
-  metadata.gz: 985d8ed3a900de96dfb99bc582227903f727a097dc53826f23062f4b8585f3b76e1300381eb43703eb15f33256e26433ffb884d036c09af0e667780e7040767a
-  data.tar.gz: 5dd455b911c275cdc98db3dbff4fd70dce1b7b6ccada654053e79639aa8351552e466b8574ce6de97cab875f5f8c7448c957ce1a33af3822f86e89ce836ba43b
+  metadata.gz: 6d1243db76fb427d8c5bcaae4976ce2942fe10c3ec45d4846f0b2b0d57bcb8ceb7a629da61f5f5a1f219afe29f8c1e5b8039dfad44af9b405225773499c9b4fd
+  data.tar.gz: 3a01a8c90f08f4740e27faf2d0789750fb15076a1e1242e45eebf09219ae500848003d09eeaa53fa16a14009383bbb424690b78419a01956d4cd7bbebfca0673

data/lib/ld-eventsource/client.rb

@@ -49,6 +49,9 @@ module SSE
     # The default value for `reconnect_reset_interval` in {#initialize}.
     DEFAULT_RECONNECT_RESET_INTERVAL = 60
 
+    # The default HTTP method for requests.
+    DEFAULT_HTTP_METHOD = "GET"
+
     #
     # Creates a new SSE client.
     #
@@ -84,6 +87,16 @@ module SSE
     # @param socket_factory [#open] (nil)  an optional factory object for creating sockets,
     #   if you want to use something other than the default `TCPSocket`; it must implement
     #   `open(uri, timeout)` to return a connected `Socket`
+    # @param method [String] ("GET")  the HTTP method to use for requests
+    # @param payload [String, Hash, Array, #call] (nil)  optional request payload. If payload is a Hash or
+    #   an Array, it will be converted to JSON and sent as the request body. A string will be sent as a non-JSON
+    #   request body. If payload responds to #call, it will be invoked on each
+    #   request to generate the payload dynamically.
+    # @param retry_enabled [Boolean] (true)  whether to retry connections after failures. If false, the client
+    #   will exit after the first connection failure instead of attempting to reconnect.
+    # @param http_client_options [Hash] (nil)  additional options to pass to
+    #   the HTTP client, such as `socket_factory` or `proxy`. These settings will override
+    #   the socket factory and proxy settings.
     # @yieldparam [Client] client  the new client instance, before opening the connection
     #
     def initialize(uri,
@@ -95,17 +108,25 @@ module SSE
           last_event_id: nil,
           proxy: nil,
           logger: nil,
-          socket_factory: nil)
+          socket_factory: nil,
+          method: DEFAULT_HTTP_METHOD,
+          payload: nil,
+          retry_enabled: true,
+          http_client_options: nil)
       @uri = URI(uri)
       @stopped = Concurrent::AtomicBoolean.new(false)
+      @retry_enabled = retry_enabled
 
       @headers = headers.clone
       @connect_timeout = connect_timeout
       @read_timeout = read_timeout
+      @method = method.to_s.upcase
+      @payload = payload
       @logger = logger || default_logger
-      http_client_options = {}
+
+      base_http_client_options = {}
       if socket_factory
-        http_client_options["socket_class"] = socket_factory
+        base_http_client_options["socket_class"] = socket_factory
       end
 
       if proxy
@@ -118,13 +139,18 @@ module SSE
       end
 
       if @proxy
-        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?
       end
 
-      @http_client = HTTP::Client.new(http_client_options)
+      options = http_client_options.is_a?(Hash) ? base_http_client_options.merge(http_client_options) : base_http_client_options
+
+      @http_client = HTTP::Client.new(options)
+        .follow
         .timeout({
           read: read_timeout,
           connect: connect_timeout,
@@ -138,6 +164,7 @@ module SSE
 
       @on = { event: ->(_) {}, error: ->(_) {} }
       @last_id = last_event_id
+      @query_params_callback = nil
 
       yield self if block_given?
 
@@ -180,6 +207,36 @@ module SSE
       @on[:error] = action
     end
 
+    #
+    # Specifies a block or Proc to generate query parameters dynamically. This will be called before
+    # each connection attempt (both initial connection and reconnections), allowing you to update
+    # query parameters based on the current client state.
+    #
+    # The block should return a Hash with string keys and string values, which will be merged with
+    # any existing query parameters in the base URI. If the callback raises an exception, it will be
+    # logged and the connection will proceed with the base URI's query parameters (or no query
+    # parameters if none were present).
+    #
+    # This is useful for scenarios where query parameters need to reflect the current state of the
+    # client, such as sending a "basis" parameter that represents what data the client already has.
+    #
+    # @example Using dynamic query parameters
+    #     client = SSE::Client.new(base_uri) do |c|
+    #       c.query_params do
+    #         {
+    #           "basis" => (selector.state if selector.defined?),
+    #           "filter" => filter_key
+    #         }.compact
+    #       end
+    #       c.on_event { |event| handle_event(event) }
+    #     end
+    #
+    # @yieldreturn [Hash<String, String>] a hash of query parameter names to values
+    #
+    def query_params(&action)
+      @query_params_callback = action
+    end
+
     #
     # Permanently shuts down the client and its connection. No further events will be dispatched. This
     # has no effect if called a second time.
@@ -246,6 +303,8 @@ module SSE
         rescue StandardError => e
           log_and_dispatch_error(e, "Unexpected error while closing stream")
         end
+
+        return close unless @retry_enabled
       end
     end
 
@@ -261,10 +320,9 @@ module SSE
         end
         cxn = nil
         begin
-          @logger.info { "Connecting to event stream at #{@uri}" }
-          cxn = @http_client.request("GET", @uri, {
-            headers: build_headers,
-          })
+          uri = build_uri_with_query_params
+          @logger.info { "Connecting to event stream at #{uri}" }
+          cxn = @http_client.request(@method, uri, build_opts)
           if cxn.status.code == 200
             content_type = cxn.content_type.mime_type
             if content_type && content_type.start_with?("text/event-stream")
@@ -358,5 +416,40 @@ module SSE
       h['Last-Event-Id'] = @last_id if !@last_id.nil? && @last_id != ""
       h.merge(@headers)
     end
+
+    def build_opts
+      return {headers: build_headers} if @payload.nil?
+
+      # Resolve payload if it's callable
+      resolved_payload = @payload.respond_to?(:call) ? @payload.call : @payload
+
+      if resolved_payload.is_a?(Hash) || resolved_payload.is_a?(Array)
+        {headers: build_headers, json: resolved_payload}
+      else
+        {headers: build_headers, body: resolved_payload.to_s}
+      end
+    end
+
+    def build_uri_with_query_params
+      uri = @uri.dup
+
+      if @query_params_callback
+        begin
+          dynamic_params = @query_params_callback.call
+          if dynamic_params.is_a?(Hash) && !dynamic_params.empty?
+            existing_params = uri.query ? URI.decode_www_form(uri.query).to_h : {}
+            merged_params = existing_params.merge(dynamic_params)
+            uri.query = URI.encode_www_form(merged_params)
+          elsif !dynamic_params.is_a?(Hash)
+            @logger.warn { "query_params callback returned non-Hash value: #{dynamic_params.class}, ignoring" }
+          end
+        rescue StandardError => e
+          @logger.warn { "query_params callback raised an exception: #{e.inspect}, proceeding with base URI" }
+          @logger.debug { "Exception trace: #{e.backtrace}" }
+        end
+      end
+
+      uri
+    end
   end
 end

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

@@ -42,9 +42,14 @@ module SSE
 
               pos += 1  # skip colon
               pos += 1 if pos < line.length && line[pos] == ' '  # skip optional single space, per SSE spec
-              line = line.slice(pos..-1)
+              value = line.slice(pos..-1)
 
-              item = process_field(name, line)
+              item = process_field(name, value)
+              gen.yield item unless item.nil?
+            else
+              # Handle field with no colon - treat as having empty value
+              # According to SSE spec, a line like "data" should be treated as "data:"
+              item = process_field(line, "")
               gen.yield item unless item.nil?
             end
           end

data/lib/ld-eventsource/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ld-eventsource
 version: !ruby/object:Gem::Version
-  version: 2.2.6
+  version: 2.4.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-15 00:00:00.000000000 Z
+date: 2026-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger