ld-eventsource 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5199039ee9ec2f9b9843d5bbb79dbc12ca2a625cc0d79cb99b97bb41de729a6c
-  data.tar.gz: 37b524d87e083d857ab4202749f6f2aac649cb0b31c04401ecfe4dfa68d082ca
+  metadata.gz: 3ba844140cea3837caa7a02aa4676af7483faa11230a353da421e435932553b3
+  data.tar.gz: 30619609829908038a63d8302cefdbe8bda6935dc691ceaaabff225f2747da8c
 SHA512:
-  metadata.gz: 6d1243db76fb427d8c5bcaae4976ce2942fe10c3ec45d4846f0b2b0d57bcb8ceb7a629da61f5f5a1f219afe29f8c1e5b8039dfad44af9b405225773499c9b4fd
-  data.tar.gz: 3a01a8c90f08f4740e27faf2d0789750fb15076a1e1242e45eebf09219ae500848003d09eeaa53fa16a14009383bbb424690b78419a01956d4cd7bbebfca0673
+  metadata.gz: 6b0ffc7be77854b053bc561d1389c3cb6327290066697ca40e6d7a96e29ad9192013b733e9b2973d0b1ebcb5aee66e0eb530066f6bbc3762f95fa80d28183b33
+  data.tar.gz: 7efe744ebf4c9cb9b4302fbbf5d2348a31a3f99f45de8cbd54346d2ac5eed8de8c8e79d5120888a2103d712afaf71035ebeec712664a797c229694a561b7dbe9

data/lib/ld-eventsource/client.rb

@@ -162,7 +162,7 @@ module SSE
         reconnect_reset_interval: reconnect_reset_interval)
       @first_attempt = true
 
-      @on = { event: ->(_) {}, error: ->(_) {} }
+      @on = { event: ->(_) {}, error: ->(_) {}, connect: ->(_) {} }
       @last_id = last_event_id
       @query_params_callback = nil
 
@@ -207,6 +207,26 @@ module SSE
       @on[:error] = action
     end
 
+    #
+    # Specifies a block or Proc to be called when a successful connection is established. This will
+    # be called with a single parameter containing the HTTP response headers. It is called
+    # from the same worker thread that reads the stream, so no more events will be dispatched until
+    # it returns.
+    #
+    # This is called every time a connection is successfully established, including on reconnections
+    # after a failure. It allows you to inspect server response headers such as rate limits, custom
+    # metadata, or fallback directives (e.g., `X-LD-FD-FALLBACK`).
+    #
+    # Any previously specified connect handler will be replaced.
+    #
+    # @yieldparam headers [Hash, nil] the HTTP response headers from the successful connection,
+    #   or nil if not available. The headers object uses case-insensitive keys (via the http gem's
+    #   HTTP::Headers).
+    #
+    def on_connect(&action)
+      @on[:connect] = 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
@@ -323,13 +343,15 @@ module SSE
           uri = build_uri_with_query_params
           @logger.info { "Connecting to event stream at #{uri}" }
           cxn = @http_client.request(@method, uri, build_opts)
+          headers = cxn.headers
           if cxn.status.code == 200
             content_type = cxn.content_type.mime_type
             if content_type && content_type.start_with?("text/event-stream")
+              @on[:connect].call(headers)  # Notify connect callback with headers
               return cxn  # we're good to proceed
             else
               reset_http
-              err = Errors::HTTPContentTypeError.new(content_type)
+              err = Errors::HTTPContentTypeError.new(content_type, headers)
               @on[:error].call(err)
               @logger.warn { "Event source returned unexpected content type '#{content_type}'" }
             end
@@ -337,7 +359,7 @@ module SSE
             body = cxn.to_s  # grab the whole response body in case it has error details
             reset_http
             @logger.info { "Server returned error status #{cxn.status.code}" }
-            err = Errors::HTTPStatusError.new(cxn.status.code, body)
+            err = Errors::HTTPStatusError.new(cxn.status.code, body, headers)
             @on[:error].call(err)
           end
         rescue

data/lib/ld-eventsource/errors.rb

@@ -9,9 +9,10 @@ module SSE
     # handler specified in {Client#on_error}.
     #
     class HTTPStatusError < StandardError
-      def initialize(status, message)
+      def initialize(status, message, headers = nil)
         @status = status
         @message = message
+        @headers = headers
         super("HTTP error #{status}")
       end
 
@@ -22,6 +23,13 @@ module SSE
       # The response body, if any.
       # @return [String]
       attr_reader :message
+
+      # The HTTP response headers, if any.
+      #
+      # The headers object uses case-insensitive keys (via the http gem's HTTP::Headers).
+      #
+      # @return [Hash, nil] the response headers, or nil if not available
+      attr_reader :headers
     end
 
     #
@@ -29,14 +37,22 @@ module SSE
     # handler specified in {Client#on_error}.
     #
     class HTTPContentTypeError < StandardError
-      def initialize(type)
+      def initialize(type, headers = nil)
         @content_type = type
+        @headers = headers
         super("invalid content type \"#{type}\"")
       end
 
       # The HTTP content type.
       # @return [String]
       attr_reader :type
+
+      # The HTTP response headers, if any.
+      #
+      # The headers object uses case-insensitive keys (via the http gem's HTTP::Headers).
+      #
+      # @return [Hash, nil] the response headers, or nil if not available
+      attr_reader :headers
     end
 
     #

data/lib/ld-eventsource/version.rb

@@ -1,3 +1,3 @@
 module SSE
-  VERSION = "2.4.0" # x-release-please-version
+  VERSION = "2.5.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.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-15 00:00:00.000000000 Z
+date: 2026-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger