ably-rest 1.1.0 → 1.1.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90b60619abe23dd6791379f83f4454ba986c97ac483a3be243889a3f33e47dae
-  data.tar.gz: a73f4ee17a5ec7191be3aecbeb638bbb197719c577554aa14035534458e1a6da
+  metadata.gz: 86237c2258c59c0009e5e59184b6ada5f21fe04aa0b216619b3d929e9e7638a3
+  data.tar.gz: 9ea2e21055c77730ccfad327807c7316e92b241b48df85741a672f0b44ffc001
 SHA512:
-  metadata.gz: c40cecc9b5064ee893550034516e35b2b75528a4648aaabf59544aca82856bf8bf8f04fbe124c8f9b6c7a704a27c5f812f501d652c2da0441c911039e3777c6e
-  data.tar.gz: 630974c14aaa82ae70f452397cfed03294219b9e3b6aeee280190635e5d8900b6b2803d5aeb33391c9933d10246ec541cab4f341b548c80dd0230db7cf3f4d2c
+  metadata.gz: 01c1c1636cd0e9e9b347c5e2cabbfb0728da542c609b4890d93295dfd93cd592ea61373674118b4b5f50b30731fdf73d1ba5e15d2c13515ecc6f838c4f0fe476
+  data.tar.gz: 44e087922e2dd4436f42e492ce36785f0fc1decb2fb9dea2a5cf9d812066d11c9b7f21f5f233f1e3734fb24d3a5061a9713f69eb84c62f1fee77ea26530c55fc

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/ably-rest.svg)](http://badge.fury.io/rb/ably-rest)
 
-A Ruby REST client library for [www.ably.io](https://www.ably.io), the realtime messaging service.
+A Ruby REST client library for [www.ably.io](https://www.ably.io), the realtime messaging service. This library currently targets the [Ably 1.1 client library specification](https://www.ably.io/documentation/client-lib-development-guide/features/). You can jump to the '[Known Limitations](#known-limitations)' section to see the features this client library does not yet support or [view our client library SDKs feature support matrix](https://www.ably.io/download/sdk-feature-support-matrix) to see the list of all the available features.
 
 ## Documentation
 
@@ -14,6 +14,14 @@ This REST only library was created for developers who do not want EventMachine a
 
 If however you need to use a realtime library that offers an asynchronous evented AP, then we recommended you [take a look at the combined REST & Realtime gem](https://rubygems.org/gems/ably).
 
+## Known Limitations
+
+This client library is currently *not compatible* with some of the Ably features:
+
+| Feature |
+| :--- |
+| [Custom transportParams](https://www.ably.io/documentation/realtime/connection#client-options) |
+
 ## Installation
 
 The client library is available as a [gem from RubyGems.org](https://rubygems.org/gems/ably-rest).

data/ably-rest.gemspec

@@ -39,10 +39,10 @@ Gem::Specification.new do |spec|
   else
     spec.add_runtime_dependency 'json'
   end
-  spec.add_runtime_dependency 'msgpack', '>= 0.6.2'
+  spec.add_runtime_dependency 'msgpack', '>= 1.3.0'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '>= 1.3.0'
   spec.add_development_dependency 'rake', '~> 11.3'
   spec.add_development_dependency 'redcarpet', '~> 3.3'
   spec.add_development_dependency 'rspec', '~> 3.2.0'

data/lib/submodules/ably-ruby/.travis.yml

@@ -1,15 +1,18 @@
 sudo: false
 env:
-  - RSPEC_RETRY=true PARALLEL_TEST_PROCESSORS=4 PROTOCOL=json
-  - RSPEC_RETRY=true PARALLEL_TEST_PROCESSORS=4 PROTOCOL=msgpack
+  - RSPEC_RETRY=true PARALLEL_TEST_PROCESSORS=2 PROTOCOL=json
+  - RSPEC_RETRY=true PARALLEL_TEST_PROCESSORS=2 PROTOCOL=msgpack
 language: ruby
 rvm:
   - 1.9.3
-  - 2.0.0
   - 2.1.10
-  - 2.2.0
-  - 2.3.6
-  - 2.4.4
+  - 2.2.10
+  - 2.3.8
+  - 2.5.5
+  - 2.6.0
+  - 2.6.1
+  - 2.6.2
+  - 2.6.3
 script: spec/run_parallel_tests
 notifications:
   slack:

data/lib/submodules/ably-ruby/CHANGELOG.md

@@ -1,7 +1,24 @@
 # Change Log
 
-## [v1.1.0](https://github.com/ably/ably-ruby/tree/v1.1.0)
+## [v1.1.1](https://github.com/ably/ably-ruby/tree/v1.1.1)
 
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.0...v1.1.1)
+
+**Implemented enhancements:**
+
+- Support transient publishes as part of 1.1 spec [\#164](https://github.com/ably/ably-ruby/issues/164)
+
+**Fixed bugs:**
+
+- RTN16b recovery not fully implemented [\#180](https://github.com/ably/ably-ruby/issues/180)
+- Publishing a high number of messages before connected results in lost messages [\#179](https://github.com/ably/ably-ruby/issues/179)
+
+**Merged pull requests:**
+
+- msgSerial fixes including connection recovery fix [\#181](https://github.com/ably/ably-ruby/pull/181) ([mattheworiordan](https://github.com/mattheworiordan))
+- Known limitations section in README [\#177](https://github.com/ably/ably-ruby/pull/177) ([Srushtika](https://github.com/Srushtika))
+
+## [v1.1.0](https://github.com/ably/ably-ruby/tree/v1.1.0) (2019-02-06)
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.7...v1.1.0)
 
 **Fixed bugs:**

data/lib/submodules/ably-ruby/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/ably.svg)](http://badge.fury.io/rb/ably)
 [![Coverage Status](https://coveralls.io/repos/ably/ably-ruby/badge.svg)](https://coveralls.io/r/ably/ably-ruby)
 
-A Ruby client library for [ably.io](https://www.ably.io), the realtime messaging service.
+A Ruby client library for [ably.io](https://www.ably.io), the realtime messaging service. This library currently targets the [Ably 1.1 client library specification](https://www.ably.io/documentation/client-lib-development-guide/features/). You can jump to the '[Known Limitations](#known-limitations)' section to see the features this client library does not yet support or [view our client library SDKs feature support matrix](https://www.ably.io/download/sdk-feature-support-matrix) to see the list of all the available features.
 
 ## Supported platforms
 
@@ -13,6 +13,14 @@ We regression-test the SDK against a selection of Ruby versions (which we update
 
 If you find any compatibility issues, please [do raise an issue](https://github.com/ably/ably-ruby/issues/new) in this repository or [contact Ably customer support](https://support.ably.io/) for advice.
 
+## Known Limitations
+
+This client library is currently *not compatible* with some of the Ably features:
+
+| Feature |
+| :--- |
+| [Custom transportParams](https://www.ably.io/documentation/realtime/connection#client-options) |
+
 ## Documentation
 
 Visit https://www.ably.io/documentation for a complete API reference and more examples.

data/lib/submodules/ably-ruby/ably.gemspec

@@ -24,24 +24,24 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'faraday', '~> 0.12'
   spec.add_runtime_dependency 'excon', '~> 0.55'
 
-  if RUBY_VERSION.match(/^1/)
+  if RUBY_VERSION.match(/^1\./)
     spec.add_runtime_dependency 'json', '< 2.0'
   else
     spec.add_runtime_dependency 'json'
   end
   spec.add_runtime_dependency 'websocket-driver', '~> 0.7'
-  spec.add_runtime_dependency 'msgpack', '>= 0.6.2'
+  spec.add_runtime_dependency 'msgpack', '>= 1.3.0'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 11.3'
   spec.add_development_dependency 'redcarpet', '~> 3.3'
   spec.add_development_dependency 'rspec', '~> 3.3.0' # version lock, see config.around(:example, :event_machine) in event_machine_helper.rb
   spec.add_development_dependency 'rspec-retry', '~> 0.6'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'rspec-instafail', '~> 1.0'
+  spec.add_development_dependency 'bundler', '>= 1.3.0'
 
-  if RUBY_VERSION.match(/^1/)
+  if RUBY_VERSION.match(/^1\./)
     spec.add_development_dependency 'public_suffix', '~> 1.4.6' # Later versions do not support Ruby 1.9
     spec.add_development_dependency 'webmock', '2.2'
     spec.add_development_dependency 'parallel_tests', '~> 2.9.0'

data/lib/submodules/ably-ruby/lib/ably/logger.rb

@@ -20,6 +20,8 @@ module Ably
       ensure_logger_interface_is_valid
 
       @logger.level = log_level
+
+      @log_mutex = Mutex.new
     end
 
     # The logger used by this class, defaults to {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger}
@@ -38,7 +40,9 @@ module Ably
     %w(fatal error warn info debug).each do |method_name|
       define_method(method_name) do |*args, &block|
         begin
-          logger.public_send(method_name, *args, &block)
+          log_mutex.synchronize do
+            logger.public_send(method_name, *args, &block)
+          end
         rescue StandardError => e
           logger.error "Logger: Failed to log #{method_name} block - #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
         end
@@ -46,6 +50,8 @@ module Ably
     end
 
     private
+    attr_reader :log_mutex
+
     def client
       @client
     end

data/lib/submodules/ably-ruby/lib/ably/modules/state_machine.rb

@@ -23,7 +23,7 @@ module Ably::Modules
     def transition_state(state, *args)
       unless result = transition_to(state.to_sym, *args)
         exception = exception_for_state_change_to(state)
-        logger.fatal { "#{self.class}: #{exception.message}" }
+        logger.fatal { "#{self.class}: #{exception.message}\n#{caller[0..20].join("\n")}" }
       end
       result
     end

data/lib/submodules/ably-ruby/lib/ably/realtime/client.rb

@@ -110,9 +110,6 @@ module Ably
         end
 
         @rest_client           = Ably::Rest::Client.new(options.merge(realtime_client: self))
-        @auth                  = Ably::Realtime::Auth.new(self)
-        @channels              = Ably::Realtime::Channels.new(self)
-        @connection            = Ably::Realtime::Connection.new(self, options)
         @echo_messages         = rest_client.options.fetch(:echo_messages, true) == false ? false : true
         @queue_messages        = rest_client.options.fetch(:queue_messages, true) == false ? false : true
         @custom_realtime_host  = rest_client.options[:realtime_host] || rest_client.options[:ws_host]
@@ -120,6 +117,10 @@ module Ably
         @recover               = rest_client.options[:recover]
 
         raise ArgumentError, "Recovery key '#{recover}' is invalid" if recover && !recover.match(Connection::RECOVER_REGEX)
+
+        @auth       = Ably::Realtime::Auth.new(self)
+        @channels   = Ably::Realtime::Channels.new(self)
+        @connection = Ably::Realtime::Connection.new(self, options)
       end
 
       # Return a {Ably::Realtime::Channel Realtime Channel} for the given name

data/lib/submodules/ably-ruby/lib/ably/realtime/connection.rb

@@ -66,7 +66,7 @@ module Ably
       ensure_state_machine_emits 'Ably::Models::ConnectionStateChange'
 
       # Expected format for a connection recover key
-      RECOVER_REGEX = /^(?<recover>[\w!-]+):(?<connection_serial>\-?\w+)$/
+      RECOVER_REGEX = /^(?<recover>[^:]+):(?<connection_serial>[^:]+):(?<msg_serial>\-?\d+)$/
 
       # Defaults for automatic connection recovery and timeouts
       DEFAULTS = {
@@ -137,7 +137,6 @@ module Ably
         @client                        = client
         @__outgoing_message_queue__    = []
         @__pending_message_ack_queue__ = []
-        reset_client_serial
 
         @defaults = DEFAULTS.dup
         options.each do |key, val|
@@ -145,12 +144,25 @@ module Ably
         end if options.kind_of?(Hash)
         @defaults.freeze
 
+        # If a recover client options is provided, then we need to ensure that the msgSerial matches the
+        # recover serial immediately at client library instantiation. This is done immediately so that any queued
+        # publishes use the correct serial number for these queued messages as well.
+        # There is no harm if the msgSerial is higher than expected if the recover fails.
+        recovery_msg_serial = connection_recover_parts && connection_recover_parts[:msg_serial].to_i
+        if recovery_msg_serial
+          @client_msg_serial = recovery_msg_serial
+        else
+          reset_client_msg_serial
+        end
+
         Client::IncomingMessageDispatcher.new client, self
         Client::OutgoingMessageDispatcher.new client, self
 
         @state_machine = ConnectionStateMachine.new(self)
         @state         = STATE(state_machine.current_state)
         @manager       = ConnectionManager.new(self)
+
+        @current_host = client.endpoint.host
       end
 
       # Causes the connection to close, entering the closed state, from any state except
@@ -303,18 +315,17 @@ module Ably
       # @!attribute [r] recovery_key
       # @return [String] recovery key that can be used by another client to recover this connection with the :recover option
       def recovery_key
-        "#{key}:#{serial}" if connection_resumable?
+        "#{key}:#{serial}:#{client_msg_serial}" if connection_resumable?
       end
 
       # Following a new connection being made, the connection ID, connection key
-      # and message serial need to match the details provided by the server.
+      # and connection serial need to match the details provided by the server.
       #
       # @return [void]
       # @api private
       def configure_new(connection_id, connection_key, connection_serial)
         @id            = connection_id
         @key           = connection_key
-        @client_serial = connection_serial
 
         update_connection_serial connection_serial
       end
@@ -542,11 +553,11 @@ module Ably
           defaults.fetch(:realtime_request_timeout)
       end
 
-      # Resets the client serial (msgSerial) sent to Ably for each new {Ably::Models::ProtocolMessage}
-      # (see #client_serial)
+      # Resets the client message serial (msgSerial) sent to Ably for each new {Ably::Models::ProtocolMessage}
+      # (see #client_msg_serial)
       # @api private
-      def reset_client_serial
-        @client_serial = -1
+      def reset_client_msg_serial
+        @client_msg_serial = -1
       end
 
       # When a hearbeat or any other message from Ably is received
@@ -568,15 +579,15 @@ module Ably
 
       private
 
-      # The client serial is incremented for every message that is published that requires an ACK.
+      # The client message serial (msgSerial) is incremented for every message that is published that requires an ACK.
       # Note that this is different to the connection serial that contains the last known serial number
       # received from the server.
       #
       # A message serial number does not guarantee a message has been received, only sent.
       # A connection serial guarantees the server has received the message and is thus used for connection recovery and resumes.
       # @return [Integer] starting at -1 indicating no messages sent, 0 when the first message is sent
-      def client_serial
-        @client_serial
+      def client_msg_serial
+        @client_msg_serial
       end
 
       def resume_callbacks
@@ -601,11 +612,11 @@ module Ably
       end
 
       def add_message_serial_to(protocol_message)
-        @client_serial += 1
-        protocol_message[:msgSerial] = client_serial
+        @client_msg_serial += 1
+        protocol_message[:msgSerial] = client_msg_serial
         yield
       rescue StandardError => e
-        @client_serial -= 1
+        @client_msg_serial -= 1
         raise e
       end
 

data/lib/submodules/ably-ruby/lib/ably/realtime/connection/connection_manager.rb

@@ -49,18 +49,31 @@ module Ably::Realtime
 
         logger.debug { 'ConnectionManager: Opening a websocket transport connection' }
 
+        # The socket attempt can fail at the same time as a timer firing so ensure
+        #   only one outcome is processed from this setup attempt
+        setup_attempt_status = {}
+        setup_failed = lambda do
+          return true if setup_attempt_status[:failed]
+          setup_attempt_status[:failed] = true
+          false
+        end
+
         connection.create_websocket_transport.tap do |socket_deferrable|
           socket_deferrable.callback do |websocket_transport|
             subscribe_to_transport_events websocket_transport
             yield websocket_transport if block_given?
           end
           socket_deferrable.errback do |error|
+            next if setup_failed.call
             connection_opening_failed error
           end
         end
 
+        # The connection request timeout must be marginally higher than the REST request timeout to ensure
+        #   any HTTP auth request failure due to timeout triggers before the connection timer kicks in
         logger.debug { "ConnectionManager: Setting up automatic connection timeout timer for #{realtime_request_timeout}s" }
         create_timeout_timer_whilst_in_state(:connecting, realtime_request_timeout) do
+          next if setup_failed.call
           connection_opening_failed Ably::Exceptions::ConnectionTimeout.new("Connection to Ably timed out after #{realtime_request_timeout}s", nil, Ably::Exceptions::Codes::CONNECTION_TIMED_OUT)
         end
       end
@@ -80,7 +93,12 @@ module Ably::Realtime
 
         logger.warn { "ConnectionManager: Connection to #{connection.current_host}:#{connection.port} failed; #{error.message}" }
         next_state = get_next_retry_state_info
-        connection.transition_state_machine next_state.fetch(:state), retry_in: next_state.fetch(:pause), reason: Ably::Exceptions::ConnectionError.new("Connection failed: #{error.message}", nil, Ably::Exceptions::Codes::CONNECTION_FAILED, error)
+
+        if connection.state == next_state.fetch(:state)
+          logger.error { "ConnectionManager: Skipping next retry state after connection opening failed as already in state #{next_state}\n#{caller[0..20].join("\n")}" }
+        else
+          connection.transition_state_machine next_state.fetch(:state), retry_in: next_state.fetch(:pause), reason: Ably::Exceptions::ConnectionError.new("Connection failed: #{error.message}", nil, Ably::Exceptions::Codes::CONNECTION_FAILED, error)
+        end
       end
 
       # Called whenever a new connection is made
@@ -100,13 +118,11 @@ module Ably::Realtime
             resend_pending_message_ack_queue
           else
             logger.debug { "ConnectionManager: Connection was not resumed, old connection ID #{connection.id} has been updated with new connection ID #{protocol_message.connection_id} and key #{protocol_message.connection_key}" }
-            connection.reset_client_serial
             nack_messages_on_all_channels protocol_message.error
             force_reattach_on_channels protocol_message.error
           end
         else
           logger.debug { "ConnectionManager: New connection created with ID #{protocol_message.connection_id} and key #{protocol_message.connection_key}" }
-          connection.reset_client_serial
         end
 
         reattach_suspended_channels protocol_message.error

data/lib/submodules/ably-ruby/lib/ably/rest/client.rb

@@ -471,11 +471,13 @@ module Ably
 
       # Allowable duration for an external auth request
       # For REST client this defaults to request_timeout
-      # For Realtime clients this defaults to realtime_request_timeout
+      # For Realtime clients this defaults to 250ms less than the realtime_request_timeout
+      #   ensuring an auth failure will be triggered before the realtime request timeout fires
+      #   which would lead to a misleading error message (connection timeout as opposed to auth request timeout)
       # @api private
       def auth_request_timeout
         if @realtime_client
-          @realtime_client.connection.defaults.fetch(:realtime_request_timeout)
+          @realtime_client.connection.defaults.fetch(:realtime_request_timeout) - 0.25
         else
           http_defaults.fetch(:request_timeout)
         end

data/lib/submodules/ably-ruby/lib/ably/version.rb

@@ -1,5 +1,5 @@
 module Ably
-  VERSION = '1.1.0'
+  VERSION = '1.1.2.rc1'
   PROTOCOL_VERSION = '1.1'
 
   # Allow a variant to be configured for all instances of this client library

data/lib/submodules/ably-ruby/spec/acceptance/realtime/auth_spec.rb

@@ -661,17 +661,19 @@ describe Ably::Realtime::Auth, :event_machine do
                 client.connection.once(:disconnected) { raise 'Upgrade does not require a disconnect' }
 
                 channel = client.channels.get('foo')
-                channel.publish('not-allowed').errback do |error|
-                  expect(error.code).to eql(40160)
-                  expect(error.message).to match(/permission denied/)
+                channel.attach do
+                  channel.publish('not-allowed').errback do |error|
+                    expect(error.code).to eql(40160)
+                    expect(error.message).to match(/permission denied/)
 
-                  client.auth.authorize(nil, auth_callback: upgraded_token_cb)
-                  client.connection.once(:update) do
-                    expect(client.connection.error_reason).to be_nil
-                    channel.subscribe('now-allowed') do |message|
-                      stop_reactor
+                    client.auth.authorize(nil, auth_callback: upgraded_token_cb)
+                    client.connection.once(:update) do
+                      expect(client.connection.error_reason).to be_nil
+                      channel.subscribe('now-allowed') do |message|
+                        stop_reactor
+                      end
+                      channel.publish 'now-allowed'
                     end
-                    channel.publish 'now-allowed'
                   end
                 end
               end
@@ -1137,6 +1139,7 @@ describe Ably::Realtime::Auth, :event_machine do
         context 'when credentials are invalid' do
           let(:key_secret) { 'invalid' }
           let(:token) { Faraday.get("#{auth_url}?keyName=#{key_name}&keySecret=#{key_secret}").body }
+          let(:client_options) { { token: token, environment: environment, protocol: protocol, log_level: :none } }
 
           it 'fails with an invalid signature error' do
             client.connection.once(:disconnected) do |state_change|
@@ -1237,7 +1240,7 @@ describe Ably::Realtime::Auth, :event_machine do
             Faraday.get("#{auth_url}?keyName=#{key_name}&keySecret=#{key_secret}&capability=#{URI.escape(basic_capability)}").body
           end
         end
-        let(:client_options) { default_options.merge(auth_callback: auth_callback) }
+        let(:client_options) { default_options.merge(auth_callback: auth_callback, log_level: :error) }
 
         it 'client fails to publish to a channel with subscribe-only capability and publishes successfully on a channel with permissions' do
           client.connection.once(:connected) do