n_1_finder 0.0.2

data/lib/n_1_finder/query.rb

@@ -0,0 +1,57 @@
+##
+# Query representation
+#
+class N1Finder::Query
+  # Regular expression to find numeric ids in queries and in params
+  ID = /(?<==\s)\d+/
+
+  # Regular expression to find UUIDs in queries and in params
+  UUID = /(?<==\s)(['"])\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\1/
+
+  # @!attribute [r] query
+  #   Original query string combined with params
+  # @!attribute [backtrace] line
+  #   Backtrace up to function where we cought this query
+  attr_reader :query, :backtrace
+
+  # @param [String] query
+  # @param [Hash] params
+  # @param [Array<String>] backtrace
+  def initialize(query, params, backtrace)
+    @query = self.class.query_with_params(query, params)
+    @backtrace = backtrace
+  end
+
+  # Generates query footprint
+  # Footprint consists of
+  #   - query with masked ids
+  #   - line of code where this query was executed
+  #
+  # @return [ {query, line} => String ]
+  def footprint
+    @footprint ||= { query: query_footprint, line: application_line }
+  end
+
+  # Combines query and its params to readable format
+  #
+  # @param [String] query
+  # @param [Hash] params
+  #
+  # @return [String]
+  def self.query_with_params(query, params)
+    params.map do |key, value|
+      value = "'#{value}'" if value.is_a?(String)
+      "#{key} = #{value}"
+    end.unshift(query).join(', ')
+  end
+
+  private
+
+  def query_footprint
+    @query_footprint ||= query.gsub(UUID, '[uuid]').gsub(ID, '[id]')
+  end
+
+  def application_line
+    @application_line ||= backtrace.find { |line| !line.include?('/gems/') }
+  end
+end

data/lib/n_1_finder/storage.rb

@@ -0,0 +1,23 @@
+##
+# Storage for queries
+#
+class N1Finder::Storage
+  # Stored queries. Default is `[]`.
+  #
+  # @return [Array[N1Finder::Query]]
+  attr_reader :queries
+
+  def initialize
+    @queries = []
+  end
+
+  # Adds query to storage
+  #
+  # @param [String] query the sql query
+  # @param [Array[String]] backtrace the backtrace up to query execution
+  #
+  # @return [void]
+  def add(query, params, backtrace)
+    queries << N1Finder::Query.new(query, params, backtrace)
+  end
+end

data/lib/n_1_finder/version.rb

@@ -0,0 +1,4 @@
+class N1Finder
+  # Gem version
+  VERSION = '0.0.2'.freeze
+end

data/spec/n_1_finder/adapters/active_record_adapter_spec.rb

@@ -0,0 +1,37 @@
+require 'shared_examples/adapter'
+
+RSpec.describe N1Finder::Adapters::ActiveRecordAdapter do
+  it_behaves_like 'adapter'
+
+  describe '#find_sql_params' do
+    subject { described_class.find_sql_params(params) }
+
+    context 'with empty params' do
+      let(:params) { [] }
+      it 'returns empty hash' do
+        expect(subject).to eq({})
+      end
+    end
+
+    context 'without sql params' do
+      let(:params) { ['some sql', { some: 'hash' }, [%w(some array)]] }
+      it 'returns empty hash' do
+        expect(subject).to eq({})
+      end
+    end
+
+    context 'without sql params' do
+      let(:params) do
+        [
+          [
+            [ActiveRecord::ConnectionAdapters::Column.new(:first_name, nil, nil), 'jane'],
+            [ActiveRecord::ConnectionAdapters::Column.new(:last_name, nil, nil), 'doe']
+          ]
+        ]
+      end
+      it 'returns empty hash' do
+        expect(subject).to eq(first_name: 'jane', last_name: 'doe')
+      end
+    end
+  end
+end

data/spec/n_1_finder/adapters/null_adapter_spec.rb

@@ -0,0 +1,5 @@
+require 'shared_examples/adapter'
+
+RSpec.describe N1Finder::Adapters::NullAdapter do
+  it_behaves_like 'adapter'
+end

data/spec/n_1_finder/adapters/sequel_adapter_spec.rb

@@ -0,0 +1,5 @@
+require 'shared_examples/adapter'
+
+RSpec.describe N1Finder::Adapters::SequelAdapter do
+  it_behaves_like 'adapter'
+end

data/spec/n_1_finder/features/active_record_mysql_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe N1Finder do
+  describe 'Using activerecord and mysql', type: :active_record_mysql do
+    before { populate_database }
+
+    subject { described_class.find(&n_1_heavy_block) }
+
+    it 'logs all N+1 queries' do
+      expect(described_class.logger).to receive(:debug).exactly(3).times
+      subject
+    end
+  end
+end

data/spec/n_1_finder/features/active_record_postgres_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe N1Finder do
+  describe 'Using activerecord and postgresql', type: :active_record_pg do
+    before { populate_database }
+
+    subject { described_class.find(&n_1_heavy_block) }
+
+    it 'logs all N+1 queries' do
+      expect(described_class.logger).to receive(:debug).exactly(3).times
+      subject
+    end
+  end
+end

data/spec/n_1_finder/features/active_record_sqlite_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe N1Finder do
+  describe 'Using activerecord and sqlite', type: :active_record_sqlite do
+    before { populate_database }
+
+    subject { described_class.find(&n_1_heavy_block) }
+
+    it 'logs all N+1 queries' do
+      expect(described_class.logger).to receive(:debug).exactly(3).times
+      subject
+    end
+  end
+end

data/spec/n_1_finder/features/sequel_mysql_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe N1Finder do
+  describe 'Using sequel and mysql', type: :sequel_mysql do
+    before { populate_database }
+
+    subject { described_class.find(&n_1_heavy_block) }
+
+    it 'logs all N+1 queries' do
+      expect(described_class.logger).to receive(:debug).exactly(3).times
+      subject
+    end
+  end
+end

data/spec/n_1_finder/features/sequel_postgres_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe N1Finder do
+  describe 'Using sequel and postgres', type: :sequel_pg do
+    before { populate_database }
+
+    subject { described_class.find(&n_1_heavy_block) }
+
+    it 'logs all N+1 queries' do
+      expect(described_class.logger).to receive(:debug).exactly(3).times
+
+      subject
+    end
+  end
+end

data/spec/n_1_finder/features/sequel_sqlite_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe N1Finder do
+  describe 'Using sequel and sqlite', type: :sequel_sqlite do
+    before { populate_database }
+
+    subject { described_class.find(&n_1_heavy_block) }
+
+    it 'logs all N+1 queries' do
+      expect(described_class.logger).to receive(:debug).exactly(3).times
+      subject
+    end
+  end
+end

data/spec/n_1_finder/logger_spec.rb

@@ -0,0 +1,40 @@
+RSpec.describe N1Finder::Logger do
+  let(:service) { described_class.new }
+  let(:n1_queries) do
+    [
+      instance_double(
+        N1Finder::N1Query,
+        line: 'line',
+        query: 'query',
+        original_queries: %w(one two)
+      )
+    ]
+  end
+
+  let(:logger) { Logger.new(STDOUT) }
+  before { allow(service).to receive(:logger).and_return logger }
+
+  describe '#log' do
+    subject { service.log(n1_queries) }
+
+    it 'logs line' do
+      expect(logger).to receive(:debug).once.with(include('line'))
+      subject
+    end
+
+    it 'logs query footprint' do
+      expect(logger).to receive(:debug).once.with(include('query'))
+      subject
+    end
+
+    it 'logs original_queries' do
+      expect(logger).to receive(:debug).once.with(include('one') && include('two'))
+      subject
+    end
+
+    it 'logs similar queries count' do
+      expect(logger).to receive(:debug).once.with(include(2.to_s))
+      subject
+    end
+  end
+end

data/spec/n_1_finder/middleware_spec.rb

@@ -0,0 +1,15 @@
+RSpec.describe N1Finder::Middleware do
+  let(:app) { ->(env) { env } }
+  let(:env) { 'OK' }
+  let(:service) { described_class.new(app) }
+
+  describe '#call' do
+    subject { service.call(env) }
+
+    it 'wraps app call into N1Finder.find method', type: :no_connection do
+      expect(N1Finder).to receive(:find).and_call_original
+
+      expect(subject).to eq 'OK'
+    end
+  end
+end

data/spec/n_1_finder/n_1_query_spec.rb

@@ -0,0 +1,28 @@
+RSpec.describe N1Finder::N1Query do
+  describe 'self.generate_by' do
+    let(:queries) do
+      [
+        N1Finder::Query.new('SELECT * FROM posts WHERE id = ?', { id: 1 }, ['line_1']),
+        N1Finder::Query.new('SELECT * FROM users WHERE id = ?', { id: 1 }, ['line_2']),
+        N1Finder::Query.new('SELECT * FROM users WHERE id = ?', { id: 1 }, ['line_1']),
+        N1Finder::Query.new('SELECT * FROM posts WHERE id = ?', { id: 2 }, ['line_1'])
+      ]
+    end
+
+    subject { described_class.generate_by(queries) }
+
+    it 'returns n+1 queries' do
+      expect(subject).to be_an Array
+      expect(subject.count).to eq 1
+      expect(subject.first).to be_an described_class
+    end
+
+    it 'sets attributes to n+1 queries' do
+      n1_query = subject.first
+      expect(n1_query.query).to eq 'SELECT * FROM posts WHERE id = ?, id = [id]'
+      expect(n1_query.line).to eq 'line_1'
+      expect(n1_query.original_queries[0]).to eq 'SELECT * FROM posts WHERE id = ?, id = 1'
+      expect(n1_query.original_queries[1]).to eq 'SELECT * FROM posts WHERE id = ?, id = 2'
+    end
+  end
+end

data/spec/n_1_finder/query_spec.rb

@@ -0,0 +1,81 @@
+require 'securerandom'
+
+RSpec.describe N1Finder::Query do
+  let(:service) { described_class.new(query, params, backtrace) }
+  let(:query) { nil }
+  let(:params) { {} }
+  let(:backtrace) { nil }
+  let(:id) { rand(1..100_000) }
+  let(:uuid) { SecureRandom.uuid }
+
+  describe '#query_footprint' do
+    subject { service.send(:query_footprint) }
+
+    context 'with id' do
+      let(:query) { "id = #{id}" }
+      it 'replaces id to mask' do
+        expect(subject).to eq 'id = [id]'
+      end
+    end
+
+    context 'with uuid' do
+      let(:query) { "id = '#{SecureRandom.uuid}'" }
+      it 'replaces id to mask' do
+        expect(subject).to eq 'id = [uuid]'
+      end
+    end
+
+    context 'without id or uuid' do
+      let(:query) { 'SELECT * FROM posts' }
+      it 'returns query without changes' do
+        expect(subject).to eq query
+      end
+    end
+
+    context 'with both id and uuid' do
+      let(:query) { "id = '#{SecureRandom.uuid}' AND author_id = #{id}" }
+      it 'replaces uuid and id to mask' do
+        expect(subject).to eq 'id = [uuid] AND author_id = [id]'
+      end
+    end
+
+    context 'with number in param' do
+      let(:query) { "id1 = #{id}" }
+      it 'not changes param name' do
+        expect(subject).to eq 'id1 = [id]'
+      end
+    end
+  end
+
+  describe '#application_line' do
+    subject { service.send(:application_line) }
+    let(:backtrace) do
+      [
+        '../gems/..',
+        '../app/file1.rb/..',
+        '../app/file2.rb/..',
+        '../gems/..'
+      ]
+    end
+    it 'finds latest app backtrace line' do
+      expect(subject).to eq '../app/file1.rb/..'
+    end
+  end
+
+  describe '#footprint' do
+    subject { service.footprint }
+    let(:query) { "SELECT * FROM posts WHERE id = #{id}" }
+    let(:backtrace) do
+      [
+        '../gems/..',
+        '../app/file1.rb/..',
+        '../app/file2.rb/..',
+        '../gems/..'
+      ]
+    end
+    it 'returns array of query footprint and application line' do
+      expect(subject[:query]).to eq 'SELECT * FROM posts WHERE id = [id]'
+      expect(subject[:line]).to eq '../app/file1.rb/..'
+    end
+  end
+end

data/spec/n_1_finder/storage_spec.rb

@@ -0,0 +1,23 @@
+RSpec.describe N1Finder::Storage do
+  let(:service) { described_class.new }
+
+  describe '#queries' do
+    subject { service.queries }
+
+    it 'returns an Array' do
+      expect(subject).to be_an Array
+    end
+  end
+
+  describe '#add' do
+    subject { service.add(query, params, backtrace) }
+
+    let(:query) { 'query' }
+    let(:params) { {} }
+    let(:backtrace) { [] }
+
+    it 'adds query to queries collection' do
+      expect { subject }.to change { service.queries.count }.by 1
+    end
+  end
+end

data/spec/n_1_finder_spec.rb

@@ -0,0 +1,67 @@
+RSpec.describe N1Finder do
+  describe 'self.find', type: :no_connection do
+    let(:block) { -> { 'OK' } }
+    let(:storage) { N1Finder::Storage.new }
+    let(:logger) { instance_double(N1Finder::Logger, log: nil) }
+    let(:n1_queries) { 'N1_QUERIES' }
+
+    before do
+      allow(N1Finder::Storage).to receive(:new).and_return(storage)
+      allow(N1Finder::Logger).to receive(:new).and_return(logger)
+      allow(N1Finder::N1Query).to \
+        receive(:generate_by).with(storage.queries).and_return(n1_queries)
+    end
+
+    subject { described_class.find(&block) }
+
+    it 'returns a block execution result' do
+      expect(subject).to eq 'OK'
+    end
+
+    it 'finds queries in block' do
+      expect(described_class).to receive(:catch_queries).with(storage)
+      subject
+    end
+
+    it 'logs n+1 queries' do
+      expect(logger).to receive(:log).with(n1_queries)
+      subject
+    end
+  end
+
+  describe '#logger=' do
+    subject { described_class.logger = logger }
+    context 'when logger is a Logger' do
+      let(:logger) { Logger.new(STDOUT) }
+      it 'sets a logger' do
+        subject
+        expect(described_class.logger).to eq logger
+      end
+    end
+
+    context 'when logger is not a Logger' do
+      let(:logger) { nil }
+      it 'raises error' do
+        expect { subject }.to raise_error described_class::InvalidLogger
+      end
+    end
+  end
+
+  describe '#orm=' do
+    subject { described_class.orm = orm }
+    context 'when provided supported orm' do
+      let(:orm) { described_class::ORM_ADAPTERS.keys.sample }
+      it 'sets orm' do
+        subject
+        expect(described_class.orm).to eq orm
+      end
+    end
+
+    context 'when orm is not supported' do
+      let(:orm) { :mongo }
+      it 'raises error' do
+        expect { subject }.to raise_error N1Finder::InvalidORM
+      end
+    end
+  end
+end