ld-eventsource 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 385c043867b40ba6ddb46cb1c9b62837018b06cb
-  data.tar.gz: a64958fc36954f72b93c59d076ebdfb06787e13e
+SHA256:
+  metadata.gz: 76ed80d3fefe60b6a147769dc1b44b0dfd7fe5b6841ff84655ae86764def70b9
+  data.tar.gz: cf24cff61716e4487d74023e09be18a516232a198aabcda2742fb8ec8de9de72
 SHA512:
-  metadata.gz: 96cc3666962b0009ea86ec049ac1f0cac778c630c33037730007b7fa5eb338fbe779726004f0b63fa9a3bd4f6ad137879d731a3415ec1e2012de193fef609743
-  data.tar.gz: 485e8d424a5a9afb394d780fb06790af17f8bc81f03e7c9a5a2eef391c66cfe7fd006e30317b472150cadc3c73ddae712f75e6444d2e7419020e34e065db99c0
+  metadata.gz: 329c044114376d9d618e37a138b7c99dc5c4f00baa3d22ea72ce88309deec8bd22a62c0513a362223542f9ddfa5aaae0413e14bbf336ef943a90e0374d2d9c89
+  data.tar.gz: 9110b5daa08a3c7fb04bb432527feaf4bee5e67d02b215621c89546ffd0a4da98c14a9618cdf4040474afe1649db777996547bfb502512930a3b364f05dd57c1

data/lib/ld-eventsource/client.rb

@@ -1,4 +1,5 @@
 require "ld-eventsource/impl/backoff"
+require "ld-eventsource/impl/buffered_line_reader"
 require "ld-eventsource/impl/event_parser"
 require "ld-eventsource/events"
 require "ld-eventsource/errors"
@@ -128,11 +129,12 @@ module SSE
           read: read_timeout,
           connect: connect_timeout
         })
-      @buffer = ""
+      @cxn = nil
       @lock = Mutex.new
 
       @backoff = Impl::Backoff.new(reconnect_time || DEFAULT_RECONNECT_TIME, MAX_RECONNECT_TIME,
         reconnect_reset_interval: reconnect_reset_interval)
+      @first_attempt = true
 
       @on = { event: ->(_) {}, error: ->(_) {} }
       @last_id = last_event_id
@@ -190,51 +192,27 @@ module SSE
       end
     end
 
+    #
+    # Tests whether the client has been shut down by a call to {Client#close}.
+    #
+    # @return [Boolean]  true if the client has been shut down
+    #
+    def closed?
+      @stopped.value
+    end
+
     private
     
     def reset_http
       @http_client.close if !@http_client.nil?
-      @cxn = nil
-      @buffer = ""
-    end
-    
-    def read_lines
-      Enumerator.new do |gen|
-        loop do
-          line = read_line
-          break if line.nil?
-          gen.yield line
-        end
-      end
-    end
-    
-    def read_line
-      loop do
-        @lock.synchronize do
-          i = @buffer.index(/[\r\n]/)
-          if !i.nil? && !(i == @buffer.length - 1 && @buffer[i] == "\r")
-            i += 1 if (@buffer[i] == "\r" && @buffer[i + 1] == "\n")
-            return @buffer.slice!(0, i + 1).force_encoding(Encoding::UTF_8)
-          end
-        end
-        return nil if !read_chunk_into_buffer
-      end
+      close_connection
     end
     
-    def read_chunk_into_buffer
-      # If @done is set, it means the Parser has signaled end of response body
-      @lock.synchronize { return false if @done }
-      begin
-        data = @cxn.readpartial
-      rescue HTTP::TimeoutError 
-        # We rethrow this as our own type so the caller doesn't have to know the httprb API
-        raise Errors::ReadTimeoutError.new(@read_timeout)
+    def close_connection
+      @lock.synchronize do
+        @cxn.connection.close if !@cxn.nil?
+        @cxn = nil
       end
-      return false if data == nil
-      @buffer << data
-      # We are piping the content through the parser so that it can handle things like chunked
-      # encoding for us. The content ends up being appended to @buffer via our callback.
-      true
     end
 
     def default_logger
@@ -246,13 +224,16 @@ module SSE
 
     def run_stream
       while !@stopped.value
-        @cxn = nil
+        close_connection
         begin
-          @cxn = connect
+          resp = connect
+          @lock.synchronize do
+            @cxn = resp
+          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
-          read_stream(@cxn) if !@cxn.nil?
+          read_stream(resp) if !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.
@@ -274,7 +255,8 @@ module SSE
     def connect
       loop do
         return if @stopped.value
-        interval = @backoff.next_interval
+        interval = @first_attempt ? 0 : @backoff.next_interval
+        @first_attempt = false
         if interval > 0
           @logger.info { "Will retry connection after #{'%.3f' % interval} seconds" } 
           sleep(interval)
@@ -317,7 +299,27 @@ module SSE
       # it can automatically reset itself if enough time passes between failures.
       @backoff.mark_success
 
-      event_parser = Impl::EventParser.new(read_lines)
+      chunks = Enumerator.new do |gen|
+        loop do
+          if @stopped.value
+            break
+          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)
+            end
+            break if data.nil?
+            gen.yield data
+          end
+        end
+      end
+      event_parser = Impl::EventParser.new(Impl::BufferedLineReader.lines_from(chunks), @last_id)
+
       event_parser.items.each do |item|
         return if @stopped.value
         case item
@@ -332,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)
@@ -355,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

@@ -0,0 +1,82 @@
+
+module SSE
+  module Impl
+    class BufferedLineReader
+      #
+      # Reads a series of data chunks from an enumerator, and returns an enumerator that
+      # parses/aggregates these into text lines. The line terminator may be CR, LF, or
+      # CRLF for each line; terminators are not included in the returned lines. When the
+      # 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 -
+      #  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 = "".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
+              # Search for a line break in any part of the buffer that we haven't yet seen.
+              i = buffer.index(/[\r\n]/, position)
+              if i.nil?
+                # There isn't a line break yet, so we'll keep accumulating data in the buffer, using
+                # position to keep track of where we left off scanning. We can also discard any previously
+                # parsed lines from the buffer at this point.
+                if line_start > 0
+                  buffer.slice!(0, line_start)
+                  line_start = 0
+                end
+                position = buffer.length
+                break
+              end
+
+              ch = buffer[i]
+              if i == 0 && ch == "\n" && last_char_was_cr
+                # This is just the dangling LF of a CRLF pair
+                last_char_was_cr = false
+                i += 1
+                position = i
+                line_start = i
+                next
+              end
+
+              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"
+                if i == buffer.length
+                  last_char_was_cr = true # We'll break the line here, but be on watch for a dangling LF
+                elsif buffer[i] == "\n"
+                  i += 1
+                end
+              end
+              if i == buffer.length
+                buffer = ""
+                i = 0
+              end
+              position = i
+              line_start = i
+              gen.yield line
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,10 +20,12 @@ module SSE
       #
       # Constructs an instance of EventParser.
       #
-      # @param [Enumerator] lines  an enumerator that will yield one line of text at a time
+      # @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
 
@@ -31,7 +33,6 @@ module SSE
       def items
         Enumerator.new do |gen|
           @lines.each do |line|
-            line.chomp!
             if line.empty?
               event = maybe_create_event
               reset_buffers
@@ -53,6 +54,7 @@ module SSE
         @id = nil
         @type = nil
         @data = ""
+        @have_data = false
       end
 
       def process_field(name, value)
@@ -60,10 +62,14 @@ module SSE
           when "event"
             @type = value.to_sym
           when "data"
-            @data << "\n" if !@data.empty?
+            @data << "\n" if @have_data
             @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)
@@ -73,8 +79,8 @@ module SSE
       end
 
       def maybe_create_event
-        return nil if @data.empty?
-        StreamEvent.new(@type || :message, @data, @id)
+        return nil if !@have_data
+        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.0.0"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ld-eventsource
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,22 @@ dependencies:
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 description: LaunchDarkly SSE client for Ruby
 email:
 - team@launchdarkly.com
@@ -101,28 +107,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".ldrelease/config.yml"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
-- ld-eventsource.gemspec
 - lib/ld-eventsource.rb
 - lib/ld-eventsource/client.rb
 - lib/ld-eventsource/errors.rb
 - lib/ld-eventsource/events.rb
 - lib/ld-eventsource/impl/backoff.rb
+- lib/ld-eventsource/impl/buffered_line_reader.rb
 - lib/ld-eventsource/impl/event_parser.rb
 - lib/ld-eventsource/version.rb
-- scripts/gendocs.sh
-- scripts/release.sh
-- spec/backoff_spec.rb
-- spec/client_spec.rb
-- spec/event_parser_spec.rb
-- spec/http_stub.rb
 homepage: https://github.com/launchdarkly/ruby-eventsource
 licenses:
 - Apache-2.0
@@ -142,13 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SSE client
-test_files:
-- spec/backoff_spec.rb
-- spec/client_spec.rb
-- spec/event_parser_spec.rb
-- spec/http_stub.rb
+test_files: []

data/.circleci/config.yml

@@ -1,51 +0,0 @@
-version: 2
-
-workflows:
-  version: 2
-  test:
-    jobs:
-      - test-2.5
-      - test-2.6
-      - test-2.7
-      - test-3.0
-      - test-jruby-9.2
-
-ruby-docker-template: &ruby-docker-template
-  steps:
-    - checkout
-    - run: |
-        if [[ $CIRCLE_JOB == test-jruby* ]]; then
-          gem install jruby-openssl; # required by bundler, no effect on Ruby MRI
-        fi
-    - run: sudo apt-get update -y && sudo apt-get install -y build-essential
-    - run: ruby -v
-    - run: gem install bundler -v "~> 1.17"
-    - run: bundle install
-    - run: mkdir ./rspec
-    - run: bundle exec rspec --format progress --format RspecJunitFormatter -o ./rspec/rspec.xml spec
-    - store_test_results:
-        path: ./rspec
-    - store_artifacts:
-        path: ./rspec
-
-jobs:
-  test-2.5:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.5
-  test-2.6:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.6
-  test-2.7:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.7
-  test-3.0:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:3.0
-  test-jruby-9.2:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/jruby:9.2-jdk

data/.gitignore

@@ -1,16 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-*.gem
-.DS_Store
-rspec

data/.ldrelease/config.yml

@@ -1,17 +0,0 @@
-repo:
-  public: ruby-eventsource
-
-publications:
-  - url: https://rubygems.org/gems/ld-eventsource
-    description: RubyGems
-  - url: https://www.rubydoc.info/gems/ld-eventsource
-    description: documentation
-
-releasableBranches:
-  - name: master
-    description: 2.x - based on the http gem
-  - name: 1.x
-    description: 1.x - based on the socketry gem
-
-template:
-  name: ruby

data/CHANGELOG.md

@@ -1,20 +0,0 @@
-# Change log
-
-All notable changes to the LaunchDarkly SSE Client for Ruby will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
-
-## [1.0.3] - 2020-03-17
-### Fixed:
-- The backoff delay logic for reconnecting after a stream failure was broken so that if a failure occurred after a stream had been active for at least `reconnect_reset_interval` (default 60 seconds), retries would use _no_ delay, potentially causing a flood of requests and a spike in CPU usage.
-
-## [1.0.2] - 2020-03-10
-### Removed:
-- Removed an unused dependency on `rake`. There are no other changes in this release.
-
-
-## [1.0.1] - 2019-07-10
-### Fixed:
-- Calling `close` on the client could cause a misleading warning message in the log, such as `Unexpected error from event source: #<IOError: stream closed in another thread>`.
-
-## [1.0.0] - 2019-01-03
-
-Initial release.

data/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ld-eventsource (2.0.0)
-      concurrent-ruby (~> 1.0)
-      http (~> 4.4.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    concurrent-ruby (1.1.8)
-    diff-lcs (1.3)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    ffi (1.14.2)
-    ffi (1.14.2-java)
-    ffi-compiler (1.0.1)
-      ffi (>= 1.0.0)
-      rake
-    http (4.4.1)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 2.2)
-      http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    http-form_data (2.3.0)
-    http-parser (1.2.3)
-      ffi-compiler (>= 1.0, < 2.0)
-    public_suffix (4.0.6)
-    rake (13.0.3)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    rspec_junit_formatter (0.3.0)
-      rspec-core (>= 2, < 4, != 2.12.0)
-    unf (0.1.4)
-      unf_ext
-    unf (0.1.4-java)
-    unf_ext (0.0.7.7)
-    webrick (1.7.0)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.7)
-  ld-eventsource!
-  rspec (~> 3.2)
-  rspec_junit_formatter (~> 0.3.0)
-  webrick (~> 1.7)
-
-BUNDLED WITH
-   1.17.3

data/ld-eventsource.gemspec

@@ -1,30 +0,0 @@
-# coding: utf-8
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ld-eventsource/version"
-
-# rubocop:disable Metrics/BlockLength
-Gem::Specification.new do |spec|
-  spec.name          = "ld-eventsource"
-  spec.version       = SSE::VERSION
-  spec.authors       = ["LaunchDarkly"]
-  spec.email         = ["team@launchdarkly.com"]
-  spec.summary       = "LaunchDarkly SSE client"
-  spec.description   = "LaunchDarkly SSE client for Ruby"
-  spec.homepage      = "https://github.com/launchdarkly/ruby-eventsource"
-  spec.license       = "Apache-2.0"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
-  spec.add_development_dependency "webrick", "~> 1.7"
-
-  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
-  spec.add_runtime_dependency "http", "~> 4.4.1"
-end

data/scripts/gendocs.sh

@@ -1,12 +0,0 @@
-#!/bin/bash
-
-# Use this script to generate documentation locally in ./doc so it can be proofed before release.
-# After release, documentation will be visible at https://www.rubydoc.info/gems/ld-eventsource
-
-gem install --conservative yard
-gem install --conservative redcarpet  # provides Markdown formatting
-
-# yard doesn't seem to do recursive directories, even though Ruby's Dir.glob supposedly recurses for "**"
-PATHS="lib/*.rb lib/**/*.rb lib/**/**/*.rb"
-
-yard doc --no-private --markup markdown --markup-provider redcarpet --embed-mixins $PATHS - README.md