cassandra-driver 3.0.0.beta.1 → 3.0.0.rc.1

data/lib/cassandra/protocol/v4.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -46,7 +46,7 @@ module Cassandra
             body   = @compressor.compress(body)
           end
 
-          header  = [@protocol_version, flags, stream_id, request.opcode, body.bytesize]
+          header = [@protocol_version, flags, stream_id, request.opcode, body.bytesize]
           buffer << header.pack(HEADER_FORMAT)
           buffer << body
 
@@ -90,7 +90,9 @@ module Cassandra
             stream_id  = (frame_header >> 8) & 0xff
             stream_id  = (stream_id & 0x7f) - (stream_id & 0x80)
 
-            @handler.complete_request(stream_id, ErrorResponse.new(nil, nil, 0x000A, "Invalid or unsupported protocol version"))
+            error_response = ErrorResponse.new(nil, nil, 0x000A,
+                                               'Invalid or unsupported protocol version')
+            @handler.complete_request(stream_id, error_response)
 
             return
           end
@@ -159,7 +161,7 @@ module Cassandra
           nil
         end
 
-        def actual_decode(buffer, fields, size, code)
+        def actual_decode(buffer, fields, frame_length, code)
           protocol_version = (fields >> 24) & 0x7f
           compression      = ((fields >> 16) & 0x01) == 0x01
           tracing          = ((fields >> 16) & 0x02) == 0x02
@@ -169,42 +171,45 @@ module Cassandra
           stream_id        = (stream_id & 0x7fff) - (stream_id & 0x8000)
           opcode           = code & 0xff
 
+          # If we're dealing with a compressed body, read the whole body, decompress,
+          # and treat the uncompressed body as if that's what we got in the first place.
+          # This means, reset frame_length to that uncompressed size.
           if compression
             if @compressor
-              buffer = CqlByteBuffer.new(@compressor.decompress(buffer.read(size)))
-              size   = buffer.size
+              buffer = CqlByteBuffer.new(
+                @compressor.decompress(buffer.read(frame_length)))
+              frame_length = buffer.size
             else
-              raise Errors::DecodingError, 'Compressed frame received, but no compressor configured'
+              raise Errors::DecodingError,
+                    'Compressed frame received, but no compressor configured'
             end
           end
 
-          if tracing
-            trace_id = buffer.read_uuid
-            size     = buffer.size
-          else
-            trace_id = nil
-          end
+          # We want to read one full frame; but after we read/parse chunks of the body
+          # there may be more cruft left in the frame that we don't care about. So,
+          # we save off the current size of the buffer, do all our reads for the
+          # frame, get the final remaining size, and based on that discard possible
+          # remaining bytes in the frame. In particular, we account for the possibility
+          # that the buffer contains some/all of a subsequent frame as well, and we
+          # don't want to mess with that.
 
-          if payload
-            custom_payload = buffer.read_bytes_map.freeze
-            size           = buffer.size
-          else
-            custom_payload = nil
-          end
+          buffer_starting_length = buffer.length
 
-          if warning
-            warnings = buffer.read_string_list
-            size     = buffer.size
-          else
-            warnings = nil
-          end
+          trace_id = (buffer.read_uuid if tracing)
 
-          extra_length = buffer.length - size
-          response = decode_response(opcode, protocol_version, buffer, size, trace_id, custom_payload, warnings)
+          warnings = (buffer.read_string_list if warning)
 
-          if buffer.length > extra_length
-            buffer.discard(buffer.length - extra_length)
-          end
+          custom_payload = (buffer.read_bytes_map.freeze if payload)
+
+          remaining_frame_length = frame_length -
+                                   (buffer_starting_length - buffer.length)
+          response = decode_response(opcode, protocol_version, buffer,
+                                     remaining_frame_length, trace_id, custom_payload,
+                                     warnings)
+
+          # Calculate and discard remaining cruft in the frame.
+          extra_length = frame_length - (buffer_starting_length - buffer.length)
+          buffer.discard(extra_length) if extra_length > 0
 
           if stream_id == -1
             @handler.notify_event_listeners(response)
@@ -213,21 +218,86 @@ module Cassandra
           end
         end
 
-        def decode_response(opcode, protocol_version, buffer, size, trace_id, custom_payload, warnings)
+        def decode_response(opcode,
+                            protocol_version,
+                            buffer,
+                            size,
+                            trace_id,
+                            custom_payload,
+                            warnings)
           case opcode
           when 0x00 # ERROR
-            code    = buffer.read_int
+            code = buffer.read_int
             message = buffer.read_string
 
             case code
-            when 0x1000 then UnavailableErrorResponse.new(custom_payload, warnings, code, message, buffer.read_consistency, buffer.read_int, buffer.read_int)
-            when 0x1100 then WriteTimeoutErrorResponse.new(custom_payload, warnings, code, message, buffer.read_consistency, buffer.read_int, buffer.read_int, buffer.read_string)
-            when 0x1200 then ReadTimeoutErrorResponse.new(custom_payload, warnings, code, message, buffer.read_consistency, buffer.read_int, buffer.read_int, (buffer.read_byte != 0))
-            when 0x1300 then ReadFailureErrorResponse.new(custom_payload, warnings, code, message, buffer.read_consistency, buffer.read_int, buffer.read_int, buffer.read_int, (buffer.read_byte != 0))
-            when 0x1400 then FunctionFailureErrorResponse.new(custom_payload, warnings, code, message, buffer.read_string, buffer.read_string, buffer.read_string_list)
-            when 0x1500 then WriteFailureErrorResponse.new(custom_payload, warnings, code, message, buffer.read_consistency, buffer.read_int, buffer.read_int, buffer.read_int, buffer.read_string)
-            when 0x2400 then AlreadyExistsErrorResponse.new(custom_payload, warnings, code, message, buffer.read_string, buffer.read_string)
-            when 0x2500 then UnpreparedErrorResponse.new(custom_payload, warnings, code, message, buffer.read_short_bytes)
+            when 0x1000
+              UnavailableErrorResponse.new(custom_payload,
+                                           warnings,
+                                           code,
+                                           message,
+                                           buffer.read_consistency,
+                                           buffer.read_int,
+                                           buffer.read_int)
+            when 0x1100
+              WriteTimeoutErrorResponse.new(custom_payload,
+                                            warnings,
+                                            code,
+                                            message,
+                                            buffer.read_consistency,
+                                            buffer.read_int,
+                                            buffer.read_int,
+                                            buffer.read_string)
+            when 0x1200
+              ReadTimeoutErrorResponse.new(custom_payload,
+                                           warnings,
+                                           code,
+                                           message,
+                                           buffer.read_consistency,
+                                           buffer.read_int,
+                                           buffer.read_int,
+                                           (buffer.read_byte != 0))
+            when 0x1300
+              ReadFailureErrorResponse.new(custom_payload,
+                                           warnings,
+                                           code,
+                                           message,
+                                           buffer.read_consistency,
+                                           buffer.read_int,
+                                           buffer.read_int,
+                                           buffer.read_int,
+                                           (buffer.read_byte != 0))
+            when 0x1400
+              FunctionFailureErrorResponse.new(custom_payload,
+                                               warnings,
+                                               code,
+                                               message,
+                                               buffer.read_string,
+                                               buffer.read_string,
+                                               buffer.read_string_list)
+            when 0x1500
+              WriteFailureErrorResponse.new(custom_payload,
+                                            warnings,
+                                            code,
+                                            message,
+                                            buffer.read_consistency,
+                                            buffer.read_int,
+                                            buffer.read_int,
+                                            buffer.read_int,
+                                            buffer.read_string)
+            when 0x2400
+              AlreadyExistsErrorResponse.new(custom_payload,
+                                             warnings,
+                                             code,
+                                             message,
+                                             buffer.read_string,
+                                             buffer.read_string)
+            when 0x2500
+              UnpreparedErrorResponse.new(custom_payload,
+                                          warnings,
+                                          code,
+                                          message,
+                                          buffer.read_short_bytes)
             else
               ErrorResponse.new(custom_payload, warnings, code, message)
             end
@@ -247,68 +317,100 @@ module Cassandra
               column_specs, paging_state = Coder.read_metadata_v4(buffer)
 
               if column_specs.nil?
-                consumed_bytes  = original_buffer_length - buffer.length
-                remaining_bytes = CqlByteBuffer.new(buffer.read(size - consumed_bytes - 4))
-                RawRowsResultResponse.new(custom_payload, warnings, protocol_version, remaining_bytes, paging_state, trace_id)
+                consumed_bytes = original_buffer_length - buffer.length
+                remaining_bytes =
+                  CqlByteBuffer.new(buffer.read(size - consumed_bytes - 4))
+                RawRowsResultResponse.new(custom_payload,
+                                          warnings,
+                                          protocol_version,
+                                          remaining_bytes,
+                                          paging_state,
+                                          trace_id)
               else
-                RowsResultResponse.new(custom_payload, warnings, Coder.read_values_v4(buffer, column_specs), column_specs, paging_state, trace_id)
+                RowsResultResponse.new(custom_payload,
+                                       warnings,
+                                       Coder.read_values_v4(buffer, column_specs),
+                                       column_specs,
+                                       paging_state,
+                                       trace_id)
               end
             when 0x0003 # SetKeyspace
-              SetKeyspaceResultResponse.new(custom_payload, warnings, buffer.read_string, trace_id)
+              SetKeyspaceResultResponse.new(custom_payload,
+                                            warnings,
+                                            buffer.read_string,
+                                            trace_id)
             when 0x0004 # Prepared
               id = buffer.read_short_bytes
               pk_idx, params_metadata = Coder.read_prepared_metadata_v4(buffer)
               result_metadata = Coder.read_metadata_v4(buffer).first
 
-              PreparedResultResponse.new(custom_payload, warnings, id, params_metadata, result_metadata, pk_idx, trace_id)
+              PreparedResultResponse.new(custom_payload,
+                                         warnings,
+                                         id,
+                                         params_metadata,
+                                         result_metadata,
+                                         pk_idx,
+                                         trace_id)
             when 0x0005 # SchemaChange
-              change    = buffer.read_string
-              target    = buffer.read_string
-              keyspace  = nil
-              name      = nil
+              change = buffer.read_string
+              target = buffer.read_string
+              name = nil
               arguments = EMPTY_LIST
 
               case target
               when Protocol::Constants::SCHEMA_CHANGE_TARGET_KEYSPACE
                 keyspace = buffer.read_string
               when Protocol::Constants::SCHEMA_CHANGE_TARGET_TABLE,
-                   Protocol::Constants::SCHEMA_CHANGE_TARGET_UDT
+                    Protocol::Constants::SCHEMA_CHANGE_TARGET_UDT
                 keyspace = buffer.read_string
-                name     = buffer.read_string
+                name = buffer.read_string
               when Protocol::Constants::SCHEMA_CHANGE_TARGET_FUNCTION,
-                   Protocol::Constants::SCHEMA_CHANGE_TARGET_AGGREGATE
-                keyspace  = buffer.read_string
-                name      = buffer.read_string
+                    Protocol::Constants::SCHEMA_CHANGE_TARGET_AGGREGATE
+                keyspace = buffer.read_string
+                name = buffer.read_string
                 arguments = buffer.read_string_list
+              else
+                raise Errors::DecodingError,
+                      "Unsupported event target: #{target.inspect}"
               end
 
-              SchemaChangeResultResponse.new(custom_payload, warnings, change, keyspace, name, target, arguments, trace_id)
+              SchemaChangeResultResponse.new(custom_payload,
+                                             warnings,
+                                             change,
+                                             keyspace,
+                                             name,
+                                             target,
+                                             arguments,
+                                             trace_id)
             else
-              raise Errors::DecodingError, "Unsupported result type: #{result_type.inspect}"
+              raise Errors::DecodingError,
+                    "Unsupported result type: #{result_type.inspect}"
             end
           when 0x0C # EVENT
             event_type = buffer.read_string
             case event_type
             when 'SCHEMA_CHANGE'
-              change    = buffer.read_string
-              target    = buffer.read_string
-              keyspace  = nil
+              change = buffer.read_string
+              target = buffer.read_string
               arguments = EMPTY_LIST
 
               case target
               when Protocol::Constants::SCHEMA_CHANGE_TARGET_KEYSPACE
                 keyspace = buffer.read_string
-                name     = nil
+                name = nil
               when Protocol::Constants::SCHEMA_CHANGE_TARGET_TABLE,
-                   Protocol::Constants::SCHEMA_CHANGE_TARGET_UDT,
-                   Protocol::Constants::SCHEMA_CHANGE_TARGET_FUNCTION,
-                   Protocol::Constants::SCHEMA_CHANGE_TARGET_AGGREGATE
+                    Protocol::Constants::SCHEMA_CHANGE_TARGET_UDT,
+                    Protocol::Constants::SCHEMA_CHANGE_TARGET_FUNCTION,
+                    Protocol::Constants::SCHEMA_CHANGE_TARGET_AGGREGATE
                 keyspace = buffer.read_string
-                name     = buffer.read_string
+                name = buffer.read_string
+              else
+                raise Errors::DecodingError,
+                      "Unsupported event target: #{target.inspect}"
               end
 
               if target == Protocol::Constants::SCHEMA_CHANGE_TARGET_FUNCTION \
-              || target == Protocol::Constants::SCHEMA_CHANGE_TARGET_AGGREGATE
+          || target == Protocol::Constants::SCHEMA_CHANGE_TARGET_AGGREGATE
                 arguments = buffer.read_string_list
               end
 
@@ -318,14 +420,16 @@ module Cassandra
             when 'TOPOLOGY_CHANGE'
               TopologyChangeEventResponse.new(buffer.read_string, *buffer.read_inet)
             else
-              raise Errors::DecodingError, "Unsupported event type: #{event_type.inspect}"
+              raise Errors::DecodingError,
+                    "Unsupported event type: #{event_type.inspect}"
             end
           when 0x0E # AUTH_CHALLENGE
             AuthChallengeResponse.new(buffer.read_bytes)
           when 0x10 # AUTH_SUCCESS
             AuthSuccessResponse.new(buffer.read_bytes)
           else
-            raise Errors::DecodingError, "Unsupported response opcode: #{opcode.inspect}"
+            raise Errors::DecodingError,
+                  "Unsupported response opcode: #{opcode.inspect}"
           end
         end
       end

data/lib/cassandra/reconnection.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/cassandra/reconnection/policies.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/cassandra/reconnection/policies/constant.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -39,9 +39,7 @@ module Cassandra
 
         # @return [Cassandra::Reconnection::Schedule] reconnection schedule
         #   with constant interval
-        def schedule
-          @schedule
-        end
+        attr_reader :schedule
       end
     end
   end

data/lib/cassandra/reconnection/policies/exponential.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -39,11 +39,11 @@ module Cassandra
           def backoff
             new_interval = @interval * @exponent
 
-            if new_interval >= @max
-              @interval = @max
-            else
-              @interval = new_interval
-            end
+            @interval = if new_interval >= @max
+                          @max
+                        else
+                          new_interval
+                        end
           end
         end
 

data/lib/cassandra/result.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,7 +23,17 @@ module Cassandra
     # Query execution information, such as number of retries and all tried hosts, etc.
     # @return [Cassandra::Execution::Info]
     def execution_info
-      @info ||= Execution::Info.new(@payload, @warnings, @keyspace, @statement, @options, @hosts, @consistency, @retries, @trace_id ? Execution::Trace.new(@trace_id, @client) : nil)
+      @info ||= Execution::Info.new(@payload,
+                                    @warnings,
+                                    @keyspace,
+                                    @statement,
+                                    @options,
+                                    @hosts,
+                                    @consistency,
+                                    @retries,
+                                    @trace_id ?
+                                        Execution::Trace.new(@trace_id, @client) :
+                                        nil)
     end
 
     # @return [Boolean] whether it has any rows
@@ -33,14 +43,14 @@ module Cassandra
     # @return [Integer] rows count
     def size
     end
-    alias :length :size
+    alias length size
 
     # @yieldparam row [Hash] current row
     # @return [Enumerator, self] returns Enumerator if no block given
     def each
     end
-    alias :rows :each
-    alias :each_row :each
+    alias rows each
+    alias each_row each
 
     # @return [Boolean] whether no more pages are available
     def last_page?
@@ -78,10 +88,10 @@ module Cassandra
     # @return [String, nil] current paging state as a `String` or `nil`.
     #
     # @note Although this feature exists to allow web applications to store
-    #   paging state in an [HTTP cookie](http://en.wikipedia.org/wiki/HTTP_cookie), **it is not safe to
-    #   expose without encrypting or otherwise securing it**. Paging state
-    #   contains information internal to the Apache Cassandra cluster, such as
-    #   partition key and data. Additionally, if a paging state is sent with CQL
+    #   paging state in an [HTTP cookie](http://en.wikipedia.org/wiki/HTTP_cookie),
+    #   **it is not safe to expose without encrypting or otherwise securing it**.
+    #   Paging state contains information internal to the Apache Cassandra cluster,
+    #   such as partition key and data. Additionally, if a paging state is sent with CQL
     #   statement, different from the original, the behavior of Cassandra is
     #   undefined and will likely cause a server process of the coordinator of
     #   such request to abort.
@@ -96,7 +106,19 @@ module Cassandra
     class Paged < Result
       attr_reader :paging_state
 
-      def initialize(payload, warnings, rows, paging_state, trace_id, keyspace, statement, options, hosts, consistency, retries, client, futures_factory)
+      def initialize(payload,
+                     warnings,
+                     rows,
+                     paging_state,
+                     trace_id,
+                     keyspace,
+                     statement,
+                     options,
+                     hosts,
+                     consistency,
+                     retries,
+                     client,
+                     futures_factory)
         @payload        = payload
         @warnings       = warnings
         @rows           = rows
@@ -121,7 +143,7 @@ module Cassandra
       def size
         @rows.size
       end
-      alias :length :size
+      alias length size
 
       def each(&block)
         if block_given?
@@ -131,8 +153,8 @@ module Cassandra
           @rows.each
         end
       end
-      alias :rows :each
-      alias :each_row :each
+      alias rows each
+      alias each_row each
 
       # Returns true when there are no more pages to load.
       def last_page?
@@ -160,12 +182,24 @@ module Cassandra
 
       # @private
       def inspect
-        "#<Cassandra::Result:0x#{self.object_id.to_s(16)} @rows=#{@rows.inspect} @last_page=#{@paging_state.nil?}>"
+        "#<Cassandra::Result:0x#{object_id.to_s(16)} " \
+            "@rows=#{@rows.inspect} " \
+            "@last_page=#{@paging_state.nil?}>"
       end
     end
 
     class Void < Result
-      def initialize(payload, warnings, trace_id, keyspace, statement, options, hosts, consistency, retries, client, futures_factory)
+      def initialize(payload,
+                     warnings,
+                     trace_id,
+                     keyspace,
+                     statement,
+                     options,
+                     hosts,
+                     consistency,
+                     retries,
+                     client,
+                     futures_factory)
         @payload     = payload
         @warnings    = warnings
         @trace_id    = trace_id
@@ -188,7 +222,7 @@ module Cassandra
       def size
         0
       end
-      alias :length :size
+      alias length size
 
       # Iterates over each row in the result set.
       #
@@ -202,8 +236,8 @@ module Cassandra
           EMPTY_LIST.each
         end
       end
-      alias :rows :each
-      alias :each_row :each
+      alias rows each
+      alias each_row each
 
       # Returns true when there are no more pages to load.
       #
@@ -234,7 +268,7 @@ module Cassandra
       end
 
       def inspect
-        "#<Cassandra::Result:0x#{self.object_id.to_s(16)} @rows=[] @last_page=true>"
+        "#<Cassandra::Result:0x#{object_id.to_s(16)} @rows=[] @last_page=true>"
       end
     end
   end