arproxy-plugin-mysql_casual_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce505a834c6485baec733aa14d3e3a79c1b452ec
+  data.tar.gz: 12a3ddb2958602d8bee4c7f027ecd53b0df2fa69
+SHA512:
+  metadata.gz: 084e9db772cb7a63b5f46821569346f50e8f7ab88caafe1e98ae1a27138b37a0ef8450e600630b460084f81c872c5a4b2da41251ec1d726e050340d0e525a87f
+  data.tar.gz: 23d5095d4a2eb537558ee706a8055e11d6682412e7c12aa9e38519dbd8cd20b1fd91d4604add1f9d359f716b4c8002df078a8a6cf254000a23f0c50770a584bf

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.1
+script:
+  - bundle install
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in arproxy-plugin-casual_log.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Genki Sugawara
+
+MIT License
+
+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,34 @@
+# Arproxy::Plugin::MysqlCasualLog
+
+Plug-in that colorize MySQL bad query for [Arproxy](https://github.com/cookpad/arproxy).
+It is porting of [MySQLCasualLog.pm](https://gist.github.com/kamipo/839e8a5b6d12bddba539).
+
+see http://kamipo.github.io/talks/20140711-mysqlcasual6
+
+[![Gem Version](https://badge.fury.io/rb/arproxy-plugin-mysql_casual_log.svg)](http://badge.fury.io/rb/arproxy-plugin-mysql_casual_log)
+[![Build Status](https://travis-ci.org/winebarrel/arproxy-plugin-mysql_casual_log.svg?branch=master)](https://travis-ci.org/winebarrel/arproxy-plugin-mysql_casual_log)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arproxy-plugin-mysql_casual_log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arproxy-plugin-mysql_casual_log
+
+## Usage
+
+```ruby
+Arproxy.configure do |config|
+   config.adapter = "mysql2"
+  config.plugin :mysql_casual_log
+end
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+task :default => :spec

data/arproxy-plugin-mysql_casual_log.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "arproxy-plugin-mysql_casual_log"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Genki Sugawara"]
+  spec.email         = ["sugawara@cookpad.com"]
+  spec.summary       = %q{Plug-in that colorize MySQL bad query for Arproxy.}
+  spec.description   = %q{Plug-in that colorize MySQL bad query for Arproxy.}
+  spec.homepage      = "https://github.com/winebarrel/arproxy-plugin-mysql_casual_log"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "arproxy", "~> 0.2.0"
+  spec.add_dependency "mysql2"
+  spec.add_dependency "term-ansicolor"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
+end

data/lib/arproxy/plugin/mysql_casual_log.rb

@@ -0,0 +1,115 @@
+require "arproxy"
+require "mysql2"
+require "term/ansicolor"
+
+module Arproxy::Plugin
+  class MysqlCasualLog < Arproxy::Base
+    Arproxy::Plugin.register(:mysql_casual_log, self)
+
+    REGEXPS = {
+      'select_type' => Regexp.union(
+        /DEPENDENT\sUNION/,
+        /DEPENDENT\sSUBQUERY/,
+        /UNCACHEABLE\sUNION/,
+        /UNCACHEABLE\sSUBQUERY/
+      ),
+      'type' =>  Regexp.union(
+        /index/,
+        /ALL/
+      ),
+      'possible_keys' => Regexp.union(
+        /NULL/
+      ),
+      'key' => Regexp.union(
+        /NULL/
+      ),
+      'Extra' => Regexp.union(
+        /Using\sfilesort/,
+        /Using\stemporary/
+      )
+    }
+
+    def initialize(*args)
+      @options = args.first || {}
+      @out = @options[:out] || $stdout
+      @raw_connection = @options[:raw_connection] || proc {|conn, sql| conn.raw_connection }
+    end
+
+    def execute(sql, name=nil)
+      if sql =~ /\ASELECT\b/i
+        proxy(sql)
+      end
+
+      super(sql, name)
+    end
+
+    private
+
+    def proxy(sql)
+      if @raw_connection.respond_to?(:call)
+        conn = @raw_connection.call(proxy_chain.connection, sql)
+      else
+        conn = @raw_connection
+      end
+
+      if conn
+        explain(conn, sql)
+      end
+    end
+
+    def explain(conn, sql)
+      badquery = false
+      explains = []
+
+      conn.query("EXPLAIN #{sql}", :as => :hash).each_with_index do |result, i|
+        colorize_explain(result).tap {|bq| badquery ||= bq }
+        explains << format_explain(result, i + 1)
+      end
+
+      if badquery
+        query_options = conn.query_options.dup
+        query_options.delete(:password)
+
+        @out << <<-EOS
+# Time: #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}
+# Query options: #{query_options.inspect}
+# Query: #{sql}
+#{explains.join("\n")}
+        EOS
+      end
+    rescue => e
+      $stderr.puts colored([e.message, e.backtrace.first].join("\n"))
+    end
+
+    def colorize_explain(explain_result)
+      badquery = false
+
+      REGEXPS.each do |key, regexp|
+        value = explain_result[key] ||= 'NULL'
+        value = value.to_s
+
+        value.gsub!(regexp) do |m|
+          badquery = true
+          colored(m)
+        end
+      end
+
+      badquery
+    end
+
+    def colored(str)
+      Term::ANSIColor.red(Term::ANSIColor.bold(str))
+    end
+
+    def format_explain(explain, i)
+      message = "*************************** #{i}. row ***************************\n"
+      max_key_length = explain.keys.map(&:length).max
+
+      explain.each do |key, value|
+        message << "%*s: %s\n" % [max_key_length, key, value]
+      end
+
+      message.chomp
+    end
+  end # CasualLog
+end # Arproxy::Plugin

data/spec/arproxy-plugin-mysql_casual_log_spec.rb

@@ -0,0 +1,68 @@
+describe Arproxy::Plugin::MysqlCasualLog do
+  before do
+    allow_any_instance_of(Arproxy::Base).to receive(:execute)
+  end
+
+  let(:today) { Time.parse("2015-05-15 20:15:55 +0000") }
+  let(:out) { StringIO.new }
+
+  let(:raw_connection) do
+    Mysql2::Client.new(host: "localhost", username: "root", database: "mysql")
+  end
+
+  let(:plugin) do
+    Arproxy::Plugin::MysqlCasualLog.new(out: out, raw_connection: raw_connection)
+  end
+
+  describe "#initialize" do
+    describe "@out" do
+      subject { plugin.instance_variable_get(:@out) }
+      it { is_expected.to eq out }
+    end
+
+    describe "@raw_connection" do
+      subject { plugin.instance_variable_get(:@raw_connection) }
+      it { is_expected.to eq raw_connection }
+    end
+  end
+
+  describe "#execute" do
+    subject { out.string.sub(/Query options:.*/, "Query options:").sub(/rows: \d+/, "rows:") }
+
+    before do
+      Timecop.freeze(today) do
+        plugin.execute(sql)
+      end
+    end
+
+    context "when bad query" do
+      let(:sql) { "select * from user" }
+
+      let(:explain) do
+        <<-EOS
+# Time: 2015-05-15 20:15:55
+# Query options:
+# Query: select * from user
+*************************** 1. row ***************************
+           id: 1
+  select_type: SIMPLE
+        table: user
+         type: #{red bold "ALL"}
+possible_keys: #{red bold "NULL"}
+          key: #{red bold "NULL"}
+      key_len:\s
+          ref:\s
+         rows:
+        Extra:\s
+        EOS
+      end
+
+      it { is_expected.to eq explain }
+    end
+
+    context "when bad query" do
+      let(:sql) { "select 1 from user where Host = 'localhost'" }
+      it { is_expected.to eq "" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "arproxy/plugin/mysql_casual_log"
+require "stringio"
+require "time"
+require "timecop"
+
+ENV["TZ"] = "UTC"
+include Term::ANSIColor

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: arproxy-plugin-mysql_casual_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Genki Sugawara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: arproxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.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: term-ansicolor
+  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: 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: timecop
+  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: Plug-in that colorize MySQL bad query for Arproxy.
+email:
+- sugawara@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arproxy-plugin-mysql_casual_log.gemspec
+- lib/arproxy/plugin/mysql_casual_log.rb
+- spec/arproxy-plugin-mysql_casual_log_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/winebarrel/arproxy-plugin-mysql_casual_log
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Plug-in that colorize MySQL bad query for Arproxy.
+test_files:
+- spec/arproxy-plugin-mysql_casual_log_spec.rb
+- spec/spec_helper.rb