Implement line profiler and rack profiler

Author: rosylilly

.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
     - '**/*.gemspec'
   Exclude:
     - 'bin/**/*'
+    - 'example/**/*'
     - 'vendor/bundle/**/*'
     - 'node_modules/**/*'
   TargetRubyVersion: 2.3

lib/rack/speed_gun.rb

@@ -0,0 +1,56 @@
+require 'rack'
+require 'speed_gun'
+require 'speed_gun/profiler/rack_profiler'
+require 'speed_gun/profiler/line_profiler'
+
+class Rack::SpeedGun
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    return @app.call(env) unless SpeedGun.config.enabled?
+
+    SpeedGun.current_report = SpeedGun::Report.new
+
+    SpeedGun::Profiler::RackProfiler.profile(env['PATH_INFO'], rack: rack_info(env), request: request_info(env)) do |event|
+      res = SpeedGun::Profiler::LineProfiler.profile { @app.call(env) }
+      event.payload[:response] = {
+        status: res[0],
+        headers: res[1]
+      }
+      res
+    end
+  ensure
+    #p SpeedGun.current_report
+    SpeedGun.current_report = nil
+  end
+
+  private
+
+  def rack_info(env)
+    {
+      version: env['rack.version'],
+      url_scheme: env['rack.url_scheme']
+    }
+  end
+
+  def request_info(env)
+    {
+      method: env['REQUEST_METHOD'],
+      path: env['PATH_INFO'],
+      headers: request_headers(env),
+      query: Rack::Utils.parse_query(env['QUERY_STRING'])
+    }
+  end
+
+  def request_headers(env)
+    headers = {}
+    env.each_pair do |key, val|
+      if key.start_with?('HTTP_')
+        headers[key[5..-1].split('_').map(&:capitalize).join('-')] = val
+      end
+    end
+    headers
+  end
+end

lib/speed_gun.rb

@@ -1,3 +1,34 @@
 # frozen_string_literal: true
 require 'speed_gun/version'
+require 'speed_gun/config'
 require 'speed_gun/report'
+require 'rack/speed_gun'
+require 'speed_gun/railtie' if defined?(::Rails)
+
+module SpeedGun
+  class << self
+    # @return [SpeedGun::Config]
+    def config
+      @config ||= SpeedGun::Config.new
+    end
+
+    # @yield [config] Configure speed gun
+    # @yieldparam config [SpeedGun::Config]
+    def configure
+      yield config
+    end
+
+    # @return [SpeedGun::Report, nil]
+    def current_report
+      Thread.current[:speed_gun_report]
+    end
+
+    def current_report=(report)
+      Thread.current[:speed_gun_report] = report
+    end
+
+    def record(event)
+      current_report && current_report.record(event)
+    end
+  end
+end

lib/speed_gun/config.rb

@@ -0,0 +1,21 @@
+require 'speed_gun'
+
+class SpeedGun::Config
+  DEFAULT_PREFIX = '/speed_gun'
+
+  # @return [Boolean] Enabled SpeedGun
+  attr_accessor :enabled
+
+  # @return [String] Console and API endpoint prefix
+  attr_accessor :prefix
+
+  def initialize
+    @enabled = true
+    @prefix = DEFAULT_PREFIX
+  end
+
+  # @return [Boolean] Enabled SpeedGun
+  def enabled?
+    enabled
+  end
+end

lib/speed_gun/event.rb

@@ -0,0 +1,31 @@
+require 'securerandom'
+require 'speed_gun'
+
+class SpeedGun::Event
+  # @return [String] Event ID
+  attr_reader :id
+  # @return [String] Event name
+  attr_reader :name
+  # @return [Hash] Event payload
+  attr_reader :payload
+  # @return [Time] Started time of event
+  attr_reader :started_at
+  # @return [Time, nil] Finished time of event
+  attr_reader :finished_at
+
+  def initialize(name, payload = {}, started_at = Time.now, finished_at = nil)
+    @id = SecureRandom.uuid
+    @name = name.to_s
+    @payload = payload
+    @started_at = started_at
+    @finished_at = finished_at
+  end
+
+  def finish!
+    @finished_at = Time.now
+  end
+
+  def duration
+    finished_at ? finished_at.to_f - started_at.to_f : 0
+  end
+end

lib/speed_gun/profiler.rb

@@ -0,0 +1,20 @@
+require 'speed_gun'
+require 'speed_gun/event'
+
+class SpeedGun::Profiler
+  def self.profile(*args, &block)
+    new.profile(*args, &block)
+  end
+
+  def profile(name = self.class.name, payload = {}, &block)
+    started_at = Time.now
+
+    event = SpeedGun::Event.new(name, payload, started_at)
+    result = yield(event)
+    event.finish!
+
+    SpeedGun.record(event)
+
+    result
+  end
+end

lib/speed_gun/profiler/line_profiler.rb

@@ -0,0 +1,24 @@
+require 'rblineprof'
+require 'speed_gun/source'
+require 'speed_gun/profiler'
+
+class SpeedGun::Profiler::LineProfiler < SpeedGun::Profiler
+  def profile(*args, &block)
+    result = nil
+    lineprofiled = lineprof(/./) do
+      result = yield
+    end
+    store(lineprofiled) if SpeedGun.current_report
+    result
+  end
+
+  def store(lineprofiled)
+    lineprofiled.each_pair do |file, linesamples|
+      SpeedGun.current_report.sources.push(SpeedGun::Source.new(file, linesamples))
+    end
+
+    puts SpeedGun.current_report.sources.select { |source|
+      source.file.end_with?('posts_controller.rb')
+    }.first.to_s
+  end
+end

lib/speed_gun/profiler/rack_profiler.rb

@@ -0,0 +1,4 @@
+require 'speed_gun/profiler'
+
+class SpeedGun::Profiler::RackProfiler < SpeedGun::Profiler
+end

lib/speed_gun/railtie.rb

@@ -0,0 +1,9 @@
+require 'speed_gun'
+require 'rack/speed_gun'
+require 'rails/railtie'
+
+class SpeedGun::Railtie < ::Rails::Railtie
+   initializer 'speed_gun' do |app|
+    app.middleware.insert(0, Rack::SpeedGun)
+  end
+end

lib/speed_gun/report.rb

@@ -17,4 +17,8 @@ def initialize
     @sources = []
     @events = []
   end
+
+  def record(event)
+    @events.push(event)
+  end
 end

lib/speed_gun/source.rb

@@ -0,0 +1,32 @@
+require 'speed_gun'
+
+class SpeedGun::Source
+  Line = Struct.new(:line, :code, :wall, :cpu, :calls, :allocations) do
+    def to_s
+      format("% 8.1fms + % 8.1fms (% 5d) % 5d allocs | %04d %s", cpu / 1000.0, (wall-cpu) / 1000.0, calls, allocations, line, code)
+    end
+  end
+
+  attr_reader :file, :lines
+
+  def initialize(file, linesamples)
+    @file = file
+    @lines = []
+    analyze(file, linesamples)
+  end
+
+  def analyze(file, linesamples)
+    code_lines = File.exists?(file) ? File.readlines(file) : []
+
+    code_lines.each_with_index do |line, idx|
+      sample = linesamples[idx + 1] || [0, 0, 0, 0]
+      wall, cpu, calls, allocations = *sample
+
+      @lines.push(Line.new(idx + 1, line, wall, cpu, calls, allocations))
+    end
+  end
+
+  def to_s
+    "#{file}====\n#{lines.map(&:to_s).join("")}"
+  end
+end

lib/speed_gun/version.rb

@@ -4,6 +4,7 @@
 module SpeedGun
   VERSION = '2.0.0-alpha.1'
 
+  # @return [Semantic::Version] Version
   def self.version
     @version ||= Semantic::Version.new(VERSION)
   end

speed_gun.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'semantic', '~> 1.4'
+  spec.add_dependency 'rblineprof', '~> 0.3'
+  spec.add_dependency 'rack', '~> 1.6'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 11.0'