sql_optimizer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab7497b7fd4fbc615fc5586afe11df80da8b6032812374009a12c0b18d095957
-  data.tar.gz: 9b5b25829db414590d19bfa701337d789108a8e240148f0754394890fd3de2c1
+  metadata.gz: '096f95c4b92b1cf43b3406da1dca462622ad9c0883528bec6b9b004c8574fb21'
+  data.tar.gz: ee6ae051ca2eb5db5aa5751f33bfba62089b9a2347fbfb9864b3d461717aa3ed
 SHA512:
-  metadata.gz: a6cb066577dd57672c671fb54f8eb36aaf52c84ae313d4adeacd72f67fcdf953555ad2ecd4202f5bb00feef1d774679de56c3d4cd7e8d138c986ded03366e1f3
-  data.tar.gz: 664819cb4acf6c94c8c622c25e259187e80cbc325750154007bfe432fd8eaecc130947e15d89c40b26280e0bf9e464b57b8124300a8251afc05401184b6f7a83
+  metadata.gz: 570b079b36dc8cfc9a218c117dd6e13d21438589b57c99080f925067ac505c42c1f7b26a788214787c229db1f8caa68b2092a630af321aa8ccab4f661cef0472
+  data.tar.gz: b844e1b144de765d464c64506c93e9e0a68989e10c4fb1cec4c5e2a4f5459a0cd95f73698be7c71dae57ce0d73236df2a769936279f4294b4c49a25a35c123c4

data/README.md

@@ -1,8 +1,6 @@
 # SqlOptimizer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sql_optimizer`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+SqlOptimizer this is a gem for query optimization in your app. You can use two our method to check you query: `anayle` and `check_n_plus_one`. This is not so much, but we'll add more in the future. Also you can visit [localhost:3000/sql_optimizer](http://localhost:3000/sql_optimizer) to see information about queries in your app.
 
 ## Installation
 
@@ -19,10 +17,28 @@ And then execute:
 Or install it yourself as:
 
     $ gem install sql_optimizer
+    
+Run `rails g sql_optimizer` to load all files and migrations
 
 ## Usage
 
-TODO: Write usage instructions here
+Visit [localhost:3000/sql_optimizer](http://localhost:3000/sql_optimizer) to see information about queries
+
+### Analyze
+
+Add to your query `analyze` method to see full information about queries
+For example:
+```
+MyModel.scope.analyze
+```
+
+### Check n+1
+
+Add to your query `check_n_plus_one` method to see if query has n+1 and if has, you'll get recommendation how to omit this.
+For example:
+```
+MyModel.scope.check_n_plus_one
+```
 
 ## Development
 

data/app/controllers/sql_optimizer_controller.rb

@@ -0,0 +1,35 @@
+class SqlOptimizerController < ApplicationController
+
+  layout false
+
+  def index
+    @query_logs = QueryLog.where.not(source: nil)
+    @popular_queries = @query_logs.group_by(&:query).sort_by { |_, val| val.size }.last(3)
+    @max_query = @query_logs.order(duration: :desc).first
+    @min_query = @query_logs.order(:duration).first
+  end
+
+  def graph
+    @query_logs = QueryLog.where.not(source: nil)
+    render json: collect_graph.to_json
+  end
+
+  private
+
+  def collect_graph
+    @query_logs.group_by(&:query).first(10).map.with_index do |query, i|
+      durations = query[1].map(&:duration)
+      avg_time  = durations.reduce(:+) / durations.size.to_f
+      {
+        index: i,
+        avg_time: avg_time.round(2),
+        data: {
+          query: query[1].first.query,
+          name:  query[1].first.source,
+          size:  query[1].size
+        }
+      }
+    end
+  end
+
+end

data/app/views/sql_optimizer/index.slim

@@ -0,0 +1,118 @@
+doctype html
+html
+  head
+    title SQL Logs Dashboard
+    meta http-equiv="Content-Type" content="text/html; charset=UTF-8"
+    script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"
+    link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/morris.js/0.5.1/morris.css"
+    script src="https://cdnjs.cloudflare.com/ajax/libs/raphael/2.1.0/raphael-min.js"
+    script src="https://cdnjs.cloudflare.com/ajax/libs/morris.js/0.5.1/morris.min.js"
+  body
+    .header
+      a.logo SQL Logs Dashboard
+    - if @query_logs.any?
+      .main
+        .custom-column
+          #chart style="height: 250px; width: 700px;"
+        .custom-column
+          .wrap
+            h1 Три найчастiшi запити
+            - @popular_queries.each do |pq|
+              p = pq.first
+      .main
+        .custom-column
+          .wrap
+            h1 Запит з найдовшим запитом
+            p Час: #{@max_query.duration}
+            p Запит: #{@max_query.query}
+        .custom-column
+          .wrap
+            h1 Запит з найменшим запитом
+            p Час: #{@min_query.duration}
+            p Запит: #{@min_query.query}
+
+javascript:
+  $(document).ready(function () {
+    $.ajax({
+      type: 'GET',
+      datatype: "json",
+      url: '/graph',
+      success: function (rendered_data) {
+        initGraph(rendered_data);
+      }
+    });
+
+    var initGraph = function (data) {
+      new Morris.Line({
+        element: 'chart',
+        data: data,
+        hoverCallback: function (index, options, content, _row) {
+          // debugger
+          content = `<div class='morris-hover-row-label'>Name: ${options['data'][index]["data"]["name"]}</div>
+                       <div class='morris-hover-point' style='color: #0b62a4'>
+                          Query: ${options['data'][index]["data"]["query"]}</br>
+                          Avg time: ${options['data'][index]["avg_time"]}</br>
+                          Number of calls: ${options['data'][index]["data"]["size"]}</br>
+                       </div>`
+          return(content);
+          // $(".morris-hover").html(content);
+        },
+        xkey: 'index',
+        ykeys: ['avg_time'],
+        labels: ['avg_time']
+      });
+    }
+  });
+
+scss:
+  .header {
+    overflow: hidden;
+    background-color: #f1f1f1;
+    padding: 20px 10px;
+    cursor: pointer;
+  }
+
+  .header a {
+    float: left;
+    color: black;
+    text-align: center;
+    padding: 12px;
+    text-decoration: none;
+    font-size: 18px;
+    line-height: 25px;
+    border-radius: 4px;
+  }
+
+  .header a.logo {
+    font-size: 25px;
+    font-weight: bold;
+  }
+
+  .main {
+    display: flex;
+    flex-direction: row;
+    width: 95%;
+    padding: 20px;
+
+    .custom-column {
+      width: 50%;
+      margin: 20px;
+
+      .wrap {
+        display: flex;
+        flex-direction: column;
+        border: 1px solid silver;
+        width: 100%;
+        height: 250px;
+        padding: 15px;
+      }
+    }
+  }
+
+
+
+
+
+
+
+

data/lib/generators/sql_optimizer_generator.rb

@@ -0,0 +1,57 @@
+class SqlOptimizerGenerator < Rails::Generators::Base
+
+  desc 'This generator creates an migration file, model file, sql_optimizer file and append to routes lines'
+  def migrate_query_logs
+    migration_number = Dir.glob("#{Rails.root}/db/migrate/*").max_by { |name| name[/\d+/].to_i }[/\d+/].to_i + 1
+    create_file "db/migrate/#{migration_number}_create_query_logs.rb", migration_content
+    create_file 'app/models/query_log.rb', model_content
+    application(nil, env: :development) { initializer_content }
+    route route_content
+    rake 'db:migrate'
+    puts 'Done'
+  end
+
+  def migration_content
+    <<~RUBY
+      class CreateQueryLogs < ActiveRecord::Migration[6.0]
+        def change
+          create_table :query_logs do |t|
+            t.string :query
+            t.float :duration
+            t.string :source
+            t.bigint :follow_id
+            t.integer :n_plus_one_size, default: 1
+
+            t.timestamps
+          end
+        end
+      end
+    RUBY
+  end
+
+  def model_content
+    <<~RUBY
+      class QueryLog < ApplicationRecord
+      end
+    RUBY
+  end
+
+  def route_content
+    <<~RUBY
+      if Rails.env.development?
+        get 'sql_optimizer', to: 'sql_optimizer#index'
+        get 'graph',         to: 'sql_optimizer#graph'
+      end
+
+    RUBY
+  end
+
+  def initializer_content
+    <<~RUBY
+      # This is for tracking sql queries
+      QueryTrace.enable!
+
+    RUBY
+  end
+
+end

data/lib/sql_optimizer/analyze.rb

@@ -16,6 +16,17 @@ module ActiveRecord
     def analyze
       exec_analyze(collecting_queries_for_explain { exec_queries })
     end
+
+    def check_n_plus_one
+      query_logs   = QueryLog.all
+      query_log    = query_logs.find_by(follow_id: query_logs.ids)
+      if query_log.present?
+        to_include = query_log.query[/"(.*?)"/].delete('\"')
+        logger.debug "Add includes(:#{to_include}) to omit n+1 query"
+      else
+        logger.debug "n+1 query does'n find"
+      end
+    end
   end
 end
 
@@ -30,6 +41,7 @@ module ActiveRecord
         end
         msg << "\n"
         msg << connection.analyze(sql, binds)
+        msg
       end.join("\n")
 
       def str.inspect
@@ -40,3 +52,45 @@ module ActiveRecord
     end
   end
 end
+
+module QueryTrace
+  def self.enable!
+    ::ActiveRecord::LogSubscriber.send(:include, self)
+  end
+
+  def self.append_features(klass)
+    super
+    klass.class_eval do
+      unless method_defined?(:log_info_without_trace)
+        alias_method :log_info_without_trace, :sql
+        alias_method :sql, :log_info_with_trace
+      end
+    end
+  end
+
+  def log_info_with_trace(event)
+    log_info_without_trace(event)
+
+    return if event.payload[:name].nil? ||
+      event.payload[:name] == 'SCHEMA' ||
+      event.payload[:name].include?('SchemaMigration') ||
+      %w[BEGIN COMMIT ROLLBACK].include?(event.payload[:sql].to_s) ||
+      !ActiveRecord::Base.connection.table_exists?(QueryLog.table_name) ||
+      event.payload[:sql].include?('query_logs')
+
+    logger = ActiveRecord::Base.logger
+    ActiveRecord::Base.logger = nil
+    query_logs = QueryLog.last(2)
+    if query_logs.last.present? && query_logs.last.query == event.payload[:sql]
+      query_logs.last.update(follow_id:       query_logs.first.id,
+                             n_plus_one_size: query_logs.last.n_plus_one_size + 1)
+    else
+      QueryLog.create(
+        query:    event.payload[:sql],
+        source:   event.payload[:name],
+        duration: event.duration.round(3)
+      )
+    end
+    ActiveRecord::Base.logger = logger
+  end
+end

data/lib/sql_optimizer/version.rb

@@ -1,5 +1,5 @@
 module SqlOptimizer
 
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 
 end

data/sql_optimizer.gemspec

@@ -13,18 +13,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/NikitaKorchma/sql_optimizer'
   spec.license       = 'MIT'
 
-  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  #
-  #   spec.metadata['homepage_uri'] = spec.homepage
-  #   spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
-  #   spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
-  # else
-  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
-  #     'public gem pushes.'
-  # end
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    # spec.metadata['homepage_uri'] = spec.homepage
+    # spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
+    # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_optimizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nikita Korchma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-05 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,8 +68,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/sql_optimizer_controller.rb
+- app/views/sql_optimizer/index.slim
 - bin/console
 - bin/setup
+- lib/generators/sql_optimizer_generator.rb
 - lib/sql_optimizer.rb
 - lib/sql_optimizer/analyze.rb
 - lib/sql_optimizer/version.rb
@@ -77,7 +80,8 @@ files:
 homepage: https://github.com/NikitaKorchma/sql_optimizer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths: