prosopite 1.4.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9353ec80e12bf0261cfb9c02f9845c2bedfd4285770e6691a18490542c551e24
-  data.tar.gz: 29ad5098ea8739119a54fdbc58d241debf166b6c0453388247b9d02b007d021a
+  metadata.gz: 3fac117d558ad73ba2057f45ce8ec278898d8c1b00aec41ec9a169f76c842c02
+  data.tar.gz: ee3a372e02cb138bdbaf1770b5758693c51bdedc173ff2ca93aed20413b22245
 SHA512:
-  metadata.gz: 40e9fe96155a0837e355c5a4292a592ecef3e71defaea97a62dc700164ea64c0647fce33975bc0ab3b79b6d09c4115c10d4c18e2bec0852f52b8a5df287ace0b
-  data.tar.gz: 8176697cd034b20ca5aacbae33377424a56694cd9fc3faa90cb3dce61b6815fa5bf532939d87edb919448dee098e9abe55c52fc1422b20e76545d3d1fdb56079
+  metadata.gz: e49619ff0354d91b0ebade2c418ef5a2d189d68ed3f259dca8674e378366d441144a71c0ff1d615baa834c8a00d1aea60ac7be6435fdb1035da63a61fefc3731
+  data.tar.gz: a6ca678e0052bdc3cdbce19e95c88ca233162bfe45a18f87f70f2ad77e68e2c0264e18e517979356159be90ac22f103f8c4779cd5fa29766a55d72228e5e1d09

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.7, '3.0', 3.1, 3.2]
+        ruby: [3.2, 3.3, 3.4]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

data/Gemfile.lock

@@ -1,87 +1,136 @@
 PATH
   remote: .
   specs:
-    prosopite (1.4.1)
+    prosopite (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.3)
-      actionview (= 6.1.3)
-      activesupport (= 6.1.3)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (8.0.1)
+      actionview (= 8.0.1)
+      activesupport (= 8.0.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.3)
-      activesupport (= 6.1.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.0.1)
+      activesupport (= 8.0.1)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activemodel (8.0.1)
+      activesupport (= 8.0.1)
+    activerecord (8.0.1)
+      activemodel (= 8.0.1)
+      activesupport (= 8.0.1)
+      timeout (>= 0.4.0)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ansi (1.5.0)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
     crass (1.0.6)
+    date (3.4.1)
+    drb (2.2.1)
     erubi (1.12.0)
-    factory_bot (6.1.0)
-      activesupport (>= 5.0.0)
+    factory_bot (6.5.1)
+      activesupport (>= 6.1.0)
     i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    loofah (2.19.1)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    logger (1.6.6)
+    loofah (2.24.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     method_source (1.0.0)
-    mini_portile2 (2.8.1)
-    minitest (5.14.3)
+    mini_portile2 (2.8.8)
+    minitest (5.25.4)
     minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.14.1)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.18.3)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.14.1-x86_64-linux)
+    nokogiri (1.18.3-x86_64-linux-gnu)
       racc (~> 1.4)
     pg_query (1.3.0)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.6.2)
-    rack (2.2.6.2)
+    psych (5.2.3)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.10)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
     rack-test (2.0.2)
       rack (>= 1.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
-    railties (6.1.3)
-      actionpack (= 6.1.3)
-      activesupport (= 6.1.3)
-      method_source
-      rake (>= 0.8.7)
-      thor (~> 1.0)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.1)
+      actionpack (= 8.0.1)
+      activesupport (= 8.0.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rake (13.0.6)
+    rdoc (6.12.0)
+      psych (>= 4.0.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
     ruby-progressbar (1.11.0)
-    sqlite3 (1.4.2)
-    thor (1.2.1)
-    tzinfo (2.0.4)
+    securerandom (0.4.1)
+    sqlite3 (2.5.0)
+      mini_portile2 (~> 2.8.0)
+    sqlite3 (2.5.0-x86_64-linux-gnu)
+    stringio (3.1.4)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    uri (1.0.2)
+    useragent (0.16.11)
+    zeitwerk (2.7.2)
 
 PLATFORMS
   ruby
@@ -100,4 +149,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.10
+   2.6.5

data/README.md

@@ -116,12 +116,12 @@ Or install it yourself as:
 The preferred type of notifications can be configured with:
 
 * `Prosopite.min_n_queries`: Minimum number of N queries to report per N+1 case. Defaults to 2.
-* `Prosopite.raise = true`: Raise warnings as exceptions
-* `Prosopite.rails_logger = true`: Send warnings to the Rails log
-* `Prosopite.prosopite_logger = true`: Send warnings to `log/prosopite.log`
-* `Prosopite.stderr_logger = true`: Send warnings to STDERR
+* `Prosopite.raise = true`: Raise warnings as exceptions. Defaults to `false`.
+* `Prosopite.rails_logger = true`: Send warnings to the Rails log. Defaults to `false`.
+* `Prosopite.prosopite_logger = true`: Send warnings to `log/prosopite.log`. Defaults to `false`.
+* `Prosopite.stderr_logger = true`: Send warnings to STDERR. Defaults to `false`.
 * `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.custom_logger = my_custom_logger`: Set a custom logger. See the following section for the details. Defaults to `false`.
 * `Prosopite.enabled = true`: Enables or disables the gem. Defaults to `true`.
 
 ### Custom Logging Configuration
@@ -221,12 +221,12 @@ 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.
+We also provide a middleware for sidekiq `6.5.0+` 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?
+  unless Rails.env.production?
     config.server_middleware do |chain|
       require 'prosopite/middleware/sidekiq'
       chain.add(Prosopite::Middleware::Sidekiq)
@@ -235,6 +235,13 @@ Sidekiq.configure_server do |config|
 end
 ```
 
+For applications running sidekiq < `6.5.0` but want to add the snippet, you can guard the snippet with something like this and remove it once you upgrade sidekiq:
+```ruby
+ if Sidekiq::VERSION >= '6.5.0' && (Rails.env.development? || Rails.env.test?)
+.....
+end
+```
+
 ## Allow list
 
 Ignore notifications for call stacks containing one or more substrings / regex:

data/lib/prosopite/middleware/rack.rb

@@ -6,7 +6,10 @@ module Prosopite
       end
 
       def call(env)
-        Prosopite.scan { @app.call(env) }
+        Prosopite.scan 
+        @app.call(env)
+      ensure
+        Prosopite.finish
       end
     end
   end

data/lib/prosopite/version.rb

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

data/lib/prosopite.rb

@@ -144,7 +144,12 @@ module Prosopite
     end
 
     def fingerprint(query)
-      db_adapter = ActiveRecord::Base.connection.adapter_name.downcase
+      conn = if ActiveRecord::Base.respond_to?(:lease_connection)
+               ActiveRecord::Base.lease_connection
+             else
+               ActiveRecord::Base.connection
+             end
+      db_adapter = conn.adapter_name.downcase
       if db_adapter.include?('mysql') || db_adapter.include?('trilogy')
         mysql_fingerprint(query)
       else
@@ -214,7 +219,7 @@ module Prosopite
       @prosopite_logger ||= false
       @raise ||= false
 
-      notifications_str = ''
+      notifications_str = String.new('')
 
       tc[:prosopite_notifications].each do |queries, kaller|
         notifications_str << "N+1 queries detected:\n"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prosopite
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-28 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: N+1 auto-detection for Rails with zero false positives / false negatives