ably 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35c9faf01a4c322800ddac5c48bfad4579f7d7bf
-  data.tar.gz: 12cd62339ee45d68f0bf70db9322b31cb66f30d5
+  metadata.gz: f84e069f72578aa8f1dd02fb6925da8a03cb702a
+  data.tar.gz: 0d96682769ebf4ed7b9d0d9fc84603e2a99101fe
 SHA512:
-  metadata.gz: 14e90c00a29dee9053e239dc957cdcfcd95e80f359a9fdbd8180f602d4ec05c61bffd2884180d3ab1d2c4a66ac249616b95318a81df26116908865b46aa93a60
-  data.tar.gz: 4b127fbf6086141d08cc50dc00a1c3cbc32a8b282ecc5bef5a8116c7d481c78c9b05eca4cdc25e50854190ba833c770044bf6810aa492240fa060be7e1bc853f
+  metadata.gz: 139bc0db9fc45e8814c352d8e046666eebb3123c46898256ca3f6c47cf9d66ad86d2dbf76a63ffbf3fdaad0b0f23c3b46c4062e4b5811892481295748826510b
+  data.tar.gz: e4f947a9eb775db94fb413522b935120b5f3ee9d4b6df965ba1c82c676034d5fe653e1120a52c45ae45713c522bed5d582b79cc24e541f69e857cab0c8874284

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.2.0
+  - 2.4.1
 script: bundle exec rspec
 notifications:
   slack:

data/CHANGELOG.md

@@ -1,11 +1,26 @@
 # Change Log
 
-## [v1.0.0](https://github.com/ably/ably-ruby/tree/v1.0.0) (2017-03-07)
-[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.14...v1.0.0)
+## [v1.0.2](https://github.com/ably/ably-ruby/tree/v1.0.2)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.1...v1.0.2)
+
+**Fixed bugs:**
+
+- Reconnect following disconnection is hitting a 403 error [\#117](https://github.com/ably/ably-ruby/issues/117)
+- [Fallback hosts were used upon any disconnection as opposed to only when the primary host is unavailable](https://github.com/ably/ably-ruby/pull/120)
 
-### v1.0 release and upgrade notes from v0.8
+**Merged pull requests:**
+
+- Fallback fixes [\#120](https://github.com/ably/ably-ruby/pull/120) ([mattheworiordan](https://github.com/mattheworiordan))
+
+## [v1.0.1](https://github.com/ably/ably-ruby/tree/v1.0.1) (2017-05-11)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.0...v1.0.1)
+
+## [v1.0.0](https://github.com/ably/ably-ruby/tree/v1.0.0) (2017-03-07)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.15...v1.0.0)
 
-- See https://github.com/ably/docs/issues/235
+## [v0.8.15](https://github.com/ably/ably-ruby/tree/v0.8.15) (2017-03-07)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.14...v0.8.15)
 
 **Implemented enhancements:**
 

data/lib/ably/realtime/connection.rb

@@ -351,7 +351,7 @@ module Ably
       def determine_host
         raise ArgumentError, 'Block required' unless block_given?
 
-        if can_use_fallback_hosts?
+        if should_use_fallback_hosts?
           internet_up? do |internet_is_up_result|
             @current_host = if internet_is_up_result
               client.fallback_endpoint.host
@@ -445,6 +445,10 @@ module Ably
               end
 
               determine_host do |host|
+                # Ensure the hostname matches the fallback host name
+                url.hostname = host
+                url.port = port
+
                 begin
                   logger.debug { "Connection: Opening socket connection to #{host}:#{port}/#{url.path}?#{url.query}" }
                   @transport = create_transport(host, port, url) do |websocket_transport|
@@ -510,6 +514,7 @@ module Ably
 
       # @api private
       def create_transport(host, port, url, &block)
+        logger.debug { "Connection: EventMachine connecting to #{host}:#{port} with URL: #{url}" }
         EventMachine.connect(host, port, WebsocketTransport, self, url.to_s, &block)
       end
 
@@ -642,14 +647,22 @@ module Ably
         !!client.custom_realtime_host
       end
 
-      def can_use_fallback_hosts?
+      def should_use_fallback_hosts?
         if client.fallback_hosts && !client.fallback_hosts.empty?
-          if connecting? && previous_state
+          if connecting? && previous_state && !disconnected_from_connected_state?
             use_fallback_if_disconnected? || use_fallback_if_suspended?
           end
         end
       end
 
+      def disconnected_from_connected_state?
+        most_recent_state_changes = state_history.last(3).first(2) # Ignore current state
+
+        # A valid connection was disconnected
+        most_recent_state_changes.last.fetch(:state) == Connection::STATE.Disconnected &&
+          most_recent_state_changes.first.fetch(:state) == Connection::STATE.Connected
+      end
+
       def use_fallback_if_disconnected?
         second_reconnect_attempt_for(:disconnected, 1)
       end

data/lib/ably/version.rb

@@ -1,5 +1,5 @@
 module Ably
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
   PROTOCOL_VERSION = '1.0'
 
   # Allow a variant to be configured for all instances of this client library

data/spec/acceptance/realtime/connection_failures_spec.rb

@@ -1178,6 +1178,27 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
               stop_reactor
             end
           end
+
+          it 'does not use a fallback host if the connection connects on the default host and then later becomes disconnected', em_timeout: 25 do
+            request = 0
+
+            allow(connection).to receive(:create_transport).and_wrap_original do |wrapped_proc, host, *args, &block|
+              expect(host).to eql(expected_host)
+              request += 1
+              wrapped_proc.call(host, *args, &block)
+            end
+
+            connection.on(:connected) do
+              if request <= 2
+                EventMachine.add_timer(3) do
+                  # Force a disconnect
+                  connection.transport.unbind
+                end
+              else
+                stop_reactor
+              end
+            end
+          end
         end
 
         context ':fallback_hosts array is provided' do
@@ -1286,6 +1307,29 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
                 end
               end
             end
+
+            it 'uses the correct host name for the WebSocket requests to the fallback hosts' do
+              request = 0
+              expect(connection).to receive(:create_transport).at_least(:once) do |host, port, uri|
+                if request == 0 || request == expected_retry_attempts + 1
+                  expect(uri.hostname).to eql(expected_host)
+                else
+                  expect(custom_hosts + [expected_host]).to include(uri.hostname)
+                  fallback_hosts_used << host if @suspended > 0
+                end
+                request += 1
+                raise EventMachine::ConnectionError
+              end
+
+              connection.on(:suspended) do
+                @suspended += 1
+
+                if @suspended > 4
+                  expect(fallback_hosts_used.uniq).to match_array(custom_hosts + [expected_host])
+                  stop_reactor
+                end
+              end
+            end
           end
 
           context ':fallback_hosts array is provided by an empty array' do

data/spec/acceptance/realtime/connection_spec.rb

@@ -980,6 +980,7 @@ describe Ably::Realtime::Connection, :event_machine do
 
       context 'transport-level heartbeats are supported in the websocket transport' do
         it 'provides the heartbeats argument in the websocket connection params (#RTN23b)' do
+          skip 'Native heartbeats not yet supported in the WS driver https://github.com/ably/ably-ruby/issues/116'
           expect(EventMachine).to receive(:connect) do |host, port, transport, object, url|
             uri = URI.parse(url)
             expect(CGI::parse(uri.query)['heartbeats'][0]).to eql('false')
@@ -1007,6 +1008,7 @@ describe Ably::Realtime::Connection, :event_machine do
         let(:client_options) { default_options.merge(websocket_heartbeats_disabled: true) }
 
         it 'does not provide the heartbeats argument in the websocket connection params (#RTN23b)' do
+          skip 'Native heartbeats not yet supported in the WS driver https://github.com/ably/ably-ruby/issues/116'
           expect(EventMachine).to receive(:connect) do |host, port, transport, object, url|
             uri = URI.parse(url)
             expect(CGI::parse(uri.query)['heartbeats'][0]).to be_nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -458,7 +458,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Ruby client library for ably.io realtime messaging implemented using EventMachine