ld-eventsource 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14623ca76eeb863804646a598dec0a4f368bdd4fbf8875b7d5bb1be62c1845bd
-  data.tar.gz: 9c9d521d4e10f01f93f04431acfbbe2821434e99dd2738c09726827a84a96ed2
+  metadata.gz: 76ed80d3fefe60b6a147769dc1b44b0dfd7fe5b6841ff84655ae86764def70b9
+  data.tar.gz: cf24cff61716e4487d74023e09be18a516232a198aabcda2742fb8ec8de9de72
 SHA512:
-  metadata.gz: 4fccea73f41283286656e7a8ad8d10c72e0175b68a34499008d38d897d9a8828000d3f9cdb582dca682e182d1d0045240d0522fd9e28e72401410aad668a603d
-  data.tar.gz: c0756a730b152c06e7a1497703d1acdc0216a9ad8938798914fda239011d34d4c5bf521d51f3cf4f06829e6830befb550d9a47bf6d9fa19bda9ee3e2ba08972b
+  metadata.gz: 329c044114376d9d618e37a138b7c99dc5c4f00baa3d22ea72ce88309deec8bd22a62c0513a362223542f9ddfa5aaae0413e14bbf336ef943a90e0374d2d9c89
+  data.tar.gz: 9110b5daa08a3c7fb04bb432527feaf4bee5e67d02b215621c89546ffd0a4da98c14a9618cdf4040474afe1649db777996547bfb502512930a3b364f05dd57c1

data/lib/ld-eventsource/client.rb

@@ -306,6 +306,9 @@ module SSE
           else
             begin
               data = cxn.readpartial
+              # readpartial gives us a string, which may not be a valid UTF-8 string because a
+              # multi-byte character might not yet have been fully read, but BufferedLineReader
+              # will handle that.
             rescue HTTP::TimeoutError 
               # For historical reasons, we rethrow this as our own type
               raise Errors::ReadTimeoutError.new(@read_timeout)
@@ -315,7 +318,7 @@ module SSE
           end
         end
       end
-      event_parser = Impl::EventParser.new(Impl::BufferedLineReader.lines_from(chunks))
+      event_parser = Impl::EventParser.new(Impl::BufferedLineReader.lines_from(chunks), @last_id)
 
       event_parser.items.each do |item|
         return if @stopped.value
@@ -331,7 +334,7 @@ module SSE
 
     def dispatch_event(event)
       @logger.debug { "Received event: #{event}" }
-      @last_id = event.id
+      @last_id = event.id if !event.id.nil?
 
       # Pass the event to the caller
       @on[:event].call(event)
@@ -354,7 +357,7 @@ module SSE
         'Cache-Control' => 'no-cache',
         'User-Agent' => 'ruby-eventsource'
       }
-      h['Last-Event-Id'] = @last_id if !@last_id.nil?
+      h['Last-Event-Id'] = @last_id if !@last_id.nil? && @last_id != ""
       h.merge(@headers)
     end
   end

data/lib/ld-eventsource/events.rb

@@ -11,6 +11,10 @@ module SSE
   #     if there were multiple `data:` lines, they are concatenated with newlines
   # @!attribute id
   #   @return [String] the string that appeared after `id:` in the stream if any, or nil
+  # @!attribute last_event_id
+  #   @return [String] the `id:` value that was most recently seen in an event from
+  #     this stream; this differs from the `id` property in that it retains the same value
+  #     in subsequent events if they do not provide their own `id:`
   #
-  StreamEvent = Struct.new(:type, :data, :id)
+  StreamEvent = Struct.new(:type, :data, :id, :last_event_id)
 end

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

@@ -41,7 +41,11 @@ module SSE
         @last_good_time = nil
         target = ([@base_interval * (2 ** @attempts), @max_interval].min).to_f
         @attempts += 1
-        (target / 2) + @jitter_rand.rand(target / 2)
+        if target == 0
+          0  # in some Ruby versions it's illegal to call rand(0)
+        else
+          (target / 2) + @jitter_rand.rand(target / 2)
+        end
       end
 
       #

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

@@ -9,17 +9,21 @@ module SSE
       # input data runs out, the output enumerator ends and does not include any partially
       # completed line.
       #
-      # @param [Enumerator] chunks  an enumerator that will yield strings from a stream
-      # @return [Enumerator]  an enumerator that will yield one line at a time
+      # @param [Enumerator] chunks  an enumerator that will yield strings from a stream -
+      #  these are treated as raw UTF-8 bytes, regardless of the string's declared encoding
+      #  (so it is OK if a multi-byte character is split across chunks); if the declared
+      #  encoding of the chunk is not ASCII-8BIT, it will be changed to ASCII-8BIT in place
+      # @return [Enumerator]  an enumerator that will yield one line at a time in UTF-8
       #
       def self.lines_from(chunks)
-        buffer = ""
+        buffer = "".b
         position = 0
         line_start = 0
         last_char_was_cr = false
 
         Enumerator.new do |gen|
           chunks.each do |chunk|
+            chunk.force_encoding("ASCII-8BIT")
             buffer << chunk
 
             loop do
@@ -47,7 +51,12 @@ module SSE
                 next
               end
 
-              line = buffer[line_start, i - line_start]
+              line = buffer[line_start, i - line_start].force_encoding("UTF-8")
+              # Calling force_encoding just declares that we believe the encoding of this string to be
+              # UTF-8 (which is the only encoding allowed in the SSE protocol); it doesn't cause any
+              # re-decoding of the string. The previous line-parsing steps were done on raw 8-bit
+              # strings so that it won't try to do any UTF-8 decoding on intermediate slices.
+
               last_char_was_cr = false
               i += 1
               if ch == "\r"

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

@@ -23,8 +23,9 @@ module SSE
       # @param [Enumerator] lines  an enumerator that will yield one line of text at a time;
       #   the lines should not include line terminators
       #
-      def initialize(lines)
+      def initialize(lines, last_event_id = nil)
         @lines = lines
+        @last_event_id = last_event_id
         reset_buffers
       end
 
@@ -65,7 +66,10 @@ module SSE
             @data << value
             @have_data = true
           when "id"
-            @id = value
+            if !value.include?("\x00")
+              @id = value
+              @last_event_id = value
+            end
           when "retry"
             if /^(?<num>\d+)$/ =~ value
               return SetRetryInterval.new(num.to_i)
@@ -76,7 +80,7 @@ module SSE
 
       def maybe_create_event
         return nil if !@have_data
-        StreamEvent.new(@type || :message, @data, @id)
+        StreamEvent.new(@type || :message, @data, @id, @last_event_id)
       end
     end
   end

data/lib/ld-eventsource/version.rb

@@ -1,3 +1,3 @@
 module SSE
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ld-eventsource
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SSE client