thrift 0.22.0 → 0.24.0

data/lib/thrift/uuid.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+#
+# 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
+# regarding copyright ownership. The ASF licenses this file
+# 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 'thrift/protocol/base_protocol'
+
+module Thrift
+  module UUID
+    UUID_REGEX = /\A[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\z/.freeze
+
+    def self.validate_uuid!(uuid)
+      unless uuid.is_a?(String)
+        raise ProtocolException.new(ProtocolException::INVALID_DATA, 'UUID must be a string')
+      end
+
+      unless uuid =~ UUID_REGEX
+        raise ProtocolException.new(ProtocolException::INVALID_DATA, 'Invalid UUID format')
+      end
+    end
+
+    def self.uuid_bytes(uuid)
+      [uuid.delete('-')].pack('H*')
+    end
+
+    def self.uuid_from_bytes(bytes)
+      unless bytes.bytesize == 16
+        raise ProtocolException.new(ProtocolException::INVALID_DATA, 'Invalid UUID data length')
+      end
+
+      hex = bytes.unpack('H*').first
+      "#{hex[0, 8]}-#{hex[8, 4]}-#{hex[12, 4]}-#{hex[16, 4]}-#{hex[20, 12]}"
+    end
+  end
+end

data/lib/thrift.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -23,7 +24,6 @@
 $:.unshift File.dirname(__FILE__)
 
 require 'thrift/bytes'
-require 'thrift/core_ext'
 require 'thrift/exceptions'
 require 'thrift/types'
 require 'thrift/processor'
@@ -32,6 +32,7 @@ require 'thrift/client'
 require 'thrift/struct'
 require 'thrift/union'
 require 'thrift/struct_union'
+require 'thrift/uuid'
 
 # serializer
 require 'thrift/serializer/serializer'
@@ -44,6 +45,7 @@ require 'thrift/protocol/binary_protocol_accelerated'
 require 'thrift/protocol/compact_protocol'
 require 'thrift/protocol/json_protocol'
 require 'thrift/protocol/multiplexed_protocol'
+require 'thrift/protocol/header_protocol'
 
 # transport
 require 'thrift/transport/base_transport'
@@ -56,6 +58,7 @@ require 'thrift/transport/unix_socket'
 require 'thrift/transport/unix_server_socket'
 require 'thrift/transport/buffered_transport'
 require 'thrift/transport/framed_transport'
+require 'thrift/transport/header_transport'
 require 'thrift/transport/http_client_transport'
 require 'thrift/transport/io_stream_transport'
 require 'thrift/transport/memory_buffer_transport'

data/spec/ThriftSpec.thrift

@@ -60,6 +60,7 @@ union TestUnion {
   3: i32 other_i32_field;
   4: SomeEnum enum_field;
   5: binary binary_field;
+  6: uuid uuid_field;
 }
 
 struct Foo {
@@ -71,6 +72,7 @@ struct Foo {
   6: set<i16> shorts = [5, 17, 239],
   7: optional string opt_string
   8: bool my_bool
+  9: optional uuid opt_uuid
 }
 
 struct Foo2 {
@@ -92,7 +94,8 @@ struct SimpleList {
   8: list<map<i16, i16>> maps,
   9: list<list<i16>> lists,
   10: list<set<i16>> sets,
-  11: list<Hello> hellos
+  11: list<Hello> hellos,
+  12: list<uuid> uuids
 }
 
 exception Xception {
@@ -119,6 +122,7 @@ union My_union {
   8: i32 other_i32
   9: SomeEnum some_enum;
   10: map<SomeEnum, list<SomeEnum>> my_map;
+  11: uuid unique_id;
 }
 
 struct Struct_with_union {
@@ -181,3 +185,19 @@ struct NestedMapInMapKey {
 struct NestedMapInMapValue {
   2: map<byte, map<byte, byte>> value
 }
+
+# Recursive types for the struct/union/exception recursion-depth limit specs (THRIFT-6045).
+struct RecTree {
+  1: list<RecTree> children
+  2: i16 item
+}
+
+union RecUnion {
+  1: list<RecUnion> children
+  2: i32 leaf
+}
+
+exception RecError {
+  1: list<RecError> children
+  2: i32 leaf
+}

data/spec/base_protocol_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -20,7 +21,6 @@
 require 'spec_helper'
 
 describe 'BaseProtocol' do
-
   before(:each) do
     @trans = double("MockTransport")
     @prot = Thrift::BaseProtocol.new(@trans)
@@ -210,12 +210,31 @@ describe 'BaseProtocol' do
       expect(@prot).to receive(:read_list_end)
       real_skip.call(Thrift::Types::LIST)
     end
+
+    it "should raise DEPTH_LIMIT when max_depth is exhausted" do
+      expect { @prot.skip(Thrift::Types::STRUCT, 0) }.to raise_error(Thrift::ProtocolException) do |e|
+        expect(e.type).to eq(Thrift::ProtocolException::DEPTH_LIMIT)
+      end
+    end
+
+    it "should skip at max_depth=1 without raising" do
+      expect(@prot).to receive(:read_bool).once
+      expect { @prot.skip(Thrift::Types::BOOL, 1) }.not_to raise_error
+    end
+
+    it "should reject negative container sizes while skipping" do
+      expect(@prot).to receive(:read_list_begin).and_return([Thrift::Types::I32, -1])
+
+      expect { @prot.skip(Thrift::Types::LIST) }.to raise_error(Thrift::ProtocolException, "Negative size") do |e|
+        expect(e.type).to eq(Thrift::ProtocolException::NEGATIVE_SIZE)
+      end
+    end
   end
 
   describe Thrift::BaseProtocolFactory do
     it "should raise NotImplementedError" do
       # returning nil since Protocol is just an abstract class
-      expect {Thrift::BaseProtocolFactory.new.get_protocol(double("MockTransport"))}.to raise_error(NotImplementedError)
+      expect { Thrift::BaseProtocolFactory.new.get_protocol(double("MockTransport")) }.to raise_error(NotImplementedError)
     end
 
     it "should provide a reasonable to_s" do

data/spec/base_transport_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -20,7 +21,6 @@
 require 'spec_helper'
 
 describe 'BaseTransport' do
-
   describe Thrift::TransportException do
     it "should make type accessible" do
       exc = Thrift::TransportException.new(Thrift::TransportException::ALREADY_OPEN, "msg")
@@ -38,6 +38,25 @@ describe 'BaseTransport' do
       expect(transport.read_all(40)).to eq("10 lettersfifteen lettersmore characters")
     end
 
+    it "should coerce reads to binary encoding" do
+      transport = Thrift::BaseTransport.new
+      expect(transport).to receive(:read).with(3).and_return(+'abc')
+
+      buf = transport.read_all(3)
+
+      expect(buf).to eq('abc')
+      expect(buf.encoding).to eq(Encoding::BINARY)
+    end
+
+    it "should reject negative read sizes" do
+      transport = Thrift::BaseTransport.new
+      expect(transport).not_to receive(:read)
+
+      expect { transport.read_all(-1) }.to raise_error(Thrift::TransportException, "Negative size") do |e|
+        expect(e.type).to eq(Thrift::TransportException::NEGATIVE_SIZE)
+      end
+    end
+
     it "should stub out the rest of the methods" do
       # can't test for stubbiness, so just make sure they're defined
       [:open?, :open, :close, :read, :write, :flush].each do |sym|
@@ -48,7 +67,7 @@ describe 'BaseTransport' do
     it "should alias << to write" do
       expect(Thrift::BaseTransport.instance_method(:<<)).to eq(Thrift::BaseTransport.instance_method(:write))
     end
-    
+
     it "should provide a reasonable to_s" do
       expect(Thrift::BaseTransport.new.to_s).to eq("base")
     end
@@ -67,7 +86,7 @@ describe 'BaseTransport' do
       transport = double("Transport")
       expect(Thrift::BaseTransportFactory.new.get_transport(transport)).to eql(transport)
     end
-    
+
     it "should provide a reasonable to_s" do
       expect(Thrift::BaseTransportFactory.new.to_s).to eq("base")
     end
@@ -149,7 +168,7 @@ describe 'BaseTransport' do
       expect(Thrift::BufferedTransport).to receive(:new).with(trans).and_return(btrans)
       expect(Thrift::BufferedTransportFactory.new.get_transport(trans)).to eq(btrans)
     end
-    
+
     it "should provide a reasonable to_s" do
       expect(Thrift::BufferedTransportFactory.new.to_s).to eq("buffered")
     end
@@ -271,7 +290,7 @@ describe 'BaseTransport' do
       expect(Thrift::FramedTransport).to receive(:new).with(trans)
       Thrift::FramedTransportFactory.new.get_transport(trans)
     end
-    
+
     it "should provide a reasonable to_s" do
       expect(Thrift::FramedTransportFactory.new.to_s).to eq("framed")
     end
@@ -287,7 +306,7 @@ describe 'BaseTransport' do
     end
 
     it "should accept a buffer on input and use it directly" do
-      s = "this is a test"
+      s = +"this is a test"
       @buffer = Thrift::MemoryBufferTransport.new(s)
       expect(@buffer.read(4)).to eq("this")
       s.slice!(-4..-1)
@@ -339,12 +358,33 @@ describe 'BaseTransport' do
       expect(@buffer.read(@buffer.available)).to eq("foo bar")
     end
 
+    it "should force mutable write buffers into binary in place" do
+      s = "abc \u20AC".encode("UTF-8")
+      @buffer.write(s)
+      expect(s.encoding).to eq(Encoding::BINARY)
+      expect(@buffer.read(@buffer.available)).to eq("abc \u20AC".encode("UTF-8").b)
+    end
+
+    it "should not mutate frozen write buffers while forcing binary encoding" do
+      s = "abc \u20AC".encode("UTF-8").freeze
+      @buffer.write(s)
+      expect(s.encoding).to eq(Encoding::UTF_8)
+      expect(s).to be_frozen
+      expect(@buffer.read(@buffer.available)).to eq("abc \u20AC".encode("UTF-8").b)
+    end
+
     it "should throw an EOFError when there isn't enough data in the buffer" do
       @buffer.reset_buffer("")
-      expect{@buffer.read(1)}.to raise_error(EOFError)
+      expect{ @buffer.read(1) }.to raise_error(EOFError)
 
       @buffer.reset_buffer("1234")
-      expect{@buffer.read(5)}.to raise_error(EOFError)
+      expect{ @buffer.read(5) }.to raise_error(EOFError)
+    end
+
+    it "should reject negative read_all sizes" do
+      expect { @buffer.read_all(-1) }.to raise_error(Thrift::TransportException, "Negative size") do |e|
+        expect(e.type).to eq(Thrift::TransportException::NEGATIVE_SIZE)
+      end
     end
   end
 

data/spec/binary_protocol_accelerated_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file

data/spec/binary_protocol_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements. See the NOTICE file
@@ -21,7 +22,6 @@ require 'spec_helper'
 require File.expand_path("#{File.dirname(__FILE__)}/binary_protocol_spec_shared")
 
 describe 'BinaryProtocol' do
-
   it_should_behave_like 'a binary protocol'
 
   def protocol_class
@@ -29,7 +29,6 @@ describe 'BinaryProtocol' do
   end
 
   describe Thrift::BinaryProtocol do
-
     before(:each) do
       @trans = Thrift::MemoryBufferTransport.new
       @prot = protocol_class.new(@trans)