cookpad-performance 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16ed8a79cc750fdc941bd559af36feda7bff7b54a6deaf36729fc277cf829a37
+  data.tar.gz: 4c004dc7a7965b55802b4011d66477aed68a9a0d5528e227a43684b9170f18f3
+SHA512:
+  metadata.gz: f73325fca388869a266b077f27c7c111309346da0d7e09221e64e7385ad7290b31f9c55fd0d619a0a5c067868afa76c40e07fb9d8b14f1bb3d88cf91fa8c5cc6
+  data.tar.gz: 8292570b2d24a37cd489a0f06b718436ac61dbb0d811ca0e4686f3182c93db84ff68848cac6e2934cdda324e40f0a37875a1652e3cfcfac659230b6dc0f72411

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Gavin Morrice
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Cookpad::Performance
+
+Adds a selection of tools to make performance troubleshooting and profiling easier in development.
+
+## Philosophy
+
+This gem should provide a set of plug-and-play performance monitoring and troubleshooting tools for use in development and test environments.
+
+Each tool should sit behind a feature toggle, and should be explicitly enabled through the use of environment variables.
+
+The gem should not make any changes to the functioning and performance of the application unless a specific feature has explicitly been enabled. This helps us to provide helpful tools that will stay out of your way unless your require them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem "cookpad-performance"
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Included tools
+
+### ActiveRecord query counter
+
+Log the total number of unique queries, cached queries, and async queries at the foot of each request in the Rails application log.
+
+Activate by setting an environment variable called `LOG_DB_QUERY_COUNT=true`.
+
+See [the initializer file](config/initializers/active_record_query_counter.rb) for more information.
+
+### Disable cached query logging
+
+Silence cached ActiveRecord database queries from the Rails application log. Makes it easier to see which unique queries are being executed in the database. 
+
+Activate by setting an environment variable called `DISABLE_CACHED_QUERY_LOGGING=true`.
+
+_Note: This should be used with discretion, to declutter very noisy logs. Cached queries are also expensive and should not be ignored_
+
+See [the initializer file](config/initializers/disable_cached_query_logging.rb) for more information.
+
+### n+1 detection in Rails logs
+
+Receive warnings in the Rails application logs when an n+1 query is detected.
+
+Activate by setting an environment variable called `LOG_N_PLUS_ONE_QUERIES=true`, or `RAISE_N_PLUS_ONE_QUERIES=true` to raise exceptions when an instance is detected.
+
+See [the initializer file](config/initializers/n_plus_one_detection.rb) for more information.
+
+### Profile mode
+
+Run your Rails application in a production-like configuration of the development environment.
+
+Activate by setting an environment variable called `PROFILE=true`.
+
+See [the initializer file](config/initializers/profile_mode.rb) for more information.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: :spec
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/config/initializers/active_record_query_counter.rb

@@ -0,0 +1,15 @@
+if ENV["LOG_DB_QUERY_COUNT"] == "true"
+  require "active_record/query_counter"
+  ActiveSupport::Notifications.subscribe(/sql/, ActiveRecord::QueryCounter.current)
+  ActionController::Base.class_eval do
+    around_action :report_active_record_queries_count
+
+    private
+
+      def report_active_record_queries_count
+        ActiveRecord::QueryCounter.current.reset_counter
+        yield
+        logger.info(ActiveRecord::QueryCounter.current.report_counts)
+      end
+  end
+end

data/config/initializers/disable_cached_query_logging.rb

@@ -0,0 +1,4 @@
+if !Rails.env.production? && ENV["DISABLE_CACHED_QUERY_LOGGING"] == "true"
+  require "cookpad/performance/disable_cached_query_logging"
+  ActiveSupport::Logger.prepend Cookpad::Performance::DisableCachedQueryLogging
+end

data/config/initializers/n_plus_one_detection.rb

@@ -0,0 +1,8 @@
+if (ENV["LOG_N_PLUS_ONE_QUERIES"] == "true" || ENV["RAISE_N_PLUS_ONE_QUERIES"] == "true") &&
+  (Rails.env.development? || Rails.env.test?)
+  require "prosopite"
+  Prosopite.rails_logger = ENV["LOG_N_PLUS_ONE_QUERIES"] == "true"
+  Prosopite.prosopite_logger = true
+  Prosopite.stderr_logger = false
+  Prosopite.raise = ENV["RAISE_N_PLUS_ONE_QUERIES"] == "true"
+end

data/config/initializers/profile_mode.rb

@@ -0,0 +1,34 @@
+if ENV["PROFILE"] == "true" && Rails.env.development?
+  Rails.application.configure do
+    config.cache_classes = true
+    config.eager_load = true
+
+    logger           = ActiveSupport::Logger.new($stdout)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+    config.log_level = :info
+
+    config.active_record.verbose_query_logs = false
+    config.active_record.migration_error = false
+
+    config.public_file_server.enabled = true
+    config.public_file_server.headers = {
+      "Cache-Control" => "max-age=315360000, public",
+      "Expires" => "Tue, 31 Dec 2030 23:55:55 GMT"
+    }
+    config.assets.js_compressor = Uglifier.new(harmony: true)
+    config.assets.compile = false
+    config.assets.digest = true
+    config.assets.debug = false
+
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.action_mailer.perform_caching = true
+
+    config.action_view.cache_template_loading = true
+    config.action_view.annotate_rendered_view_with_filenames = false
+
+    config.log_tags = [:request_id]
+  end
+end

data/lib/active_record/query_counter.rb

@@ -0,0 +1,66 @@
+module ActiveRecord
+  require "active_support/subscriber"
+  class QueryCounter < ActiveSupport::Subscriber
+    PAYLOAD_QUERY_TYPE_KEYS = %i(cached async).freeze
+    private_constant :PAYLOAD_QUERY_TYPE_KEYS
+
+    LOG_TEMPLATE = <<~STRING.chomp.freeze
+      DB query summary: \
+      Unique: %{unique} | \
+      Async: %{async} | \
+      Cached: %{cached} | \
+      Total: %{total}
+    STRING
+    private_constant :LOG_TEMPLATE
+
+    INGORED_QUERY_PREFIXES = [
+      "BEGIN",
+      "COMMIT",
+      "CREATE TABLE",
+      "DROP TABLE",
+      "PRAGMA",
+      "SELECT column_name",
+      "SELECT sqlite_version(*)",
+      "SELECT name FROM sqlite_master",
+      "SELECT sql FROM",
+      "SELECT table_name",
+      "SELECT `schema_migrations`.`version`",
+      "SET  @@SESSION.sql_mode",
+      "SET NAME",
+      "SHOW FULL FIELDS"
+    ].freeze
+    private_constant :INGORED_QUERY_PREFIXES
+
+    def self.current
+      @_current ||= new
+    end
+
+    def sql(event)
+      return if INGORED_QUERY_PREFIXES.detect { |s| event.payload[:sql].start_with?(s) }
+
+      increment_counter(type: type_of_event(event))
+    end
+
+    def reset_counter
+      counter.transform_values! { 0 }
+    end
+
+    def report_counts
+      LOG_TEMPLATE % counter.merge({ total: counter.values.sum })
+    end
+
+    private
+    
+      def counter
+        @_counter ||= Hash.new { |hash, key| hash[key] = 0 }
+      end
+
+      def increment_counter(type:)
+        counter[type] += 1
+      end
+
+      def type_of_event(event)
+        PAYLOAD_QUERY_TYPE_KEYS.detect { |key| event.payload[key] } || :unique
+      end
+  end
+end

data/lib/cookpad/performance/disable_cached_query_logging.rb

@@ -0,0 +1,13 @@
+module Cookpad
+  module Performance
+    module DisableCachedQueryLogging
+      CACHE_REGEXP = /\[36mCACHE\s[\w:]+\s(Load|Pluck)+/.freeze
+
+      def add(severity, message = nil, progname = nil, &block)
+        super if progname.nil? || !progname&.match?(CACHE_REGEXP)
+
+        # :noop:
+      end
+    end
+  end
+end

data/lib/cookpad/performance/engine.rb

@@ -0,0 +1,15 @@
+module Cookpad
+  module Performance
+    class Engine < ::Rails::Engine
+      isolate_namespace Cookpad::Performance
+
+      config.to_prepare do
+        if !Rails.env.production? &&
+           (ENV["LOG_N_PLUS_ONE_QUERIES"] == "true" ||
+             ENV["RAISE_N_PLUS_ONE_QUERIES"] == "true")
+          ActionController::Base.include(NPlusOneDetection)
+        end
+      end
+    end
+  end
+end

data/lib/cookpad/performance/version.rb

@@ -0,0 +1,5 @@
+module Cookpad
+  module Performance
+    VERSION = "0.2.1".freeze
+  end
+end

data/lib/cookpad/performance.rb

@@ -0,0 +1,8 @@
+require "rails"
+require "cookpad/performance/version"
+require "cookpad/performance/engine"
+
+module Cookpad
+  module Performance
+  end
+end

data/lib/cookpad-performance.rb

@@ -0,0 +1 @@
+require "cookpad/performance"

metadata

@@ -0,0 +1,256 @@
+--- !ruby/object:Gem::Specification
+name: cookpad-performance
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Bodacious
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prosopite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pronto-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Provides a set of performance tools for our Rails apps
+email:
+- gavin@gavinmorrice.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/initializers/active_record_query_counter.rb
+- config/initializers/disable_cached_query_logging.rb
+- config/initializers/n_plus_one_detection.rb
+- config/initializers/profile_mode.rb
+- lib/active_record/query_counter.rb
+- lib/cookpad-performance.rb
+- lib/cookpad/performance.rb
+- lib/cookpad/performance/disable_cached_query_logging.rb
+- lib/cookpad/performance/engine.rb
+- lib/cookpad/performance/version.rb
+homepage: https://github.com/cookpad/cookpad-performance
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cookpad/cookpad-performance
+  source_code_uri: https://github.com/cookpad/cookpad-performance
+  changelog_uri: https://github.com/cookpad/cookpad-performance/blob/main/CHANGELOG
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.8
+signing_key: 
+specification_version: 4
+summary: Rails app performance tools
+test_files: []