thrift-rack-middleware 0.1.0 → 0.2.0

data/README.md

@@ -2,7 +2,7 @@
 
 A simple rack middleware that can intercept HTTP thrift requests.
 
-This is useful when used in cobination with a pooled application server like passenger.
+This is useful when used in combination with a pooled application server like passenger.
 It is not an easy task to have thrift directly target worker processes that application servers like passenger manage.
 
 Accessing the handler applications via thrift this was may not be the fastest, but it is one of the easier ways to get started.
@@ -20,13 +20,14 @@ If you want to add this middleware to a Rails application, add the following to
 
 ### Defaults
 
-* `hook_path` defaults to `'/thrift_rpc'`
+* `hook_path` defaults to `'/rpc_api'`
 * `protocol_factory` defaults to `Thrift::BinaryProtocolFactory.new`
 * `logger` see logging section below
 
 #### Logging
-You can optionally pass in a custom logger instance. If your application is a 
-Rails application, Rails.logger will automatically be used. Otherwise, logging
+You can optionally pass in a custom logger instance. If your application is a
+Rails application, Rails.logger will automatically be used. If your application
+is a Rack application, rack logger will automatically be used. Otherwise, logging
 will be directed to STDOUT
 
 ## Future features

data/lib/thrift/rack_middleware.rb

@@ -21,18 +21,18 @@
 # access via Thrift. You have to insert it into the MiddlewareStack of Rails
 # within a custom initializer and not within the environment, because Thrift
 # is not fully loaded at that point.
-# 
+#
 # Here is a sample of to to use it:
-# 
+#
 #     ActionController::Dispatcher.middleware.insert_before Rails::Rack::Metal, Thrift::RackMiddleware,
 #                                                                               { :processor => YourCustomProcessor.new,
 #                                                                                 :hook_path => "/the_path_to_receive_api_calls",
 #                                                                                 :protocol_factory => Thrift::BinaryProtocolAcceleratedFactory.new }
-# 
+#
 # Some benchmarking showed this is much slower then any Thrift solution without
 # Rails, but it is still fast enough if you need to integrate your Rails app
 # into a Thrift-based infrastructure.
-# 
+#
 begin
   require 'rack'
   require 'rack/response'
@@ -42,6 +42,7 @@ rescue LoadError => e
 end
 
 require "thrift"
+require "thrift/rack_middleware/logger"
 
 module Thrift
   class RackMiddleware
@@ -56,47 +57,49 @@ module Thrift
     end
 
     def call(env)
-      set_logger(env)
       request = ::Rack::Request.new(env)
-      # Need to add in more logging about the thrift object that was sent in if possible.
-      if request.post? && request.path == hook_path
-        # Try to parse the method called from the request body
-        rpc_method = request.body.read.match(/(?<method_name>[a-z_0-9]+)/i).try { |match| match[:method_name] }
-        request.body.rewind
-        request.logger.info "[#{Time.now}] #{@hook_path} called with method: #{rpc_method}"
-        start_time = Time.now
-        output = StringIO.new
-        transport = IOStreamTransport.new(request.body, output)
-        protocol = @protocol_factory.get_protocol(transport)
+
+      if request.post? && request.path == @hook_path
+        process(request)
+      else
+        @app.call(env)
+      end
+    end
+
+    def process(request)
+      log = Thrift::Rack::Middleware::Logger.new(request.env).or(@logger).create!
+
+      rpc_method = parse_rpc_method(request)
+      log.method_name(@hook_path, rpc_method)
+
+      output = StringIO.new
+      transport = IOStreamTransport.new(request.body, output)
+      protocol = @protocol_factory.get_protocol(transport)
+
+      log.processing_time(@hook_path, rpc_method) do
         begin
           @processor.process(protocol, protocol)
         rescue
-          request.logger.error "There was an error processing the thrift request!"
-          request.body.rewind
-          request.logger.error "  request body: #{request.body.read}"
-          output.rewind
-          request.logger.error "  output: #{output.read}"
-          raise $! # reraise the exception
+          log.error($!, request)
         end
-        
-        request.logger.info "  Total time taken processing RPC request for #{rpc_method}: #{Time.now - start_time} seconds"
-        output.rewind
-        response = ::Rack::Response.new(output)
-        response["Content-Type"] = "application/x-thrift"
-        response.finish
-      else
-        @app.call(env)
       end
+
+      return_output(output)
+    end
+
+    def return_output(output)
+      output.rewind
+      response = ::Rack::Response.new(output)
+      response["Content-Type"] = "application/x-thrift"
+      response.finish
     end
 
-    def set_logger(env)
-      env['rack.logger'] = if @logger
-                             @logger
-                           elsif defined?(Rails) && Rails.logger
-                             Rails.logger
-                           else
-                             Logger.new(STDOUT)
-                           end
+    # Try to parse the method called from the request body
+    def parse_rpc_method(request)
+      rpc_method_match = request.body.read.match(/([a-z_0-9]+)/i)
+      rpc_method = rpc_method_match ? rpc_method_match[1] : 'UNKNOWN'
+      request.body.rewind
+      rpc_method
     end
   end
 end

data/lib/thrift/rack_middleware/logger.rb

@@ -0,0 +1,64 @@
+require "logger"
+require "benchmark"
+
+module Thrift
+  module Rack
+    module Middleware
+      class Logger
+
+        def initialize(env)
+          @env = env
+        end
+
+        def or(logger)
+          @logger = logger if logger
+          self
+        end
+
+        def create!
+          return self if @logger
+
+          @logger = if defined?(Rails) && Rails.logger
+            Rails.logger
+          elsif env.key? "rack.logger"
+            env["rack.logger"]
+          else
+            Logger.new(STDOUT)
+          end
+
+          self
+        end
+
+        def processing_time(hook_path, rpc_method, &block)
+          time = Benchmark.realtime &block
+          @logger.info "Completed #{hook_path}##{rpc_method} in #{time_to_readable(time)}"
+        end
+
+        def error(error, request)
+          @logger.error "Error processing thrift request"
+          request.body.rewind
+          @logger.error "  request body: '#{binary_to_readable(request.body.read)}'"
+
+          @logger.error error
+          @logger.error error.backtrace.join("\n\t")
+
+          raise error # reraise the error
+        end
+
+        def method_name(hook_path, rpc_method)
+          @logger.info "Called #{hook_path}##{rpc_method}"
+        end
+
+        private
+
+        def time_to_readable(time)
+          time >= 1 ? "#{time.round(3)}s" : "#{(time * 1000).round}ms"
+        end
+
+        def binary_to_readable(input)
+          input.gsub(/[^[:print:]]/) { |x| "\\#{x.ord}" }
+        end
+      end
+    end
+  end
+end

data/lib/thrift/rack_middleware/version.rb

@@ -1,7 +1,7 @@
 module Thrift
   module Rack
     module Middleware
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/spec/rack_middleware_spec.rb

@@ -24,10 +24,11 @@ require 'thrift/rack_middleware'
 
   describe RackMiddleware do
     before(:each) do
-      @processor = mock("Processor")
-      @factory = mock("ProtocolFactory")
-      @mock_app = mock("AnotherRackApp")
-      @middleware = RackMiddleware.new(@mock_app, :processor => @processor, :protocol_factory => @factory)
+      @processor = double("Processor", :process => nil)
+      @factory = double("ProtocolFactory", :get_protocol => double)
+      @mock_app = double("AnotherRackApp")
+      @logger = double("Logger").as_null_object
+      @middleware = RackMiddleware.new(@mock_app, :processor => @processor, :protocol_factory => @factory, :logger => @logger)
     end
 
     it "should call next rack application in the stack if request was not a post and not pointed to the hook_path" do
@@ -37,47 +38,55 @@ require 'thrift/rack_middleware'
       @middleware.call(env)
     end
 
-    it "should serve using application/x-thrift" do
-      env = {"REQUEST_METHOD" => "POST", "PATH_INFO" => "/rpc_api"}
-      IOStreamTransport.stub!(:new)
-      @factory.stub!(:get_protocol)
-      @processor.stub!(:process)
-      response = mock("RackResponse")
-      response.should_receive(:[]=).with("Content-Type", "application/x-thrift")
-      response.should_receive(:finish)
-      Rack::Response.should_receive(:new).and_return(response)
-      @middleware.call(env)
-    end
+    context "thrift request" do
+      let(:request_body) { StringIO.new 'test_method' }
+      let(:env) { {"REQUEST_METHOD" => "POST", "PATH_INFO" => "/rpc_api", "rack.input" => request_body} }
 
-    it "should use the IOStreamTransport" do
-      body = mock("body")
-      env = {"REQUEST_METHOD" => "POST", "PATH_INFO" => "/rpc_api", "rack.input" => body}
-      output = mock("output")
-      output.should_receive(:rewind)
-      StringIO.should_receive(:new).and_return(output)
-      protocol = mock("protocol")
-      transport = mock("transport")
-      IOStreamTransport.should_receive(:new).with(body, output).and_return(transport)
-      @factory.should_receive(:get_protocol).with(transport).and_return(protocol)
-      @processor.should_receive(:process).with(protocol, protocol)
-      response = mock("RackResponse")
-      response.stub!(:[]=)
-      response.should_receive(:finish)
-      Rack::Response.should_receive(:new).and_return(response)
-      @middleware.call(env)
+      it "should serve using application/x-thrift" do
+        response = double("RackResponse")
+        response.should_receive(:[]=).with("Content-Type", "application/x-thrift")
+        response.should_receive(:finish)
+        Rack::Response.should_receive(:new).and_return(response)
+        @middleware.call(env)
+      end
+
+      it "should use the IOStreamTransport" do
+        protocol = double("protocol")
+        transport = double("transport")
+        IOStreamTransport.should_receive(:new).with(request_body, instance_of(StringIO)).and_return(transport)
+        @factory.should_receive(:get_protocol).with(transport).and_return(protocol)
+        @processor.should_receive(:process).with(protocol, protocol)
+        response = double("RackResponse")
+        response.stub(:[]=)
+        response.should_receive(:finish)
+        Rack::Response.should_receive(:new).and_return(response)
+        @middleware.call(env)
+      end
+
+      it "should log incoming method names" do
+        @logger.should_receive(:info).twice.with(/test_method/)
+        @middleware.call(env)
+      end
+
+      it "should log failures" do
+        error = RuntimeError.new('Fake Error')
+        @processor.stub(:process).and_raise(error)
+        @logger.should_receive(:error).with(error)
+        expect { @middleware.call(env) }.to raise_error(error)
+      end
     end
 
     it "should have appropriate defaults for hook_path and protocol_factory" do
-      mock_factory = mock("BinaryProtocolFactory")
-      mock_proc = mock("Processor")
+      mock_factory = double("BinaryProtocolFactory")
+      mock_proc = double("Processor")
       BinaryProtocolFactory.should_receive(:new).and_return(mock_factory)
       rack_middleware = RackMiddleware.new(@mock_app, :processor => mock_proc)
       rack_middleware.hook_path.should == "/rpc_api"
     end
 
     it "should understand :hook_path, :processor and :protocol_factory" do
-      mock_proc = mock("Processor")
-      mock_factory = mock("ProtocolFactory")
+      mock_proc = double("Processor")
+      mock_factory = double("ProtocolFactory")
 
       rack_middleware = RackMiddleware.new(@mock_app, :processor => mock_proc,
                                                       :protocol_factory => mock_factory,

data/thrift-rack-middleware.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec", "~> 2.14.0"
+  s.add_development_dependency "rake"
   s.add_runtime_dependency "rack", '>= 1.1.0'
   s.add_runtime_dependency "thrift", ">= 0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thrift-rack-middleware
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2013-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70220388130540 !ruby/object:Gem::Requirement
+  requirement: &70297905478640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: *70297905478640
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70297905478220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220388130540
+  version_requirements: *70297905478220
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70220388130000 !ruby/object:Gem::Requirement
+  requirement: &70297905477680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220388130000
+  version_requirements: *70297905477680
 - !ruby/object:Gem::Dependency
   name: thrift
-  requirement: &70220388129400 !ruby/object:Gem::Requirement
+  requirement: &70297905477180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220388129400
+  version_requirements: *70297905477180
 description: Rack middleware for thrift services
 email:
 - tomas.brazys@gmail.com
@@ -57,6 +68,7 @@ files:
 - README.md
 - Rakefile
 - lib/thrift/rack_middleware.rb
+- lib/thrift/rack_middleware/logger.rb
 - lib/thrift/rack_middleware/version.rb
 - spec/rack_middleware_spec.rb
 - spec/spec_helper.rb
@@ -73,12 +85,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 40008673381423064
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 40008673381423064
 requirements: []
 rubyforge_project: thrift-rack-middleware
 rubygems_version: 1.8.10