ably 1.1.4 → 1.1.8

data/lib/ably/version.rb

@@ -1,19 +1,7 @@
 module Ably
-  VERSION = '1.1.4'
+  VERSION = '1.1.8'
   PROTOCOL_VERSION = '1.1'
 
-  # Allow a variant to be configured for all instances of this client library
-  # such as ruby-rest-[VERSION]
-
-  # @api private
-  def self.lib_variant=(variant)
-    @lib_variant = variant
-  end
-
-  def self.lib_variant
-    @lib_variant
-  end
-
   # @api private
   def self.major_minor_version_numeric
     VERSION.gsub(/\.\d+$/, '').to_f

data/lib/ably.rb

@@ -1,6 +1,7 @@
 require 'addressable/uri'
 
 require 'ably/version'
+require 'ably/agent'
 
 %w(modules util).each do |namespace|
   Dir.glob(File.expand_path("ably/#{namespace}/*.rb", File.dirname(__FILE__))).sort.each do |file|

data/spec/acceptance/realtime/auth_spec.rb

@@ -1237,7 +1237,7 @@ describe Ably::Realtime::Auth, :event_machine do
         let(:basic_capability) { JSON.dump(channel_name => ['subscribe'], channel_with_publish_permissions => ['publish']) }
         let(:auth_callback) do
           lambda do |token_params|
-            Faraday.get("#{auth_url}?keyName=#{key_name}&keySecret=#{key_secret}&capability=#{URI.escape(basic_capability)}").body
+            Faraday.get("#{auth_url}?keyName=#{key_name}&keySecret=#{key_secret}&capability=#{URI::Parser.new.escape(basic_capability)}").body
           end
         end
         let(:client_options) { default_options.merge(auth_callback: auth_callback, log_level: :error) }

data/spec/acceptance/realtime/channel_history_spec.rb

@@ -183,6 +183,31 @@ describe Ably::Realtime::Channel, '#history', :event_machine do
         end
       end
 
+      context 'when channel receives update event after an attachment' do
+        before do
+          channel.on(:attached) do
+            channel.publish(event, message_after_attach) do
+              subsequent_serial = channel.properties.attach_serial.dup.tap { |serial| serial[-1] = '1' }
+              attached_message = Ably::Models::ProtocolMessage.new(action: 11, channel: channel_name, flags: 0, channel_serial: subsequent_serial)
+              client.connection.__incoming_protocol_msgbus__.publish :protocol_message, attached_message
+            end
+          end
+        end
+
+        it 'updates attach_serial' do
+          rest_channel.publish event, message_before_attach
+
+          channel.on(:update) do
+            channel.history(until_attach: true) do |messages|
+              expect(messages.items.count).to eql(2)
+              stop_reactor
+            end
+          end
+
+          channel.attach
+        end
+      end
+
       context 'and two pages of messages' do
         it 'retrieves two pages of messages before channel was attached' do
           10.times { rest_channel.publish event, message_before_attach }

data/spec/acceptance/realtime/channel_spec.rb

@@ -750,6 +750,107 @@ describe Ably::Realtime::Channel, :event_machine do
         end
       end
 
+      describe '#(RTL17)' do
+        context 'when channel is initialized' do
+          it 'sends messages only on attach' do
+            expect(channel).to be_initialized
+            channel.publish('event', payload)
+
+            channel.subscribe do |message|
+              stop_reactor if message.data == payload && channel.attached?
+            end
+
+            channel.attach
+          end
+        end
+
+        context 'when channel is attaching' do
+          it 'sends messages only on attach' do
+            channel.publish('event', payload)
+
+            sent_message = nil
+            channel.subscribe do |message|
+              return if message.data != payload
+              sent_message = message
+
+              stop_reactor if channel.attached?
+            end
+
+            channel.on(:attaching) do
+              expect(channel).to be_attaching
+              expect(sent_message).to be_nil
+            end
+
+            channel.attach
+          end
+        end
+
+        context 'when channel is detaching' do
+          it 'stops sending message' do
+            sent_message = nil
+            event_published = false
+            channel.subscribe do |message|
+              sent_message = message if message.data == payload
+            end
+
+            channel.on(:detaching) do
+              channel.publish('event', payload)
+              event_published = true
+            end
+
+            channel.on(:detaching) do
+              EventMachine.next_tick do
+                expect(sent_message).to be_nil
+                stop_reactor if event_published
+              end
+            end
+
+            channel.attach do
+              channel.detach
+            end
+          end
+        end
+
+        context 'when channel is detached' do
+          it 'stops sending message' do
+            sent_message = nil
+            event_published = false
+            channel.subscribe do |message|
+              sent_message = message if message.data == payload
+            end
+
+            channel.on(:detaching) do
+              channel.publish('event', payload)
+              event_published = true
+            end
+
+            channel.on(:detached) do
+              expect(sent_message).to be_nil
+              stop_reactor if event_published
+            end
+
+            channel.attach do
+              channel.detach
+            end
+          end
+        end
+
+        context 'when channel is failed' do
+          it 'errors when trying to send a message' do
+            channel.once(:failed) do
+              channel.publish('event', payload).errback do |error|
+                expect(error).to be_a(Ably::Exceptions::ChannelInactive)
+                stop_reactor
+              end
+            end
+
+            channel.attach do
+              channel.transition_state_machine(:failed)
+            end
+          end
+        end
+      end
+
       context 'when channel is not attached in state Initializing (#RTL6c1)' do
         it 'publishes messages immediately and does not implicitly attach (#RTL6c1)' do
           sub_channel.attach do
@@ -1181,7 +1282,7 @@ describe Ably::Realtime::Channel, :event_machine do
       end
 
       context 'with more than allowed messages in a single publish' do
-        let(:channel_name) { random_str }
+        65536
 
         it 'rejects the publish' do
           messages = (Ably::Realtime::Connection::MAX_PROTOCOL_MESSAGE_BATCH_SIZE + 1).times.map do
@@ -1403,6 +1504,103 @@ describe Ably::Realtime::Channel, :event_machine do
           end
         end
       end
+
+      context 'message size exceeded (#TO3l8)' do
+        let(:client) { auto_close Ably::Realtime::Client.new(client_options) }
+        let(:channel) { client.channels.get(channel_name) }
+
+        context 'and max_message_size is default (65536 bytes)' do
+          let(:channel_name) { random_str }
+          let(:max_message_size) { 65536 }
+
+          it 'should allow to send a message (32 bytes)' do
+            client.connection.once(:connected) do
+              channel.subscribe('event') do |msg|
+                expect(msg.data).to eq('x' * 32)
+                stop_reactor
+              end
+              channel.publish('event', 'x' * 32)
+            end
+          end
+
+          it 'should not allow to send a message (700000 bytes)' do
+            client.connection.once(:connected) do
+              connection_details = Ably::Models::ConnectionDetails.new(
+                client.connection.details.attributes.attributes.merge('maxMessageSize' => max_message_size)
+              )
+              client.connection.set_connection_details(connection_details)
+              expect(client.connection.details.max_message_size).to eq(65536)
+              channel.publish('event', 'x' * 700000).errback do |error|
+                expect(error).to be_instance_of(Ably::Exceptions::MaxMessageSizeExceeded)
+                stop_reactor
+              end
+            end
+          end
+        end
+
+        context 'and max_message_size is customized (11 bytes)' do
+          let(:max_message_size) { 11 }
+
+          context 'and the message size is 30 bytes' do
+            let(:channel_name) { random_str }
+
+            it 'should not allow to send a message' do
+              client.connection.once(:connected) do
+                connection_details = Ably::Models::ConnectionDetails.new(
+                  client.connection.details.attributes.attributes.merge('maxMessageSize' => max_message_size)
+                )
+                client.connection.set_connection_details(connection_details)
+                expect(client.connection.details.max_message_size).to eq(11)
+                channel.publish('event', 'x' * 30).errback do |error|
+                  expect(error).to be_instance_of(Ably::Exceptions::MaxMessageSizeExceeded)
+                  stop_reactor
+                end
+              end
+            end
+          end
+        end
+
+        context 'and max_message_size is nil' do
+          let(:max_message_size) { nil }
+
+          context 'and the message size is 30 bytes' do
+            let(:channel_name) { random_str }
+
+            it 'should allow to send a message' do
+              client.connection.once(:connected) do
+                connection_details = Ably::Models::ConnectionDetails.new(
+                  client.connection.details.attributes.attributes.merge('maxMessageSize' => max_message_size)
+                )
+                client.connection.set_connection_details(connection_details)
+                expect(client.connection.details.max_message_size).to eq(65536)
+                channel.subscribe('event') do |msg|
+                  expect(msg.data).to eq('x' * 30)
+                  stop_reactor
+                end
+                channel.publish('event', 'x' * 30)
+              end
+            end
+          end
+
+          context 'and the message size is 65537 bytes' do
+            let(:channel_name) { random_str }
+
+            it 'should not allow to send a message' do
+              client.connection.once(:connected) do
+                connection_details = Ably::Models::ConnectionDetails.new(
+                  client.connection.details.attributes.attributes.merge('maxMessageSize' => max_message_size)
+                )
+                client.connection.set_connection_details(connection_details)
+                expect(client.connection.details.max_message_size).to eq(65536)
+                channel.publish('event', 'x' * 65537).errback do |error|
+                  expect(error).to be_instance_of(Ably::Exceptions::MaxMessageSizeExceeded)
+                  stop_reactor
+                end
+              end
+            end
+          end
+        end
+      end
     end
 
     describe '#subscribe' do
@@ -2210,6 +2408,27 @@ describe Ably::Realtime::Channel, :event_machine do
             channel.transition_state_machine! :suspended
           end
         end
+
+        context 'when connection is no longer connected' do
+          it 'will not attempt to reattach (#RTL13c)' do
+            channel.attach do
+              connection.once(:closing) do
+                channel.once(:attaching) do |state_change|
+                  raise 'Channel should not attempt to reattach'
+                end
+
+                channel.transition_state_machine! :suspended
+              end
+
+              connection.once(:closed) do
+                expect(channel).to be_suspended
+                stop_reactor
+              end
+
+              connection.close
+            end
+          end
+        end
       end
 
       context 'and channel is attaching' do

data/spec/acceptance/realtime/connection_failures_spec.rb

@@ -156,10 +156,20 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
 
               stub_request(:get, auth_url).
                 to_return do |request|
-                  sleep Ably::Rest::Client::HTTP_DEFAULTS.fetch(:request_timeout)
-                  { status: [500, "Internal Server Error"] }
-                end.then.
-                to_return(:status => 201, :body => token_response.to_json, :headers => { 'Content-Type' => 'application/json' })
+                sleep Ably::Rest::Client::HTTP_DEFAULTS.fetch(:request_timeout)
+                { status: [500, "Internal Server Error"] }
+              end.then.
+              to_return(:status => 201, :body => token_response.to_json, :headers => { 'Content-Type' => 'application/json' })
+
+              stub_request(:get, 'https://internet-up.ably-realtime.com/is-the-internet-up.txt')
+                .with(
+                  headers: {
+                    'Accept-Encoding' => 'gzip, compressed',
+                    'Connection' => 'close',
+                    'Host' => 'internet-up.ably-realtime.com',
+                    'User-Agent' => 'EventMachine HttpClient'
+                  }
+                ).to_return(status: 200, body: 'yes\n', headers: { 'Content-Type' => 'text/plain' })
             end
 
             specify 'the connection moves to the disconnected state and tries again, returning again to the disconnected state (#RSA4c, #RSA4c1, #RSA4c2)' do
@@ -560,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
@@ -580,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
@@ -1310,7 +1375,9 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
             end)
           end
 
-          it 'triggers a re-authentication and then resumes the connection' do
+          xit 'triggers a re-authentication and then resumes the connection' do
+            # [PENDING] After sandbox env update connection isn't found and a new connection is created. Spec fails
+            #
             connection.once(:connected) do
               connection_id = connection.id
 
@@ -1423,14 +1490,19 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
         let(:expected_host)  { "#{environment}-#{Ably::Realtime::Client::DOMAIN}" }
         let(:client_options) { timeout_options.merge(environment: environment) }
 
-        it 'does not use a fallback host by default' do
-          expect(connection).to receive(:create_transport).exactly(retry_count_for_all_states).times do |host|
-            expect(host).to eql(expected_host)
-            raise EventMachine::ConnectionError
-          end
+        context ':fallback_hosts_use_default is unset' do
+          let(:max_time_in_state_for_tests) { 8 }
+          let(:expected_hosts) { Ably::CUSTOM_ENVIRONMENT_FALLBACKS_SUFFIXES.map { |suffix| "#{environment}#{suffix}" } + [expected_host] }
+          let(:fallback_hosts_used) { Array.new }
+
+          it 'uses fallback hosts by default' do
+            allow(connection).to receive(:create_transport) do |host|
+              fallback_hosts_used << host
+              raise EventMachine::ConnectionError
+            end
 
-          connection.once(:suspended) do
             connection.once(:suspended) do
+              expect(fallback_hosts_used.uniq).to match_array(expected_hosts)
               stop_reactor
             end
           end
@@ -1508,7 +1580,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
       end
 
       context 'with production environment' do
-        let(:custom_hosts)   { %w(A.ably-realtime.com B.ably-realtime.com) }
+        let(:custom_hosts)   { %w(a.ably-realtime.com b.ably-realtime.com) }
         before do
           stub_const 'Ably::FALLBACK_HOSTS', custom_hosts
         end