perf_check 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b748791510099f0d04eccd3624623f0f268484a1
-  data.tar.gz: ebd96c65c3d27d78bd64cf01727e1e5a476e1d89
+  metadata.gz: a4bbced7edbd4eb60e691db4241203c9d0c40fe7
+  data.tar.gz: fc643decd944fe233446917257c78aaea678f5c5
 SHA512:
-  metadata.gz: ee57d225bcd04131ddbc874688eb383db6ca7296c44372e4e49bb0ab1b22f77088715e7cef012321594516620ff5a40aff528c19891ff5af69af3d249dd1de16
-  data.tar.gz: 0e4426dc65b80ef2ac67f931f1c84eed0dbbe6e3957a3844072ab02b9d7f2733be7a168601dd7d12156bb2e23417fa105fce613d7b02a3996d0ac13231e057f4
+  metadata.gz: 6628a8deceb43e9bcd8a5d858d99c3e28b19cbff162bf16b83fa725752b18265e5785d8de220a2aac2b3db51e1021cd54339690f3d3a2782a8e433898e96cfec
+  data.tar.gz: 35432fe77f9de33e73064bfd046097dfde0130e48b4f2fe5e9a4ca2ef3cbbc9291c1680e0ac7f76b585cd0509a45c1b6cc193df59778ae62e19ba4294ad7e1d9

data/lib/perf_check/callbacks.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+class PerfCheck
+  def self.when_finished(&block)
+    @when_finished_callbacks ||= []
+    @when_finished_callbacks << block
+  end
+
+  def self.when_finished_callbacks
+    @when_finished_callbacks || []
+  end
+
+  def self.before_start(&block)
+    @before_start_callbacks ||= []
+    @before_start_callbacks << block
+  end
+
+  def self.before_start_callbacks
+    (@before_start_callbacks || []) + [
+      proc {
+        logger.info("=" * 77)
+        logger.info("PERRRRF CHERRRK! Grab a ☕️  and don't touch your working tree (we automate git)")
+        logger.info("=" * 77)
+      }
+    ]
+  end
+
+
+  def trigger_before_start_callbacks
+    PerfCheck.before_start_callbacks.each{ |f| f.call(self) }
+  end
+
+  def trigger_when_finished_callbacks(data={})
+    data = data.merge(:current_branch => PerfCheck::Git.current_branch)
+    results = OpenStruct.new(data)
+    results[:ARGV] = ORIGINAL_ARGV
+    if test_cases.size == 1
+      results.current_latency = test_cases.first.this_latency
+      results.reference_latency = test_cases.first.reference_latency
+    end
+    PerfCheck.when_finished_callbacks.each{ |f| f.call(results) }
+  end
+end

data/lib/perf_check/config.rb

@@ -0,0 +1,126 @@
+require 'optparse'
+
+class PerfCheck
+  def self.config
+    @config ||= OpenStruct.new(
+      number_of_requests: 10,
+      reference: 'master',
+      cookie: nil,
+      http_statuses: [200],
+      verify_responses: false,
+      caching: true,
+      json: false
+     )
+  end
+
+  def config
+    PerfCheck.config
+  end
+
+  alias :options :config
+
+  Options = OptionParser.new do |opts|
+    opts.banner = "Usage: perf_check [options] [route ...]"
+
+    opts.separator "\nBenchmark options:"
+    opts.on('--requests N', '-n',
+            'Use N requests in benchmark, defaults to 10') do |n|
+      config.number_of_requests = n.to_i
+    end
+
+    opts.on('--reference COMMIT', '-r',
+            'Benchmark against COMMIT instead of master') do |commit|
+      config.reference = commit
+    end
+
+    opts.on('--quick', '-q',
+            'Fire off 5 requests just on this branch, no comparison with master') do
+      config.number_of_requests = 5
+      config.reference = nil
+    end
+
+    opts.on('--no-caching', 'Do not enable fragment caching') do
+      config.caching = false
+    end
+
+    opts.on('--fail-fast', '-f', 'Bail immediately on non-200 HTTP response') do
+      config[:fail_fast?] = true
+    end
+
+    opts.on('--302-success', 'Consider HTTP 302 code a successful request') do
+      config.http_statuses.push(302)
+    end
+
+    opts.on('--302-failure', 'Consider HTTP 302 code an unsuccessful request') do
+      config.http_statuses.delete(302)
+    end
+
+    opts.separator "\nMisc"
+    opts.on('--cookie COOKIE', '-c') do |cookie|
+      config.cookie = cookie
+    end
+
+    opts.on('--json', '-j') do
+      config.json = true
+    end
+
+    opts.on('--input FILE', '-i') do |input|
+      File.readlines(input).each do |resource|
+        ARGV << resource.strip
+      end
+    end
+
+    opts.on('--verify-responses',
+            'Check whether there is a diff between the responses of this and the reference branch') do
+      config.verify_responses = true
+    end
+
+    opts.on('--brief', '-b') do
+      config.brief = true
+    end
+
+    opts.on('--diff') do
+      config.diff = true
+      config.brief = true
+      config.verify_responses = true
+      config.number_of_requests = 1
+    end
+
+    opts.separator ''
+    opts.separator <<EOF
+Usage examples:
+  Benchmark PostController#index against master
+     perf_check /user/45/posts
+     perf_check /user/45/posts -n5
+
+  Benchmark against a specific commit
+     perf_check /user/45/posts -r 0123abcdefg
+     perf_check /user/45/posts -r HEAD~2
+
+  Benchmark the changes in the working tree
+     perf_check /user/45/posts -r HEAD
+
+  Benchmark and diff the output against master
+     perf_check /user/45/posts --verify-responses
+
+  Just diff the output on your branch with master
+     perf_check /user/45/posts --diff
+
+  Diff a bunch of urls listed in a file (newline seperated)
+    perf_check --diff --input FILE
+EOF
+
+    opts.separator ''
+  end
+
+  def self.diff_options
+    @@diff_options ||=
+      ['-U3', '--ignore-matching-lines=/mini-profiler-resources/includes.js']
+  end
+
+  def self.load_config
+    if File.exists?("#{app_root}/config/perf_check.rb")
+      require "#{app_root}/config/perf_check"
+    end
+  end
+end

data/lib/perf_check/logger.rb

@@ -0,0 +1,19 @@
+
+require 'logger'
+
+class PerfCheck
+  def self.logger
+    @logger ||= Logger.new(STDERR).tap do |logger|
+      logger.formatter = proc do |severity, datetime, progname, msg|
+        "[#{datetime}] #{sprintf('%5s', severity)} --: #{msg}\n"
+      end
+    end
+  end
+
+  def logger; self.class.logger; end
+end
+
+class Object
+  def self.logger; PerfCheck.logger; end
+  def logger; PerfCheck.logger; end
+end

data/lib/perf_check/middleware.rb

@@ -0,0 +1,24 @@
+class PerfCheck
+  class Middleware
+    attr_reader :app
+    attr_accessor :query_count
+
+    def initialize(app)
+      @app = app
+
+      self.query_count = 0
+      ActiveSupport::Notifications.subscribe('sql.active_record') do |_|
+        self.query_count += 1
+      end
+    end
+
+    def call(env)
+      self.query_count = 0
+      status, headers, body = app.call(env)
+
+      headers['X-PerfCheck-Query-Count'] = query_count.to_s
+
+      [status, headers, body]
+    end
+  end
+end

data/lib/perf_check/output.rb

@@ -0,0 +1,112 @@
+class PerfCheck
+
+  def print_diff_results(diff)
+    if diff.changed?
+      print(" Diff: #{diff.file}".bold.light_red)
+    else
+      print(" Diff: Output is identical!".bold.light_green)
+    end
+  end
+
+  def print_brief_results
+    test_cases.each do |test|
+      print(test.resource.ljust(40) + ': ')
+
+      codes = (test.this_profiles+test.reference_profiles).map(&:response_code).uniq
+      print("(HTTP "+codes.join(',')+") ")
+
+      printf('%.1fms', test.this_latency)
+
+      puts && next if test.reference_profiles.empty?
+
+      print(sprintf(' (%+5.1fms)', test.latency_difference).bold)
+      print_diff_results(test.response_diff) if options.verify_responses
+      puts
+    end
+  end
+
+  def print_full_results
+    puts("==== Results ====")
+    test_cases.each do |test|
+      puts(test.resource.bold)
+
+      if test.reference_profiles.empty?
+        printf("your branch: ".rjust(15)+"%.1fms\n", test.this_latency)
+        next
+      end
+
+      master_latency = sprintf('%.1fms', test.reference_latency)
+      this_latency = sprintf('%.1fms', test.this_latency)
+      difference = sprintf('%+.1fms', test.latency_difference)
+
+      if test.latency_difference < 0
+        change_factor = test.reference_latency / test.this_latency
+      else
+        change_factor = test.this_latency / test.reference_latency
+      end
+      formatted_change = sprintf('%.1fx', change_factor)
+
+      percent_change = 100*(test.latency_difference / test.reference_latency).abs
+      if percent_change < 10
+        formatted_change = "yours is about the same"
+        color = :blue
+      elsif test.latency_difference < 0
+        formatted_change = "yours is #{formatted_change} faster!"
+        color = :green
+      else
+        formatted_change = "yours is #{formatted_change} slower!!!"
+        color = :light_red
+      end
+      formatted_change = difference + " (#{formatted_change})"
+
+      puts("reference: ".rjust(15)  + "#{master_latency}")
+      puts("your branch: ".rjust(15)+ "#{this_latency}")
+      puts(("change: ".rjust(15)    + "#{formatted_change}").bold.send(color))
+
+      print_diff_results(test.response_diff) if options.verify_responses
+    end
+  end
+
+  def print_json_results
+    results = []
+    test_cases.each do |test|
+      results.push(
+        route: test.resource,
+        latency: test.this_latency,
+        query_count: test.this_query_count,
+        requests: []
+      )
+
+      test.this_profiles.each do |profile|
+        results[-1][:requests].push(
+          latency: profile.latency,
+          query_count: profile.query_count,
+          server_memory: profile.server_memory,
+          response_code: profile.response_code,
+          miniprofiler_url: profile.profile_url
+        )
+      end
+
+      if options.reference
+        results[-1].merge!(
+          reference_latency: test.reference_latency,
+          latency_difference: test.latency_difference,
+          speedup_factor: test.reference_latency / test.this_latency,
+          reference_query_count: test.reference_query_count,
+          reference_requests: []
+        )
+
+        test.reference_profiles.each do |profile|
+          results[-1][:reference_requests].push(
+            latency: profile.latency,
+            query_count: profile.query_count,
+            server_memory: profile.server_memory,
+            response_code: profile.response_code,
+            miniprofiler_url: profile.profile_url
+          )
+        end
+      end
+    end
+    puts JSON.pretty_generate(results)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perf_check
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - rubytune
@@ -47,7 +47,12 @@ extra_rdoc_files: []
 files:
 - bin/perf_check
 - lib/perf_check.rb
+- lib/perf_check/callbacks.rb
+- lib/perf_check/config.rb
 - lib/perf_check/git.rb
+- lib/perf_check/logger.rb
+- lib/perf_check/middleware.rb
+- lib/perf_check/output.rb
 - lib/perf_check/railtie.rb
 - lib/perf_check/server.rb
 - lib/perf_check/test_case.rb