gitlab-derailed_benchmarks 1.6.1

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+require "bundler/gem_tasks"
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+

data/bin/derailed

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+unless File.respond_to? :realpath
+  class File #:nodoc:
+    def self.realpath path
+      return realpath(File.readlink(path)) if symlink?(path)
+      path
+    end
+  end
+end
+lib = File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
+$: << lib
+
+
+require File.join(lib, 'derailed_benchmarks.rb')
+
+Bundler.setup
+
+require 'thor'
+
+class DerailedBenchmarkCLI < Thor
+
+  desc "exec", "executes given derailed benchmark"
+  def exec(task = nil)
+    setup_bundler!
+    require 'derailed_benchmarks'
+    require 'rake'
+    Rake::TaskManager.record_task_metadata = true
+    require 'derailed_benchmarks/tasks'
+
+    perf_rakefile = File.expand_path(".", "perf.rake")
+    load perf_rakefile if File.exist?(perf_rakefile)
+
+    if task.nil? || task == "--help"
+      Rake.application.tasks.map do |task, n|
+        next unless task.comment
+        puts "  $ derailed exec #{task.name}  # #{task.comment}"
+      end
+    else
+      task = "perf:#{task}" unless Rake::Task.task_defined?(task)
+      Rake::Task[task].invoke
+    end
+  end
+
+  desc "bundle:objects", "measures objects created by gems"
+  define_method(:"bundle:objects") do |env = "production"|
+    setup_bundler!
+    env = [:default] + env.split(",")
+    puts "Measuring objects created by gems in groups #{ env.inspect }"
+    require 'memory_profiler'
+    report = MemoryProfiler.report do
+      Bundler.require(*env)
+    end
+    report.pretty_print
+  end
+
+  map :"bundler:objects" => :"bundle:objects"
+
+  desc "bundle:mem", "measures memory used by gems at boot time"
+  define_method(:"bundle:mem") do |env = "production"|
+    env = [:default] + env.split(",")
+    require 'get_process_mem'
+    mem    = GetProcessMem.new
+    require 'derailed_benchmarks/core_ext/kernel_require'
+    before = mem.mb
+    setup_bundler!
+    Bundler.require(*env)
+    after  = mem.mb
+    TOP_REQUIRE.print_sorted_children
+  end
+  map :"bundler:mem" => :"bundle:mem"
+
+  private
+    def setup_bundler!
+      ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+      require 'bundler/setup'
+
+      begin
+        if ENV["DERAILED_SKIP_ACTIVE_RECORD"]
+          require "action_controller/railtie"
+          require "action_mailer/railtie"
+          require "sprockets/railtie"
+          require "rails/test_unit/railtie"
+        else
+          require 'rails/all'
+        end
+      rescue LoadError
+      end
+    end
+end
+
+DerailedBenchmarkCLI.start(ARGV)

data/derailed_benchmarks.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'derailed_benchmarks/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gitlab-derailed_benchmarks"
+  gem.version       = DerailedBenchmarks::VERSION
+  gem.authors       = ["Richard Schneeman"]
+  gem.email         = ["richard.schneeman+rubygems@gmail.com"]
+  gem.description   = %q{ Go faster, off the Rails }
+  gem.summary       = %q{ Benchmarks designed to performance test your ENTIRE site }
+  gem.homepage      = "https://github.com/schneems/derailed_benchmarks"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 2.1.0"
+
+  gem.add_dependency "heapy",           "~> 0"
+  gem.add_dependency "memory_profiler", "~> 0"
+  gem.add_dependency "get_process_mem", "~> 0"
+  gem.add_dependency "benchmark-ips",   "~> 2"
+  gem.add_dependency "rack",            ">= 1"
+  gem.add_dependency "rake",            "> 10", "< 14"
+  gem.add_dependency "thor",            ">= 0.19", "< 2"
+  gem.add_dependency "ruby-statistics", ">= 2.1"
+
+  gem.add_development_dependency "capybara",  "~> 2"
+  gem.add_development_dependency "m"
+  gem.add_development_dependency "rails",     "> 3", "<= 7"
+  gem.add_development_dependency "devise",    "> 3", "< 6"
+  gem.add_development_dependency "appraisal", "2.2.0"
+end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.1.0"
+
+group :development, :test do
+  gem "sqlite3", platform: [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.13", platform: :jruby
+  gem "test-unit", "~> 3.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+group :development, :test do
+  gem "sqlite3", platform: [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.13", platform: :jruby
+  gem "test-unit", "~> 3.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "6.0.0"
+
+group :development, :test do
+  gem "sqlite3", platform: [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.13", platform: :jruby
+  gem "test-unit", "~> 3.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_git.gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# $ BUNDLE_GEMFILE="$(pwd)/gemfiles/rails_git.gemfile" bundle exec m test/integration/tasks_test.rb:30
+
+source "https://rubygems.org"
+
+gem "rails", github: "rails/rails", ref: "3054e1d584e7eca110c69a1f8423f2e0866abbf9"
+
+gem 'devise', github: "plataformatec/devise"
+
+group :development, :test do
+  gem "sqlite3", platform: [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.13", platform: :jruby
+  gem "test-unit", "~> 3.0"
+end
+
+gemspec path: "../"
+
+ENV['USING_RAILS_GIT'] = "1"

data/lib/derailed_benchmarks.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'bundler'
+
+require 'get_process_mem'
+
+module DerailedBenchmarks
+  def self.gem_is_bundled?(name)
+    specs = ::Bundler.locked_gems.specs.each_with_object({}) {|spec, hash| hash[spec.name] = spec }
+    specs[name]
+  end
+
+  class << self
+    attr_accessor :auth
+  end
+
+  def self.rails_path_on_disk
+    require 'rails/version'
+    rails_version_file = Rails.method(:version).source_location[0]
+    path = Pathname.new(rails_version_file).expand_path.parent.parent
+
+    while path != Pathname.new("/")
+      basename = path.expand_path.basename.to_s
+
+      break if basename.start_with?("rails") && basename != "railties"
+      path = path.parent
+    end
+    raise "Could not find rails folder on a folder in #{rails_version_file}"  if path == Pathname.new("/")
+    path.expand_path
+  end
+
+  def self.add_auth(app)
+    if use_auth = ENV['USE_AUTH']
+      puts "Auth: #{use_auth}"
+      auth.add_app(app)
+    else
+      app
+    end
+  end
+end
+
+require 'derailed_benchmarks/require_tree'
+require 'derailed_benchmarks/auth_helper'
+
+require 'derailed_benchmarks/stats_in_file'
+require 'derailed_benchmarks/stats_from_dir'
+
+if DerailedBenchmarks.gem_is_bundled?("devise")
+  DerailedBenchmarks.auth = DerailedBenchmarks::AuthHelpers::Devise.new
+end

data/lib/derailed_benchmarks/auth_helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module DerailedBenchmarks
+  # Base helper class. Can be used to authenticate different strategies
+  # The root app will be wrapped by an authentication action
+  class AuthHelper
+    attr_reader   :app
+
+    # Put any coded needed to set up or initialize your authentication module here
+    def setup
+      raise "Must subclass"
+    end
+
+    # Gets called for every request. Place all auth logic here.
+    # Return value is expected to be an valid Rack response array.
+    # If you do not manually `app.call(env)` here, the client app
+    # will never be called.
+    def call(env)
+      raise "Must subclass"
+    end
+
+    # Returns self and sets the target app
+    def add_app(app)
+      raise "App is required argument" unless app
+      @app = app
+      setup
+      self
+    end
+  end
+end
+
+require 'derailed_benchmarks/auth_helpers/devise'

data/lib/derailed_benchmarks/auth_helpers/devise.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DerailedBenchmarks
+  class AuthHelpers
+    # Devise helper for authenticating requests
+    # Setup adds necessarry test methods, user provides a sample user.
+    # The authenticate method is called on every request when authentication is enabled
+    class Devise < AuthHelper
+      attr_writer :user
+
+      # Include devise test helpers and turn on test mode
+      # We need to do this on the class level
+      def setup
+        # self.class.instance_eval do
+          require 'devise'
+          require 'warden'
+          extend ::Warden::Test::Helpers
+          extend ::Devise::TestHelpers
+          Warden.test_mode!
+        # end
+      end
+
+      def user
+        if @user
+          @user = @user.call if @user.is_a?(Proc)
+          @user
+        else
+          password = SecureRandom.hex
+          @user = User.first_or_create!(email: "#{SecureRandom.hex}@example.com", password: password, password_confirmation: password)
+        end
+      end
+
+      # Logs the user in, then call the parent app
+      def call(env)
+        login_as(user)
+        app.call(env)
+      end
+    end
+  end
+end
+

data/lib/derailed_benchmarks/core_ext/kernel_require.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'get_process_mem'
+require 'derailed_benchmarks/require_tree'
+
+ENV['CUT_OFF'] ||= "0.3"
+
+# This file contains classes and monkey patches to measure the amount of memory
+# useage requiring an individual file adds.
+
+# Monkey patch kernel to ensure that all `require` calls call the same
+# method
+module Kernel
+  REQUIRE_STACK = []
+
+  module_function
+
+  alias_method :original_require, :require
+  alias_method :original_require_relative, :require_relative
+
+  def 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)
+    if Pathname.new(file).absolute?
+      require file
+    else
+      require File.expand_path("../#{file}", caller_locations(1, 1)[0].absolute_path)
+    end
+  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.
+  # We then push it onto a stack, this is because requiring a file can
+  # require other files before it is finished.
+  #
+  # When a child file is required, a tree node is created and the child file
+  # is pushed onto the parents tree. We then repeat the process as child
+  # files may require additional files.
+  #
+  # 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 measure_memory_impact(file, &block)
+    mem    = GetProcessMem.new
+    node   = DerailedBenchmarks::RequireTree.new(file)
+
+    parent = REQUIRE_STACK.last
+    parent << node
+    REQUIRE_STACK.push(node)
+    begin
+      before = mem.mb
+      block.call file
+    ensure
+      REQUIRE_STACK.pop # node
+      after = mem.mb
+    end
+    node.cost = after - before
+  end
+end
+
+# Top level node that will store all require information for the entire app
+TOP_REQUIRE = DerailedBenchmarks::RequireTree.new("TOP")
+REQUIRE_STACK.push(TOP_REQUIRE)
+
+class Object
+  private
+
+  def require(path)
+    Kernel.require(path)
+  end
+end
+
+# Don't forget to assign a cost to the top level
+cost_before_requiring_anything = GetProcessMem.new.mb
+TOP_REQUIRE.cost = cost_before_requiring_anything
+def TOP_REQUIRE.print_sorted_children(*args)
+  self.cost = GetProcessMem.new.mb - self.cost
+  super
+end