ably 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41a1cf12a01ccf1b9ecf3523790c45d77c08815d23d1cd3b23058dd456377a0b
-  data.tar.gz: e5174d825c354bc813819c3e0a0ab7341c46b8e04864ac24575c475cd773ad54
+  metadata.gz: 26f56201f9faae28b9b74ef9223e8d50c049a25d065f80d8612ce0013da46783
+  data.tar.gz: f74af9b0f0178576e41094fccf80821983da0b896e6bd7667fe534abe0d096bb
 SHA512:
-  metadata.gz: 8327568876690de6bbc5e95d3ce7759f7856b73d91e8726f5880291cb5a5579d962cd4b93b4d87b497d9e395a7971f515b926c2f54e220b1ba2667744bc891dd
-  data.tar.gz: 13752c5b6f79067275b192a55d14019ace0781eb061844248faf56b878d9afd78229396e82c11d171851f5570164921d9729e3ca1560c297e179e556ba87ed2e
+  metadata.gz: 2a4c6c4006a176c01eacd9f38d9f11a61fb7f64880a764a663eca26e2ed2b7806203f972edf7cb5f0dec1034e6776d6b6dac459766ba920cc09ea156022640a9
+  data.tar.gz: 59d33ebc03521cf47449140715b5506dca17ac6b3708b914b6b0987d038c56667231086c8ff81c8d740d8a62c4474ac78c9839360b795e2d5c8f779ad972e3a5

data/.travis.yml

@@ -5,11 +5,14 @@ env:
 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/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/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/ably.gemspec

@@ -24,7 +24,7 @@ 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'
@@ -33,15 +33,15 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'msgpack', '>= 0.6.2'
   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/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/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,6 +144,17 @@ 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
 
@@ -303,18 +313,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 +551,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 +577,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 +610,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/ably/realtime/connection/connection_manager.rb

@@ -100,13 +100,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/ably/version.rb

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

data/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

data/spec/acceptance/realtime/channel_history_spec.rb

@@ -112,22 +112,26 @@ describe Ably::Realtime::Channel, '#history', :event_machine do
 
       context 'in multiple ProtocolMessages', em_timeout: (30 / 10) + 5 do
         it 'retrieves limited history forwards with pagination' do
-          messages_sent.times do |index|
-            EventMachine.add_timer(index.to_f / rate_per_second) do
-              channel.publish('event', "history#{index}") do
-                next unless index == messages_sent - 1
-                ensure_message_history_direction_and_paging_is_correct :forwards
+          channel.attach do
+            messages_sent.times do |index|
+              EventMachine.add_timer(index.to_f / rate_per_second) do
+                channel.publish('event', "history#{index}") do
+                  next unless index == messages_sent - 1
+                  ensure_message_history_direction_and_paging_is_correct :forwards
+                end
               end
             end
           end
         end
 
         it 'retrieves limited history backwards with pagination' do
-          messages_sent.times.to_a.reverse.each do |index|
-            EventMachine.add_timer((messages_sent - index).to_f / rate_per_second) do
-              channel.publish('event', "history#{index}") do
-                next unless index == 0
-                ensure_message_history_direction_and_paging_is_correct :backwards if index == 0
+          channel.attach do
+            messages_sent.times.to_a.reverse.each do |index|
+              EventMachine.add_timer((messages_sent - index).to_f / rate_per_second) do
+                channel.publish('event', "history#{index}") do
+                  next unless index == 0
+                  ensure_message_history_direction_and_paging_is_correct :backwards if index == 0
+                end
               end
             end
           end
@@ -139,18 +143,20 @@ describe Ably::Realtime::Channel, '#history', :event_machine do
         let(:messages_per_batch) { 10 }
 
         it 'return the same results with unique matching message IDs' do
-          batches.times do |batch|
-            EventMachine.add_timer(batch.to_f / batches.to_f) do
-              messages_per_batch.times { channel.publish('event', 'data') }
+          channel.attach do
+            batches.times do |batch|
+              EventMachine.add_timer(batch.to_f / batches.to_f) do
+                messages_per_batch.times { |index| channel.publish('event') }
+              end
             end
-          end
 
-          channel.subscribe('event') do |message|
-            messages << message
-            if messages.count == batches * messages_per_batch
-              channel.history do |page|
-                expect(page.items.map(&:id).sort).to eql(messages.map(&:id).sort)
-                stop_reactor
+            channel.subscribe('event') do |message|
+              messages << message
+              if messages.count == batches * messages_per_batch
+                channel.history do |page|
+                  expect(page.items.map(&:id).sort).to eql(messages.map(&:id).sort)
+                  stop_reactor
+                end
               end
             end
           end

data/spec/acceptance/realtime/connection_failures_spec.rb

@@ -921,7 +921,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
           end
         end
 
-        it 'retains the client_serial (#RTN15c2, #RTN15c3)' do
+        it 'retains the client_msg_serial (#RTN15c2, #RTN15c3)' do
           last_message = nil
           channel = client.channels.get("foo")
 
@@ -1103,7 +1103,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
             end
           end
 
-          it 'resets the client_serial (#RTN15c3)' do
+          it 'continues to use the client_msg_serial (#RTN15c3)' do
             last_message = nil
             channel = client.channels.get("foo")
 
@@ -1121,7 +1121,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
                   connection.once(:connected) do
                     channel.publish("first on new connection") do
                       # Message serial reset after failed resume
-                      expect(last_message.message_serial).to eql(0)
+                      expect(last_message.message_serial).to eql(2)
                       stop_reactor
                     end
                   end

data/spec/acceptance/realtime/connection_spec.rb

@@ -264,7 +264,7 @@ describe Ably::Realtime::Connection, :event_machine do
                     channel.subscribe('event') do |message|
                       messages_received << message.data.to_i
                       if messages_received.count == total_expected
-                        expect(messages_received).to match(total_expected.times)
+                        expect(messages_received).to match(total_expected.times.to_a)
                         expect(auth_requests.count).to eql(iteration + 1)
                         EventMachine.add_timer(1) do
                           channel.unsubscribe 'event'
@@ -649,16 +649,47 @@ describe Ably::Realtime::Connection, :event_machine do
       end
 
       it 'is set to 1 when the second message is received' do
-        channel.publish('event', 'data') do
-          channel.publish('event', 'data')
+        channel.attach do
+          messages = []
+          channel.subscribe do |message|
+            messages << message
+            if messages.length == 2
+              expect(connection.serial).to eql(1)
+              stop_reactor
+            end
+          end
+
+          channel.publish('event', 'data') do
+            channel.publish('event', 'data')
+          end
         end
+      end
+    end
 
-        messages = []
-        channel.subscribe do |message|
-          messages << message
-          if messages.length == 2
-            expect(connection.serial).to eql(1)
-            stop_reactor
+    describe '#msgSerial' do
+      context 'when messages are queued for publish before a connection is established' do
+        let(:batches) { 6 }
+        let(:messages_per_batch) { 10 }
+
+        let(:publishing_client)  { auto_close Ably::Realtime::Client.new(default_options) }
+        let(:channel_name)       { random_str }
+        let(:publishing_channel) { publishing_client.channels.get(channel_name) }
+        let(:receiving_channel)  { client.channels.get(channel_name) }
+
+        it 'the msgSerial is always incrementing (and not reset when the new connection is established) ensuring messages are never de-duped by the realtime service' do
+          messages = []
+
+          receiving_channel.attach do
+            receiving_channel.subscribe('event') do |message|
+              messages << message
+              stop_reactor if messages.count == batches * messages_per_batch
+            end
+
+            batches.times do |batch|
+              EventMachine.add_timer(batch.to_f / batches.to_f) do
+                messages_per_batch.times { |index| publishing_channel.publish('event') }
+              end
+            end
           end
         end
       end
@@ -1005,10 +1036,9 @@ 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
+            expect(CGI::parse(uri.query)['heartbeats'][0]).to eql('true')
             stop_reactor
           end
           client
@@ -1126,7 +1156,7 @@ describe Ably::Realtime::Connection, :event_machine do
                   expected_serial += 1 # attach message received
                   expect(connection.serial).to eql(expected_serial)
 
-                  expect(connection.recovery_key).to eql("#{connection.key}:#{connection.serial}")
+                  expect(connection.recovery_key).to eql("#{connection.key}:#{connection.serial}:#{connection.send(:client_msg_serial)}")
                   stop_reactor
                 end
               end
@@ -1237,6 +1267,78 @@ describe Ably::Realtime::Connection, :event_machine do
             end
           end
         end
+
+        context 'when messages have been published' do
+          describe 'the new connection' do
+            it 'uses the correct msgSerial from the old connection' do
+              msg_serial, recovery_key, connection_id = nil, nil, nil
+
+              channel.attach do
+                expect(connection.send(:client_msg_serial)).to eql(-1) # no messages published yet
+                connection_id = client.connection.id
+                connection.transport.__incoming_protocol_msgbus__
+                channel.publish('event', 'message') do
+                  msg_serial = connection.send(:client_msg_serial)
+                  expect(msg_serial).to eql(0)
+                  recovery_key = client.connection.recovery_key
+                  connection.transition_state_machine! :failed
+                end
+              end
+
+              connection.on(:failed) do
+                recover_client = auto_close Ably::Realtime::Client.new(default_options.merge(recover: recovery_key))
+                recover_client_channel = recover_client.channel(channel_name)
+                recover_client_channel.attach do
+                  expect(recover_client.connection.id).to eql(connection_id)
+                  expect(recover_client.connection.send(:client_msg_serial)).to eql(msg_serial)
+                  stop_reactor
+                end
+              end
+            end
+          end
+        end
+
+        context 'when messages are published before the new connection is recovered' do
+          describe 'the new connection' do
+            it 'uses the correct msgSerial from the old connection for the queued messages' do
+              msg_serial, recovery_key, connection_id = nil, nil, nil
+
+              channel.attach do
+                expect(connection.send(:client_msg_serial)).to eql(-1) # no messages published yet
+                connection_id = client.connection.id
+                connection.transport.__incoming_protocol_msgbus__
+                channel.publish('event', 'message-1') do
+                  msg_serial = connection.send(:client_msg_serial)
+                  expect(msg_serial).to eql(0)
+                  recovery_key = client.connection.recovery_key
+                  connection.transition_state_machine! :failed
+                end
+              end
+
+              connection.on(:failed) do
+                recover_client = auto_close Ably::Realtime::Client.new(default_options.merge(recover: recovery_key))
+                recover_client_channel = recover_client.channel(channel_name)
+                expect(recover_client.connection.send(:client_msg_serial)).to eql(msg_serial)
+
+                recover_client.connection.once(:connecting) do
+                  recover_client_channel.publish('event', 'message-2')
+                  expect(recover_client.connection.send(:client_msg_serial)).to eql(msg_serial + 1)
+                end
+
+                recover_client_channel.attach do
+                  expect(recover_client.connection.id).to eql(connection_id)
+
+                  recover_client_channel.subscribe do |message|
+                    raise "Unexpected message #{message}" if message.data != 'message-2'
+                    EventMachine.add_timer(2) do
+                      stop_reactor
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
       end
 
       context 'with :recover option' do
@@ -1250,7 +1352,7 @@ describe Ably::Realtime::Connection, :event_machine do
         end
 
         context 'with invalid formatted value sent to server' do
-          let(:client_options) { default_options.merge(recover: 'not-a-valid-connection-key:1', log_level: :none) }
+          let(:client_options) { default_options.merge(recover: 'not-a-valid-connection-key:1:0', log_level: :none) }
 
           it 'sets the #error_reason and moves the connection to FAILED' do
             connection.once(:failed) do |state_change|
@@ -1265,7 +1367,7 @@ describe Ably::Realtime::Connection, :event_machine do
         end
 
         context 'with expired (missing) value sent to server' do
-          let(:client_options) { default_options.merge(recover: 'wVIsgTHAB1UvXh7z-1991d8586:0', log_level: :fatal) }
+          let(:client_options) { default_options.merge(recover: 'wVIsgTHAB1UvXh7z-1991d8586:0:0', log_level: :fatal) }
 
           it 'connects but sets the error reason and includes the reason in the state change' do
             connection.once(:connected) do |state_change|