Merge pull request #259 from ably/TO3l9

TO3l9 Max frame size

lib/ably/exceptions.rb

@@ -52,6 +52,9 @@ def as_json(*args)
       end
     end
 
+    # Maximum frame size exceeded TO3l9
+    class MaxFrameSizeExceeded < BaseAblyException; end
+
     # Maximum message size exceeded TO3l8
     class MaxMessageSizeExceeded < BaseAblyException; end
 

lib/ably/models/connection_details.rb

@@ -39,6 +39,7 @@ def initialize(attributes = {})
         end
       end
       self.attributes[:max_message_size] ||= 65536
+      self.attributes[:max_frame_size] ||= 524288
       self.attributes.freeze
     end
 

lib/ably/rest/client.rb

@@ -25,6 +25,8 @@ class Client
       # Default Ably domain for REST
       DOMAIN = 'rest.ably.io'
 
+      MAX_FRAME_SIZE = 524288
+
       # Configuration for HTTP timeouts and HTTP request reattempts to fallback hosts
       HTTP_DEFAULTS = {
         open_timeout:       4,
@@ -363,6 +365,9 @@ def request(method, path, params = {}, body = nil, headers = {}, options = {})
             send_request(method, path, params, headers: headers)
           end
         when :post, :patch, :put
+          if body.to_json.bytesize > MAX_FRAME_SIZE
+            raise Ably::Exceptions::MaxFrameSizeExceeded.new("Maximum frame size exceeded #{MAX_FRAME_SIZE} bytes.")
+          end
           path_with_params = Addressable::URI.new
           path_with_params.query_values = params || {}
           query = path_with_params.query

spec/acceptance/rest/client_spec.rb

@@ -1103,7 +1103,7 @@ def encode64(text)
       end
     end
 
-    context '#request (#RSC19*)' do
+    context '#request (#RSC19*, #TO3l9)' do
       let(:client_options) { default_options.merge(key: api_key) }
       let(:device_id) { random_str }
       let(:endpoint) { client.endpoint }
@@ -1158,6 +1158,12 @@ def encode64(text)
 
           expect(response).to be_success
         end
+
+        it 'raises an exception once body size in bytes exceeded' do
+          expect {
+            client.request(:post, endpoint, {}, { content: 'x' * Ably::Rest::Client::MAX_FRAME_SIZE })
+          }.to raise_error(Ably::Exceptions::MaxFrameSizeExceeded)
+        end
       end
 
       context 'delete', :webmock do
@@ -1187,6 +1193,12 @@ def encode64(text)
 
           expect(response).to be_success
         end
+
+        it 'raises an exception once body size in bytes exceeded' do
+          expect {
+            client.request(:patch, endpoint, {}, { content: 'x' * Ably::Rest::Client::MAX_FRAME_SIZE })
+          }.to raise_error(Ably::Exceptions::MaxFrameSizeExceeded)
+        end
       end
 
       context 'put', :webmock do
@@ -1210,6 +1222,12 @@ def encode64(text)
 
           expect(response).to be_success
         end
+
+        it 'raises an exception once body size in bytes exceeded' do
+          expect {
+            client.request(:put, endpoint, {}, { content: 'x' * Ably::Rest::Client::MAX_FRAME_SIZE })
+          }.to raise_error(Ably::Exceptions::MaxFrameSizeExceeded)
+        end
       end
     end
 

spec/shared/model_behaviour.rb

@@ -19,7 +19,7 @@
     end
 
     context '#attributes', :api_private do
-      let(:model_options) { { action: 5, max_message_size: 65536 } }
+      let(:model_options) { { action: 5, max_message_size: 65536, max_frame_size: 524288 } }
 
       it 'provides access to #attributes' do
         expect(model.attributes).to eq(model_options)