derailed_benchmarks 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 534c94c162b5f9959a2013292d3f58fdf3bad5f17276a6db240a75596f1b041e
-  data.tar.gz: e7db4cf3bb3ea0f965dd25af1dcfe1a85dbfb80d6c3508e295ac68432b4e9868
+  metadata.gz: 843a6c3b99ee45120c15af62a592e9bbecb2d88f0917fa292faf9f7128ab721a
+  data.tar.gz: f1cdfb9c4145c27a8dac7f2c868077c6359213c3c367f2cf8a0f8909f50c9468
 SHA512:
-  metadata.gz: 4f39f3b7df3d063c703df439aba0dd0be34650bbbf490d9af11c28dac0a9449eb347bfd9201124bedfea3b53b6f731280fafa5a9f6e40e7c311d1584b5061e13
-  data.tar.gz: 151966ff16e1e07bf217ce88e3c4868089eb2ef6428ddd6e93d8d3761d97902a4c4ee8cca32389e80e5dcaf658f21c121e9a9bffcd2a52d80985e1560021767d
+  metadata.gz: 1936293cd836af98e6af454a7482534c7481b938f4944813a5261a04a9b766b0a169b866397b3d9745d25316cd8916df3b74fc1fd4f1ff46f6e5753eba92bd96
+  data.tar.gz: 7de041007e174314699cac83eef5b70626e5447eddd705190d68d74cc7d50c0b9d660d032127cf747ea67566a096bbca4aafa05774c413da6f4ca802c8da2c08

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## master (unreleased)
 
+## 1.7.0
+
+- Add histogram support to `perf:library` (https://github.com/schneems/derailed_benchmarks/pull/169)
+- Fix bug with `Kernel#require` patch when Zeitwerk is enabled (https://github.com/schneems/derailed_benchmarks/pull/170)
+
 ## 1.6.0
 
 - Added the `perf:app` command to compare commits within the same application. (https://github.com/schneems/derailed_benchmarks/pull/157)

data/derailed_benchmarks.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency "rake",            "> 10", "< 14"
   gem.add_dependency "thor",            ">= 0.19", "< 2"
   gem.add_dependency "ruby-statistics", ">= 2.1"
+  gem.add_dependency "unicode_plot",    ">= 0.0.4", "< 1.0.0"
+  gem.add_dependency "mini_histogram",    "~> 0"
 
   gem.add_development_dependency "capybara",  "~> 2"
   gem.add_development_dependency "m"

data/lib/derailed_benchmarks/core_ext/kernel_require.rb

@@ -11,14 +11,20 @@ ENV['CUT_OFF'] ||= "0.3"
 # Monkey patch kernel to ensure that all `require` calls call the same
 # method
 module Kernel
+  REQUIRE_STACK = []
 
-  private
+  module_function
 
-  alias :original_require :require
-  REQUIRE_STACK = []
+  alias_method :original_require, :require
+  alias_method :original_require_relative, :require_relative
 
   def require(file)
-    Kernel.require(file)
+    measure_memory_impact(file) do |file|
+      # "source_annotation_extractor" is deprecated in Rails 6
+      # # if we don't skip the library it leads to a crash
+      # next if file == "rails/source_annotation_extractor" && Rails.version >= '6.0'
+      original_require(file)
+    end
   end
 
   def require_relative(file)
@@ -29,10 +35,7 @@ module Kernel
     end
   end
 
-  class << self
-    alias :original_require          :require
-    alias :original_require_relative :require_relative
-  end
+  private
 
   # The core extension we use to measure require time of all requires
   # When a file is required we create a tree node with its file name.
@@ -46,7 +49,7 @@ module Kernel
   # When a require returns we remove it from the require stack so we don't
   # accidentally push additional children nodes to it. We then store the
   # memory cost of the require in the tree node.
-  def self.measure_memory_impact(file, &block)
+  def measure_memory_impact(file, &block)
     mem    = GetProcessMem.new
     node   = DerailedBenchmarks::RequireTree.new(file)
 
@@ -68,15 +71,6 @@ end
 TOP_REQUIRE = DerailedBenchmarks::RequireTree.new("TOP")
 REQUIRE_STACK.push(TOP_REQUIRE)
 
-Kernel.define_singleton_method(:require) do |file|
-  measure_memory_impact(file) do |file|
-    # "source_annotation_extractor" is deprecated in Rails 6
-    # # if we don't skip the library it leads to a crash
-    # next if file == "rails/source_annotation_extractor" && Rails.version >= '6.0'
-    original_require(file)
-  end
-end
-
 class Object
   private
 

data/lib/derailed_benchmarks/load_tasks.rb

@@ -30,7 +30,7 @@ namespace :perf do
       DERAILED_APP.initialize! unless DERAILED_APP.instance_variable_get(:@initialized)
     end
 
-    if  ENV["DERAILED_SKIP_ACTIVE_RECORD"] && defined? ActiveRecord
+    if !ENV["DERAILED_SKIP_ACTIVE_RECORD"] && defined? ActiveRecord
       if defined? ActiveRecord::Tasks::DatabaseTasks
         ActiveRecord::Tasks::DatabaseTasks.create_current
       else # Rails 3.2
@@ -39,7 +39,14 @@ namespace :perf do
 
       ActiveRecord::Migrator.migrations_paths = DERAILED_APP.paths['db/migrate'].to_a
       ActiveRecord::Migration.verbose         = true
-      ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, nil)
+
+      if Rails.version.start_with? '6'
+        ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths, ActiveRecord::SchemaMigration).migrate
+      elsif Rails.version.start_with? '5.2'
+        ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths).migrate
+      else
+        ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, nil)
+      end
     end
 
     DERAILED_APP.config.consider_all_requests_local = true
@@ -135,4 +142,4 @@ namespace :perf do
       WARM_COUNT.times { call_app }
     end
   end
-end
+end

data/lib/derailed_benchmarks/stats_from_dir.rb

@@ -2,6 +2,9 @@
 
 require 'bigdecimal'
 require 'statistics'
+require 'unicode_plot'
+require 'stringio'
+require 'mini_histogram'
 
 module DerailedBenchmarks
   # A class used to read several benchmark files
@@ -100,7 +103,26 @@ module DerailedBenchmarks
       " " * (percent_faster.to_s.index(".") - x_faster.to_s.index("."))
     end
 
-    def banner(io = Kernel)
+    def histogram(io = $stdout)
+      newest_histogram = MiniHistogram.new(newest.values)
+      oldest_histogram = MiniHistogram.new(oldest.values)
+      MiniHistogram.set_average_edges!(newest_histogram, oldest_histogram)
+
+      {newest => newest_histogram, oldest => oldest_histogram}.each do |report, histogram|
+        plot = UnicodePlot.histogram(
+          histogram,
+          title: "\n#{' ' * 18 }Histogram - [#{report.name}] #{report.desc.inspect}",
+          ylabel: "Time (s)",
+          xlabel: "# of runs in range"
+        )
+        plot.render(io)
+        io.puts
+      end
+
+      io.puts
+    end
+
+    def banner(io = $stdout)
       io.puts
       if significant?
         io.puts "❤️ ❤️ ❤️  (Statistically Significant) ❤️ ❤️ ❤️"
@@ -122,6 +144,9 @@ module DerailedBenchmarks
       io.puts "Is significant? (max > critical): #{significant?}"
       io.puts "D critical: #{d_critical}"
       io.puts "D max: #{d_max}"
+
+      histogram(io)
+
       io.puts
     end
   end

data/lib/derailed_benchmarks/tasks.rb

@@ -88,7 +88,8 @@ namespace :perf do
 
         if (i % 50).zero?
           puts "Intermediate result"
-          stats.call.banner
+          stats.call
+          stats.banner
           puts "Continuing execution"
         end
       end
@@ -102,7 +103,8 @@ namespace :perf do
       end
 
       if stats
-        stats.call.banner
+        stats.call
+        stats.banner
 
         result_file = out_dir + "results.txt"
         File.open(result_file, "w") do |f|

data/lib/derailed_benchmarks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DerailedBenchmarks
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/test/derailed_benchmarks/stats_from_dir_test.rb

@@ -29,6 +29,22 @@ class StatsFromDirTest < ActiveSupport::TestCase
     assert_equal "11.3844", format % newest.median
   end
 
+  test "histogram output" do
+    dir = fixtures_dir("stats/significant")
+    branch_info = {}
+    branch_info["loser"]  = { desc: "Old commit", time: Time.now, file: dir.join("loser.bench.txt"), name: "loser" }
+    branch_info["winner"] = { desc: "I am the new commit", time: Time.now + 1, file: dir.join("winner.bench.txt"), name: "winner" }
+    stats = DerailedBenchmarks::StatsFromDir.new(branch_info).call
+
+    io = StringIO.new
+    stats.call.banner(io)
+    puts io.string
+
+    assert_match(/11\.2 , 11\.28/, io.string)
+    assert_match(/11\.8 , 11\.88/, io.string)
+  end
+
+
   test "alignment" do
     dir = fixtures_dir("stats/significant")
     branch_info = {}

data/test/integration/tasks_test.rb

@@ -26,7 +26,7 @@ class TasksTest < ActiveSupport::TestCase
     env_string = env.map {|key, value| "#{key.shellescape}=#{value.to_s.shellescape}" }.join(" ")
     cmd        = "env #{env_string} bundle exec rake -f perf.rake #{cmd} --trace"
     puts "Running: #{cmd}"
-    result = `cd '#{rails_app_path}' && #{cmd}`
+    result = Bundler.with_original_env { `cd '#{rails_app_path}' && #{cmd}` }
     if assert_success
       assert $?.success?, "Expected '#{cmd}' to return a success status.\nOutput: #{result}"
     end

data/test/rails_app/config/application.rb

@@ -13,6 +13,8 @@ require 'devise'
 
 module Dummy
   class Application < Rails::Application
+    config.load_defaults Rails.version.to_f
+
     config.action_mailer.default_url_options = { host: 'localhost:3000' }
 
     # Settings in config/environments/* take precedence over those specified here.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: derailed_benchmarks
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: heapy
@@ -134,6 +134,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: unicode_plot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: mini_histogram
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement