rdavila-query_reviewer 0.1.0

data/lib/query_reviewer/views/_explain.rhtml

@@ -0,0 +1,30 @@
+<table class="explain">
+	<thead>
+	<tr>
+		<th>table</th>
+		<th>select_type</th>
+		<th>type</th>
+		<th>extra</th>
+		<th>possible_keys</th>
+		<th>key</th>
+    <th>key length</th>
+    <th>ref</th>
+		<th>rows</th>
+	</tr>
+	</thead>
+	<tbody>
+	<% query.subqueries.each do |subquery| %>
+	<tr>
+		<td title="<%= h subquery.table %>"><%= h subquery.table %></td>
+		<td title="<%= h subquery.select_type %>"><%= h subquery.select_type %></td>
+		<td title="<%= h subquery.query_type %>"><%= h subquery.query_type %></td>
+		<td title="<%= h subquery.extra %>"><%= h subquery.extra %></td>
+		<td title="<%= h subquery.possible_keys %>"><%= h subquery.possible_keys %></td>
+		<td title="<%= h subquery.key %>"><%= h subquery.key %></td>
+    <td title="<%= h subquery.key_len %>"><%= h subquery.key_len %></td>  
+    <td title="<%= h subquery.ref %>"><%= h subquery.ref %></td>
+		<td title="<%= h subquery.rows %>"><%= h subquery.rows %></td>
+	</tr>
+	<% end %>
+	</tbody>
+</table>

data/lib/query_reviewer/views/_profile.rhtml

@@ -0,0 +1,26 @@
+<table>
+	<thead>
+	<tr>
+		<th>stage</th>
+		<th>duration</th>
+		<th>user cpu</th>
+		<th>context switches</th>
+		<th>block ops</th>
+		<th>messages</th>
+		<th>page faults</th>
+	</tr>
+	</thead>
+	<tbody>
+	<% query.profile.each do |profile| %>
+	<tr>
+		<td title="<%= h profile.Status %>"><%= h profile.Status %></td>
+		<td title="<%= h profile.Duration %> seconds"><%= h("%.4f" % profile.Duration.to_f) %>s</td>
+		<td title="USER: <%= profile.CPU_user.to_f %>s  SYSTEM: <%= profile.CPU_system.to_f %>s"><%= h("%.4f" % profile.CPU_user.to_f) %>s</td>
+		<td title="Voluntary: <%= h profile.Context_voluntary %>  Involuntary: <%= h profile.Context_involuntary %>"><%= h(profile.Context_voluntary.to_i + profile.Context_involuntary.to_i) %></td>
+		<td title="Ops in: <%= h profile.Block_ops_in %>  Ops out: <%= h profile.Block_ops_out %>"><%= h(profile.Block_ops_in.to_i + profile.Block_ops_out.to_i) %></td>
+		<td title="Sent: <%= h profile.Messages_sent %>  Received: <%= h profile.Messages_received %>"><%= h(profile.Messages_sent.to_i + profile.Messages_received.to_i) %></td>
+    <td title="Major: <%= h profile.Page_faults_major %>  Minor: <%= h profile.Page_faults_minor %>"><%= h profile.Page_faults_major %></td>
+	<tr>
+	<% end %>
+	</tbody>
+</table>

data/lib/query_reviewer/views/_query_sql.rhtml

@@ -0,0 +1,8 @@
+<span id="query_plain_sql_<%= query_sql.id %>" style="display: none;">
+  <%= syntax_highlighted_sql(query_sql.sql) %> 
+  <% if query_sql.respond_to?(:subqueries) && query_sql.subqueries.length > 1 %>
+  <% end %>
+</span>
+<span id="query_sanitized_sql_<%= query_sql.id %>">
+  <%= syntax_highlighted_sql(query_sql.sanitized_sql) if query_sql.sanitized_sql %>
+</span>

data/lib/query_reviewer/views/_query_trace.rhtml

@@ -0,0 +1,31 @@
+<div class="trace" id="trace_<%= query_id %>_abridged">
+<code>
+    <% query_trace[0..(QueryReviewer::CONFIGURATION["stack_trace_lines"] - 1)].compact.each do |c| %>
+      <% if c.match(/:.*:/) %>
+        <% file = h(c.slice(0..(c.index(":", c.index(":")+1)-1))) %>
+        <span><%= file.split("/")[0..-2].join("/") %>/</span><span class="bold"><%= file.split("/").last %></span>
+        <br/>
+        <span class="indent"><%= h(c.slice((c.index(":", c.index(":")+1)+1)..-1)) %></span><br/>
+      <% else %>
+          <span><%= h c %></span><br/>
+      <% end  %>
+    <% end %>
+</code>
+<a href="javascript: query_review_toggle('trace_<%= query_id %>_abridged'); query_review_toggle('trace_<%= query_id %>_full')" title="show full trace">FULL</a>
+</div>
+
+<div class="trace" style="display: none; max-height: 300px; overflow: scroll" id="trace_<%= query_id %>_full">
+<code>
+	<% full_trace.compact.each do |c| %>
+    <% if c.match(/:.*:/) %>
+      <% file = h(c.slice(0..(c.index(":", c.index(":")+1)-1))) %>
+      <span><%= file.split("/")[0..-2].join("/") %>/</span><span class="bold"><%= file.split("/").last %></span>
+      <br/>
+      <span class="indent"><%= h(c.slice((c.index(":", c.index(":")+1)+1)..-1)) %></span><br/>
+    <% else %>
+        <span><%= h c %></span><br/>
+    <% end  %>
+  <% end %>
+</code>
+<a href="javascript: query_review_toggle('trace_<%= query_id %>_abridged'); query_review_toggle('trace_<%= query_id %>_full')" title="show short trace">SHORT</a>
+</div>

data/lib/query_reviewer/views/_query_with_warning.rhtml

@@ -0,0 +1,54 @@
+<li id="query_<%= query_with_warning.id %>">
+	<div>
+		<%= render :partial => "/spectrum", :locals => {:severity => query_with_warning.max_severity} %>
+    <% if QueryReviewer::CONFIGURATION["production_data"] %>
+      <div style="float: left; padding-right: 5px;">
+        <%= duration_with_color(query_with_warning) %>s
+      </div>
+    <% end %>
+    <p>
+      <% if query_with_warning.count > 1 %>
+        <b title="<%= query_with_warning.count %> queries were executed with the same stack trace and similar SQL structure">
+            <%= query_with_warning.count  %> identical queries
+        </b>
+      <% end %>
+      <i>Table <%= (query_with_warning.warnings.detect {|w| !w.table.blank? } || query_with_warning.warnings.last).table %>:</i>
+			<% query_with_warning.warnings.sort{|a,b| a.severity <=> b.severity}.reverse.each_with_index do |warn, index| %>
+				<span style="color: <%= severity_color warn.severity%>;" title="<%= warn.desc%>"><%= warn.problem %></span><%= ", " if index < query_with_warning.warnings.length - 1 %>
+			<% end %>
+			<a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_desc')" title="show/hide warning message">MSG</a>
+			<a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_sql')" title="show/hide sql">SQL</a>
+      <% if query_with_warning.select? %>
+      	<a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_explain')" title="show/hide explain output">EXPLN</a>
+      <% end %>
+      <% if QueryReviewer::CONFIGURATION["profiling"] && query_with_warning.profile %>
+  			<a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_profile')" title="show/hide profile output">PROF</a>
+      <% end %>
+      <a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_trace')" title="show/hide stack trace">TRACE</a>
+			<% if ignore_hash?(query_with_warning.to_hash) %>
+				<a href="javascript: remove_ignore_hash('<%= query_with_warning.to_hash %>'); query_review_hide('query_<%= query_with_warning.id %>')" title="stop ignore this query from now on">UNIGNR</a>
+			<% else %>
+				<a href="javascript: add_ignore_hash('<%= query_with_warning.to_hash %>'); query_review_hide('query_<%= query_with_warning.id %>')" title="ignoring this query from now on">IGNR</a>
+			<% end %>
+		</p>
+	</div>
+	<p style="display: none" id="warning_<%= query_with_warning.id %>_desc" class="indent">
+		<% query_with_warning.warnings.each do |warn| %>
+			<span style="color: <%= severity_color warn.severity%>"><%= warn.desc %></span><br/>
+		<% end %>
+	</p>
+	<p style="display: none" id="warning_<%= query_with_warning.id %>_sql" class="indent small tbpadded">
+		<%= render :partial => "/query_sql", :object => query_with_warning %>
+	</p>
+	<div style="display: none" id="warning_<%= query_with_warning.id %>_explain" class="indent small tbpadded">
+		<%= render :partial => "/explain", :locals => {:query => query_with_warning} %>
+	</div>
+  <% if QueryReviewer::CONFIGURATION["profiling"] && query_with_warning.profile %>
+    <div style="display: none" id="warning_<%= query_with_warning.id %>_profile" class="indent small tbpadded">
+      <%= render :partial => "/profile", :locals => {:query => query_with_warning} %>
+    </div>
+  <% end %>
+  <div style="display: none" id="warning_<%= query_with_warning.id %>_trace" class="indent small">
+		<%= render :partial => "/query_trace", :object => query_with_warning.relevant_trace, :locals => {:query_id => query_with_warning.id, :full_trace => query_with_warning.full_trace} %>
+	</div>
+</li>

data/lib/query_reviewer/views/_spectrum.rhtml

@@ -0,0 +1,10 @@
+<div class="spectrum_container" title="Severity: <%= severity%> out of 10">
+	<% 0.upto(15) do |i| %>
+		<div class="spectrum_elem" style="background-color: <%= "##{i.to_s(16)}F0"%>"></div>
+	<% end %>
+	<% 0.upto(15) do |i| %>
+		<div class="spectrum_elem" style="background-color: <%= "#F#{((15-i)).to_s(16)}0"%>"></div>
+	<% end %>
+	<div class="spectrum_elem" style="background-color: #FF0000"></div>
+	<div class="spectrum_pointer" style="left: <%= severity * 3 + 2 %>px;"></div>
+</div>

data/lib/query_reviewer/views/_warning_no_query.rhtml

@@ -0,0 +1,8 @@
+<li id="warning_<%= warning_no_query.id %>">
+	<div>
+		<%= render :partial => "/spectrum", :locals => {:severity => warning_no_query.severity} %>
+		<p>
+			<span style="color: <%= severity_color warning_no_query.severity%>" title="<%= warning_no_query.desc %>"><%= warning_no_query.problem %></span>
+		</p>
+	</div>
+</li>

data/lib/query_reviewer/views/query_review_box_helper.rb

@@ -0,0 +1,97 @@
+module QueryReviewer
+  module Views
+    module QueryReviewBoxHelper
+      def parent_div_class
+        "sql_#{parent_div_status.downcase}"
+      end
+
+      def parent_div_status
+        if !enabled_by_cookie
+          "DISABLED"
+        elsif overall_max_severity < (QueryReviewer::CONFIGURATION["warn_severity"] || 4)
+          "OK"
+        elsif overall_max_severity < (QueryReviewer::CONFIGURATION["critical_severity"] || 7)
+          # uh oh
+          "WARNING"
+        else
+          # oh @#&!
+          "CRITICAL"
+        end
+      end
+
+      def syntax_highlighted_sql(sql)
+        if QueryReviewer::CONFIGURATION["uv"]
+          uv_out = Uv.parse(sql, "xhtml", "sql_rails", false, "blackboard")
+          uv_out.gsub("<pre class=\"blackboard\">", "<code class=\"sql\">").gsub("</pre>", "</code>")
+        else
+          sql
+        end
+      end
+
+      def overall_max_severity
+        max = 0
+        max = queries_with_warnings_sorted_nonignored[0].max_severity unless queries_with_warnings_sorted_nonignored.empty?
+        max = warnings_no_query_sorted.first.severity unless warnings_no_query_sorted.empty? || warnings_no_query_sorted.first.severity < max
+        max
+      end
+
+      def severity_color(severity)
+        red = (severity * 16.0 / 10).to_i
+        green = ((10-severity) * 16.0 / 10).to_i
+        red = 8 if red > 8
+        red = 0 if red < 0
+        green = 8 if green > 8
+        green = 0 if green < 0
+        "##{red.to_s(16)}#{green.to_s(16)}0"
+      end
+
+      def ignore_hash?(h)
+      	(@controller.send(:cookies)["query_review_ignore_list"] || "").split(",").include?(h.to_s)
+      end
+
+      def queries_with_warnings
+        @queries.queries.select{|q| q.has_warnings?}
+      end
+
+      def queries_with_warnings_sorted
+        queries_with_warnings.sort{|a,b| (b.max_severity * 1000 + (b.duration || 0)) <=> (a.max_severity * 1000 + (a.duration || 0))}
+      end
+
+      def queries_with_warnings_sorted_nonignored
+        queries_with_warnings_sorted.select{|q| q.max_severity >= ::QueryReviewer::CONFIGURATION["warn_severity"] && !ignore_hash?(q.to_hash)}
+      end
+
+      def queries_with_warnings_sorted_ignored
+        queries_with_warnings_sorted.reject{|q| q.max_severity >= ::QueryReviewer::CONFIGURATION["warn_severity"] && !ignore_hash?(q.to_hash)}
+      end
+
+      def warnings_no_query_sorted
+        @queries.collection_warnings.sort{|a,b| a.severity <=> b.severity}.reverse
+      end
+
+      def warnings_no_query_sorted_ignored
+        warnings_no_query_sorted.select{|q| q.severity < ::QueryReviewer::CONFIGURATION["warn_severity"]}
+      end
+
+      def warnings_no_query_sorted_nonignored
+        warnings_no_query_sorted.select{|q| q.severity >= ::QueryReviewer::CONFIGURATION["warn_severity"]}
+      end
+
+      def enabled_by_cookie
+        @controller.send(:cookies)["query_review_enabled"]
+      end
+
+      def duration_with_color(query)
+        title = query.duration_stats
+        duration = query.duration
+        if duration > QueryReviewer::CONFIGURATION["critical_duration_threshold"]
+          "<span style=\"color: #{severity_color(9)}\" title=\"#{title}\">#{"%.3f" % duration}</span>"
+        elsif duration > QueryReviewer::CONFIGURATION["warn_duration_threshold"]
+          "<span style=\"color: #{severity_color(QueryReviewer::CONFIGURATION["critical_severity"])}\" title=\"#{title}\">#{"%.3f" % duration}</span>"
+        else
+          "<span title=\"#{title}\">#{"%.3f" % duration}</span>"
+        end
+      end
+    end
+  end
+end

data/query_reviewer_defaults.yml

@@ -0,0 +1,39 @@
+all:
+    inject_view: true
+    stack_trace_lines: 3
+    trace_includes_vendor: false
+    trace_includes_lib: true
+    profiling: enabled
+    production_data: true
+    max_safe_key_length: 100
+    disable_sql_cache: true    
+
+    warn_severity: 3
+    critical_severity: 7
+
+    warn_select_count: 20
+    critical_select_count: 50
+
+    warn_update_count: 5
+    critical_update_count: 10
+
+    warn_insert_count: 5
+    critical_insert_count: 10
+
+    warn_delete_count: 5
+    critical_delete_count: 10
+
+    warn_duration_threshold: 0.2
+    critical_duration_threshold: 1.0
+
+    warn_affected_rows: 10
+    critical_affected_rows: 100
+
+development:
+    enabled: true
+
+production:
+    enabled: false
+
+test:
+    enabled: false

data/rails/init.rb

@@ -0,0 +1,13 @@
+# Include hook code here
+
+require 'query_reviewer'
+
+if QueryReviewer.enabled?
+  ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:include, QueryReviewer::MysqlAdapterExtensions)
+  ActionController::Base.send(:include, QueryReviewer::ControllerExtensions)
+  Array.send(:include, QueryReviewer::ArrayExtensions)
+  
+  if ActionController::Base.respond_to?(:append_view_path)
+    ActionController::Base.append_view_path(File.dirname(__FILE__) + "/lib/query_reviewer/views")
+  end
+end

data/tasks/query_reviewer_tasks.rake

@@ -0,0 +1,7 @@
+# desc "Explaining what the task does"
+namespace :query_reviewer do
+  desc "Create a default config/query_reviewer.yml"
+  task :setup do
+    FileUtils.copy(File.join(File.dirname(__FILE__), "..", "query_reviewer_defaults.yml"), File.join(RAILS_ROOT, "config", "query_reviewer.yml"))
+  end  
+end

data/test/sql_query_test.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class SqlQueryTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    assert true
+  end
+end

data/test/sql_sub_query_test.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class SqlSubqueryTest < Test::Unit::TestCase
+  def test_analyze_select_type
+    query = get_query(:select_type => "DEPENDENT UNION")
+    query.send :analyze_select_type!
+    query.should_warn("DEPENDENT UNION", 2)
+    
+    query = get_query(:select_type => "UNCACHEABLE SUBQUERY")
+    query.send :analyze_select_type!
+    query.should_warn("UNCACHEABLE SUBQUERY", 10)
+  end
+  
+  def get_query(options)
+    SqlSubQuery.new(options)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require "activesupport"
+require 'test/unit'
+require "query_reviewer"
+
+module QueryReviewer
+  class SqlSubQuery
+    include Test::Unit::Assertions
+    def should_warn(problem, severity = nil)
+      assert self.warnings.detect{|warn| warn.problem.downcase == problem.downcase && 
+        (!severity || warn.severity == severity)}
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  include QueryReviewer
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: rdavila-query_reviewer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kongregate
+- David Stevenson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-26 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: |
+  This rails plugin not only runs "EXPLAIN" before each of your select queries in development, but provides a small DIV in the rendered output of each page with the summary of query warnings that it analyzed.
+
+email: rdavila84@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- query_reviewer_defaults.yml
+- Rakefile
+- README
+- init.rb
+- lib/query_reviewer/sql_sub_query.rb
+- lib/query_reviewer/array_extensions.rb
+- lib/query_reviewer/views/_box_ajax.js
+- lib/query_reviewer/views/_query_sql.rhtml
+- lib/query_reviewer/views/_query_with_warning.rhtml
+- lib/query_reviewer/views/_box_disabled.rhtml
+- lib/query_reviewer/views/_explain.rhtml
+- lib/query_reviewer/views/_query_trace.rhtml
+- lib/query_reviewer/views/_box_includes.rhtml
+- lib/query_reviewer/views/_box.rhtml
+- lib/query_reviewer/views/_box_body.rhtml
+- lib/query_reviewer/views/_box_header.rhtml
+- lib/query_reviewer/views/_profile.rhtml
+- lib/query_reviewer/views/_spectrum.rhtml
+- lib/query_reviewer/views/query_review_box_helper.rb
+- lib/query_reviewer/views/_warning_no_query.rhtml
+- lib/query_reviewer/mysql_adapter_extensions.rb
+- lib/query_reviewer/query_warning.rb
+- lib/query_reviewer/controller_extensions.rb
+- lib/query_reviewer/mysql_analyzer.rb
+- lib/query_reviewer/sql_query.rb
+- lib/query_reviewer/sql_query_collection.rb
+- lib/query_reviewer.rb
+- rails/init.rb
+- tasks/query_reviewer_tasks.rake
+- test/test_helper.rb
+- test/sql_sub_query_test.rb
+- test/sql_query_test.rb
+has_rdoc: true
+homepage: http://github.com/dsboulder/query_reviewer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An advanced mysql query analyzer for rails
+test_files: []
+