spring_onion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cfc3f0d5560a94e94ae9e4c0e4801b9a9a02e4fd9b5bb74b6b59d9569a6d8613
+  data.tar.gz: 1d12d7b4b1e984eb1b9c0383b0a82a49f79ee5d47e5ccb12b342a0182dda572d
+SHA512:
+  metadata.gz: 0eff35cb7949993b9161dae0d4d89b3714d513e8b6a80272c214e8a19d4b56381382fc52640773c324d896e0f7f2d9ea50ff992306cf6272506334d3f0ab5dbe
+  data.tar.gz: 1fcd2d6d57328bc7272cdff88626fd9396837faad035b6c5f1377687a97d502ea357798889b6011d6dcb68e59ad03b112ee08bb27ea7a3aceb2ce313fd074872

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Appraisal Gemfile.lock
+/gemfiles/*.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,63 @@
+AllCops:
+  Exclude:
+    - "gemfiles/**/*"
+  TargetRubyVersion: 2.5
+Style/Documentation:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArrayCoercion:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.2

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spring_onion.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    spring_onion (0.1.0)
+      activerecord
+      mysql2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.1)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    mysql2 (0.5.3)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+  spring_onion!
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 winebarrel
+
+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,77 @@
+# SpringOnion
+
+Log MySQL queries with EXPLAIN that may be slow.
+Inspired by [MySQLCasualLog.pm](https://gist.github.com/kamipo/839e8a5b6d12bddba539).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spring_onion'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install spring_onion
+
+## Usage
+
+```ruby
+#!/usr/bin/env ruby
+require 'active_record'
+require 'spring_onion'
+require 'logger'
+
+ActiveRecord::Base.establish_connection(
+  adapter:  'mysql2',
+  username: 'root',
+  database: 'employees',
+)
+
+SpringOnion.enabled = true
+SpringOnion.connection = ActiveRecord::Base.connection.raw_connection
+SpringOnion.source_filter_re = //
+
+class Employee < ActiveRecord::Base; end
+
+Employee.all.to_a.count
+#=> SpringOnion	INFO	2020-07-18 01:53:27 +0900	{"sql":"SELECT `employees`.* FROM `employees`","explain":[{"line":1,"select_type":"SIMPLE","table":"employees","partitions":null,"type":"ALL","possible_keys":null,"key":null,"key_len":null,"ref":null,"rows":298936,"filtered":100.0,"Extra":null}],"violations":{"line 1":["slow_type"]},"backtrace":["/foo/bar/zoo/baz.rb:18:in `\u003ctop (required)\u003e'"]}
+#=> 300024
+```
+
+## Log Output
+
+```json
+{
+    "sql": "SELECT `employees`.* FROM `employees`",
+    "explain": [
+        {
+            "line": 1,
+            "select_type": "SIMPLE",
+            "table": "employees",
+            "partitions": null,
+            "type": "ALL",
+            "possible_keys": null,
+            "key": null,
+            "key_len": null,
+            "ref": null,
+            "rows":298936,
+            "filtered": 100.0,
+            "Extra": null
+        }
+    ],
+    "violations": {
+        "line 1": [
+            "slow_type"
+        ]
+    },
+    "backtrace": [
+        "/foo/bar/zoo/baz.rb:18:in `\u003ctop (required)\u003e'"
+    ]
+}
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/spring_onion.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'active_support'
+
+require 'spring_onion/config'
+require 'spring_onion/error'
+require 'spring_onion/explainer'
+require 'spring_onion/version'
+
+ActiveSupport.on_load :active_record do
+  require 'active_record/connection_adapters/abstract_mysql_adapter'
+  ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.prepend SpringOnion::Explainer
+end

data/lib/spring_onion/config.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module SpringOnion
+  SLOW_SELECT_TYPE_RE = Regexp.union(
+    'DEPENDENT UNION',
+    'DEPENDENT SUBQUERY',
+    'UNCACHEABLE UNION',
+    'UNCACHEABLE SUBQUERY'
+  )
+
+  SLOW_TYPE_RE = Regexp.union('index', 'ALL')
+  SLOW_POSSIBLE_KEYS_RE = Regexp.union('NULL')
+  SLOW_KEY_RE = Regexp.union('NULL')
+
+  SLOW_EXTRA_RE = Regexp.union(
+    'Using filesort',
+    'Using temporary'
+  )
+
+  @violations = {
+    slow_select_type: ->(exp) { SLOW_SELECT_TYPE_RE =~ exp['select_type'] },
+    slow_type: ->(exp) { SLOW_TYPE_RE =~ exp['type'] },
+    slow_possible_keys: ->(exp) { SLOW_POSSIBLE_KEYS_RE =~ exp['possible_keys'] },
+    slow_key: ->(exp) { SLOW_KEY_RE =~ exp['key'] },
+    slow_extra: ->(exp) { SLOW_EXTRA_RE =~ exp['Extra'] },
+  }
+
+  @enabled = ENV.fetch('SPRING_ONION_ENABLED', '') =~ /\A(1|true)\z/i
+
+  @sql_filter_re = if ENV.fetch('SPRING_ONION_SQL_FILTER_RE', '').empty?
+                     //
+                   else
+                     Regexp.new(ENV['SPRING_ONION_SQL_FILTER_RE'])
+                   end
+
+  @ignore_sql_filter_re = Regexp.union(
+    /\binformation_schema\b/,
+    *(ENV.fetch('SPRING_ONION_IGNORE_SQL_FILTER_RE', '').empty? ? nil : Regexp.new(ENV['SPRING_ONION_IGNORE_SQL_FILTER_RE']))
+  )
+
+  @sql_filter = lambda do |sql|
+    @ignore_sql_filter_re !~ sql && @sql_filter_re =~ sql
+  end
+
+  @source_filter_re = Regexp.union(
+    %r{/app/},
+    *(ENV.fetch('SPRING_ONION_SOURCE_FILTER_RE', '').empty? ? nil : Regexp.new(ENV['SPRING_ONION_SOURCE_FILTER_RE']))
+  )
+
+  @ignore_source_filter_re = Regexp.union(
+    Regexp.union(RbConfig::TOPDIR, *Gem.path),
+    *(ENV.fetch('SPRING_ONION_IGNORE_SOURCE_FILTER_RE', '').empty? ? nil : Regexp.new(ENV['SPRING_ONION_IGNORE_SOURCE_FILTER_RE']))
+  )
+
+  @source_filter = lambda do |backtrace_lines|
+    backtrace_lines.grep_v(@ignore_source_filter_re).grep(@source_filter_re)
+  end
+
+  @logger = Logger.new($stdout).tap do |logger|
+    logger.formatter = lambda { |severity, datetime, _progname, msg|
+      "\n#{self}\t#{severity}\t#{datetime}\t#{msg}\n"
+    }
+  end
+
+  @trace_len = 3
+
+  class << self
+    attr_accessor :enabled,
+                  :connection,
+                  :violations,
+                  :sql_filter_re, :ignore_sql_filter_re, :sql_filter,
+                  :source_filter_re, :ignore_source_filter_re, :source_filter,
+                  :logger,
+                  :trace_len
+  end
+end

data/lib/spring_onion/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SpringOnion
+  class Error < StandardError
+  end
+end

data/lib/spring_onion/explainer.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SpringOnion
+  module Explainer
+    def execute(*args)
+      _with_explain(args.first) do
+        super
+      end
+    end
+
+    def _with_explain(sql)
+      begin
+        if SpringOnion.enabled && sql =~ /^SELECT\b/ && SpringOnion.sql_filter.call(sql)
+          trace = SpringOnion.source_filter.call(caller)
+
+          unless trace.length.zero?
+            conn = SpringOnion.connection
+            raise SpringOnion::Error, 'MySQL connection is not set' unless conn
+
+            exp = conn.query("EXPLAIN #{sql}", as: :hash).to_a
+            exp.each { |r| r.delete('id') }
+            _validate(exp, sql, trace)
+          end
+        end
+      rescue StandardError => e
+        SpringOnion.logger.error(e)
+      end
+
+      yield
+    end
+
+    def _validate(exp, sql, trace)
+      violations = SpringOnion.violations
+      violation_names_by_line = {}
+
+      exp.each_with_index do |row, i|
+        violation_names = violations.select do |_name, validator|
+          validator.call(row)
+        end.keys
+
+        violation_names_by_line["line #{i + 1}"] = violation_names unless violation_names.empty?
+      end
+
+      return if violation_names_by_line.empty?
+
+      SpringOnion.logger.info({
+        sql: sql,
+        explain: exp.each_with_index.map { |r, i| { line: i + 1 }.merge(r) },
+        violations: violation_names_by_line,
+        backtrace: trace.slice(0, SpringOnion.trace_len),
+      }.to_json)
+    end
+  end
+end

data/lib/spring_onion/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SpringOnion
+  VERSION = '0.1.0'
+end

data/spring_onion.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/spring_onion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'spring_onion'
+  spec.version       = SpringOnion::VERSION
+  spec.authors       = ['winebarrel']
+  spec.email         = ['sugawara@winebarrel.jp']
+
+  spec.summary       = 'Log MySQL queries with EXPLAIN that may be slow.'
+  spec.description   = 'Log MySQL queries with EXPLAIN that may be slow.'
+  spec.homepage      = 'https://github.com/winebarrel/spring_onion'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'mysql2'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: spring_onion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- winebarrel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: mysql2
+  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: appraisal
+  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: bundler
+  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: rake
+  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: rspec
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Log MySQL queries with EXPLAIN that may be slow.
+email:
+- sugawara@winebarrel.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spring_onion.rb
+- lib/spring_onion/config.rb
+- lib/spring_onion/error.rb
+- lib/spring_onion/explainer.rb
+- lib/spring_onion/version.rb
+- spring_onion.gemspec
+homepage: https://github.com/winebarrel/spring_onion
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Log MySQL queries with EXPLAIN that may be slow.
+test_files: []