ld-eventsource 1.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8af7db395f6a4a500ea56ff3f742aab25b8ca416
-  data.tar.gz: ee59c90efdf456e277a6f6ea7209a62941dbe96b
+SHA256:
+  metadata.gz: e62fdcf615bb0c699746e63a929e5eb582b8680cf873659d2be9e7e018fb0a89
+  data.tar.gz: f5f2b5694a3049e4f5dc2fd5f49de948ab6a8d040151d506a5589b0da4bca0f6
 SHA512:
-  metadata.gz: 3c1c5e63d0f8bcff6c27a60f9a8cb04f5d1ffc3e4128bc5d9822f19663934b70ab3f90725ba747b4e13cc77c154c8d23605ed677c392dab980fd56c3d87d8cef
-  data.tar.gz: eec5bfce676d858bca4d8c687c043d45f2e200d3fb8819d693e81812e5504f597fcbed9bbe011d29f4aba967ee17de1e1302b3b673fbb5d2b9af03ba6558a823
+  metadata.gz: dd8ec3f6a4719860f1bf32bef767917a6b97753b8c9eb060c5478fa93b9115c3090313d5cfe4d00137dd1f764cb4bdfb3af000246718dd446691912f4c17ee1d
+  data.tar.gz: 23a6178d006572791caddbfb372bd9a4c68c5e9f32c272c7b3230008698744e973fcecee8d51b2bfc5471ba99f18190b95e0f074307b77dee81d1274b0416d07

data/.circleci/config.yml

@@ -1,92 +1,39 @@
-version: 2
-
+# This CircleCI configuration was generated by Releaser for a specific release. It is not to be used
+# for regular CI builds. Be aware that rerunning this build may cause it to repeat release actions
+# such as publishing to a package manager. However, it will not perform any Git actions other than
+# reading the repository.
+version: 2.1
 workflows:
-  version: 2
   test:
     jobs:
-      - test-misc-rubies
-      - test-2.2
-      - test-2.3
-      - test-2.4
-      - test-2.5
-      - 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: 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
-
+      - release_linux:
+          context: org-global
 jobs:
-  test-2.2:
-    <<: *ruby-docker-template
+  release_linux:
     docker:
-      - image: circleci/ruby:2.2.10-jessie
-  test-2.3:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.3.7-jessie
-  test-2.4:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.4.5-stretch
-  test-2.5:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/ruby:2.5.3-stretch
-  test-jruby-9.2:
-    <<: *ruby-docker-template
-    docker:
-      - image: circleci/jruby:9-jdk
-
-  # The following very slow job uses an Ubuntu container to run the Ruby versions that
-  # CircleCI doesn't provide Docker images for.
-  test-misc-rubies:
-    machine:
-      image: circleci/classic:latest
+      - image: cimg/ruby:2.5
     environment:
-      - RUBIES: "jruby-9.1.17.0"
+      LD_RELEASE_CIRCLECI_TYPE: linux
+      LD_RELEASE_BRANCH: "master"
+      LD_RELEASE_CIRCLECI_BRANCH: ""
+      LD_RELEASE_DOCS_GITHUB_PAGES: ""
+      LD_RELEASE_DOCS_TITLE: ""
+      LD_RELEASE_PROJECT: "ruby-eventsource"
+      LD_RELEASE_PROJECT_TEMPLATE: "ruby"
+      LD_RELEASE_VERSION: "2.1.0"
     steps:
       - checkout
       - run:
-          name: install all Ruby versions
-          command: "parallel rvm install ::: $RUBIES"
+          name: "Releaser: prepare"
+          command: .ldrelease/circleci/mac/execute.sh prepare .ldrelease/circleci/template/prepare.sh
+      - run:
+          name: "Releaser: build"
+          command: .ldrelease/circleci/mac/execute.sh build .ldrelease/circleci/template/build.sh
       - run:
-          name: bundle install for all versions
-          shell: /bin/bash -leo pipefail # need -l in order for "rvm use" to work
-          command: |
-            set -e;
-            for i in $RUBIES;
-            do
-              rvm use $i;
-              if [[ $i == jruby* ]]; then
-                gem install jruby-openssl; # required by bundler, no effect on Ruby MRI
-              fi;
-              # bundler 2.0 may be preinstalled, we need to remove it if so
-              yes | gem uninstall bundler --version '>=2.0' || true;
-              gem install bundler -v "~> 1.17";
-              bundle install;
-              mv Gemfile.lock "Gemfile.lock.$i"
-            done
+          name: "Releaser: test"
+          command: .ldrelease/circleci/mac/execute.sh test .ldrelease/circleci/template/test.sh
       - run:
-          name: run tests for all versions
-          shell: /bin/bash -leo pipefail
-          command: |
-            set -e;
-            for i in $RUBIES;
-            do
-              rvm use $i;
-              cp "Gemfile.lock.$i" Gemfile.lock;
-              bundle exec rspec spec;
-            done
+          name: "Releaser: publish"
+          command: .ldrelease/circleci/mac/execute.sh publish .ldrelease/circleci/template/publish.sh
+      - store_artifacts:
+          path: artifacts

data/.gitignore

@@ -13,3 +13,5 @@
 mkmf.log
 *.gem
 .DS_Store
+rspec
+Gemfile.lock

data/.ldrelease/circleci/linux/execute.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -ue
+
+# Performs a delegated release step in a CircleCI Linux container. This mechanism is described
+# in scripts/circleci/README.md. All of the necessary environment variables should already be
+# in the generated CircleCI configuration.
+
+mkdir -p artifacts
+
+export LD_RELEASE_TEMP_DIR=/tmp/project-releaser-temp
+mkdir -p ${LD_RELEASE_TEMP_DIR}
+
+STEP="$1"
+SCRIPT="$2"
+echo
+echo "[${STEP}] executing ${SCRIPT}"
+"./${SCRIPT}"

data/.ldrelease/circleci/mac/execute.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -ue
+
+# Performs a delegated release step in a CircleCI Mac container. This mechanism is described
+# in scripts/circleci/README.md. All of the necessary environment variables should already be
+# in the generated CircleCI configuration.
+
+mkdir -p artifacts
+
+export LD_RELEASE_TEMP_DIR=/tmp/project-releaser-temp
+mkdir -p ${LD_RELEASE_TEMP_DIR}
+
+STEP="$1"
+SCRIPT="$2"
+echo
+echo "[${STEP}] executing ${SCRIPT}"
+"./${SCRIPT}"

data/.ldrelease/circleci/template/build.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -ue
+
+# Standard build.sh for Ruby-based projects that publish a gem
+
+echo "Using gem $(gem --version)"
+
+#shellcheck source=/dev/null
+source "$(dirname "$0")/gems-setup.sh"
+
+echo; echo "Installing dependencies"
+${BUNDLER_COMMAND} install
+
+# Build Ruby Gem - this assumes there is a single .gemspec file in the main project directory
+# Note that the gemspec must be able to get the project version either from $LD_RELEASE_VERSION,
+# or from somewhere in the source code that the project-specific update-version.sh has updated.
+echo "Running gem build"
+gem build ./*.gemspec || { echo "gem build failed" >&2; exit 1; }

data/.ldrelease/circleci/template/gems-setup.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# helper script to set GEM_HOME, PATH, and BUNDLER_COMMAND for Ruby - must be sourced, not executed
+
+mkdir -p "${LD_RELEASE_TEMP_DIR}/gems"
+export GEM_HOME="${LD_RELEASE_TEMP_DIR}/gems"
+export PATH="${GEM_HOME}/bin:${PATH}"
+
+# also, determine whether we'll need to run a specific version of Bundler
+
+GEMSPEC_BUNDLER_VERSION=$(sed -n -e "s/.*['\"]bundler['\"], *['\"]\([^'\"]*\)['\"]/\1/p" ./*.gemspec | tr -d ' ')
+if [ -n "${GEMSPEC_BUNDLER_VERSION}" ]; then
+  BUNDLER_COMMAND="bundler _${GEMSPEC_BUNDLER_VERSION}_"
+else
+  BUNDLER_COMMAND="bundler"
+fi

data/.ldrelease/circleci/template/prepare.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -ue
+
+echo "Using gem $(gem --version)"
+
+#shellcheck source=/dev/null
+source "$(dirname "$0")/gems-setup.sh"
+
+# If the gemspec specifies a certain version of bundler, we need to make sure we install that version.
+echo "Installing bundler"
+if [ -n "${GEMSPEC_BUNDLER_VERSION:-}" ]; then
+  GEMSPEC_OPTIONS="-v ${GEMSPEC_BUNDLER_VERSION}"
+else
+  GEMSPEC_OPTIONS=""
+fi
+gem install bundler ${GEMSPEC_OPTIONS} || { echo "installing bundler failed" >&2; exit 1; }

data/.ldrelease/circleci/template/publish.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -ue
+
+# Standard publish.sh for Ruby-based projects - we can assume build.sh has already been run
+
+#shellcheck source=/dev/null
+source "$(dirname "$0")/gems-setup.sh"
+
+# If we're running in CircleCI, the RubyGems credentials will be in an environment
+# variable and should be copied to the variable the gem command expects
+if [ -n "${LD_RELEASE_RUBYGEMS_API_KEY:-}" ]; then
+  export GEM_HOST_API_KEY="${LD_RELEASE_RUBYGEMS_API_KEY}"
+fi
+
+# Since all Releaser builds are clean builds, we can assume that the only .gem file here
+# is the one we just built
+echo "Running gem push"
+gem push ./*.gem || { echo "gem push failed" >&2; exit 1; }

data/.ldrelease/circleci/template/test.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -ue
+
+# Standard test.sh for Ruby-based projects
+
+#shellcheck source=/dev/null
+source "$(dirname "$0")/gems-setup.sh"
+
+${BUNDLER_COMMAND} exec rspec spec

data/.ldrelease/circleci/template/update-version.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -ue
+
+# Standard update-version.sh for Ruby-based projects - this will work only if the version string
+# is in a source file under lib/ that has a line like his: VERSION = "2.0.0"
+
+"$(dirname "$0")/../update-version-constant.sh" lib '*.rb'

data/.ldrelease/circleci/windows/execute.ps1

@@ -0,0 +1,19 @@
+param(
+    [string]$step,
+    [string]$script
+)
+
+# Performs a delegated release step in a CircleCI Windows container using PowerShell. This
+# mechanism is described in scripts/circleci/README.md. All of the necessary environment
+# variables should already be in the generated CircleCI configuration.
+
+$ErrorActionPreference = "Stop"
+
+New-Item -Path "./artifacts" -ItemType "directory" -Force | Out-Null
+
+$env:LD_RELEASE_TEMP_DIR = "$env:TEMP\project-releaser-temp"
+New-Item -Path $env:LD_RELEASE_TEMP_DIR -ItemType "directory" -Force | Out-Null
+
+Write-Host
+Write-Host "[$step] executing $script"
+& "./$script"

data/.ldrelease/config.yml

@@ -1,3 +1,5 @@
+repo:
+  public: ruby-eventsource
 
 publications:
   - url: https://rubygems.org/gems/ld-eventsource
@@ -5,5 +7,16 @@ publications:
   - 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
+
+circleci:
+  linux:
+    image: cimg/ruby:2.5
+    context: org-global
+
 template:
   name: ruby

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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).
 
+## [2.0.1] - 2021-08-10
+### Changed:
+- The dependency version constraint for the `http` gem is now looser: it allows 5.x versions as well as 4.x. The breaking changes in `http` v5.0.0 do not affect `ld-eventsource`.
+- The project's build now uses v2.2.10 of `bundler` due to known vulnerabilities in other versions.
+- `Gemfile.lock` has been removed from source control. As this is a library project, the lockfile never affected application code that used this gem, but only affected the gem's own CI build. It is preferable for the CI build to refer only to the gemspec so that it resolves dependencies the same way an application using this gem would, rather than using pinned dependencies that an application would not use.
+
+## [2.0.0] - 2021-01-26
+### Added:
+- Added a `socket_factory` configuration option which can be used for socket creation by the HTTP client if provided. The value of `socket_factory` must be an object providing an `open(uri, timeout)` method and returning a connected socket.
+
+### Changed:
+- Switched to the `http` gem instead of `socketry` and a custom HTTP client.
+- Dropped support for Ruby < version 2.5
+- Dropped support for JRuby < version 9.2
+
+## [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.

data/README.md

@@ -3,14 +3,14 @@ LaunchDarkly SSE Client for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/ld-eventsource.svg)](http://badge.fury.io/rb/ld-eventsource) [![Circle CI](https://circleci.com/gh/launchdarkly/ruby-eventsource/tree/master.svg?style=svg)](https://circleci.com/gh/launchdarkly/ruby-eventsource/tree/master)
 
-A client for the [Server-Sent Events](https://www.w3.org/TR/eventsource/) protocol. This implementation runs on a worker thread, and uses the [`socketry`](https://rubygems.org/gems/socketry) gem to manage a persistent connection. Its primary purpose is to support the [LaunchDarkly SDK for Ruby](https://github.com/launchdarkly/ruby-client), but it can be used independently.
+A client for the [Server-Sent Events](https://www.w3.org/TR/eventsource/) protocol. This implementation runs on a worker thread, and uses the [`http`](https://rubygems.org/gems/http) gem to manage a persistent connection. Its primary purpose is to support the [LaunchDarkly SDK for Ruby](https://github.com/launchdarkly/ruby-client), but it can be used independently.
 
 Parts of this code are based on https://github.com/Tonkpils/celluloid-eventsource, but it does not use Celluloid.
 
 Supported Ruby versions
 -----------------------
 
-This gem has a minimum Ruby version of 2.2.6, or 9.1.6 for JRuby.
+This gem has a minimum Ruby version of 2.5, or 9.2 for JRuby.
 
 Quick setup
 -----------

data/ld-eventsource.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
   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 "bundler", "2.2.10"
   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_tools", '~> 0.4.5'
-  spec.add_runtime_dependency "socketry", "~> 0.5.1"
+  spec.add_runtime_dependency "http", ">= 4.4.1", "< 6.0.0"
 end

data/lib/ld-eventsource/client.rb

@@ -1,6 +1,5 @@
 require "ld-eventsource/impl/backoff"
 require "ld-eventsource/impl/event_parser"
-require "ld-eventsource/impl/streaming_http"
 require "ld-eventsource/events"
 require "ld-eventsource/errors"
 
@@ -8,6 +7,7 @@ require "concurrent/atomics"
 require "logger"
 require "thread"
 require "uri"
+require "http"
 
 module SSE
   #
@@ -80,6 +80,9 @@ module SSE
     #   proxy with the `HTTP_PROXY` or `HTTPS_PROXY` environment variable)
     # @param logger [Logger]  a Logger instance for the client to use for diagnostic output;
     #   defaults to a logger with WARN level that goes to standard output
+    # @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`
     # @yieldparam [Client] client  the new client instance, before opening the connection
     # 
     def initialize(uri,
@@ -90,7 +93,8 @@ module SSE
           reconnect_reset_interval: DEFAULT_RECONNECT_RESET_INTERVAL,
           last_event_id: nil,
           proxy: nil,
-          logger: nil)
+          logger: nil,
+          socket_factory: nil)
       @uri = URI(uri)
       @stopped = Concurrent::AtomicBoolean.new(false)
 
@@ -98,7 +102,11 @@ module SSE
       @connect_timeout = connect_timeout
       @read_timeout = read_timeout
       @logger = logger || default_logger
-
+      http_client_options = {}
+      if socket_factory
+        http_client_options["socket_class"] = socket_factory
+      end
+      
       if proxy
         @proxy = proxy
       else
@@ -108,6 +116,21 @@ module SSE
         end
       end
 
+      if @proxy
+        http_client_options["proxy"] = {
+          :proxy_address => @proxy.host,
+          :proxy_port => @proxy.port
+        }
+      end
+
+      @http_client = HTTP::Client.new(http_client_options)
+        .timeout({
+          read: read_timeout,
+          connect: connect_timeout
+        })
+      @buffer = ""
+      @lock = Mutex.new
+
       @backoff = Impl::Backoff.new(reconnect_time || DEFAULT_RECONNECT_TIME, MAX_RECONNECT_TIME,
         reconnect_reset_interval: reconnect_reset_interval)
 
@@ -163,12 +186,65 @@ module SSE
     #
     def close
       if @stopped.make_true
-        @cxn.close if !@cxn.nil?
-        @cxn = nil
+        reset_http
       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
+    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)
+      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
       log = ::Logger.new($stdout)
@@ -196,7 +272,7 @@ module SSE
           end
         end
         begin
-          @cxn.close if !@cxn.nil?
+          reset_http
         rescue StandardError => e
           log_and_dispatch_error(e, "Unexpected error while closing stream")
         end
@@ -215,31 +291,28 @@ module SSE
         cxn = nil
         begin
           @logger.info { "Connecting to event stream at #{@uri}" }
-          cxn = Impl::StreamingHTTPConnection.new(@uri,
-            proxy: @proxy,
-            headers: build_headers,
-            connect_timeout: @connect_timeout,
-            read_timeout: @read_timeout
-          )
-          if cxn.status == 200
+          cxn = @http_client.request("GET", @uri, {
+            headers: build_headers
+          })
+          if cxn.status.code == 200
             content_type = cxn.headers["content-type"]
             if content_type && content_type.start_with?("text/event-stream")
               return cxn  # we're good to proceed
             else
-              cxn.close
+              reset_http
               err = Errors::HTTPContentTypeError.new(cxn.headers["content-type"])
               @on[:error].call(err)
               @logger.warn { "Event source returned unexpected content type '#{cxn.headers["content-type"]}'" }
             end
           else
-            body = cxn.read_all  # grab the whole response body in case it has error details
-            cxn.close
-            @logger.info { "Server returned error status #{cxn.status}" }
-            err = Errors::HTTPStatusError.new(cxn.status, body)
+            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)
             @on[:error].call(err)
           end
         rescue
-          cxn.close if !cxn.nil?
+          reset_http
           raise  # will be handled in run_stream
         end
         # if unsuccessful, continue the loop to connect again
@@ -253,7 +326,7 @@ module SSE
       # it can automatically reset itself if enough time passes between failures.
       @backoff.mark_success
 
-      event_parser = Impl::EventParser.new(cxn.read_lines)
+      event_parser = Impl::EventParser.new(read_lines)
       event_parser.items.each do |item|
         return if @stopped.value
         case item
@@ -288,7 +361,8 @@ module SSE
     def build_headers
       h = {
         'Accept' => 'text/event-stream',
-        'Cache-Control' => 'no-cache'
+        'Cache-Control' => 'no-cache',
+        'User-Agent' => 'ruby-eventsource'
       }
       h['Last-Event-Id'] = @last_id if !@last_id.nil?
       h.merge(@headers)