jls-lumberjack 0.0.20 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 257e7277d9d370246671e1a117e9102674386177
-  data.tar.gz: be48c31b83ccecc610c152a1c928f8040dd3a1dd
+  metadata.gz: 9a5fbaaf0c05070435f5ce9299ef8b4d67309f0a
+  data.tar.gz: 8b382ea94f4dc405580cad2477c3209a59c6b95e
 SHA512:
-  metadata.gz: 998a1720267a70608f3061a661624d420875e66bef41eba4193047815319023da6de7365d0b934ee1983f96c4ee8e28e6730af77e687ab5dd5accca2294141f9
-  data.tar.gz: 698db79fc9618f656d4767baa2bbbf058268d768744e9d38d75841acca8af4b6fcad9908221c63fff589289516ea77387822b3438346487428d932df70079874
+  metadata.gz: d05766693143ceb79ab82872c82acd904d9004e73fcefa769393c623d029e0731f7153522ade00709cde4b475a9a0c8d667e5a39cd51e9dc514053864cfb5ede
+  data.tar.gz: eca095412e36b14c8a6a71f4bf1961ddfbf849f34b1ddadbc9e283427205a1566743d047ded06bb288461d24b70471441fa6039905a75bb73df85cb6a21e23d0

data/lib/lumberjack/client.rb

@@ -4,8 +4,8 @@ require "openssl"
 require "zlib"
 
 module Lumberjack
-  
-  SEQUENCE_MAX = (2**(0.size * 8 -2) -1)
+
+  SEQUENCE_MAX = (2**32-1).freeze
 
   class Client
     def initialize(opts={})
@@ -73,44 +73,64 @@ module Lumberjack
       @host = @opts[:address]
       @window_size = @opts[:window_size]
 
-      tcp_socket = TCPSocket.new(@opts[:address], @opts[:port])
-      openssl_cert = OpenSSL::X509::Certificate.new(File.read(@opts[:ssl_certificate]))
+      connection_start(opts)
+    end
+
+    private
+    def connection_start(opts)
+      tcp_socket = TCPSocket.new(opts[:address], opts[:port])
       @socket = OpenSSL::SSL::SSLSocket.new(tcp_socket)
       @socket.connect
-
-      #if @socket.peer_cert.to_s != openssl_cert.to_s
-      #  raise "Client and server certificates do not match."
-      #end
-
       @socket.syswrite(["1", "W", @window_size].pack("AAN"))
     end
 
     private 
     def inc
-      @sequence = 0 if @sequence+1 > Lumberjack::SEQUENCE_MAX
-      @sequence += 1
+      @sequence = 0 if @sequence + 1 > Lumberjack::SEQUENCE_MAX
+      @sequence = @sequence + 1
     end
 
     private
     def write(msg)
       compress = Zlib::Deflate.deflate(msg)
-      @socket.syswrite(["1","C",compress.length,compress].pack("AANA#{compress.length}"))
+      payload = ["1","C",compress.length,compress].pack("AANA#{compress.length}")
+      # SSLSocket has a limit of 16k per message
+      # execute multiple writes if needed
+      bytes_written = 0
+      while bytes_written < payload.bytesize
+        bytes_written += @socket.syswrite(payload.byteslice(bytes_written..-1))
+      end
     end
 
     public
     def write_hash(hash)
-      frame = to_frame(hash, inc)
-      ack if (@sequence - (@last_ack + 1)) >= @window_size
+      frame = Encoder.to_compressed_frame(hash, inc)
+      ack if unacked_sequence_size >= @window_size
       write frame
     end
 
     private
     def ack
-      version = @socket.read(1)
-      type = @socket.read(1)
+      _, type = read_version_and_type
       raise "Whoa we shouldn't get this frame: #{type}" if type != "A"
-      @last_ack = @socket.read(4).unpack("N").first
-      ack if (@sequence - (@last_ack + 1)) >= @window_size
+      @last_ack = read_last_ack
+      ack if unacked_sequence_size >= @window_size
+    end
+
+    private
+    def unacked_sequence_size
+      sequence - (@last_ack + 1)
+    end
+
+    private
+    def read_version_and_type
+      version = @socket.read(1)
+      type    = @socket.read(1)
+      [version, type]
+    end
+    private
+    def read_last_ack
+      @socket.read(4).unpack("N").first
     end
 
     private
@@ -122,8 +142,8 @@ module Lumberjack
       pack << "N"
       keys.each do |k|
         val = deep_get(hash,k)
-        key_length = k.length
-        val_length = val.length
+        key_length = k.bytesize
+        val_length = val.bytesize
         frame << key_length
         pack << "N"
         frame << k
@@ -155,4 +175,51 @@ module Lumberjack
       keys.flatten
     end
   end
+
+  module Encoder
+    def self.to_compressed_frame(hash, sequence)
+      compress = Zlib::Deflate.deflate(to_frame(hash, sequence))
+      ["1", "C", compress.bytesize, compress].pack("AANA#{compress.length}")
+    end
+
+    def self.to_frame(hash, sequence)
+      frame = ["1", "D", sequence]
+      pack = "AAN"
+      keys = deep_keys(hash)
+      frame << keys.length
+      pack << "N"
+      keys.each do |k|
+        val = deep_get(hash,k)
+        key_length = k.bytesize
+        val_length = val.bytesize
+        frame << key_length
+        pack << "N"
+        frame << k
+        pack << "A#{key_length}"
+        frame << val_length
+        pack << "N"
+        frame << val
+        pack << "A#{val_length}"
+      end
+      frame.pack(pack)
+    end
+
+    private
+    def self.deep_get(hash, key="")
+      return hash if key.nil?
+      deep_get(
+        hash[key.split('.').first],
+        key[key.split('.').first.length+1..key.length]
+      )
+    end
+    private
+    def self.deep_keys(hash, prefix="")
+      keys = []
+      hash.each do |k,v|
+        keys << "#{prefix}#{k}" if v.class == String
+        keys << deep_keys(hash[k], "#{k}.") if v.class == Hash
+      end
+      keys.flatten
+    end
+  end # module Encoder
 end

data/lib/lumberjack/server.rb

@@ -22,7 +22,7 @@ module Lumberjack
         :address => "0.0.0.0",
         :ssl_certificate => nil,
         :ssl_key => nil,
-        :ssl_key_passphrase => nil,
+        :ssl_key_passphrase => nil
       }.merge(options)
 
       [:ssl_certificate, :ssl_key].each do |k|
@@ -31,7 +31,8 @@ module Lumberjack
         end
       end
 
-      @tcp_server = TCPServer.new(@options[:port])
+      @tcp_server = TCPServer.new(@options[:address], @options[:port])
+
       # Query the port in case the port number is '0'
       # TCPServer#addr == [ address_family, port, address, address ]
       @port = @tcp_server.addr[1]
@@ -44,22 +45,26 @@ module Lumberjack
 
     def run(&block)
       while true
-        # NOTE: This means ssl accepting is single-threaded.
-        begin
-          client = @ssl_server.accept
-        rescue EOFError, OpenSSL::SSL::SSLError, IOError
-          # ssl handshake failure or other issue, skip it.
-          # TODO(sissel): log the error
-          # TODO(sissel): try to identify what client was connecting that failed.
-          client.close rescue nil
-          next
-        end
-
-        Thread.new(client) do |fd|
-          Connection.new(fd).run(&block)
+        connection = accept
+        Thread.new(connection) do |connection|
+          connection.run(&block)
         end
       end
     end # def run
+
+    def accept(&block)
+      begin
+        fd = @ssl_server.accept
+      rescue EOFError, OpenSSL::SSL::SSLError, IOError
+        # ssl handshake or other accept-related failure.
+        # TODO(sissel): Make it possible to log this.
+      end
+      if block_given?
+        block.call(fd)
+      else
+        Connection.new(fd)
+      end
+    end
   end # class Server
 
   class Parser
@@ -92,16 +97,16 @@ module Lumberjack
       while have?(@need)
         send(@state, &block) 
         #case @state
-          #when :header; header(&block)
-          #when :window_size; window_size(&block)
-          #when :data_lead; data_lead(&block)
-          #when :data_field_key_len; data_field_key_len(&block)
-          #when :data_field_key; data_field_key(&block)
-          #when :data_field_value_len; data_field_value_len(&block)
-          #when :data_field_value; data_field_value(&block)
-          #when :data_field_value; data_field_value(&block)
-          #when :compressed_lead; compressed_lead(&block)
-          #when :compressed_payload; compressed_payload(&block)
+        #when :header; header(&block)
+        #when :window_size; window_size(&block)
+        #when :data_lead; data_lead(&block)
+        #when :data_field_key_len; data_field_key_len(&block)
+        #when :data_field_key; data_field_key(&block)
+        #when :data_field_value_len; data_field_value_len(&block)
+        #when :data_field_value; data_field_value(&block)
+        #when :data_field_value; data_field_value(&block)
+        #when :compressed_lead; compressed_lead(&block)
+        #when :compressed_payload; compressed_payload(&block)
         #end # case @state
       end
       return nil
@@ -136,10 +141,10 @@ module Lumberjack
       version, frame_type = get.bytes.to_a[0..1]
 
       case frame_type
-        when FRAME_WINDOW; transition(:window_size, 4)
-        when FRAME_DATA; transition(:data_lead, 8)
-        when FRAME_COMPRESSED; transition(:compressed_lead, 4)
-        else; raise "Unknown frame type: #{frame_type}"
+      when FRAME_WINDOW; transition(:window_size, 4)
+      when FRAME_DATA; transition(:data_lead, 8)
+      when FRAME_COMPRESSED; transition(:compressed_lead, 4)
+      else; raise "Unknown frame type: #{frame_type}"
       end
     end
 
@@ -189,7 +194,7 @@ module Lumberjack
       length = get.unpack("N").first
       transition(:compressed_payload, length)
     end
-    
+
     def compressed_payload(&block)
       original = Zlib::Inflate.inflate(get)
       transition(:header, 2)
@@ -219,8 +224,8 @@ module Lumberjack
         # X: too many events after errors.
         @parser.feed(@fd.sysread(16384)) do |event, *args|
           case event
-            when :window_size; window_size(*args, &block)
-            when :data; data(*args, &block)
+          when :window_size; window_size(*args, &block)
+          when :data; data(*args, &block)
           end
           #send(event, *args)
         end # feed
@@ -229,16 +234,19 @@ module Lumberjack
       # EOF or other read errors, only action is to shutdown which we'll do in
       # 'ensure'
     ensure
-      # Try to ensure it's closed, but if this fails I don't care.
-      @fd.close rescue nil
+      close rescue 'Already closed stream'
     end # def run
 
+    def close
+      @fd.close
+    end
+
     def window_size(size)
       @window_size = size
     end
 
     def data(sequence, map, &block)
-      block.call(map)
+      block.call(map) if block_given?
       if (sequence - @last_ack) >= @window_size
         @fd.syswrite(["1A", sequence].pack("A*N"))
         @last_ack = sequence

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jls-lumberjack
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - Jordan Sissel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2015-02-27 00:00:00.000000000 Z
 dependencies: []
 description: lumberjack log transport library
 email:
@@ -17,11 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/lumberjack/server.rb
 - lib/lumberjack/client.rb
+- lib/lumberjack/server.rb
 homepage: https://github.com/jordansissel/lumberjack
-licenses:
-- Apache 2.0
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -29,17 +28,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: lumberjack log transport library