ably 1.1.7 → 1.2.1

data/spec/acceptance/realtime/connection_failures_spec.rb

@@ -570,7 +570,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
       end
 
       context 'when DISCONNECTED ProtocolMessage received from the server' do
-        it 'reconnects automatically and immediately' do
+        it 'reconnects automatically and immediately (#RTN15a)' do
           fail_if_suspended_or_failed
 
           connection.once(:connected) do
@@ -590,6 +590,61 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
           end
         end
 
+        context 'when protocolMessage contains token error' do
+          context "library does not have a means to renew the token (#RTN15h1)" do
+            let(:auth_url) { 'https://echo.ably.io/createJWT' }
+            let(:token) { Faraday.get("#{auth_url}?keyName=#{key_name}&keySecret=#{key_secret}").body }
+            let(:client_options) { default_options.merge(token: token, log_level: :none) }
+
+            let(:error_message) { 'error_message' }
+
+            it 'moves connection state to failed'  do
+              connection.on(:failed) do |connection_state_change|
+                expect(connection.error_reason.message).to eq(error_message)
+                stop_reactor
+              end
+
+              connection.on(:connected) do
+                protocol_message = Ably::Models::ProtocolMessage.new(action: Ably::Models::ProtocolMessage::ACTION.Disconnected.to_i, error: { code: 40140, message: error_message })
+                connection.__incoming_protocol_msgbus__.publish :protocol_message, protocol_message
+              end
+
+              connection.connect
+            end
+          end
+
+          context "library have a means to renew the token (#RTN15h2)" do
+            let(:client_options) { default_options.merge(log_level: :none) }
+            let(:error_message) { 'error_message' }
+
+            def send_disconnect_message
+              protocol_message = Ably::Models::ProtocolMessage.new(action: Ably::Models::ProtocolMessage::ACTION.Disconnected.to_i, error: { code: 40140, message: error_message })
+              connection.__incoming_protocol_msgbus__.publish :protocol_message, protocol_message
+            end
+
+            it 'attempts to reconnect'  do
+              connection.on(:failed) do |connection_state_change|
+                raise "Connection shouldn't be failed"
+              end
+
+              connection.on(:connected) do
+                connection.once(:connecting) do
+                  connection.once(:disconnected) do
+                    expect(connection.error_reason.message).to eq(error_message)
+                    stop_reactor
+                  end
+
+                  send_disconnect_message
+                end
+
+                send_disconnect_message
+              end
+
+              connection.connect
+            end
+          end
+        end
+
         context 'connection state freshness is monitored' do
           it 'resumes connections when disconnected within the connection_state_ttl period (#RTN15g)' do
             connection.once(:connected) do

data/spec/acceptance/realtime/connection_spec.rb

@@ -482,6 +482,138 @@ describe Ably::Realtime::Connection, :event_machine do
         end
       end
 
+      context "when can't connect to host" do
+        let(:client_options) { super().merge(realtime_host: 'non-existent.ably.io') }
+
+        it 'logs error on failed connection attempt' do
+          logger_expectation = lambda do |*args, &block|
+            error_message = "Connection to non-existent.ably.io:443 failed"
+            expect(args.concat([block ? block.call : nil]).join(',')).to include(error_message)
+            stop_reactor
+          end
+
+          expect(connection.logger).to receive(:warn, &logger_expectation).at_least(:once)
+
+          connection.on(:connected) do
+            raise "Connection should not succeed"
+          end
+
+          connection.connect
+        end
+      end
+
+      context 'when explicitly reconnecting disconnected/suspended connection in retry (#RTN11c)' do
+        let(:close_connection_proc) do
+          lambda do
+            EventMachine.add_timer(0.001) do
+              if connection.transport.nil?
+                close_connection_proc.call
+              else
+                connection.transport.close_connection_after_writing
+              end
+            end
+          end
+        end
+
+        context 'when suspended' do
+          let(:suspended_retry_timeout) { 60 }
+          let(:client_options) do
+            default_options.merge(
+              disconnected_retry_timeout: 0.02,
+              suspended_retry_timeout: suspended_retry_timeout,
+              connection_state_ttl: 0
+            )
+          end
+
+          it 'reconnects immediately' do
+            connection.once(:connecting) { close_connection_proc.call }
+
+            connection.on(:suspended) do |connection_state_change|
+              if connection_state_change.retry_in.zero?
+                # Exhausting immediate retries
+                connection.once(:connecting) { close_connection_proc.call }
+              else
+                suspended_at = Time.now.to_f
+                connection.on(:connected) do
+                  expect(connection_state_change.retry_in).to eq(suspended_retry_timeout)
+                  expect(connection.state).to eq(:connected)
+                  expect(Time.now.to_f).to be_within(4).of(suspended_at)
+                  stop_reactor
+                end
+              end
+
+              connection.connect
+            end
+
+            connection.connect
+          end
+        end
+
+        context 'when disconnected' do
+          let(:retry_timeout) { 60 }
+          let(:client_options) do
+            default_options.merge(
+              disconnected_retry_timeout: retry_timeout,
+              suspended_retry_timeout: retry_timeout,
+              connection_state_ttl: 0
+            )
+          end
+
+          it 'reconnects immediately' do
+            connection.once(:connected) do
+              connection.on(:disconnected) do |connection_state_change|
+                disconnected_at = Time.now.to_f
+                connection.on(:connected) do
+                  if connection_state_change.retry_in.zero?
+                    # Exhausting immediate retries
+                    close_connection_proc.call
+                  else
+                    expect(connection_state_change.retry_in).to eq(retry_timeout)
+                    expect(connection.state).to eq(:connected)
+                    expect(Time.now.to_f).to be_within(4).of(disconnected_at)
+                    stop_reactor
+                  end
+                end
+                connection.connect
+              end
+
+              close_connection_proc.call
+            end
+
+            connection.connect
+          end
+        end
+      end
+
+      context 'when reconnecting a failed connection' do
+        let(:channel) { client.channel(random_str) }
+        let(:client_options) { default_options.merge(log_level: :none) }
+
+        it 'transitions all channels state to initialized and cleares error_reason' do
+          connection.on(:failed) do |connection_state_change|
+            expect(connection.error_reason).to be_a(Ably::Exceptions::BaseAblyException)
+            expect(channel.error_reason).to be_a(Ably::Exceptions::BaseAblyException)
+            expect(channel).to be_failed
+
+            connection.on(:connected) do
+              expect(connection.error_reason).to eq(nil)
+              expect(channel).to be_initialized
+              expect(channel.error_reason).to eq(nil)
+              stop_reactor
+            end
+
+            connection.connect
+          end
+
+          connection.connect do
+            channel.attach do
+              error = Ably::Exceptions::ConnectionFailed.new('forced failure', 500, 50000)
+              client.connection.manager.error_received_from_server error
+            end
+          end
+        end
+      end
+
       context 'with invalid auth details' do
         let(:client_options) { default_options.merge(key: 'this.is:invalid', log_level: :none) }
 
@@ -693,6 +825,18 @@ describe Ably::Realtime::Connection, :event_machine do
     end
 
     context '#close' do
+      let(:close_connection_proc) do
+        lambda do
+          EventMachine.add_timer(0.001) do
+            if connection.transport.nil?
+              close_connection_proc.call
+            else
+              connection.transport.close_connection_after_writing
+            end
+          end
+        end
+      end
+
       it 'returns a SafeDeferrable that catches exceptions in callbacks and logs them' do
         connection.connect do
           expect(connection.close).to be_a(Ably::Util::SafeDeferrable)
@@ -754,6 +898,56 @@ describe Ably::Realtime::Connection, :event_machine do
           end
         end
 
+        context ':connecting RTN12f' do
+          context ":connected does not arrive when trying to close" do
+            it 'moves to closed' do
+              connection.on(:closed) do |state_change|
+                state_changes = connection.state_history.map { |t| t[:state].to_sym }
+
+                expect(state_changes).to eq([:connecting, :closing, :closed])
+                stop_reactor
+              end
+
+              connection.on(:connecting) do
+                connection.close
+                connection.__outgoing_protocol_msgbus__.unsubscribe
+              end
+
+              connection.connect
+            end
+          end
+
+          context ":connected arrive when trying to close" do
+            let(:protocol_message_attributes) do
+              {
+                action: Ably::Models::ProtocolMessage::ACTION.Connected.to_i,
+                connection_serial: 55,
+                connection_details: {
+                  max_idle_interval: 2 * 1000
+                }
+              }
+            end
+
+            it 'moves to connected and then to closed' do
+              connection.on(:closed) do |state_change|
+                state_changes = connection.state_history.map { |t| t[:state].to_sym }
+
+                expect(state_changes).to eq([:connecting, :connected, :closing, :closed])
+                stop_reactor
+              end
+
+              connection.on(:connecting) do
+                connection.__outgoing_protocol_msgbus__.unsubscribe
+
+                connection.__incoming_protocol_msgbus__.publish :protocol_message, Ably::Models::ProtocolMessage.new(protocol_message_attributes)
+                connection.close
+              end
+
+              connection.connect
+            end
+          end
+        end
+
         context ':connected' do
           it 'changes the connection state to :closing and waits for the server to confirm connection is :closed with a ProtocolMessage' do
             connection.on(:connected) do
@@ -800,6 +994,81 @@ describe Ably::Realtime::Connection, :event_machine do
             end
           end
         end
+
+        context ':suspended RTN12d' do
+          let(:suspended_retry_timeout) { 60 }
+          let(:client_options) do
+            default_options.merge(
+              disconnected_retry_timeout: 0.02,
+              suspended_retry_timeout: suspended_retry_timeout,
+              connection_state_ttl: 0
+            )
+          end
+
+          it 'immediatly closes connection' do
+            connection.on(:connecting) { close_connection_proc.call }
+            connection.on(:suspended) do |connection_state_change|
+              if connection_state_change.retry_in.zero?
+                # Exhausting immediate retries
+                connection.once(:connecting) { close_connection_proc.call }
+              else
+                suspended_at = Time.now.to_f
+                connection.on(:closed) do
+                  expect(connection_state_change.retry_in).to eq(suspended_retry_timeout)
+                  expect(connection.state).to eq(:closed)
+                  expect(Time.now.to_f).to be_within(4).of(suspended_at)
+                  stop_reactor
+                end
+
+                connection.close
+              end
+
+              connection.connect
+            end
+
+            connection.connect
+          end
+        end
+
+        context ':disconnected RTN12d' do
+          let(:retry_timeout) { 60 }
+          let(:client_options) do
+            default_options.merge(
+              disconnected_retry_timeout: retry_timeout,
+              suspended_retry_timeout: retry_timeout,
+              connection_state_ttl: 0
+            )
+          end
+
+          it 'immediatly closes connection' do
+            connection.once(:connected) do
+              connection.on(:disconnected) do |connection_state_change|
+                disconnected_at = Time.now.to_f
+                connection.on(:connected) do
+                  if connection_state_change.retry_in.zero?
+                    # Exhausting immediate retries
+                    close_connection_proc.call
+                  else
+                    connection.once(:closed) do
+                      expect(connection_state_change.retry_in).to eq(retry_timeout)
+                      expect(connection.state).to eq(:closed)
+                      expect(Time.now.to_f).to be_within(4).of(disconnected_at)
+                      stop_reactor
+                    end
+
+                    connection.close
+                  end
+                end
+
+                connection.connect
+              end
+
+              close_connection_proc.call
+            end
+
+            connection.connect
+          end
+        end
       end
     end
 
@@ -1834,7 +2103,7 @@ describe Ably::Realtime::Connection, :event_machine do
       it 'sends the protocol version param v (#G4, #RTN2f)' do
         expect(EventMachine).to receive(:connect) do |host, port, transport, object, url|
           uri = URI.parse(url)
-          expect(CGI::parse(uri.query)['v'][0]).to eql('1.1')
+          expect(CGI::parse(uri.query)['v'][0]).to eql('1.2')
           stop_reactor
         end
         client

data/spec/acceptance/realtime/message_spec.rb

@@ -75,6 +75,83 @@ describe 'Ably::Realtime::Channel Message', :event_machine do
       end
     end
 
+    context 'a single Message object (#RSL1a)' do
+      let(:name) { random_str }
+      let(:data) { random_str }
+      let(:message) { Ably::Models::Message.new(name: name, data: data) }
+
+      it 'publishes the message' do
+        channel.attach
+        channel.publish(message)
+        channel.subscribe do |msg|
+          expect(msg.name).to eq(message.name)
+          expect(msg.data).to eq(message.data)
+          stop_reactor
+        end
+      end
+    end
+
+    context 'an array of Message objects (#RSL1a)' do
+      let(:data) { random_str }
+      let(:message1) { Ably::Models::Message.new(name: random_str, data: data) }
+      let(:message2) { Ably::Models::Message.new(name: random_str, data: data) }
+      let(:message3) { Ably::Models::Message.new(name: random_str, data: data) }
+
+      it 'publishes three messages' do
+        channel.attach
+        channel.publish([message1, message2, message3])
+        counter = 0
+        channel.subscribe do |message|
+          counter += 1
+          expect(message.data).to eq(data)
+          expect(message.name).to eq(message1.name) if counter == 1
+          expect(message.name).to eq(message2.name) if counter == 2
+          if counter == 3
+            expect(message.name).to eq(message3.name)
+            stop_reactor
+          end
+        end
+      end
+    end
+
+    context 'an array of hashes (#RSL1a)' do
+      let(:data) { random_str }
+      let(:message1) { { name: random_str, data: data } }
+      let(:message2) { { name: random_str, data: data } }
+      let(:message3) { { name: random_str, data: data } }
+
+      it 'publishes three messages' do
+        channel.attach
+        channel.publish([message1, message2, message3])
+        counter = 0
+        channel.subscribe do |message|
+          counter += 1
+          expect(message.data).to eq(data)
+          expect(message.name).to eq(message1[:name]) if counter == 1
+          expect(message.name).to eq(message2[:name]) if counter == 2
+          if counter == 3
+            expect(message.name).to eq(message3[:name])
+            stop_reactor
+          end
+        end
+      end
+    end
+
+    context 'a name with data payload (#RSL1a, #RSL1b)' do
+      let(:name) { random_str }
+      let(:data) { random_str }
+
+      it 'publishes a message' do
+        channel.attach
+        channel.publish(name, data)
+        channel.subscribe do |message|
+          expect(message.name).to eql(name)
+          expect(message.data).to eq(data)
+          stop_reactor
+        end
+      end
+    end
+
     context 'with supported extra payload content type (#RTL6h, #RSL6a2)' do
       let(:channel) { client.channel("pushenabled:#{random_str}") }
 

data/spec/acceptance/realtime/presence_spec.rb

@@ -2634,7 +2634,24 @@ describe Ably::Realtime::Presence, :event_machine do
       end
     end
 
-    context 'channel state side effects' do
+    context 'channel state side effects (RTP5)' do
+      context 'channel transitions to the ATTACHED state (RTP5b)' do
+        it 'all queued presence messages are sent' do
+          channel_client_one.on(:attached) do
+            client_one.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+              if protocol_message.action == :presence
+                expect(protocol_message.action).to eq(:presence)
+                stop_reactor
+              end
+            end
+          end
+
+          presence_client_one.enter do
+            channel_client_one.attach
+          end
+        end
+      end
+
       context 'channel transitions to the FAILED state' do
         let(:anonymous_client) { auto_close Ably::Realtime::Client.new(client_options.merge(log_level: :fatal)) }
         let(:client_one)       { auto_close Ably::Realtime::Client.new(client_options.merge(client_id: client_one_id, log_level: :fatal)) }

data/spec/acceptance/rest/auth_spec.rb

@@ -1165,6 +1165,24 @@ describe Ably::Auth do
         end
       end
 
+      context 'when token does not expire' do
+        let(:client_options) { default_options.merge(use_token_auth: true, key: api_key, query_time: true) }
+        let(:channel) { client.channels.get(random_str) }
+
+        context 'for the next 2 hours' do
+          let(:local_time) { Time.now - 2 * 60 * 60 }
+
+          before { allow(Time).to receive(:now).and_return(local_time) }
+
+          it 'should not request for the new token (#RSA4b1)' do
+            expect { channel.publish 'event' }.to change { auth.current_token_details }
+            expect do
+              expect { channel.publish 'event' }.not_to change { auth.current_token_details }
+            end.not_to change { auth.current_token_details.expires }
+          end
+        end
+      end
+
       context 'when :client_id is provided in a token' do
         let(:client_id) { '123' }
         let(:token) do

data/spec/acceptance/rest/channel_spec.rb

@@ -5,11 +5,13 @@ describe Ably::Rest::Channel do
   include Ably::Modules::Conversions
 
   vary_by_protocol do
-    let(:default_options) { { key: api_key, environment: environment, protocol: protocol} }
+    let(:default_options) { { key: api_key, environment: environment, protocol: protocol, max_frame_size: max_frame_size, max_message_size: max_message_size, idempotent_rest_publishing: false } }
     let(:client_options)  { default_options }
     let(:client) do
       Ably::Rest::Client.new(client_options)
     end
+    let(:max_message_size) { nil }
+    let(:max_frame_size) { nil }
 
     describe '#publish' do
       let(:channel_name) { random_str }
@@ -60,7 +62,8 @@ describe Ably::Rest::Channel do
         end
 
         it 'publishes an array of messages in one HTTP request' do
-          expect(messages.sum(&:size) < Ably::Rest::Channel::MAX_MESSAGE_SIZE).to eq(true)
+          expect(client.max_message_size).to eq(Ably::Rest::Client::MAX_MESSAGE_SIZE)
+          expect(messages.sum(&:size) < Ably::Rest::Client::MAX_MESSAGE_SIZE).to eq(true)
 
           expect(client).to receive(:post).once.and_call_original
           expect(channel.publish(messages)).to eql(true)
@@ -70,19 +73,78 @@ describe Ably::Rest::Channel do
       end
 
       context 'with an array of Message objects' do
-        let(:messages) do
-          10.times.map do |index|
-            Ably::Models::Message(name: index.to_s, data: { "index" => index + 10 })
+        context 'when max_message_size and max_frame_size is not set' do
+          before do
+            expect(client.max_message_size).to eq(Ably::Rest::Client::MAX_MESSAGE_SIZE)
+            expect(client.max_frame_size).to eq(Ably::Rest::Client::MAX_FRAME_SIZE)
+          end
+
+          context 'and messages size (130 bytes) is smaller than the max_message_size' do
+            let(:messages) do
+              10.times.map do |index|
+                Ably::Models::Message(name: index.to_s, data: { "index" => index + 10 })
+              end
+            end
+
+            it 'publishes an array of messages in one HTTP request' do
+              expect(messages.sum &:size).to eq(130)
+              expect(client).to receive(:post).once.and_call_original
+              expect(channel.publish(messages)).to eql(true)
+              expect(channel.history.items.map(&:name)).to match_array(messages.map(&:name))
+              expect(channel.history.items.map(&:data)).to match_array(messages.map(&:data))
+            end
+          end
+
+          context 'and messages size (177784 bytes) is bigger than the max_message_size' do
+            let(:messages) do
+              10000.times.map do |index|
+                Ably::Models::Message(name: index.to_s, data: { "index" => index + 1 })
+              end
+            end
+
+            it 'should not publish and raise Ably::Exceptions::MaxMessageSizeExceeded' do
+              expect(messages.sum &:size).to eq(177784)
+              expect { channel.publish(messages) }.to raise_error(Ably::Exceptions::MaxMessageSizeExceeded)
+            end
           end
         end
 
-        it 'publishes an array of messages in one HTTP request' do
-          expect(messages.sum(&:size) < Ably::Rest::Channel::MAX_MESSAGE_SIZE).to eq(true)
+        context 'when max_message_size is 655 bytes' do
+          let(:max_message_size) { 655 }
 
-          expect(client).to receive(:post).once.and_call_original
-          expect(channel.publish(messages)).to eql(true)
-          expect(channel.history.items.map(&:name)).to match_array(messages.map(&:name))
-          expect(channel.history.items.map(&:data)).to match_array(messages.map(&:data))
+          before do
+            expect(client.max_message_size).to eq(max_message_size)
+            expect(client.max_frame_size).to eq(Ably::Rest::Client::MAX_FRAME_SIZE)
+          end
+
+          context 'and messages size (130 bytes) is smaller than the max_message_size' do
+            let(:messages) do
+              10.times.map do |index|
+                Ably::Models::Message(name: index.to_s, data: { "index" => index + 10 })
+              end
+            end
+
+            it 'publishes an array of messages in one HTTP request' do
+              expect(messages.sum &:size).to eq(130)
+              expect(client).to receive(:post).once.and_call_original
+              expect(channel.publish(messages)).to eql(true)
+              expect(channel.history.items.map(&:name)).to match_array(messages.map(&:name))
+              expect(channel.history.items.map(&:data)).to match_array(messages.map(&:data))
+            end
+          end
+
+          context 'and messages size (177784 bytes) is bigger than the max_message_size' do
+            let(:messages) do
+              10000.times.map do |index|
+                Ably::Models::Message(name: index.to_s, data: { "index" => index + 1 })
+              end
+            end
+
+            it 'should not publish and raise Ably::Exceptions::MaxMessageSizeExceeded' do
+              expect(messages.sum &:size).to eq(177784)
+              expect { channel.publish(messages) }.to raise_error(Ably::Exceptions::MaxMessageSizeExceeded)
+            end
+          end
         end
       end
 

data/spec/acceptance/rest/channels_spec.rb

@@ -5,11 +5,11 @@ describe Ably::Rest::Channels do
   shared_examples 'a channel' do
     it 'returns a channel object' do
       expect(channel).to be_a Ably::Rest::Channel
-      expect(channel.name).to eql(channel_name)
+      expect(channel.name).to eq(channel_name)
     end
 
     it 'returns channel object and passes the provided options' do
-      expect(channel_with_options.options).to eql(options)
+      expect(channel_with_options.options.to_h).to eq(options)
     end
   end
 
@@ -32,12 +32,29 @@ describe Ably::Rest::Channels do
       it_behaves_like 'a channel'
     end
 
+    describe '#set_options (#RTL16)' do
+      let(:channel) { client.channel(channel_name) }
+
+      it "updates channel's options" do
+        expect { channel.options = options }.to change { channel.options.to_h }.from({}).to(options)
+      end
+
+      context 'when providing Ably::Models::ChannelOptions object' do
+        let(:options_object) { Ably::Models::ChannelOptions.new(options) }
+
+        it "updates channel's options" do
+          expect { channel.options =  options_object}.to change { channel.options.to_h }.from({}).to(options)
+        end
+      end
+    end
+
     describe 'accessing an existing channel object with different options' do
       let(:new_channel_options) { { encrypted: true } }
       let(:original_channel)    { client.channels.get(channel_name, options) }
 
-      it 'overrides the existing channel options and returns the channel object' do
-        expect(original_channel.options).to_not include(:encrypted)
+      it 'overrides the existing channel options and returns the channel object (RSN3c)' do
+        expect(original_channel.options.to_h).to_not include(:encrypted)
+
         new_channel = client.channels.get(channel_name, new_channel_options)
         expect(new_channel).to be_a(Ably::Rest::Channel)
         expect(new_channel.options[:encrypted]).to eql(true)
@@ -48,10 +65,10 @@ describe Ably::Rest::Channels do
       let(:original_channel) { client.channels.get(channel_name, options) }
 
       it 'returns the existing channel without modifying the channel options' do
-        expect(original_channel.options).to eql(options)
+        expect(original_channel.options.to_h).to eq(options)
         new_channel = client.channels.get(channel_name)
         expect(new_channel).to be_a(Ably::Rest::Channel)
-        expect(original_channel.options).to eql(options)
+        expect(original_channel.options.to_h).to eq(options)
       end
     end