active-record-query-count 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 832a3feb47d50f2629fe629a61d8b373e1e34f657c5367af3a414faed1e3b26e
+  data.tar.gz: 00a7ba247067342cbb64939cee6d2ad3023e022ef7e64103edd789bd087a247f
+SHA512:
+  metadata.gz: d63ff812445352062bd2118bd12dd1f6d2a9f07745d702de1075953f27b457a59c41c19c1404981cbc95d7707a48911e354a4526118ac3d6ac3327fae179b500
+  data.tar.gz: f70978b3f812a631a3814792572d8502351c2b1e2c8a52c8e617d72f4936331944370b10d53bdc48afff5722734ab49e5f33662c4b4583e3ff0593d9aa00c22e

data/README.md

@@ -0,0 +1,126 @@
+# ActiveRecordQueryCount
+
+`ActiveRecordQueryCount` is a Ruby gem designed to help you track and analyze SQL queries executed by your ActiveRecord models. By subscribing to ActiveSupport notifications, it provides detailed insights into the queries being run, including the tables involved and the locations in your code where the queries are generated.
+There are three things this gem allows you to do
+
+1. You can compare two codes to view the difference in SQL counts on locations with a graph or a table.
+2. You can view an overview of the SQL that a code does in a graph, a table or in the console.
+3. (In progress) You can see an overview of the current request on a controller action
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_query_tracker'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install active_record_query_tracker
+```
+
+## Usage
+
+There are four ways of using this gem:
+
+1. With a block of code
+
+```ruby
+require 'active_record_query_tracker'
+ActiveRecordQueryCount.start_with_block(printer: :html) do
+    # your code goes here
+end
+```
+
+this will open up a html table with the SQL stats of your code
+
+2. Starting recording manually
+
+```ruby
+require 'active_record_query_tracker'
+
+ActiveRecordQueryCount.start_recording
+# your code goes here
+ActiveRecordQueryCount.end_recording(printer: :html)
+```
+
+3. Comparing two blocks of code (only available for html printer)
+
+```ruby
+require 'active_record_query_tracker'
+ActiveRecordQueryCount.compare do |bench|
+    bench.code('script1') do
+    end
+    bench.code('script2') do
+    end
+    bench.compare!
+end
+```
+
+this will open up a graph comparing the quantity of SQL of the two codes
+
+4. (In progress) Enabling a middleware to see an overview of the current request SQL's in Rack Application.
+    On `config/development.rb` or the initializer of the application.
+
+```ruby
+  config.after_initialize do
+    ActiveRecordQueryCount.configure do |configuration|
+      configuration.enable_middleware = true
+    end
+  end
+```
+
+### Printing options
+
+There are two ways of displaying the collected queries data, `:console` and `:html`, to select one pass the printer argument to `start_with_block` o `end_recording` methods.
+
+If you use `html` with WSL enviroment, you need to set on your enviroments variables the `WSL_DISTRIBUTION` that you are using, so the dependency Launchy work as expected.
+
+### Configuration options
+
+When visualizing the html table or the console output, tables with less than `ignore_table_count` will not be shown. Also, the ammount of locations to show is given by `max_locations_per_table`
+
+```ruby
+config.after_initialize do
+    ActiveRecordQueryCount.configure do |configuration|
+      configuration.ignore_table_count = 1
+      configuration.max_locations_per_table = 4
+    end
+  end
+end
+```
+
+## Examples of visualization
+
+1. Console output
+   ![Console output](images/console.png)
+2. HTML output
+   ![HTML output](images/html.png)
+3. Bar chart output
+   ![Bar chart output](images/bar_chart.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/[USERNAME]/active_record_query_tracker>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/active_record_query_tracker/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveRecordQueryCount project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_record_query_tracker/blob/master/CODE_OF_CONDUCT.md).

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record_query_count/compare/comparator.rb

@@ -0,0 +1,33 @@
+module ActiveRecordQueryCount
+  module Compare
+    class Comparator
+      attr_accessor :results, :scripts_loaded
+
+      def initialize
+        @results = {}
+        @scripts_loaded = 0
+      end
+
+      def code(name)
+        @scripts_loaded += 1
+
+        ActiveRecordQueryCount.start_with_block(printer: :none) do
+          yield
+          @results[name] = ActiveRecordQueryCount.tracker.active_record_query_tracker.dup
+        end
+      end
+
+      def compare!
+        raise 'Exactly two code blocks are required' if @scripts_loaded != 2
+
+        ActiveRecordQueryCount::Printer::HtmlCompare.new(data_1: results.slice(results.keys[0]),
+                                               data_2: results.slice(results.keys[1])).print
+      end
+    end
+
+    def self.compare
+      comparator = Comparator.new
+      yield(comparator)
+    end
+  end
+end

data/lib/active_record_query_count/configuration.rb

@@ -0,0 +1,12 @@
+require 'active_support'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module ActiveRecordQueryCount
+  module Configuration
+    mattr_accessor :ignore_table_count, :max_locations_per_table, :enable_middleware
+
+    self.ignore_table_count = ENV['QUERY_COUNTER_IGNORE_TABLE_COUNT'] || 10
+    self.max_locations_per_table = ENV['MAX_LOCATIONS_PER_TABLE'] || 3
+    self.enable_middleware = false
+  end
+end

data/lib/active_record_query_count/middleware.rb

@@ -0,0 +1,37 @@
+require 'json'
+require 'nokogiri'
+
+module ActiveRecordQueryCount
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      return @app.call(env) unless Configuration.enable_middleware
+
+      status, headers, response, query_count_data = nil
+      ActiveRecordQueryCount.start_recording
+      status, headers, response = @app.call(env)
+      query_count_data = ActiveRecordQueryCount.tracker.active_record_query_tracker.clone
+      ActiveRecordQueryCount.end_recording(printer: :none)
+      if headers['Content-Type']&.include?('text/html') && response.respond_to?(:body) && response.body['<body']
+        response_body = inject_query_counter_js(response.body, query_count_data)
+        headers['Content-Length'] = response_body.bytesize.to_s
+        response = [response_body]
+      end
+      [status, headers, response]
+    end
+
+    def inject_query_counter_js(response_body, query_count_data)
+      injected_html = ::ActiveRecordQueryCount::Printer::Html.new(data: query_count_data).inject_in_html
+      # Parse the response body with Nokogiri
+      doc = Nokogiri::HTML(response_body)
+
+      # Inject the query counter JS before the closing </body> tag
+      doc.at('body').add_child(injected_html)
+
+      doc.to_html
+    end
+  end
+end

data/lib/active_record_query_count/printer/base.rb

@@ -0,0 +1,42 @@
+module ActiveRecordQueryCount
+  module Printer
+    class Base
+      def filter_data data
+        data = data.select { |_, v| v[:count] >= Configuration.ignore_table_count }
+        data = data.sort_by { |_, v| -v[:count] }.each do |_category, info|
+          info[:location] = info[:location].sort_by do |_, detail|
+            -detail[:count]
+          end.first(Configuration.max_locations_per_table).to_h
+        end
+        data.to_h
+      end
+
+      def sort_data data
+        data = data.sort_by { |_, v| -v[:count] }.each do |_category, info|
+          info[:location] = info[:location].sort_by do |_, detail|
+            -detail[:count]
+          end.to_h
+        end
+        data.to_h
+      end
+
+      def open_file html_dest
+        if ENV['WSL_DISTRIBUTION']
+          Launchy.open("file://wsl%24/#{ENV['WSL_DISTRIBUTION']}#{html_dest}")
+        else
+          Launchy.open(html_dest)
+        end
+      end
+
+      # this js is not used as erb, it could be changed
+      def js_content
+        File.read(@js_path)
+      end
+
+      # this js is not used as erb, it could be changed
+      def css_content
+        File.read(@css_path)
+      end
+    end
+  end
+end

data/lib/active_record_query_count/printer/console.rb

@@ -0,0 +1,30 @@
+require 'colorize'
+
+module ActiveRecordQueryCount
+  module Printer
+    class Console < Base
+      def initialize data:
+        super()
+        @data = data
+      end
+
+      def print
+        data = filter_data(@data)
+        puts '[ActiveRecordQueryCount] Query count per table:'.colorize(:blue)
+        puts "Total query count: #{data.values.sum { |v| v[:count] }}\n\n"
+        puts "All tables with less than #{Configuration.ignore_table_count} queries are ignored. \n\n"
+        puts "For each table, the top #{Configuration.max_locations_per_table} locations with the most queries will be shown.\n\n"
+        data.each do |category, info|
+          puts "Table #{category.colorize(:cyan)}"
+          puts "  Total query count: #{info[:count].to_s.colorize(:blue)}"
+          puts '  Locations where the table was called:'
+          info[:location].each do |loc, details|
+            puts "    - File location: #{loc}"
+            puts "        Query count: #{details[:count].to_s.colorize(:blue)}"
+          end
+          puts
+        end
+      end
+    end
+  end
+end

data/lib/active_record_query_count/printer/html.rb

@@ -0,0 +1,68 @@
+require 'erb'
+require 'tempfile'
+require 'launchy'
+require 'pry-byebug'
+require 'json'
+
+module ActiveRecordQueryCount
+  module Printer
+    class Html < Base
+      attr_accessor :data
+
+      def initialize data:
+        @template_path = File.join(__dir__, 'templates', 'template.html.erb')
+        @base_query_counter_path = File.join(__dir__, 'templates', 'template_base_query_counter.html.erb')
+        @inject_template_path = File.join(__dir__, 'templates', 'template_for_inject.html.erb')
+        @css_path = File.join(__dir__, 'templates', 'style.css')
+        # este no falla, quizá pueda poner lo mismo aquí con chart.js y así no hacer lo del nonce y csp
+        @js_path = File.join(__dir__, 'templates', 'bar_chart.js')
+        @data = data
+      end
+
+      def chart_data
+        @chart_data ||= generate_chart_data(data)
+      end
+
+      # maybe this should not be filtered
+      def total_query_count
+        @total_query_count ||= data.values.sum { |v| v[:count] }
+      end
+
+      def inject_in_html
+        ERB.new(File.read(@inject_template_path)).result(binding)
+      end
+
+      def render_query_counter_base_div
+        ERB.new(File.read(@base_query_counter_path)).result(binding)
+      end
+
+      def print
+        html_dest = generate_html(binding)
+        open_file(html_dest)
+      end
+
+      private
+
+      def generate_chart_data(data)
+        chart_data = { labels: [], data: [], locations: {} }
+        data.each do |table, info|
+          chart_data[:labels] << table
+          chart_data[:data] << info[:count]
+          chart_data[:locations][table] = info[:location].map do |loc, detail|
+            { location: loc, count: detail[:count] }
+          end
+        end
+        chart_data
+      end
+
+      def generate_html binding
+        template = ERB.new(File.read(@template_path))
+        html_content = template.result(binding)
+        temp_dir = Dir.mktmpdir
+        html_dest = File.join(temp_dir, 'query_counter_report.html')
+        File.write(html_dest, html_content)
+        html_dest
+      end
+    end
+  end
+end

data/lib/active_record_query_count/printer/html_compare.rb

@@ -0,0 +1,64 @@
+require 'erb'
+require 'tempfile'
+require 'launchy'
+require 'pry-byebug'
+require 'json'
+
+module ActiveRecordQueryCount
+  module Printer
+    class HtmlCompare < Base
+      def initialize data_1:, data_2:
+        super()
+        @template_path = File.join(__dir__, 'templates', 'comparing.html.erb')
+        @css_path = File.join(__dir__, 'templates', 'style.css')
+        @js_path = File.join(__dir__, 'templates', 'bar_chart.js')
+        @script_1_name = data_1.keys.first
+        @script_2_name = data_2.keys.first
+        @data_1 = data_1[@script_1_name]
+        @data_2 = data_2[@script_2_name]
+      end
+
+      def print
+        # used by binding on erb templates
+        data_1 = sort_data(@data_1)
+        data_2 = sort_data(@data_2)
+        tables = data_1.keys | data_2.keys
+        total_query_count_1 = data_1.values.sum { |v| v[:count] }
+        total_query_count_2 = data_2.values.sum { |v| v[:count] }
+        chart_data = generate_chart_data_compare(data_1, data_2)
+        # end
+        html_dest = generate_html(binding)
+        open_file(html_dest)
+      end
+
+      private
+
+      def generate_chart_data_compare(data_1, data_2)
+        labels = (data_1.keys | data_2.keys).sort
+        chart_data = { labels: [], data_1: {}, data_2: {}, locations: {} }
+        chart_data[:data_1][:name] = @script_1_name
+        chart_data[:data_2][:name] = @script_2_name
+        chart_data[:data_1][:data] = []
+        chart_data[:data_2][:data] = []
+        labels.each do |label|
+          chart_data[:labels] << label
+          chart_data[:data_1][:data] << (data_1[label] ? data_1[label][:count] : 0)
+          chart_data[:data_2][:data] << (data_2[label] ? data_2[label][:count] : 0)
+          chart_data[:locations][label] =
+            (data_1[label] ? data_1[label][:location] : {}).merge(data_2[label] ? data_2[label][:location] : {})
+        end
+        chart_data
+      end
+
+      def generate_html binding
+        template = ERB.new(File.read(@template_path))
+        html_content = template.result(binding)
+
+        temp_dir = Dir.mktmpdir
+        html_dest = File.join(temp_dir, 'query_counter_report.html')
+        File.write(html_dest, html_content)
+        html_dest
+      end
+    end
+  end
+end

data/lib/active_record_query_count/printer/templates/bar_chart.js

@@ -0,0 +1,153 @@
+
+function toggleView() {
+  const chart = document.getElementById('queryCountChart');
+  const chartContainer = chart.parentElement;
+  const table = document.getElementById('queryTable');
+  const button = document.getElementById('toggleButton');
+  if (chartContainer.style.display === 'none') {
+    chartContainer.style.display = 'block';
+    table.style.display = 'none';
+    button.textContent = 'Show Table View';
+  } else {
+    chartContainer.style.display = 'none';
+    table.style.display = 'table';
+    button.textContent = 'Show chartContainer View';
+  };
+};
+
+function toggleColumnContent() {
+  const columnHeader = document.getElementById('columnHeader');
+  const toggleContents = document.querySelectorAll('.toggle-content');
+  const showSQL = columnHeader.textContent === 'File Path';
+
+  columnHeader.textContent = showSQL ? 'SQL' : 'File Path';
+
+  toggleContents.forEach(content => {
+    const filepath = content.querySelector('.filepath');
+    const sql = content.querySelector('.sql');
+
+    if (showSQL) {
+      filepath.style.display = 'none';
+      sql.style.display = 'block';
+    } else {
+      filepath.style.display = 'block';
+      sql.style.display = 'none';
+    }
+  });
+}
+
+function initializeChart(chartData) {
+  console.log(chartData);
+  const ctx = document.getElementById('queryCountChart').getContext('2d');
+  const queryCountChart = new Chart(ctx, {
+    type: 'bar',
+    data: {
+      labels: chartData.labels,
+      datasets: [
+        {
+          label: 'Dataset 1',
+          data: chartData.data,
+          backgroundColor: 'rgba(75, 192, 192, 0.2)',
+          borderColor: 'rgba(75, 192, 192, 1)',
+          borderWidth: 1
+        }
+      ]
+    },
+    options: {
+      scales: {
+        y: {
+          type: 'logarithmic',
+          beginAtZero: true,
+          title: {
+            display: true,
+            text: 'Logarithmic Scale'
+          },
+          ticks: {
+            callback: function(value, index, values) {
+              if (value === 0 || value === 10 || value === 100 || value === 1000 || value === 10000) {
+                return value.toString();
+              }
+              return null;
+            }
+          }
+        }
+      },
+      plugins: {
+        tooltip: {
+          callbacks: {
+            label: function(tooltipItem) {
+              const index = tooltipItem.dataIndex;
+              const table = chartData.labels[index];
+              // const locations = chartData.locations[table];
+              // Aquí se podría hacer el stackgraph
+              return [
+                `Total Queries: ${tooltipItem.raw}`,
+              ];
+            }
+          }
+        }
+      }
+    }
+  });
+  document.getElementById('queryCountChart').parentElement.style.display = 'none';
+}
+
+function initializeChartCompare(chartData) {
+  const ctx = document.getElementById('queryCountChart').getContext('2d');
+  const queryCountChart = new Chart(ctx, {
+    type: 'bar',
+    data: {
+      labels: chartData.labels,
+      datasets: [
+        {
+          label: chartData.data_1.name,
+          data: chartData.data_1.data,
+          backgroundColor: 'rgba(75, 192, 192, 0.2)',
+          borderColor: 'rgba(75, 192, 192, 1)',
+          borderWidth: 1
+        },
+        {
+          label: chartData.data_2.name,
+          data: chartData.data_2.data,
+          backgroundColor: 'rgba(255, 99, 132, 0.2)',
+          borderColor: 'rgba(255, 99, 132, 1)',
+          borderWidth: 1
+        }
+      ]
+    },
+    options: {
+      scales: {
+        y: {
+          type: 'logarithmic',
+          beginAtZero: true,
+          title: {
+            display: true,
+            text: 'Logarithmic Scale'
+          },
+          ticks: {
+            callback: function(value, index, values) {
+              if (value === 0 || value === 10 || value === 100 || value === 1000 || value === 10000) {
+                return value.toString();
+              }
+              return null;
+            }
+          }
+        }
+      },
+      plugins: {
+        tooltip: {
+          callbacks: {
+            label: function(tooltipItem) {
+              const index = tooltipItem.dataIndex;
+              const table = chartData.labels[index];
+              return [
+                `Total Queries: ${tooltipItem.raw}`,
+              ];
+            }
+          }
+        }
+      }
+    }
+  });
+  document.getElementById('queryCountChart').parentElement.style.display = 'none';
+}

data/lib/active_record_query_count/printer/templates/comparing.html.erb

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Query Counter Report</title>
+</head>
+<body>
+  <script>
+    <%= js_content %>
+  </script>
+  <style>
+    <%= css_content %>
+  </style>
+  <div id='query_counter_report_gem'>
+    <h2>Query Counter Report</h2>
+    <p>Total query count on <%= @script_1_name %>: <%= total_query_count_1 %></p>
+    <p>Total query count on <%= @script_2_name %>: <%= total_query_count_2 %></p>
+    <button id="toggleButton" onclick="toggleView()">Show Chart View</button>
+    <button id="toggleColumnButton" onclick="toggleColumnContent()">Show SQL</button>
+
+    <div class="center-container">
+      <canvas id="queryCountChart"></canvas>
+    </div>
+  <table id="queryTable">
+      <tr>
+        <th>Table</th>
+        <th>Total Query Count <%= @script_1_name %></th>
+        <th>Total Query Count <%= @script_2_name %></th>
+        <th id="columnHeader">File Path</th>
+        <th>Method</th>
+        <th>Location Count <%= @script_1_name %></th>
+        <th>Location Count <%= @script_2_name %></th>
+      </tr>
+      <% tables.each do |table_name| %>
+        <% locations = (data_1.dig(table_name, :location)&.keys || []) | (data_2.dig(table_name, :location)&.keys || [])%>
+        <tr>
+          <td rowspan="<%= locations.count + 1 %>"><%= table_name %></td>
+          <td rowspan="<%= locations.count + 1 %>"><%= data_1.dig(table_name, :count) || 0%></td>
+          <td rowspan="<%= locations.count + 1 %>"><%= data_2.dig(table_name, :count) || 0 %></td>
+        </tr>
+        <% locations.each do |loc| %>
+          <% details_1 = data_1.dig(table_name, :location, loc) || {}%>
+          <% details_2 = data_2.dig(table_name, :location, loc) || {}%>
+          <% present_detail = details_1 || details_2 %>
+          <tr class="sub-row">
+            <% match = loc&.match(/^(?<file_path>.*):in.*`(?<method>.*)'$/) %>
+            <% file_path = match ? match[:file_path] : loc %>
+            <% method = match ? match[:method] : nil %>
+            <td class="toggle-content">
+              <span class="filepath"><%= file_path %></span>
+              <span class="sql" style="display: none;"><%= present_detail[:sql]&.gsub('"', '') %></span>
+            </td>
+            <td class="method-column"><%= method %></td>
+            <td><%= details_1[:count] || 0 %></td>
+            <td><%= details_2[:count] || 0 %></td>
+          </tr>
+        <% end %>
+      <% end %>
+    </table>
+    <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
+    <script>
+      const chartData = <%= chart_data.to_json %>;
+      initializeChartCompare(chartData);
+    </script>
+  </div>
+</body>
+</html>