prosopite 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c9deb860379923d4dc495bb4f24bc44932a8be7d633be9ea59435da7ea7f51f
-  data.tar.gz: 4598734ccd6d01208847d97ac03f5bfe570c5121a3d36c6b1746b4f3ab1b455d
+  metadata.gz: 56809d2470b99359e6a6399d6814fa430ef1f3e57df935468b23a0c00125dc87
+  data.tar.gz: 85bbe7fe09890e1854ca002609af8dba88065bf33b6ac95be3f6bbefb99b3ff8
 SHA512:
-  metadata.gz: a7f1d7d7a9a5607e5d5ea73f734b3ae62a250a49f149daa2a04bf693cfd1072cb4fb3922d97f268b65116db7ad76d629430ce1dfcc792ba9dec5e8185b0440ac
-  data.tar.gz: b67c9e0c61ee1a5858c00ba666521699e69efb3866fccc770482e31a04a57a01661dd4e52dac5229b922461aa1f1d0fdff156c7d1ad8ad8b1b9f17d011748042
+  metadata.gz: d78f71f85256a83f4ca2ee94b4afed69f6b661a9af35b920acee889a7a795c9c360f55ad2dcd4b87bf4403fc6eef832916cb67d27af852fa7e14dc18c3533b44
+  data.tar.gz: 89b90cb2c449fc40ce2d09787ec2fa92791633c1474dfd7a5dad472de8ca087dc010c878b8cc26290e9b240feab6b508cf35fcde5cc92e741826dbd8b2b1e62d

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    prosopite (0.1.3)
-      pg_query (~> 1.3.0)
+    prosopite (0.2.0)
+      pg_query (~> 1.3)
 
 GEM
   remote: https://rubygems.org/

data/LICENSE.txt

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2021 Mpampis Kostas
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -77,6 +77,11 @@ Leg::Design.last(20) do |l|
 end
 ```
 
+## Why a new gem
+
+Creating a new gem makes more sense since bullet's core mechanism is completely
+different from prosopite's.
+
 ## How it works
 
 Prosopite monitors all SQL queries using the Active Support instrumentation
@@ -115,12 +120,14 @@ Prosopite auto-detection can be enabled on all controllers:
 
 ```ruby
 class ApplicationController < ActionController::Base
-  before_action do
-    Prosopite.scan
-  end
-
-  after_action do
-    Prosopite.finish
+  unless Rails.env.production?
+    before_action do
+      Prosopite.scan
+    end
+
+    after_action do
+      Prosopite.finish
+    end
   end
 end
 ```
@@ -152,21 +159,23 @@ And each test can be scanned with:
 ```ruby
 # spec/spec_helper.rb
 
-config.before do
+config.before(:each) do
   Prosopite.scan
 end
 
-config.after do
+config.after(:each) do
   Prosopite.finish
 end
 ```
 
-## Whitelisting
+WARNING: scan/finish should run before/after **each** test and NOT before/after the whole suite.
+
+## Allow list
 
 Ignore notifications for call stacks containing one or more substrings:
 
 ```ruby
-Prosopite.whitelist = ['substring_in_call_stack']
+Prosopite.allow_list = ['substring_in_call_stack']
 ```
 
 ## Scanning code outside controllers or tests

data/lib/prosopite.rb

@@ -7,32 +7,46 @@ module Prosopite
                 :stderr_logger,
                 :rails_logger,
                 :prosopite_logger,
-                :whitelist
+                :allow_list
 
     def scan
+      tc[:prosopite_scan] ||= false
       return if scan?
+
       subscribe
 
-      @query_counter = Hash.new(0)
-      @query_holder = Hash.new { |h, k| h[k] = [] }
-      @query_caller = {}
+      tc[:prosopite_query_counter] = Hash.new(0)
+      tc[:prosopite_query_holder] = Hash.new { |h, k| h[k] = [] }
+      tc[:prosopite_query_caller] = {}
+
+      @allow_list ||= []
 
-      @whitelist ||= []
-      @scan = true
+      tc[:prosopite_scan] = true
+    end
+
+    def tc
+      Thread.current
     end
 
     def scan?
-      @scan
+      tc[:prosopite_scan]
     end
 
     def finish
       return unless scan?
 
-      @notifications = {}
+      tc[:prosopite_scan] = false
+
+      create_notifications
+      send_notifications if tc[:prosopite_notifications].present?
+    end
+
+    def create_notifications
+      tc[:prosopite_notifications] = {}
 
-      @query_counter.each do |location_key, count|
+      tc[:prosopite_query_counter].each do |location_key, count|
         if count > 1
-          fingerprints = @query_holder[location_key].map do |q|
+          fingerprints = tc[:prosopite_query_holder][location_key].map do |q|
             begin
               fingerprint(q)
             rescue
@@ -40,30 +54,31 @@ module Prosopite
             end
           end
 
-          kaller = @query_caller[location_key]
+          kaller = tc[:prosopite_query_caller][location_key]
 
-          if fingerprints.uniq.size == 1 && !kaller.any? { |f| @whitelist.any? { |s| f.include?(s) } }
-            queries = @query_holder[location_key]
+          if fingerprints.uniq.size == 1 && !kaller.any? { |f| @allow_list.any? { |s| f.include?(s) } }
+            queries = tc[:prosopite_query_holder][location_key]
 
             unless kaller.any? { |f| f.include?('active_record/validations/uniqueness') }
-              @notifications[queries] = kaller
+              tc[:prosopite_notifications][queries] = kaller
             end
           end
         end
       end
+    end
 
-      @scan = false
-      Prosopite.send_notifications if @notifications.present?
+    def fingerprint(query)
+      if ActiveRecord::Base.connection.adapter_name.downcase.include?('mysql')
+        mysql_fingerprint(query)
+      else
+        PgQuery.fingerprint(query)
+      end
     end
 
     # Many thanks to https://github.com/genkami/fluent-plugin-query-fingerprint/
-    def fingerprint(query)
+    def mysql_fingerprint(query)
       query = query.dup
 
-      unless ActiveRecord::Base.connection.adapter_name.downcase.include?('mysql')
-        return PgQuery.fingerprint(query)
-      end
-
       return "mysqldump" if query =~ %r#\ASELECT /\*!40001 SQL_NO_CACHE \*/ \* FROM `#
       return "percona-toolkit" if query =~ %r#\*\w+\.\w+:[0-9]/[0-9]\*/#
       if match = /\A\s*(call\s+\S+)\(/i.match(query)
@@ -108,9 +123,14 @@ module Prosopite
     end
 
     def send_notifications
+      @rails_logger ||= false
+      @stderr_logger ||= false
+      @prosopite_logger ||= false
+      @raise ||= false
+
       notifications_str = ''
 
-      @notifications.each do |queries, kaller|
+      tc[:prosopite_notifications].each do |queries, kaller|
         notifications_str << "N+1 queries detected:\n"
         queries.each { |q| notifications_str << "  #{q}\n" }
         notifications_str << "Call stack:\n"
@@ -120,8 +140,8 @@ module Prosopite
         notifications_str << "\n"
       end
 
-      Rails.logger.warn(notifications_str) if @rails_logger
-      $stderr.puts(notifications_str) if @stderr_logger
+      Rails.logger.warn(red(notifications_str)) if @rails_logger
+      $stderr.puts(red(notifications_str)) if @stderr_logger
 
       if @prosopite_logger
         File.open(File.join(Rails.root, 'log', 'prosopite.log'), 'a') do |f|
@@ -132,9 +152,13 @@ module Prosopite
       raise NPlusOneQueriesError.new(notifications_str) if @raise
     end
 
+    def red(str)
+      "\e[91m#{str}\e[0m\n"
+    end
+
     def subscribe
+      @subscribed ||= false
       return if @subscribed
-      @subscribed = true
 
       ActiveSupport::Notifications.subscribe 'sql.active_record' do |_, _, _, _, data|
         sql = data[:sql]
@@ -142,14 +166,16 @@ module Prosopite
         if scan? && sql.include?('SELECT') && data[:cached].nil?
           location_key = Digest::SHA1.hexdigest(caller.join)
 
-          @query_counter[location_key] += 1
-          @query_holder[location_key] << sql
+          tc[:prosopite_query_counter][location_key] += 1
+          tc[:prosopite_query_holder][location_key] << sql
 
-          if @query_counter[location_key] > 1
-            @query_caller[location_key] = caller.dup
+          if tc[:prosopite_query_counter][location_key] > 1
+            tc[:prosopite_query_caller][location_key] = caller.dup
           end
         end
       end
+
+      @subscribed = true
     end
   end
 end

data/lib/prosopite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prosopite
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/prosopite.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'pg_query', '~> 1.3.0'
+  spec.add_runtime_dependency 'pg_query', '~> 1.3'
 
   spec.add_development_dependency "pry"
   spec.add_development_dependency "minitest"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prosopite
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_query
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -132,7 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: N+1 auto-detection for Rails with zero false positives / false negatives