thrift 0.22.0 → 0.23.0

data/ext/struct.c

@@ -20,6 +20,7 @@
 #include "struct.h"
 #include "constants.h"
 #include "macros.h"
+#include "protocol.h"
 #include "strlcpy.h"
 
 VALUE thrift_union_class;
@@ -34,6 +35,19 @@ static ID sorted_field_ids_method_id;
 #define IS_CONTAINER(ttype) ((ttype) == TTYPE_MAP || (ttype) == TTYPE_LIST || (ttype) == TTYPE_SET)
 #define STRUCT_FIELDS(obj) rb_const_get(CLASS_OF(obj), fields_const_id)
 
+static VALUE new_container_array(int size) {
+  if (size < 0) {
+    rb_exc_raise(
+      get_protocol_exception(
+        INT2FIX(PROTOERR_NEGATIVE_SIZE),
+        rb_str_new2("Negative container size")
+      )
+    );
+  }
+
+  return rb_ary_new2(size > 1024 ? 1024 : size);
+}
+
 //-------------------------------------------
 // Writing section
 //-------------------------------------------
@@ -75,6 +89,11 @@ VALUE default_write_string(VALUE protocol, VALUE value) {
   return Qnil;
 }
 
+VALUE default_write_uuid(VALUE protocol, VALUE value) {
+  rb_funcall(protocol, write_uuid_method_id, 1, value);
+  return Qnil;
+}
+
 VALUE default_write_binary(VALUE protocol, VALUE value) {
   rb_funcall(protocol, write_binary_method_id, 1, value);
   return Qnil;
@@ -195,6 +214,10 @@ VALUE default_read_string(VALUE protocol) {
   return rb_funcall(protocol, read_string_method_id, 0);
 }
 
+VALUE default_read_uuid(VALUE protocol) {
+  return rb_funcall(protocol, read_uuid_method_id, 0);
+}
+
 VALUE default_read_binary(VALUE protocol) {
   return rb_funcall(protocol, read_binary_method_id, 0);
 }
@@ -342,6 +365,8 @@ static void write_anything(int ttype, VALUE value, VALUE protocol, VALUE field_i
     } else {
       default_write_binary(protocol, value);
     }
+  } else if (ttype == TTYPE_UUID) {
+    default_write_uuid(protocol, value);
   } else if (IS_CONTAINER(ttype)) {
     write_container(ttype, field_info, value, protocol);
   } else if (ttype == TTYPE_STRUCT) {
@@ -452,6 +477,8 @@ static VALUE read_anything(VALUE protocol, int ttype, VALUE field_info) {
     }
   } else if (ttype == TTYPE_DOUBLE) {
     result = default_read_double(protocol);
+  } else if (ttype == TTYPE_UUID) {
+    result = default_read_uuid(protocol);
   } else if (ttype == TTYPE_STRUCT) {
     VALUE klass = rb_hash_aref(field_info, class_sym);
     result = rb_class_new_instance(0, NULL, klass);
@@ -469,6 +496,10 @@ static VALUE read_anything(VALUE protocol, int ttype, VALUE field_info) {
     int value_ttype = FIX2INT(rb_ary_entry(map_header, 1));
     int num_entries = FIX2INT(rb_ary_entry(map_header, 2));
 
+    if (num_entries < 0) {
+      rb_exc_raise(get_protocol_exception(INT2FIX(PROTOERR_NEGATIVE_SIZE), rb_str_new2("Negative container size")));
+    }
+
     // Check the declared key and value types against the expected ones and skip the map contents
     // if the types don't match.
     VALUE key_info = rb_hash_aref(field_info, key_sym);
@@ -509,7 +540,7 @@ static VALUE read_anything(VALUE protocol, int ttype, VALUE field_info) {
     if (!NIL_P(element_info)) {
       int specified_element_type = FIX2INT(rb_hash_aref(element_info, type_sym));
       if (specified_element_type == element_ttype) {
-        result = rb_ary_new2(num_elements);
+        result = new_container_array(num_elements);
 
         for (i = 0; i < num_elements; ++i) {
           rb_ary_push(result, read_anything(protocol, element_ttype, rb_hash_aref(field_info, element_sym)));
@@ -536,7 +567,7 @@ static VALUE read_anything(VALUE protocol, int ttype, VALUE field_info) {
     if (!NIL_P(element_info)) {
       int specified_element_type = FIX2INT(rb_hash_aref(element_info, type_sym));
       if (specified_element_type == element_ttype) {
-        items = rb_ary_new2(num_elements);
+        items = new_container_array(num_elements);
 
         for (i = 0; i < num_elements; ++i) {
           rb_ary_push(items, read_anything(protocol, element_ttype, rb_hash_aref(field_info, element_sym)));
@@ -643,7 +674,7 @@ static VALUE rb_thrift_union_read(VALUE self, VALUE protocol) {
   field_type = FIX2INT(field_type_value);
 
   if (field_type != TTYPE_STOP) {
-    rb_raise(rb_eRuntimeError, "too many fields in union!");
+    rb_exc_raise(get_protocol_exception(INT2FIX(PROTOERR_INVALID_DATA), rb_str_new2("too many fields in union!")));
   }
 
   // read struct end
@@ -671,7 +702,7 @@ static VALUE rb_thrift_union_write(VALUE self, VALUE protocol) {
   VALUE field_info = rb_hash_aref(struct_fields, field_id);
 
   if(NIL_P(field_info)) {
-    rb_raise(rb_eRuntimeError, "set_field is not valid for this union!");
+    rb_exc_raise(get_protocol_exception(INT2FIX(PROTOERR_INVALID_DATA), rb_str_new2("set_field is not valid for this union!")));
   }
 
   VALUE ttype_value = rb_hash_aref(field_info, type_sym);
@@ -691,7 +722,7 @@ static VALUE rb_thrift_union_write(VALUE self, VALUE protocol) {
   return Qnil;
 }
 
-void Init_struct() {
+void Init_struct(void) {
   VALUE struct_module = rb_const_get(thrift_module, rb_intern("Struct"));
 
   rb_define_method(struct_module, "write", rb_thrift_struct_write, 1);

data/ext/thrift_native.c

@@ -43,6 +43,7 @@ int TTYPE_MAP;
 int TTYPE_SET;
 int TTYPE_LIST;
 int TTYPE_STRUCT;
+int TTYPE_UUID;
 
 // method ids
 ID validate_method_id;
@@ -57,6 +58,7 @@ ID write_i32_method_id;
 ID write_i64_method_id;
 ID write_double_method_id;
 ID write_string_method_id;
+ID write_uuid_method_id;
 ID write_binary_method_id;
 ID write_map_begin_method_id;
 ID write_map_end_method_id;
@@ -70,6 +72,7 @@ ID read_i16_method_id;
 ID read_i32_method_id;
 ID read_i64_method_id;
 ID read_string_method_id;
+ID read_uuid_method_id;
 ID read_binary_method_id;
 ID read_double_method_id;
 ID read_map_begin_method_id;
@@ -109,7 +112,16 @@ VALUE class_sym;
 VALUE binary_sym;
 VALUE protocol_exception_class;
 
-void Init_thrift_native() {
+// protocol errors
+int PROTOERR_UNKNOWN;
+int PROTOERR_INVALID_DATA;
+int PROTOERR_NEGATIVE_SIZE;
+int PROTOERR_SIZE_LIMIT;
+int PROTOERR_BAD_VERSION;
+int PROTOERR_NOT_IMPLEMENTED;
+int PROTOERR_DEPTH_LIMIT;
+
+RUBY_FUNC_EXPORTED void Init_thrift_native(void) {
   // cached classes
   thrift_module = rb_const_get(rb_cObject, rb_intern("Thrift"));
   rb_global_variable(&thrift_module);
@@ -138,6 +150,7 @@ void Init_thrift_native() {
   TTYPE_SET = FIX2INT(rb_const_get(thrift_types_module, rb_intern("SET")));
   TTYPE_LIST = FIX2INT(rb_const_get(thrift_types_module, rb_intern("LIST")));
   TTYPE_STRUCT = FIX2INT(rb_const_get(thrift_types_module, rb_intern("STRUCT")));
+  TTYPE_UUID = FIX2INT(rb_const_get(thrift_types_module, rb_intern("UUID")));
 
   // method ids
   validate_method_id = rb_intern("validate");
@@ -152,6 +165,7 @@ void Init_thrift_native() {
   write_i64_method_id = rb_intern("write_i64");
   write_double_method_id = rb_intern("write_double");
   write_string_method_id = rb_intern("write_string");
+  write_uuid_method_id = rb_intern("write_uuid");
   write_binary_method_id = rb_intern("write_binary");
   write_map_begin_method_id = rb_intern("write_map_begin");
   write_map_end_method_id = rb_intern("write_map_end");
@@ -165,10 +179,11 @@ void Init_thrift_native() {
   read_i32_method_id = rb_intern("read_i32");
   read_i64_method_id = rb_intern("read_i64");
   read_string_method_id = rb_intern("read_string");
+  read_uuid_method_id = rb_intern("read_uuid");
   read_binary_method_id = rb_intern("read_binary");
   read_double_method_id = rb_intern("read_double");
   read_map_begin_method_id = rb_intern("read_map_begin");
-  read_map_end_method_id = rb_intern("read_map_end");  
+  read_map_end_method_id = rb_intern("read_map_end");
   read_list_begin_method_id = rb_intern("read_list_begin");
   read_list_end_method_id = rb_intern("read_list_end");
   read_set_begin_method_id = rb_intern("read_set_begin");
@@ -192,7 +207,7 @@ void Init_thrift_native() {
   fields_const_id = rb_intern("FIELDS");
   transport_ivar_id = rb_intern("@trans");
   strict_read_ivar_id = rb_intern("@strict_read");
-  strict_write_ivar_id = rb_intern("@strict_write");  
+  strict_write_ivar_id = rb_intern("@strict_write");
 
   // cached symbols
   type_sym = ID2SYM(rb_intern("type"));
@@ -203,6 +218,15 @@ void Init_thrift_native() {
   class_sym = ID2SYM(rb_intern("class"));
   binary_sym = ID2SYM(rb_intern("binary"));
 
+  // protocol errors
+  PROTOERR_UNKNOWN = FIX2INT(rb_const_get(protocol_exception_class, rb_intern("UNKNOWN")));
+  PROTOERR_INVALID_DATA = FIX2INT(rb_const_get(protocol_exception_class, rb_intern("INVALID_DATA")));
+  PROTOERR_NEGATIVE_SIZE = FIX2INT(rb_const_get(protocol_exception_class, rb_intern("NEGATIVE_SIZE")));
+  PROTOERR_SIZE_LIMIT = FIX2INT(rb_const_get(protocol_exception_class, rb_intern("SIZE_LIMIT")));
+  PROTOERR_BAD_VERSION = FIX2INT(rb_const_get(protocol_exception_class, rb_intern("BAD_VERSION")));
+  PROTOERR_NOT_IMPLEMENTED = FIX2INT(rb_const_get(protocol_exception_class, rb_intern("NOT_IMPLEMENTED")));
+  PROTOERR_DEPTH_LIMIT = FIX2INT(rb_const_get(protocol_exception_class, rb_intern("DEPTH_LIMIT")));
+
   rb_global_variable(&type_sym);
   rb_global_variable(&name_sym);
   rb_global_variable(&key_sym);

data/lib/thrift/bytes.rb

@@ -1,5 +1,5 @@
 # encoding: ascii-8bit
-# 
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
 # distributed with this work for additional information
@@ -7,9 +7,9 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License. You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -21,111 +21,78 @@
 module Thrift
   # A collection of utilities for working with bytes and byte buffers.
   module Bytes
-    if RUBY_VERSION >= '1.9'
-      # Creates and empty byte buffer (String with BINARY encoding)
-      #
-      # size - The Integer size of the buffer (default: nil) to create
-      #
-      # Returns a String with BINARY encoding, filled with null characters 
-      # if size is greater than zero
-      def self.empty_byte_buffer(size = nil)
-        if (size && size > 0)
-          "\0".force_encoding(Encoding::BINARY) * size
-        else
-          ''.force_encoding(Encoding::BINARY)
-        end
-      end
-
-      # Forces the encoding of the buffer to BINARY. If the buffer
-      # passed is frozen, then it will be duplicated.
-      #
-      # buffer - The String to force the encoding of.
-      #
-      # Returns the String passed with an encoding of BINARY; returned
-      # String may be a duplicate.
-      def self.force_binary_encoding(buffer)
-        buffer = buffer.dup if buffer.frozen?
-        buffer.force_encoding(Encoding::BINARY)
-      end
-
-      # Gets the byte value of a given position in a String.
-      #
-      # string - The String to retrive the byte value from.
-      # index  - The Integer location of the byte value to retrieve.
-      #
-      # Returns an Integer value between 0 and 255.
-      def self.get_string_byte(string, index)
-        string.getbyte(index)
-      end
-
-      # Sets the byte value given to a given index in a String.
-      #
-      # string - The String to set the byte value in.
-      # index  - The Integer location to set the byte value at.
-      # byte   - The Integer value (0 to 255) to set in the string.
-      #
-      # Returns an Integer value of the byte value to set.
-      def self.set_string_byte(string, index, byte)
-        string.setbyte(index, byte)
-      end
-
-      # Converts the given String to a UTF-8 byte buffer.
-      #
-      # string - The String to convert.
-      #
-      # Returns a new String with BINARY encoding, containing the UTF-8
-      # bytes of the original string.
-      def self.convert_to_utf8_byte_buffer(string)
-        if string.encoding != Encoding::UTF_8
-          # transcode to UTF-8
-          string = string.encode(Encoding::UTF_8)
-        else
-          # encoding is already UTF-8, but a duplicate is needed
-          string = string.dup
-        end
-        string.force_encoding(Encoding::BINARY)
-      end
-
-      # Converts the given UTF-8 byte buffer into a String
-      #
-      # utf8_buffer - A String, with BINARY encoding, containing UTF-8 bytes
-      #
-      # Returns a new String with UTF-8 encoding,
-      def self.convert_to_string(utf8_buffer)
-        # duplicate the buffer, force encoding to UTF-8
-        utf8_buffer.dup.force_encoding(Encoding::UTF_8)
-      end
-    else
-      def self.empty_byte_buffer(size = nil)
-        if (size && size > 0)
-          "\0" * size
-        else
-          ''
-        end
+    # Creates and empty byte buffer (String with BINARY encoding)
+    #
+    # size - The Integer size of the buffer (default: nil) to create
+    #
+    # Returns a String with BINARY encoding, filled with null characters
+    # if size is greater than zero
+    def self.empty_byte_buffer(size = nil)
+      if (size && size > 0)
+        "\0".b * size
+      else
+        ''.b
       end
+    end
 
-      def self.force_binary_encoding(buffer)
-        buffer
-      end
+    # Forces the encoding of the buffer to BINARY. If the buffer
+    # passed is frozen, then it will be duplicated.
+    #
+    # buffer - The String to force the encoding of.
+    #
+    # Returns the String passed with an encoding of BINARY; returned
+    # String may be a duplicate.
+    def self.force_binary_encoding(buffer)
+      buffer = buffer.dup if buffer.frozen?
+      buffer.force_encoding(Encoding::BINARY)
+    end
 
-      def self.get_string_byte(string, index)
-        string[index]
-      end
+    # Gets the byte value of a given position in a String.
+    #
+    # string - The String to retrive the byte value from.
+    # index  - The Integer location of the byte value to retrieve.
+    #
+    # Returns an Integer value between 0 and 255.
+    def self.get_string_byte(string, index)
+      string.getbyte(index)
+    end
 
-      def self.set_string_byte(string, index, byte)
-        string[index] = byte
-      end
+    # Sets the byte value given to a given index in a String.
+    #
+    # string - The String to set the byte value in.
+    # index  - The Integer location to set the byte value at.
+    # byte   - The Integer value (0 to 255) to set in the string.
+    #
+    # Returns an Integer value of the byte value to set.
+    def self.set_string_byte(string, index, byte)
+      string.setbyte(index, byte)
+    end
 
-      def self.convert_to_utf8_byte_buffer(string)
-        # This assumes $KCODE is 'UTF8'/'U', which would mean the String is already a UTF-8 byte buffer
-        # TODO consider handling other $KCODE values and transcoding with iconv
-        string
+    # Converts the given String to a UTF-8 byte buffer.
+    #
+    # string - The String to convert.
+    #
+    # Returns a new String with BINARY encoding, containing the UTF-8
+    # bytes of the original string.
+    def self.convert_to_utf8_byte_buffer(string)
+      if string.encoding != Encoding::UTF_8
+        # transcode to UTF-8
+        string = string.encode(Encoding::UTF_8)
+      else
+        # encoding is already UTF-8, but a duplicate is needed
+        string = string.dup
       end
+      string.force_encoding(Encoding::BINARY)
+    end
 
-      def self.convert_to_string(utf8_buffer)
-        # See comment in 'convert_to_utf8_byte_buffer' for relevant assumptions.
-        utf8_buffer
-      end
+    # Converts the given UTF-8 byte buffer into a String
+    #
+    # utf8_buffer - A String, with BINARY encoding, containing UTF-8 bytes
+    #
+    # Returns a new String with UTF-8 encoding,
+    def self.convert_to_string(utf8_buffer)
+      # duplicate the buffer, force encoding to UTF-8
+      utf8_buffer.dup.force_encoding(Encoding::UTF_8)
     end
   end
 end

data/lib/thrift/client.rb

@@ -19,19 +19,25 @@
 
 module Thrift
   module Client
-    def initialize(iprot, oprot=nil)
+    MIN_SEQUENCE_ID = -(2**31)
+    MAX_SEQUENCE_ID = (2**31) - 1
+
+    def initialize(iprot, oprot = nil)
       @iprot = iprot
       @oprot = oprot || iprot
       @seqid = 0
+      @pending_seqids = []
     end
 
     def send_message(name, args_class, args = {})
-      @oprot.write_message_begin(name, MessageTypes::CALL, @seqid)
+      seqid = next_seqid!
+      @oprot.write_message_begin(name, MessageTypes::CALL, seqid)
       send_message_args(args_class, args)
+      @pending_seqids << seqid
     end
 
     def send_oneway_message(name, args_class, args = {})
-      @oprot.write_message_begin(name, MessageTypes::ONEWAY, @seqid)
+      @oprot.write_message_begin(name, MessageTypes::ONEWAY, next_seqid!)
       send_message_args(args_class, args)
     end
 
@@ -56,8 +62,37 @@ module Thrift
     end
 
     def reply_seqid(rseqid)
-     result = (rseqid==@seqid)?true:false
-     result
+      expected_seqid = dequeue_pending_seqid
+      !expected_seqid.nil? && rseqid == expected_seqid
+    end
+
+    def validate_message_begin(fname, mtype, rseqid, expected_name)
+      expected_seqid = dequeue_pending_seqid
+
+      if mtype == MessageTypes::EXCEPTION
+        raise_application_exception
+      end
+
+      if mtype != MessageTypes::REPLY
+        raise ApplicationException.new(
+          ApplicationException::INVALID_MESSAGE_TYPE,
+          "#{expected_name} failed: invalid message type"
+        )
+      end
+
+      if fname != expected_name
+        raise ApplicationException.new(
+          ApplicationException::WRONG_METHOD_NAME,
+          "#{expected_name} failed: wrong method name"
+        )
+      end
+
+      return if !expected_seqid.nil? && rseqid == expected_seqid
+
+      raise ApplicationException.new(
+        ApplicationException::BAD_SEQUENCE_ID,
+        "#{expected_name} failed: out of sequence response"
+      )
     end
 
     def receive_message(result_klass)
@@ -69,11 +104,28 @@ module Thrift
 
     def handle_exception(mtype)
       if mtype == MessageTypes::EXCEPTION
-        x = ApplicationException.new
-        x.read(@iprot)
-        @iprot.read_message_end
-        raise x
+        dequeue_pending_seqid
+        raise_application_exception
       end
     end
+
+    private
+
+    def next_seqid!
+      seqid = @seqid
+      @seqid = (seqid == MAX_SEQUENCE_ID) ? MIN_SEQUENCE_ID : seqid + 1
+      seqid
+    end
+
+    def dequeue_pending_seqid
+      @pending_seqids.shift
+    end
+
+    def raise_application_exception
+      x = ApplicationException.new
+      x.read(@iprot)
+      @iprot.read_message_end
+      raise x
+    end
   end
 end

data/lib/thrift/exceptions.rb

@@ -1,4 +1,4 @@
-# 
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
 # distributed with this work for additional information
@@ -6,16 +6,16 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License. You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-# 
+#
 
 module Thrift
   class Exception < StandardError
@@ -43,7 +43,7 @@ module Thrift
 
     attr_reader :type
 
-    def initialize(type=UNKNOWN, message=nil)
+    def initialize(type = UNKNOWN, message = nil)
       super(message)
       @type = type
     end

data/lib/thrift/multiplexed_processor.rb

@@ -1,4 +1,4 @@
-# 
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
 # distributed with this work for additional information
@@ -6,9 +6,9 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License. You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -24,11 +24,11 @@ module Thrift
     def initialize
       @actual_processors = {}
     end
- 
+
     def register_processor(service_name, processor)
       @actual_processors[service_name] = processor
     end
- 
+
     def process(iprot, oprot)
       name, type, seqid = iprot.read_message_begin
       check_type(type)
@@ -63,7 +63,7 @@ module Thrift
   class StoredMessageProtocol < BaseProtocol
 
     include ProtocolDecorator
-    
+
     def initialize(protocol, message_begin)
       super(protocol)
       @message_begin = message_begin

data/lib/thrift/processor.rb

@@ -1,4 +1,4 @@
-# 
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
 # distributed with this work for additional information
@@ -6,22 +6,22 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License. You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-# 
+#
 
 require 'logger'
 
 module Thrift
   module Processor
-    def initialize(handler, logger=nil)
+    def initialize(handler, logger = nil)
       @handler = handler
       if logger.nil?
         @logger = Logger.new(STDERR)
@@ -32,7 +32,7 @@ module Thrift
     end
 
     def process(iprot, oprot)
-      name, type, seqid  = iprot.read_message_begin
+      name, type, seqid = iprot.read_message_begin
       if respond_to?("process_#{name}")
         begin
           send("process_#{name}", seqid, iprot, oprot)