ably 1.1.7 → 1.2.1

data/spec/acceptance/realtime/channel_spec.rb

@@ -117,6 +117,94 @@ describe Ably::Realtime::Channel, :event_machine do
           end
         end
 
+        context 'context when channel options contain modes' do
+          before do
+            channel.options = { modes: %i[publish] }
+          end
+
+          it 'sends an ATTACH with options as flags (#RTL4l)' do
+            connection.once(:connected) do
+              client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+                next if protocol_message.action != :attach
+
+                expect(protocol_message.has_attach_publish_flag?).to eq(true)
+                stop_reactor
+              end
+
+              channel.attach
+            end
+          end
+
+          context 'when channel is reattaching' do
+            it 'sends ATTACH_RESUME flag along with other modes (RTL4j)' do
+              channel.attach do
+                channel.on(:suspended) do
+                  client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+                    next if protocol_message.action != :attach
+
+                    expect(protocol_message.has_attach_resume_flag?).to eq(true)
+                    expect(protocol_message.has_attach_publish_flag?).to eq(true)
+                    stop_reactor
+                  end
+
+                  client.connection.connect
+                end
+                client.connection.transition_state_machine :suspended
+              end
+            end
+          end
+        end
+
+        context 'context when channel options contain params' do
+          let(:params) do
+            { foo: 'foo', bar: 'bar'}
+          end
+
+          before do
+            channel.options = { params: params }
+          end
+
+          it 'sends an ATTACH with params (#RTL4k)' do
+            connection.once(:connected) do
+              client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+                next if protocol_message.action != :attach
+
+                expect(protocol_message.params).to eq(params)
+                stop_reactor
+              end
+
+              channel.attach
+            end
+          end
+        end
+
+        context 'when received attached' do
+          it 'decodes flags and sets it as modes on channel options (#RTL4m)'do
+            channel.on(:attached) do
+              expect(channel.options.modes.map(&:to_sym)).to eq(%i[subscribe])
+              stop_reactor
+            end
+
+            channel.transition_state_machine(:attaching)
+            attached_message = Ably::Models::ProtocolMessage.new(action: 11, channel: channel_name, flags: 262144)
+            client.connection.__incoming_protocol_msgbus__.publish :protocol_message, attached_message
+          end
+
+          it 'set params as channel options params (#RTL4k1)' do
+            params = { param: :something }
+
+            channel.on(:attached) do
+              expect(channel.params).to eq(channel.options.params)
+              expect(channel.params).to eq(params)
+              stop_reactor
+            end
+
+            channel.transition_state_machine(:attaching)
+            attached_message = Ably::Models::ProtocolMessage.new(action: 11, channel: channel_name, params: params)
+            client.connection.__incoming_protocol_msgbus__.publish :protocol_message, attached_message
+          end
+        end
+
         it 'implicitly attaches the channel (#RTL7c)' do
           expect(channel).to be_initialized
           channel.subscribe { |message| }
@@ -368,6 +456,42 @@ describe Ably::Realtime::Channel, :event_machine do
           end
         end
       end
+
+      describe 'clean attach (RTL4j)' do
+        context "when channel wasn't previously attached" do
+          it "doesn't send ATTACH_RESUME" do
+            client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+              next if protocol_message.action != :attach
+
+              expect(protocol_message.has_attach_resume_flag?).to eq(false)
+              stop_reactor
+            end
+
+            channel.attach
+          end
+        end
+
+        context "when channel was explicitly detached" do
+          it "doesn't send ATTACH_RESUME" do
+            channel.once(:detached) do
+              client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+                next if protocol_message.action != :attach
+
+                expect(protocol_message.has_attach_resume_flag?).to eq(false)
+                stop_reactor
+              end
+
+              channel.attach
+            end
+
+            channel.once(:attached) do
+              channel.detach
+            end
+
+            channel.attach
+          end
+        end
+      end
     end
 
     describe '#detach' do
@@ -750,6 +874,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 +1406,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
@@ -1405,15 +1630,98 @@ describe Ably::Realtime::Channel, :event_machine do
       end
 
       context 'message size exceeded (#TO3l8)' do
-        let(:message) { 'x' * 700000 }
-
         let(:client) { auto_close Ably::Realtime::Client.new(client_options) }
         let(:channel) { client.channels.get(channel_name) }
 
-        it 'should not allow to send a message' do
-          channel.publish('event', message).errback do |error|
-            expect(error).to be_instance_of(Ably::Exceptions::MaxMessageSizeExceeded)
-            stop_reactor
+        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
@@ -1752,15 +2060,33 @@ describe Ably::Realtime::Channel, :event_machine do
             end
           end
 
-          it 'transitions state automatically to :attaching once the connection is re-established (#RTN15c3)' do
-            channel.attach do
-              channel.on(:suspended) do
-                client.connection.connect
-                channel.once(:attached) do
-                  stop_reactor
+          describe 'reattaching (#RTN15c3)' do
+            it 'transitions state automatically to :attaching once the connection is re-established ' do
+              channel.attach do
+                channel.on(:suspended) do
+                  client.connection.connect
+                  channel.once(:attached) do
+                    stop_reactor
+                  end
                 end
+                client.connection.transition_state_machine :suspended
+              end
+            end
+
+            it 'sends ATTACH_RESUME flag when reattaching (RTL4j)' do
+              channel.attach do
+                channel.on(:suspended) do
+                  client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+                    next if protocol_message.action != :attach
+
+                    expect(protocol_message.has_attach_resume_flag?).to eq(true)
+                    stop_reactor
+                  end
+
+                  client.connection.connect
+                end
+                client.connection.transition_state_machine :suspended
               end
-              client.connection.transition_state_machine :suspended
             end
           end
         end
@@ -1950,6 +2276,68 @@ describe Ably::Realtime::Channel, :event_machine do
       end
     end
 
+    describe '#set_options (#RTL16a)' do
+      let(:modes) { %i[subscribe] }
+      let(:channel_options) do
+        { modes: modes }
+      end
+
+      def self.build_flags(flags)
+        flags.map { |flag| Ably::Models::ProtocolMessage::ATTACH_FLAGS_MAPPING[flag] }.reduce(:|)
+      end
+
+      shared_examples 'an update that sends ATTACH message' do |state, flags|
+        it 'sends an ATTACH message on options change' do
+          attach_sent = nil
+
+          client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+            if protocol_message.action == :attach && protocol_message.flags.nonzero?
+              attach_sent = true
+              expect(protocol_message.flags).to eq(flags)
+            end
+          end
+
+          channel.once(state) do
+            channel.options = channel_options
+          end
+
+          channel.on(:attached) do
+            client.connection.__incoming_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+              next if protocol_message.action != :attached
+
+              expect(attach_sent).to eq(true)
+              stop_reactor
+            end
+          end
+
+          channel.attach
+        end
+      end
+
+      context 'when channel is attaching' do
+        it_behaves_like 'an update that sends ATTACH message', :attaching, build_flags(%i[subscribe])
+      end
+
+      context 'when channel is attaching' do
+        it_behaves_like 'an update that sends ATTACH message', :attached, build_flags(%i[resume subscribe])
+      end
+
+      context 'when channel is initialized' do
+        it "doesn't send ATTACH message" do
+          client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+            raise "Unexpected message" if protocol_message.action == :attach
+          end
+
+          channel.options = channel_options
+          expect(channel.options.modes.map(&:to_sym)).to eq(modes)
+
+          EventMachine.next_tick do
+            stop_reactor
+          end
+        end
+      end
+    end
+
     context 'channel state change' do
       it 'emits a ChannelStateChange object' do
         channel.on(:attached) do |channel_state_change|
@@ -2191,11 +2579,20 @@ describe Ably::Realtime::Channel, :event_machine do
       end
 
       context 'and channel is attached' do
-        it 'reattaches immediately (#RTL13a)' do
-          channel.attach do
+        it 'reattaches immediately (#RTL13a) with ATTACH_RESUME flag(RTL4j)' do
+          resume_flag = false
+
+          channel.once(:attached) do
+            client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+              next if protocol_message.action != :attach
+
+              resume_flag = protocol_message.has_attach_resume_flag?
+            end
+
             channel.once(:attaching) do |state_change|
               expect(state_change.reason.code).to eql(50505)
               channel.once(:attached) do
+                expect(resume_flag).to eq(true)
                 stop_reactor
               end
             end
@@ -2203,25 +2600,59 @@ describe Ably::Realtime::Channel, :event_machine do
             detach_message = Ably::Models::ProtocolMessage.new(action: detached_action, channel: channel_name, error: { code: 50505 })
             client.connection.__incoming_protocol_msgbus__.publish :protocol_message, detach_message
           end
+
+          channel.attach
         end
       end
 
       context 'and channel is suspended' do
-        it 'reattaches immediately (#RTL13a)' do
-          channel.attach do
-            channel.once(:suspended) do
-              channel.once(:attaching) do |state_change|
-                expect(state_change.reason.code).to eql(50505)
-                channel.once(:attached) do
-                  stop_reactor
+        it 'reattaches immediately (#RTL13a) with ATTACH_RESUME flag(RTL4j)' do
+          resume_flag = false
+
+          channel.once(:attached) do
+            channel.transition_state_machine! :suspended
+          end
+
+          channel.once(:suspended) do
+            client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+              next if protocol_message.action != :attach
+
+              resume_flag = protocol_message.has_attach_resume_flag?
+            end
+
+            channel.once(:attaching) do |state_change|
+              expect(state_change.reason.code).to eql(50505)
+              channel.once(:attached) do
+                expect(resume_flag).to eq(true)
+                stop_reactor
+              end
+            end
+
+            detach_message = Ably::Models::ProtocolMessage.new(action: detached_action, channel: channel_name, error: { code: 50505 })
+            client.connection.__incoming_protocol_msgbus__.publish :protocol_message, detach_message
+          end
+
+          channel.attach
+        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
 
-              detach_message = Ably::Models::ProtocolMessage.new(action: detached_action, channel: channel_name, error: { code: 50505 })
-              client.connection.__incoming_protocol_msgbus__.publish :protocol_message, detach_message
-            end
+              connection.once(:closed) do
+                expect(channel).to be_suspended
+                stop_reactor
+              end
 
-            channel.transition_state_machine! :suspended
+              connection.close
+            end
           end
         end
       end

data/spec/acceptance/realtime/channels_spec.rb

@@ -10,17 +10,56 @@ describe Ably::Realtime::Channels, :event_machine do
     end
 
     it 'returns channel object and passes the provided options' do
-      expect(channel_with_options.options).to eql(options)
+      expect(channel_options).to be_a(Ably::Models::ChannelOptions)
+      expect(channel_options.to_h).to eq(options)
       stop_reactor
     end
   end
 
   vary_by_protocol do
+    let(:client_options) do
+      { key: api_key, environment: environment, protocol: protocol }
+    end
     let(:client) do
-      auto_close Ably::Realtime::Client.new(key: api_key, environment: environment, protocol: protocol)
+      auto_close Ably::Realtime::Client.new(client_options)
     end
     let(:channel_name) { random_str }
-    let(:options)      { { key: 'value' } }
+    let(:options) do
+      { params: { key: 'value' } }
+    end
+
+    subject(:channel_options) { channel_with_options.options }
+
+    context 'when channel supposed to trigger reattachment per RTL16a (#RTS3c1)' do
+      it 'will raise an error' do
+        channel = client.channels.get(channel_name, options)
+
+        channel.on(:attached) do
+          expect { client.channels.get(channel_name, { modes: [] }) }.to raise_error ArgumentError, /use Channel#set_options directly/
+          stop_reactor
+        end
+
+        channel.attach
+      end
+
+      context 'params keys are the same but values are different' do
+        let(:options)      do
+          { params: { x: '1' } }
+        end
+
+        it 'will raise an error' do
+          channel = client.channels.get(channel_name, options)
+
+          channel.on(:attached) do
+            expect { client.channels.get(channel_name, { params: { x: '2' } }) }.to raise_error ArgumentError, /use Channel#set_options directly/
+
+            stop_reactor
+          end
+
+          channel.attach
+        end
+      end
+    end
 
     describe 'using shortcut method #channel on the client object' do
       let(:channel) { client.channel(channel_name) }
@@ -35,26 +74,39 @@ describe Ably::Realtime::Channels, :event_machine do
     end
 
     describe 'accessing an existing channel object with different options' do
+      let(:client_options)  { super().merge(logger: custom_logger_object) }
+      let(:custom_logger_object) { TestLogger.new }
       let(:new_channel_options) { { encrypted: true } }
-      let(:original_channel)    { client.channels.get(channel_name, options) }
+      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)
+        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::Realtime::Channel)
         expect(new_channel.options[:encrypted]).to eql(true)
         stop_reactor
       end
+
+      it 'shows deprecation warning' do
+        client.channels.get(channel_name, new_channel_options)
+
+        warning = custom_logger_object.logs.find do |severity, message|
+          message.match(/Using this method to update channel options is deprecated and may be removed/)
+        end
+
+        expect(warning).to_not be_nil
+        stop_reactor
+      end
     end
 
     describe 'accessing an existing channel object without specifying any channel options' 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::Realtime::Channel)
-        expect(original_channel.options).to eql(options)
+        expect(original_channel.options.to_h).to eq(options)
         stop_reactor
       end
     end