rack_jruby_profiling 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jason Rogers
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= rack_jruby_profiling
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jason Rogers. See LICENSE for details.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack_jruby_profiling.rb

@@ -0,0 +1,106 @@
+require 'jruby-prof'
+
+module Rack
+  # Based on rack/contrib/profiling
+  #
+  # Set the profile=call_tree query parameter to view a calltree profile of the request.
+  #
+  # Set the download query parameter to download the result locally
+  #
+  class JRubyProfiler
+    DEFAULT_CONTENT_TYPE = 'text/html'
+
+    PRINTER_CONTENT_TYPE = {
+      :print_flat_text => 'text/plain',
+      :print_graph_text => 'text/plain',
+      :print_call_tree => 'text/plain',
+      :print_graph_html => 'text/html',
+      :print_tree_html => 'text/html'
+    }
+    
+    DEFAULT_PRINTER = :print_tree_html
+
+    PRINTER_METHODS = {
+      :flat => :print_flat_text,
+      :graph => :print_graph_text,
+      :call_tree => :print_call_tree,
+      :graph_html => :print_graph_html,
+      :tree_html => :print_tree_html
+    }
+    
+    FILE_NAMING = {
+      :print_flat_text => 'flat',
+      :print_graph_text => 'graph',
+      :print_call_tree => 'call_tree',
+      :print_graph_html => 'graph',
+      :print_tree_html => 'call_tree'
+    }
+
+    # Accepts a :times => [Fixnum] option defaulting to 1.
+    def initialize(app, options = {})
+      @app = app
+      @times = (options[:times] || 1).to_i
+    end
+
+    def call(env)
+      profile(env)
+    end
+    
+    def profile_file
+      @profile_file
+    end
+
+    private
+      def profile(env)
+        request  = Rack::Request.new(env)
+        @printer = parse_printer(request.params.delete('profile'))
+        if JRubyProf.running?
+          @app.call(env)
+        else
+          count  = (request.params.delete('times') || @times).to_i
+          result = JRubyProf.profile do
+            count.times { @app.call(env) }
+          end
+          @uniq_id = Java::java.lang.System.nano_time
+          @profile_file = ::File.expand_path( filename(@printer, env) )
+          [200, headers(@printer, request, env), print(@printer, request, env, result)]
+        end
+      end
+      
+      def filename(printer, env)
+        extension = printer.to_s.include?("html") ? "html" : "txt"
+        "#{::File.basename(env['PATH_INFO'])}_#{FILE_NAMING[printer]}_#{@uniq_id}.#{extension}"
+      end
+
+      def print(printer, request, env, result)
+        return result if printer.nil?
+        filename = filename(printer, env)
+        JRubyProf.send(printer, result, filename)
+        ::File.read filename
+      end
+
+      def headers(printer, request, env)
+        headers = { 'Content-Type' => PRINTER_CONTENT_TYPE[printer] || DEFAULT_CONTENT_TYPE }
+        if boolean(request.params['download'])
+          filename = filename(printer, env)
+          headers['Content-Disposition'] = %(attachment; filename="#{filename}")
+        end
+        headers
+      end
+      
+      def boolean(parameter)
+        return false if parameter.nil?
+        return true if %w{t true y yes}.include?(parameter.downcase)
+        false
+      end
+
+      def parse_printer(printer)
+        printer = printer.to_sym rescue nil
+        if printer.nil?
+          DEFAULT_PRINTER
+        else
+          PRINTER_METHODS[printer] || DEFAULT_PRINTER
+        end
+      end
+  end
+end

data/spec/rack_jruby_profiling_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module TestHelpers
+  def basic_application(code)
+    Proc.new { |env| 
+      500.times {|t| "construct a string for #{t} just so that we have some work to do in this application"}
+      500.times {|t| [t, t/4.0].max }
+      [@code, {"Content-Type" => "text/plain", "Content-Length" => "3"}, [@code.to_s]] 
+    }
+  end
+  
+  def error_application(error)
+    Proc.new { |env| raise error }
+  end
+  
+  def response_for(app, request)
+    @profiler = Rack::JRubyProfiler.new(app)
+    @profiler.call(request)
+  end
+  
+  def all_profiles
+    Dir["./#{@path}*"]
+  end
+  
+  def first_profile
+    all_profiles.first
+  end
+end
+
+describe Rack::JRubyProfiler do
+  include Rack::Test::Methods
+  include TestHelpers
+  
+  before :each do
+    @path = 'profile_test'
+    @request = Rack::MockRequest.env_for("/#{@path}")
+  end
+  
+  after :each do
+    if @profiler
+      File.delete @profiler.profile_file
+    end
+  end
+  
+  [200, 301, 404, 500].each do | code |
+    it "should successfully respond with 200 if down-stream app returns #{code}" do
+      response = response_for( basic_application(code), @request )
+      response[0].should == 200
+      response[1].should include("Content-Type")
+      response[1]["Content-Type"].should == 'text/html'
+      @profiler.profile_file.should_not be_nil
+      response[2].class.should == String
+      response[2].length.should > 0
+      response[2].should == File.read(@profiler.profile_file)
+    end
+  end
+  
+  it "should NOT mask when a down-stream app throws an error" do
+    @request = Rack::MockRequest.env_for("/profile_test")
+    lambda{ response_for( error_application('ka-boom!'), request ) }.should raise_error
+  end
+
+  class Tuple
+    TRUISH = %w{true t yes y}
+    attr_reader :profile_type, :content_type, :partial_filename, :extension
+    
+    def initialize(profile_type, content_type, partial_filename=nil)
+      @profile_type = profile_type
+      @content_type = content_type
+      @partial_filename = (partial_filename || profile_type)
+      @extension = content_type == :plain ? 'txt' : 'html'
+    end
+    
+    def download
+      TRUISH[rand(TRUISH.length)]
+    end
+  end
+  
+  [
+    Tuple.new(:flat, :plain), 
+    Tuple.new(:graph, :plain), 
+    Tuple.new(:call_tree, :plain), 
+    Tuple.new(:graph_html, :html, :graph), 
+    Tuple.new(:tree_html, :html, :call_tree)
+  ].each do |tuple|
+    it "should construct a #{tuple.profile_type} profile with content type of #{tuple.content_type} and download it" do
+      @request = Rack::MockRequest.env_for("/profile_test?profile=#{tuple.profile_type}&download=#{tuple.download}")
+      response = response_for( basic_application(200), @request )
+      response[0].should == 200
+      response[1].should include("Content-Type")
+      response[1]["Content-Type"].should == "text/#{tuple.content_type}"
+      
+      @profiler.profile_file.should_not be_nil
+      @profiler.profile_file.should =~ /profile_test_#{tuple.partial_filename}_\d+\.#{tuple.extension}$/
+      response[1].should include("Content-Disposition")
+      response[1]["Content-Disposition"].should =~ Regexp.compile(%(attachment; filename="#{File.basename(@profiler.profile_file)}"))
+      response[2].class.should == String
+      response[2].should == File.read(@profiler.profile_file)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+raise 'specs can only be run with JRuby' unless Object.const_defined?('Java')
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'rack_jruby_profiling'
+require 'spec'
+require 'spec/autorun'
+require 'rack/test'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: rack_jruby_profiling
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Rack middleware for running profiling JRuby applications
+email: jacaetevha@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- VERSION
+- lib/rack_jruby_profiling.rb
+- spec/rack_jruby_profiling_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jacaetevha/rack_jruby_profiling
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rack middleware for running profiling JRuby applications
+test_files: 
+- spec/rack_jruby_profiling_spec.rb
+- spec/spec_helper.rb