ld-eventsource 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294a32bc78de81b8f7c5ffa0a8b9ffc25847b0ecd20eee8f27caea576ae2b6fc
-  data.tar.gz: 5c0bb7736f090364098525477ec192b89ee02b96e0d12542bf72f08112180ba2
+  metadata.gz: 63f2bcc65635183d4d5499f1d2d1ade11151293ee4a289d7f824667c7aa9e0f4
+  data.tar.gz: a9d9f0ab5bc24b4f04e6222d4e3d87cdf07814ef1c4721ef874c1cf1439ac3e4
 SHA512:
-  metadata.gz: b6466b0b4c060b681640e2b47cc1844bb93a9588076fbcc901a5922be303860538d6e064d1f9ea897062ffeafcb86690e68e26e0c28d6f795ea68bb41dc7d364
-  data.tar.gz: 67a62d448f673893e9fc397cb536ad6ba4194292e3f8c3058d96bcc39b0f8bf3ce6bf12b1bdeb8e843ff962e3324505b9cddc3e42486cdb915456dbe1dba4dcc
+  metadata.gz: 97183f611132a017c66069336bf36e920ee83ac5fbfde1955f451cda6e25ed58b9cf3817bd0bc72575c682763084a36a6c90d8915a9c826ac4d82340f97d8c63
+  data.tar.gz: 9b521be3f883ed8c7a53410ce1e71932680af30fe13901ac1489c7957a46575ca2906df59c1eb2049a65a49147f02f0935785b432db97918cdf2893853c0d000

data/.circleci/config.yml

@@ -72,7 +72,9 @@ jobs:
               rvm use $i;
               if [[ $i == jruby* ]]; then
                 gem install jruby-openssl; # required by bundler, no effect on Ruby MRI
-              fi
+              fi;
+              # bundler 2.0 may be preinstalled, we need to remove it if slow
+              yes | gem uninstall bundler --version '>=2.0' || true;
               gem install bundler -v "~> 1.17";
               bundle install;
               mv Gemfile.lock "Gemfile.lock.$i"

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 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.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/lib/ld-eventsource/client.rb

@@ -186,12 +186,14 @@ module SSE
           # 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?
-        rescue Errno::EBADF
-          # Don't log this as an error - it probably means we closed our own connection deliberately
-          @logger.info { "Stream connection closed" }
-        rescue StandardError => e
-          # This should not be possible because connect catches all StandardErrors
-          log_and_dispatch_error(e, "Unexpected error from event source")
+        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.
+          if @stopped.value
+            @logger.info { "Stream connection closed" }
+          else
+            log_and_dispatch_error(e, "Unexpected error from event source")
+          end
         end
         begin
           @cxn.close if !@cxn.nil?
@@ -210,6 +212,7 @@ module SSE
           @logger.info { "Will retry connection after #{'%.3f' % interval} seconds" } 
           sleep(interval)
         end
+        cxn = nil
         begin
           @logger.info { "Connecting to event stream at #{@uri}" }
           cxn = Impl::StreamingHTTPConnection.new(@uri,
@@ -235,11 +238,9 @@ module SSE
             err = Errors::HTTPStatusError.new(cxn.status, body)
             @on[:error].call(err)
           end
-        rescue Errno::EBADF
-          raise # See EBADF comment in run_stream
-        rescue StandardError => e
+        rescue
           cxn.close if !cxn.nil?
-          log_and_dispatch_error(e, "Unexpected error from event source")
+          raise  # will be handled in run_stream
         end
         # if unsuccessful, continue the loop to connect again
       end

data/lib/ld-eventsource/version.rb

@@ -1,3 +1,3 @@
 module SSE
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/client_spec.rb

@@ -112,6 +112,29 @@ EOT
     end
   end
 
+  it "does not trigger an error when stream is closed" do
+    events_body = simple_event_1_text + simple_event_2_text
+    with_server do |server|
+      server.setup_response("/") do |req,res|
+        send_stream_content(res, events_body, keep_open: true)
+      end
+
+      event_sink = Queue.new
+      error_sink = Queue.new
+      client = subject.new(server.base_uri) do |c|
+        c.on_event { |event| event_sink << event }
+        c.on_error { |error| error_sink << error }
+      end
+
+      with_client(client) do |client|
+        event_sink.pop  # wait till we have definitely started reading the stream
+        client.close
+        sleep 0.25  # there's no way to really know when the stream thread has finished
+        expect(error_sink.empty?).to be true
+      end
+    end
+  end
+
   it "reconnects after error response" do
     events_body = simple_event_1_text
     with_server do |server|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ld-eventsource
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-05 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,8 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SSE client