prosopite 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c755dcf6b652f0c40d14ff94a4f6dc7beb9cc4f9612cff5ea95ce272d81b31bb
-  data.tar.gz: 4c15915fb03a38760c93edd4fa5c12a7db3d48d1611d470f320a494c3f6673a1
+  metadata.gz: b53b2e152727ab756b2ddb8ae7b34e36c82f0bdb84a59a7345cdf3a8866daf88
+  data.tar.gz: b7aed1d1436d6fb14347b826eed46802ee7c0bb9069a22cdf4bf01d5ce1fbad2
 SHA512:
-  metadata.gz: 1048554ad84f00835366801abd599fd590512d88d1523de3434ee24eec23aac9a9f1506084244295cbd34b80808b1ade2068027e958e531028d70ea9df21b970
-  data.tar.gz: 5acd7e945c9056875adb72cc4222ec766df17f7ff638e1307de28b8a4486067df40f736522a9dd4f10d69da859350fcb9477fe98de4027ca57b362cb9bf930b8
+  metadata.gz: c42247c6d608841951aeec07580528578581856dff3f24a0bd72655036c9aace5de4db18587e2db489e6f5a44662531b45e0a2ec900da37e65d3c3e2a1c10a3e
+  data.tar.gz: b164c81ea349b7b537e09c286110316fe8d36b5b2343df425543786ef92f7448d6e1632d792a37146f2af77d418f9bb17a1dbe8c146af643f2c2362fe9bf99b3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prosopite (1.3.2)
+    prosopite (1.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -122,6 +122,7 @@ The preferred type of notifications can be configured with:
 * `Prosopite.stderr_logger = true`: Send warnings to STDERR
 * `Prosopite.backtrace_cleaner = my_custom_backtrace_cleaner`: use a different [ActiveSupport::BacktraceCleaner](https://api.rubyonrails.org/classes/ActiveSupport/BacktraceCleaner.html). Defaults to `Rails.backtrace_cleaner`.
 * `Prosopite.custom_logger = my_custom_logger`:
+* `Prosopite.enabled = true`: Enables or disables the gem. Defaults to `true`.
 
 ### Custom Logging Configuration
 
@@ -203,6 +204,37 @@ end
 
 WARNING: scan/finish should run before/after **each** test and NOT before/after the whole suite.
 
+## Middleware
+
+### Rack
+
+Instead of using an `around_action` hook in a Rails Controller, you can also use the rack middleware instead
+implementing auto detect for all controllers.
+
+Add the following line into your `config/initializers/prosopite.rb` file.
+
+```ruby
+unless Rails.production?
+  require 'prosopite/middleware/rack'
+  Rails.configuration.middleware.use(Prosopite::Middleware::Rack)
+end
+
+
+### Sidekiq
+We also provide a middleware for sidekiq so that you can auto detect n+1 queries that may occur in a sidekiq job.
+You just need to add the following to your sidekiq initializer.
+
+```ruby
+Sidekiq.configure_server do |config|
+  unless Rails.production?
+    config.server_middleware do |chain|
+      require 'prosopite/middleware/sidekiq'
+      chain.add(Prosopite::Middleware::Sidekiq)
+    end
+  end
+end
+```
+
 ## Allow list
 
 Ignore notifications for call stacks containing one or more substrings / regex:

data/lib/prosopite/middleware/rack.rb

@@ -0,0 +1,13 @@
+module Prosopite
+  module Middleware
+    class Rack
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Prosopite.scan { @app.call(env) }
+      end
+    end
+  end
+end

data/lib/prosopite/middleware/sidekiq.rb

@@ -0,0 +1,14 @@
+module Prosopite
+  module Middleware
+    class Sidekiq
+      include Sidekiq::ServerMiddleware
+  
+      def call(_worker, _msg, _queue)
+        Prosopite.scan
+        yield
+      ensure
+        Prosopite.finish
+      end
+    end
+  end  
+end

data/lib/prosopite/version.rb

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

data/lib/prosopite.rb

@@ -12,11 +12,13 @@ module Prosopite
                 :rails_logger,
                 :prosopite_logger,
                 :custom_logger,
-                :allow_stack_paths,
-                :ignore_queries,
                 :ignore_pauses,
-                :min_n_queries,
-                :backtrace_cleaner
+                :backtrace_cleaner,
+                :enabled
+
+    attr_accessor :allow_stack_paths,
+                  :ignore_queries,
+                  :min_n_queries
 
     def allow_list=(value)
       puts "Prosopite.allow_list= is deprecated. Use Prosopite.allow_stack_paths= instead."
@@ -28,9 +30,21 @@ module Prosopite
       @backtrace_cleaner ||= Rails.backtrace_cleaner
     end
 
+    def enabled?
+      @enabled = true if @enabled.nil?
+
+      @enabled
+    end
+
+    def disabled?
+      !enabled?
+    end
+
     def scan
       tc[:prosopite_scan] ||= false
-      return if scan?
+      if scan? || disabled?
+        return block_given? ? yield : nil
+      end
 
       subscribe
 
@@ -130,7 +144,8 @@ module Prosopite
     end
 
     def fingerprint(query)
-      if ActiveRecord::Base.connection.adapter_name.downcase.include?('mysql')
+      db_adapter = ActiveRecord::Base.connection.adapter_name.downcase
+      if db_adapter.include?('mysql') || db_adapter.include?('trilogy')
         mysql_fingerprint(query)
       else
         begin
@@ -246,13 +261,14 @@ module Prosopite
         sql, name = data[:sql], data[:name]
 
         if scan? && name != "SCHEMA" && sql.include?('SELECT') && data[:cached].nil? && !ignore_query?(sql)
-          location_key = Digest::SHA1.hexdigest(caller.join)
+          query_caller = caller
+          location_key = Digest::SHA256.hexdigest(query_caller.join)
 
           tc[:prosopite_query_counter][location_key] += 1
           tc[:prosopite_query_holder][location_key] << sql
 
           if tc[:prosopite_query_counter][location_key] > 1
-            tc[:prosopite_query_caller][location_key] = caller.dup
+            tc[:prosopite_query_caller][location_key] = query_caller.dup
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prosopite
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -123,6 +123,8 @@ files:
 - README.md
 - Rakefile
 - lib/prosopite.rb
+- lib/prosopite/middleware/rack.rb
+- lib/prosopite/middleware/sidekiq.rb
 - lib/prosopite/version.rb
 - prosopite.gemspec
 homepage: https://github.com/charkost/prosopite