query_reviewer 0.1

data/lib/query_reviewer/sql_query_collection.rb

@@ -0,0 +1,103 @@
+module QueryReviewer
+  # a collection of SQL SELECT queries  
+  class SqlQueryCollection
+    COMMANDS = %w(SELECT DELETE INSERT UPDATE)
+
+    attr_reader :query_hash
+    attr_accessor :overhead_time
+    def initialize(query_hash = {})
+      @query_hash = query_hash
+      @overhead_time = 0.0
+    end
+    
+    def queries
+      query_hash.values
+    end
+
+    def total_duration
+      self.queries.collect(&:durations).flatten.sum
+    end
+
+    def query_count
+      queries.collect(&:count).sum
+    end
+    
+    def analyze!
+      self.queries.collect(&:analyze!)
+
+      @warnings = []
+
+      crit_severity = 9# ((QueryReviewer::CONFIGURATION["critical_severity"] + 10)/2).to_i
+      warn_severity = QueryReviewer::CONFIGURATION["critical_severity"] - 1 # ((QueryReviewer::CONFIGURATION["warn_severity"] + QueryReviewer::CONFIGURATION["critical_severity"])/2).to_i
+
+      COMMANDS.each do |command|
+        count = count_of_command(command)
+        if count > QueryReviewer::CONFIGURATION["critical_#{command.downcase}_count"]
+          warn(:severity => crit_severity, :problem => "#{count} #{command} queries on this page", :description => "Too many #{command} queries can severely slow down a page")
+        elsif count > QueryReviewer::CONFIGURATION["warn_#{command.downcase}_count"]
+          warn(:severity => warn_severity, :problem => "#{count} #{command} queries on this page", :description => "Too many #{command} queries can slow down a page")
+        end
+      end
+    end
+    
+    def find_or_create_sql_query(sql, cols, run_time, profile, command, affected_rows)
+      sanitized_sql = SqlQuery.sanitize_strings_and_numbers_from_sql(sql)
+      trace = SqlQuery.generate_full_trace(Kernel.caller)
+      key = [sanitized_sql, trace]
+      if query_hash[key]
+        query_hash[key].add(sql, run_time, profile)
+      else
+        query_hash[key] = SqlQuery.new(sql, cols, trace, run_time, profile, command, affected_rows, sanitized_sql)
+      end
+    end
+    
+    def warn(options)
+      @warnings << QueryWarning.new(options)
+    end
+    
+    def warnings
+      self.queries.collect(&:warnings).flatten.sort{|a,b| b.severity <=> a.severity}
+    end
+
+    def without_warnings
+      self.queries.reject{|q| q.has_warnings?}.sort{|a,b| b.duration <=> a.duration}
+    end
+    
+    def collection_warnings
+      @warnings
+    end
+    
+    def max_severity
+      warnings.empty? && collection_warnings.empty? ? 0 : [warnings.empty? ? 0 : warnings.collect(&:severity).flatten.max, collection_warnings.empty? ? 0 : collection_warnings.collect(&:severity).flatten.max].max
+    end
+
+    def only_of_command(command, only_no_warnings = false)
+      qs = only_no_warnings ? self.without_warnings : self.queries
+      qs.select{|q| q.command == command}
+    end
+
+    def count_of_command(command, only_no_warnings = false)
+      only_of_command(command, only_no_warnings).collect(&:durations).collect(&:size).sum
+    end
+    
+    def total_severity
+      warnings.collect(&:severity).sum
+    end
+    
+    def total_with_warnings
+      queries.select(&:has_warnings?).length
+    end
+
+    def total_without_warnings
+      queries.length - total_with_warnings
+    end
+    
+    def percent_with_warnings
+      queries.empty? ? 0 : (100.0 * total_with_warnings / queries.length).to_i
+    end
+
+    def percent_without_warnings
+      queries.empty? ? 0 : (100.0 * total_without_warnings / queries.length).to_i
+    end
+  end
+end

data/lib/query_reviewer/sql_sub_query.rb

@@ -0,0 +1,45 @@
+module QueryReviewer
+  # a single part of an SQL SELECT query
+  class SqlSubQuery < OpenStruct
+    include MysqlAnalyzer
+
+    delegate :sql, :to => :parent
+    attr_reader :cols, :warnings, :parent
+    def initialize(parent, cols)
+      @parent = parent
+      @warnings = []
+      @cols = cols.inject({}) {|memo, obj| memo[obj[0].to_s.downcase] = obj[1].to_s.downcase; memo }
+      @cols["query_type"] = @cols.delete("type")
+      super(@cols)
+    end
+
+    def analyze!
+      @warnings = []
+      adapter_name = ActiveRecord::Base.connection.instance_variable_get("@config")[:adapter]
+      adapter_name = 'mysql' if adapter_name == 'mysql2'
+      method_name = "do_#{adapter_name}_analysis!"
+      self.send(method_name.to_sym)
+    end
+
+    def table
+      @table[:table]
+    end
+
+    private
+
+    def warn(options)
+      if (options[:field])
+        field = options.delete(:field)
+        val = self.send(field)
+        options[:problem] = ("#{field.to_s.titleize}: #{val.blank? ? "(blank)" : val}")
+      end
+      options[:query] = self
+      options[:table] = self.table
+      @warnings << QueryWarning.new(options)
+    end
+
+    def praise(options)
+      # no credit, only pain
+    end
+  end
+end

data/lib/query_reviewer/tasks.rb

@@ -0,0 +1,8 @@
+namespace :query_reviewer do
+  desc "Create a default config/query_reviewer.yml"
+  task :setup do
+    defaults_path = File.join(File.dirname(__FILE__), "../..", "query_reviewer_defaults.yml")
+    dest_path = File.join(Rails.root.to_s, "config", "query_reviewer.yml")
+    FileUtils.copy(defaults_path, dest_path)
+  end
+end

data/lib/query_reviewer/views/_box.html.erb

@@ -0,0 +1,11 @@
+<div id="query_review_parent" class="query_review_parent">
+  <div id="query_review_0" class="query_review_container">
+    <%= render :partial => "/box_includes"%>
+    <div class="query_review <%= parent_div_class %>" id = "query_review_header_0">
+      <%= render :partial => "/box_header" %>
+    </div>
+    <div class="query_review_details" id="query_review_details_0" style="display: none;">
+      <%= render :partial => enabled_by_cookie ? "/box_body" : "/box_disabled" %>
+    </div>
+  </div>
+</div>

data/lib/query_reviewer/views/_box_ajax.js

@@ -0,0 +1,34 @@
+var i = 0;
+var last = null;
+for(i=0; i<10; i++) {
+  if(document.getElementById("query_review_"+i)) {
+    last = document.getElementById("query_review_"+i);
+  } else {
+    break;
+  }
+}
+if(i < 10) {
+  var container_div = document.createElement("div");
+  container_div.style.left = ""+(i * 30 + 1)+"px";
+  container_div.setAttribute("id", "query_review_"+i);
+  container_div.className = "query_review_container";
+  var ihtml = '<%= escape_javascript(render(:partial => "/box_includes"))%>';
+  ihtml += '<div class="query_review <%= parent_div_class %>" id = "query_review_header_'+i+'">';
+  ihtml += '<%= escape_javascript(render(:partial => "/box_header"))%>';
+  ihtml += '</div>    ';
+  ihtml += '<div class="query_review_details" id="query_review_details_'+i+'" style="display: none;">';
+  ihtml += '<%= escape_javascript(render(:partial => enabled_by_cookie ? "/box_body" : "/box_disabled")) %>';
+  ihtml += '</div>';
+
+  container_div.innerHTML = ihtml;
+
+  var parent_div = document.getElementById("query_review_parent")
+  if(!parent_div) {
+    parent_div = document.createElement("div");
+    parent_div.setAttribute("id", "query_review_parent");
+    parent_div.className = "query_reivew_parent";
+    document.getElementById("body")[0].appendChild(parent_div);
+  }
+
+  parent_div.appendChild(container_div);
+}

data/lib/query_reviewer/views/_box_body.html.erb

@@ -0,0 +1,73 @@
+	<p>Total queries: <span class="number"><%= @queries.query_count %></span>&nbsp;&nbsp;
+      <% if @total_time %>Total time: <span class="number" title="TOTAL TIME: <%= @total_time %>s  QR_OVERHEAD: <%= @queries.overhead_time %>s">
+        <%= '%.3f' % (@total_time - @queries.overhead_time) %></span>s&nbsp;&nbsp;
+      <% end %>
+      MySQL Database Time: <span class="number"><%= '%.3f' % @queries.total_duration %></span>s</p>
+	<p class="indent">With warnings: <span class="number bad"><%= @queries.total_with_warnings %></span> (<%= @queries.percent_with_warnings %>%)</p>
+	<p class="indent">Without warnings: <span class="number good"><%= @queries.total_without_warnings %></span> (<%= @queries.percent_without_warnings %>%)</p>
+  <p>Type:
+      <% QueryReviewer::SqlQueryCollection::COMMANDS.each do |command| %>
+        <% next if @queries.count_of_command(command).zero? %>
+        <span class="number"><%= @queries.count_of_command(command) %></span> <%= command %>s&nbsp;&nbsp;
+      <% end %>
+  </p>
+	<% if warnings_no_query_sorted.length + queries_with_warnings_sorted.length > 0 %>
+		<div class="divider"></div>
+		<% if warnings_no_query_sorted_nonignored.length + queries_with_warnings_sorted_nonignored.length > 0 %>
+			<p class="title"><%= warnings_no_query_sorted_nonignored.length + queries_with_warnings_sorted_nonignored.length %> Errors:</p>
+			<ul>
+				<%= render :partial => "/warning_no_query", :collection => warnings_no_query_sorted_nonignored %>
+				<%= render :partial => "/query_with_warning", :collection => queries_with_warnings_sorted_nonignored %>
+			</ul>
+		<% end %>
+		<% if warnings_no_query_sorted_ignored.length + queries_with_warnings_sorted_ignored.length > 0 %>
+			<%= warnings_no_query_sorted_ignored.length + queries_with_warnings_sorted_ignored.length %> Warnings:
+			<ul id="query_review_ignored_warnings">
+				<%= render :partial => "/warning_no_query", :collection => warnings_no_query_sorted_ignored %>
+				<%= render :partial => "/query_with_warning", :collection => queries_with_warnings_sorted_ignored %>
+			</ul>
+		<% end %>
+	<% end %>
+	<div class="divider"></div>
+	<p class="title">Safe queries:</p>
+	<% if @queries.queries.empty? %>
+		No queries to display.
+	<% else %>
+    <% QueryReviewer::SqlQueryCollection::COMMANDS.reverse.each do |command| %>
+      <% next if @queries.count_of_command(command, true).zero? %>
+      <ul class="small">
+        <% @queries.only_of_command(command, true).each do |query| %>
+        <li>
+          <% if QueryReviewer::CONFIGURATION["production_data"] %>
+            <%= duration_with_color(query) %>s
+          <% end %>
+          <% if query.count > 1 %>
+            <b title="<%= query.count %> queries were executed with the same stack trace and similar SQL structure">
+              <%= query.count  %> identical queries
+            </b>
+          <% end %>
+          <%= render :partial => "/query_sql", :locals=>{ :query_sql => query } %>
+            <% if query.select? %>
+              <a href="javascript: query_review_toggle('warning_<%= query.id %>_explain')" title="show/hide sql">EXPLN</a>
+            <% end %>
+            <% if QueryReviewer::CONFIGURATION["profiling"] && query.profile %>
+              <a href="javascript: query_review_toggle('warning_<%= query.id %>_profile')" title="show/hide profile">PROF</a>
+            <% end %>
+            <a href="javascript: query_review_toggle('warning_<%= query.id %>_trace')" title="show/hide stack trace">TRACE</a>
+            <div style="display: none" id="warning_<%= query.id %>_explain" class="indent small tbpadded">
+              <%= render :partial => "/explain", :locals => {:query => query} %>
+            </div>
+            <% if QueryReviewer::CONFIGURATION["profiling"] && query.profile %>
+              <div style="display: none" id="warning_<%= query.id %>_profile" class="indent small">
+                <%= render :partial => "/profile", :locals => {:query => query} %>
+              </div>
+            <% end %>
+            <div style="display: none" id="warning_<%= query.id %>_trace" class="indent small">
+              <%= render :partial => "/query_trace", :object => query.relevant_trace, :locals => {:query_id => query.id, :full_trace => query.full_trace} %>
+            </div>
+        </li>
+        <% end %>
+      </ul>
+    <% end %>
+  <% end %>
+  <p id="query_review_disable_link"><a href="javascript: eraseCookie('query_review_enabled'); query_review_hide('query_review_disable_link'); alert('Cookie successfully set.');">Disable analysis report</a> on next page load and from now on.</p>

data/lib/query_reviewer/views/_box_disabled.html.erb

@@ -0,0 +1,2 @@
+<p>SQL analysis has been disabled for you. A cookie must be set to enable analysis. This generally slows down your browser, so it's only recommended for users analyzing SQL queries.</p>
+<p id="query_review_enable_link"><b><a href="javascript: createCookie('query_review_enabled', '1'); query_review_hide('query_review_enable_link'); alert('Cookie successfully set.');">Enabled it</a> on next page load and from now on.</b></p>

data/lib/query_reviewer/views/_box_header.html.erb

@@ -0,0 +1 @@
+<a href="#" onclick="query_review_toggle(this.parentNode.nextSibling.nextSibling.id); return false;">SQL <%= parent_div_status %></a>

data/lib/query_reviewer/views/_box_includes.html.erb

@@ -0,0 +1,234 @@
+<style>
+div#query_review_parent {
+    position: absolute;
+    top: 1px;
+    left: 1px;
+    z-index: 100000;
+}
+
+div.query_review_container {
+    float: left;
+}
+
+div.query_review {
+  height: 18px;
+  margin: 1px;
+  opacity: 0.75;
+  padding-left: 3px;
+  padding-right: 3px;
+  border: 1px solid black;
+  font-size: 12px;
+  font-weight: bold;
+  text-align: left;
+}
+
+div.query_review.sql_ok {
+  background-color: #090;
+  color: #020;
+}
+
+div.query_review.sql_warning {
+  background-color: #FAE100;
+  color: #F05000;
+}
+
+div.query_review.sql_critical {
+  background-color: #F99;
+  color: #A00;
+}
+
+div.query_review.sql_disabled {
+  background-color: #BBB;
+  color: #555;
+}
+
+div.query_review a {
+  color: inherit;
+  text-decoration: none;
+}
+
+div.query_review_details {
+  width: 900px;
+  height: 600px;
+  opacity: 0.9;
+  margin: 1px;
+  padding: 2px;
+  border: 1px solid black;
+  font-size: 12px;
+  overflow: auto;
+  background-color: #DDD;
+  text-align: left;
+  text-indent: 0px;
+  color: black;
+}
+
+div.query_review_details p {
+  margin: 2px 0 2px 0;
+  padding: 0px;
+}
+
+div.query_review_details a {
+  color: #29ABE2;
+}
+
+div.query_review_details ul {
+  list-style-type: circle;
+  padding-left: 15px;
+}
+
+div.query_review_details li {
+  clear: both;
+}
+
+div.query_review_details code {
+  white-space: normal;
+  line-height: 120%;
+}
+
+div.query_review_details table.explain th {
+  cell-padding: 5px;
+}
+
+div.query_review_details .title {
+  font-weight: bold;
+}
+
+div.query_review_details .indent {
+  padding-left: 10px;
+}
+
+div.query_review_details .number {
+  font-weight: bold;
+}
+
+div.query_review_details .bad {
+  color: #900;
+}
+
+div.query_review_details .good {
+  color: #090;
+}
+
+div.query_review_details div.divider {
+  width: 504px;
+  position: relative;
+  left: -2px;
+  height: 1px;
+  border-top: 1px dashed black;
+  margin: 2px 0 2px 0;
+}
+
+div.query_review_details .small {
+  font-size: 10px;
+}
+
+div.query_review_details .tbpadded {
+  padding-top: 3px;
+  padding-bottom: 3px;
+}
+
+div.query_review_details .trace {
+  background-color: #0C1021;
+  color: #7F908A;
+  padding: 5px;
+  margin-right: 30px;
+}
+
+div.query_review_details .trace .bold {
+  color: white;
+}
+
+div.query_review_details div.spectrum_container {
+  margin-top: 4px;
+  width: 35px;
+  display: block;
+  float: left;
+  position: relative;
+  height: 14px;
+  margin-right: 5px;
+}
+
+div.query_review_details div.spectrum_elem {
+  width: 1px;
+  display: block;
+  float: left;
+  height: 10px;
+}
+div.query_review_details div.spectrum_pointer {
+  width: 2px;
+  display: block;
+  float: left;
+  position: absolute;
+  height: 14px;
+  background-color: black;
+  top: -2px;
+}
+
+div.query_review_details table {
+  background-color: white;
+  border: 1px solid gray;
+  padding: 0px;
+  margin: 0px;
+}
+
+div.query_review_details tbody {
+  border: 0px;
+  padding: 0px;
+  margin: 0px;
+}
+
+div.query_review_details thead {
+  border-bottom: 1px solid gray;
+  padding: 0px;
+  margin: 0px;
+}
+
+
+div.query_review_details tr {
+  border: 0px;
+  padding: 0px;
+  margin: 0px;
+}
+
+div.query_review_details td {
+  border: 1px solid gray;
+  padding: 3px;
+  margin: 0px;
+    overflow: hidden;
+}
+
+div.query_review_details th {
+  border: 1px solid gray;
+  padding: 3px;
+  margin: 0px;
+}
+
+</style>
+
+<style>
+.sql {
+  color: black;
+}
+.sql .String {
+  color: #009933;
+}
+.sql .Keyword {
+  color: #0000FF;
+}
+.sql .Constant {
+  color: #6782D3;
+}
+.sql .Number {
+  color: #0066FF;
+}
+.sql .Comment {
+   color: #0066FF;
+   font-style: italic;
+}
+</style>
+
+<% if defined?(Rails::Railtie)  %>
+  <%= render :partial => "/js_includes_new" %>
+<% else %>
+  <%= render :partial => "/js_includes" %>
+<% end %>

data/lib/query_reviewer/views/_explain.html.erb

@@ -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/_js_includes.html.erb

@@ -0,0 +1,68 @@
+<% javascript_tag do %>
+//Super lame show/hide functions so we don't need any 3rd party JS libs
+function query_review_show(id) {
+  document.getElementById(id).style.display = "block";
+}
+
+function query_review_hide(id) {
+  document.getElementById(id).style.display = "none";
+}
+function query_review_toggle(id) {
+  if(document.getElementById(id).style.display == "none") {
+    document.getElementById(id).style.display = "block";
+  } else {
+    document.getElementById(id).style.display = "none";
+  }
+}
+function createCookie(name,value,days) {
+  if (days) {
+    var date = new Date();
+    date.setTime(date.getTime()+(days*24*60*60*1000));
+    var expires = "; expires="+date.toGMTString();
+  }
+  else var expires = "";
+  document.cookie = name+"="+value+expires+"; path=/";
+}
+
+function readCookie(name) {
+  var nameEQ = name + "=";
+  var ca = document.cookie.split(';');
+  for(var i=0;i < ca.length;i++) {
+    var c = ca[i];
+    while (c.charAt(0)==' ') c = c.substring(1,c.length);
+    if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length,c.length);
+  }
+  return null;
+}
+
+function eraseCookie(name) {
+  createCookie(name,"",-1);
+}
+
+function ignore_list() {
+  var ignore_list = readCookie("query_review_ignore_list")
+  if (!ignore_list)
+    ignore_list = []
+  else
+    ignore_list = ignore_list.split(",")
+  return ignore_list
+}
+
+function add_ignore_hash(h){
+  var list = ignore_list();
+  list[list.length] = h
+  createCookie("query_review_ignore_list", list.join(","))
+}
+
+function remove_ignore_hash(h) {
+  var list = ignore_list();
+  var new_list = []
+  for(var i=0; i<list.length; i++)
+  {
+    if(list[i].toString() != h.toString()) {
+      new_list[new_list.length] = list[i]
+    }
+  }
+  createCookie("query_review_ignore_list", new_list.join(","))
+}
+<% end %>

data/lib/query_reviewer/views/_js_includes_new.html.erb

@@ -0,0 +1,68 @@
+<%= javascript_tag do %>
+//Super lame show/hide functions so we don't need any 3rd party JS libs
+function query_review_show(id) {
+  document.getElementById(id).style.display = "block";
+}
+
+function query_review_hide(id) {
+  document.getElementById(id).style.display = "none";
+}
+function query_review_toggle(id) {
+  if(document.getElementById(id).style.display == "none") {
+    document.getElementById(id).style.display = "block";
+  } else {
+    document.getElementById(id).style.display = "none";
+  }
+}
+function createCookie(name,value,days) {
+  if (days) {
+    var date = new Date();
+    date.setTime(date.getTime()+(days*24*60*60*1000));
+    var expires = "; expires="+date.toGMTString();
+  }
+  else var expires = "";
+  document.cookie = name+"="+value+expires+"; path=/";
+}
+
+function readCookie(name) {
+  var nameEQ = name + "=";
+  var ca = document.cookie.split(';');
+  for(var i=0;i < ca.length;i++) {
+    var c = ca[i];
+    while (c.charAt(0)==' ') c = c.substring(1,c.length);
+    if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length,c.length);
+  }
+  return null;
+}
+
+function eraseCookie(name) {
+  createCookie(name,"",-1);
+}
+
+function ignore_list() {
+  var ignore_list = readCookie("query_review_ignore_list")
+  if (!ignore_list)
+    ignore_list = []
+  else
+    ignore_list = ignore_list.split(",")
+  return ignore_list
+}
+
+function add_ignore_hash(h){
+  var list = ignore_list();
+  list[list.length] = h
+  createCookie("query_review_ignore_list", list.join(","))
+}
+
+function remove_ignore_hash(h) {
+  var list = ignore_list();
+  var new_list = []
+  for(var i=0; i<list.length; i++)
+  {
+    if(list[i].toString() != h.toString()) {
+      new_list[new_list.length] = list[i]
+    }
+  }
+  createCookie("query_review_ignore_list", new_list.join(","))
+}
+<% end %>