ruby-prof 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de991aaaa9b3bae6b7d38da2adac6112e7f254d2927ec3e6cb6e7d1d07fb4c7b
-  data.tar.gz: 1f246cf6795b6cb955188349c5f4da06e95a3fd94241fbd29aab8dcdcd19d312
+  metadata.gz: 9dbafd0a6aebb3d09c5f7f198d4261fbd39709c33ec216ea542e8fe2063cd2b9
+  data.tar.gz: f66379b3e8b2c5fde1ef01ce84484a6b9f958bb643c4783e32fd6b37f033efb0
 SHA512:
-  metadata.gz: bc39dad6f9d5795ba4f48fa674097798de0be279ea9ccae63c2a7c683f22031bbf6bda85b81b46bccd8b4112d30e65b40d5a5dac9311ced4d033f3ccb32fd2de
-  data.tar.gz: bf04b46a607a9ff896fc6d8eb169447920136ce5a713132993d2f1e830b215c4fa97f9c43253024ddebb289bc5b3f1ceba0200579796f28a9e31c6faffedb698
+  metadata.gz: 134cb10903895675ccfa34ab880ecdcd04bf55d8b749fff2f431655777b1801820e0a68c5b402d5200beb0c2e942d5833cac6a2faaa897a9be36c5b2531e30d2
+  data.tar.gz: '09400b5f8f70abb628984dff8cd270bfb490db686f06d89530ee25a68c9e5cf7546da429ca48570cfa57e73af092ca38964fa64fb30e3b987a1fa1503b212047'

data/CHANGES

@@ -1,3 +1,8 @@
+1.3.2 (2020-04-19)
+=====================
+* Fix rack profiler so it is thread safe (Charlie Savage)
+* Fix loading of prebuilt binaries on mingw64 to use Ruby's major and minor version (Charlie Savage)
+
 1.3.1 (2020-03-11)
 =====================
 * Add max_percent and filter_by options to flat printer (Sean McGivern)

data/Rakefile

@@ -38,9 +38,9 @@ Rake::ExtensionTask.new do |ext|
   ext.gem_spec = default_spec
   ext.name = SO_NAME
   ext.ext_dir = "ext/#{SO_NAME}"
-  ext.lib_dir = "lib/#{RUBY_VERSION}"
+  ext.lib_dir = "lib/#{Gem::Version.new(RUBY_VERSION).segments[0..1].join('.')}"
   ext.cross_compile = true
-  ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
+  ext.cross_platform = ['x64-mingw32']
 end
 
 # Rake task to build the default package
@@ -58,7 +58,6 @@ if RUBY_PLATFORM.match(/win32|mingw32/)
   win_spec = default_spec.clone
   win_spec.platform = Gem::Platform::CURRENT
   win_spec.files += Dir.glob('lib/**/*.so')
-  win_spec.instance_variable_set(:@cache_file, nil) # Hack to work around gem issue
 
   # Unset extensions
   win_spec.extensions = nil

data/lib/ruby-prof.rb

@@ -1,9 +1,10 @@
 # encoding: utf-8
+require 'rubygems/version'
 
 # Load the C-based binding.
 begin
-  RUBY_VERSION =~ /(\d+\.\d+\.\d+)/
-  require "#{$1}/ruby_prof.so"
+  version = Gem::Version.new(RUBY_VERSION)
+  require "#{version.segments[0..1].join('.')}/ruby_prof.so"
 rescue LoadError
   require "ruby_prof.so"
 end

data/lib/ruby-prof/rack.rb

@@ -5,43 +5,37 @@ module Rack
   class RubyProf
     def initialize(app, options = {})
       @app = app
+      @options = options
+      @options[:min_percent] ||= 1
 
-      options[:min_percent] ||= 1
+      @tmpdir = options[:path] || Dir.tmpdir
+      FileUtils.mkdir_p(@tmpdir)
 
-      options[:path] ||= Dir.tmpdir
-      FileUtils.mkdir_p(options[:path])
+      @printer_klasses = @options[:printers]  || {::RubyProf::FlatPrinter => 'flat.txt',
+                                                  ::RubyProf::GraphPrinter => 'graph.txt',
+                                                  ::RubyProf::GraphHtmlPrinter => 'graph.html',
+                                                  ::RubyProf::CallStackPrinter => 'call_stack.html'}
 
       @skip_paths = options[:skip_paths] || [%r{^/assets}, %r{\.(css|js|png|jpeg|jpg|gif)$}]
       @only_paths = options[:only_paths]
-
-      @max_requests = options[:max_requests]
-
-      @options = options
     end
 
     def call(env)
       request = Rack::Request.new(env)
 
       if should_profile?(request.path)
-        profiler.resume
         begin
-          result = @app.call(env)
-        ensure
-          profiler.pause
-        end
+          result = nil
+          data = ::RubyProf::Profile.profile(profiling_options) do
+            result = @app.call(env)
+          end
 
-        if profiler.max_requests_reached?
-          prefix = if aggregate_requests?
-              nil
-            else
-              request.path.gsub('/', '-')[1..-1]
-            end
+          path = request.path.gsub('/', '-')
+          path.slice!(0)
 
-          profiler.print!(prefix)
-          delete_profiler!
+          print(data, path)
+          result
         end
-
-        result
       else
         @app.call(env)
       end
@@ -49,126 +43,53 @@ module Rack
 
     private
 
-    class RackProfiler
-      def initialize(options)
-        @options = options
-
-        @profile = ::RubyProf::Profile.new(profiling_options)
-        @profile.start
-        @profile.pause
-
-        @printer_klasses = options[:printers] || default_printers
-
-        @tmpdir = options[:path]
-
-        @max_requests = options[:max_requests] || 1
-        @requests_count = 0
+    def should_profile?(path)
+      return false if paths_match?(path, @skip_paths)
 
-        @printed = false
-        # if running across multiple requests, we want to make sure that the
-        # ongoing profile is not lost if the process shuts down before the
-        # max request count is reached
-        ObjectSpace.define_finalizer(self, proc { print! })
-      end
+      @only_paths ? paths_match?(path, @only_paths) : true
+    end
 
-      def resume
-        @profile.resume
-      end
+    def paths_match?(path, paths)
+      paths.any? { |skip_path| skip_path =~ path }
+    end
 
-      def pause
-        @profile.pause
-        @requests_count += 1
+    def profiling_options
+      options = {}
+      options[:measure_mode] = ::RubyProf.measure_mode
+      options[:exclude_threads] =
+        if @options[:ignore_existing_threads]
+          Thread.list.select{|t| t != Thread.current}
+        else
+          ::RubyProf.exclude_threads
+        end
+      if @options[:request_thread_only]
+        options[:include_threads] = [Thread.current]
       end
-
-      def max_requests_reached?
-        @requests_count >= @max_requests
+      if @options[:merge_fibers]
+        options[:merge_fibers] = true
       end
+      options
+    end
 
-      def print!(prefix = nil)
-        return false if @printed || @requests_count == 0
-
-        data = @profile.stop
-
-        prefix ||= "multi-requests-#{@requests_count}"
-
-        @printer_klasses.each do |printer_klass, base_name|
-          printer = printer_klass.new(data)
-
-          if base_name.respond_to?(:call)
-            base_name = base_name.call
-          end
+    def print(data, path)
+      @printer_klasses.each do |printer_klass, base_name|
+        printer = printer_klass.new(data)
 
-          if printer_klass == ::RubyProf::MultiPrinter \
-              || printer_klass == ::RubyProf::CallTreePrinter
-            printer.print(@options.merge(:profile => "#{prefix}-#{base_name}"))
-          else
-            file_name = ::File.join(@tmpdir, "#{prefix}-#{base_name}")
-            ::File.open(file_name, 'wb') do |file|
-              printer.print(file, @options)
-            end
-          end
+        if base_name.respond_to?(:call)
+          base_name = base_name.call
         end
 
-        @printed = true
-      end
-
-      private
-
-      def profiling_options
-        options = {}
-        options[:measure_mode] = ::RubyProf.measure_mode
-        options[:exclude_threads] =
-          if @options[:ignore_existing_threads]
-            Thread.list.select{|t| t != Thread.current}
-          else
-            ::RubyProf.exclude_threads
+        if printer_klass == ::RubyProf::MultiPrinter
+          printer.print(@options.merge(:profile => "#{path}-#{base_name}"))
+        elsif printer_klass == ::RubyProf::CallTreePrinter
+          printer.print(@options.merge(:profile => "#{path}-#{base_name}"))
+        else
+          file_name = ::File.join(@tmpdir, "#{path}-#{base_name}")
+          ::File.open(file_name, 'wb') do |file|
+            printer.print(file, @options)
           end
-        if @options[:request_thread_only]
-          options[:include_threads] = [Thread.current]
         end
-        if @options[:merge_fibers]
-          options[:merge_fibers] = true
-        end
-        options
-      end
-
-      def default_printers
-        {::RubyProf::FlatPrinter => 'flat.txt',
-         ::RubyProf::GraphPrinter => 'graph.txt',
-         ::RubyProf::GraphHtmlPrinter => 'graph.html',
-         ::RubyProf::CallStackPrinter => 'call_stack.html'}
       end
     end
-
-    def profiler
-      if aggregate_requests?
-        @@_shared_profiler ||= RackProfiler.new(@options)
-      else
-        @_profiler ||= RackProfiler.new(@options)
-      end
-    end
-
-    def delete_profiler!
-      if aggregate_requests?
-        @@_shared_profiler.print! if @@_shared_profiler
-        @@_shared_profiler = nil
-      else
-        @_profiler = nil
-      end
-    end
-
-    def aggregate_requests?
-      !@max_requests.nil?
-    end
-
-    def should_profile?(path)
-      return false if paths_match?(path, @skip_paths)
-
-      @only_paths ? paths_match?(path, @only_paths) : true
-    end
-
-    def paths_match?(path, paths)
-      paths.any? { |skip_path| skip_path =~ path }
-    end
   end
 end

data/lib/ruby-prof/version.rb

@@ -1,3 +1,3 @@
 module RubyProf
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/test/rack_test.rb

@@ -24,16 +24,6 @@ module Rack
   end
 end
 
-module Rack
-  class RubyProf
-    attr_reader :_profiler
-
-    def public_delete_profiler!
-      delete_profiler!
-    end
-  end
-end
-
 class RackTest < TestCase
   def test_create_print_path
     path = Dir.mktmpdir
@@ -100,58 +90,4 @@ class RackTest < TestCase
     file_path = ::File.join(path, 'path-to-resource.json-dynamic.txt')
     assert(File.exist?(file_path))
   end
-
-  def test_works_for_multiple_requests
-    path = Dir.mktmpdir
-
-    adapter = Rack::RubyProf.new(FakeRackApp.new, :path => path, :max_requests => 2)
-
-    # make a 1st request, and check that this didn't create any files
-    adapter.call(:fake_env)
-    assert(Dir["#{path}/*"].empty?)
-
-    # now a second request should create all the expected files
-    adapter.call(:fake_env)
-    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
-      file_path = ::File.join(path, "multi-requests-2-#{base_name}")
-      assert(File.exist?(file_path))
-    end
-
-    # let's clean up
-    FileUtils.rm_rf(Dir["#{path}/*"])
-
-    # and do the same again for the next 2 requests
-    adapter.call(:fake_env)
-    assert(Dir["#{path}/*"].empty?)
-
-    adapter.call(:fake_env)
-    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
-      file_path = ::File.join(path, "multi-requests-2-#{base_name}")
-      assert(File.exist?(file_path))
-    end
-  end
-
-  def test_tries_to_print_results_if_shut_down_before_max_requests_reached
-    path = Dir.mktmpdir
-
-    adapter = Rack::RubyProf.new(FakeRackApp.new, :path => path, :max_requests => 100)
-
-    # make a 1st request, and check that this didn't create any files
-    adapter.call(:fake_env)
-    assert(Dir["#{path}/*"].empty?)
-
-    adapter.public_delete_profiler!
-
-    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
-      file_path = ::File.join(path, "multi-requests-1-#{base_name}")
-      assert(File.exist?(file_path))
-    end
-  end
-
-  def test_it_uses_separate_profilers_if_not_aggregating_multiple_requests
-    adapter1 = Rack::RubyProf.new(FakeRackApp.new)
-    adapter2 = Rack::RubyProf.new(FakeRackApp.new)
-
-    assert(adapter1.object_id != adapter2.object_id)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-prof
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Shugo Maeda, Charlie Savage, Roger Pack, Stefan Kaes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -177,7 +177,7 @@ metadata:
   bug_tracker_uri: https://github.com/ruby-prof/ruby-prof/issues
   changelog_uri: https://github.com/ruby-prof/ruby-prof/blob/master/CHANGES
   documentation_uri: https://ruby-prof.github.io/
-  source_code_uri: https://github.com/ruby-prof/ruby-prof/tree/v1.3.1
+  source_code_uri: https://github.com/ruby-prof/ruby-prof/tree/v1.3.2
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Fast Ruby profiler