log_sanity 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bddde1806a3f446baf620b17fa996ba29cbe75488577e72a1a3fc865332cf931
-  data.tar.gz: af41ffa35843b478b464007c08e53531ac24259ac4fb4519d75f783e33abc6c4
+  metadata.gz: 3a0edb320430f364dcba88e455a88eb3cea47cc2630b691457e70b9727001a70
+  data.tar.gz: db6591479d06b2b435bbd8992f3abf28e47dc15414bc87ccf6d7d3f0864e998d
 SHA512:
-  metadata.gz: 5ef34565a72c61fd99c4d23bc7033fb9c06cd90cbf6d98a7d81ad792c06f54d191e50dd26edd78e2fc9864d125da0cabfc296b1ef821bd5fddba313ee120819d
-  data.tar.gz: 65088f0e38663f5f813ed0c05e21330fc519cbc5181ef003292613418bdd219c9f1c5f6fd519c50a5ea6733e08f69f182e1440ca194148c0506b1c180693d2fe
+  metadata.gz: ef54dae274716b9d5c2bc180747b44cda69892a42e1c7addb7c8bee1275869ec9d4db97e88a5c0428eb15562bc49b1611c94160031fae6022c88c49902bda53f
+  data.tar.gz: '0191a93198383de05c394f38d3cf4f046d0189d3b5ef78da900fd237353aab913bff98665fc606225a0179e187cd063e87e1947b617a08beebeead11d77cf8d6'

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+#### 2.0.0
+
+- (Breaking) Require Rails 7.1
+  For Rails 5.2, 6.x, and 7.0, use log_sanity 1.x
+- (Potentially breaking) Remove RoutingErrorCatcher middleware
+  Shouldn't break unless directly referenced during app's middleware setup
+  Mostly not needed on Rails 7.1, but for an alternative, see [rails-hush](https://github.com/zarqman/rails-hush) gem
+- Handle new events and updated payloads for Rails 7.1
+- Use updated instrumentation API in request_logger
+- Refactor initializer to use on_load
+
+#### 1.3.2
+
+- Fix logging on Rails 7.1 due to default use of BroadcastLogger
+
 #### 1.3.1
 
 - Handle updated show_exceptions values in Rails 7.1

data/Gemfile.lock

@@ -1,86 +1,103 @@
 PATH
   remote: .
   specs:
-    log_sanity (1.3.1)
-      rails (>= 5.2, < 7.2)
+    log_sanity (2.0.0)
+      rails (>= 7.1, < 7.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.5)
-      actionpack (= 7.0.5)
-      activesupport (= 7.0.5)
+    actioncable (7.1.0)
+      actionpack (= 7.1.0)
+      activesupport (= 7.1.0)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.5)
-      actionpack (= 7.0.5)
-      activejob (= 7.0.5)
-      activerecord (= 7.0.5)
-      activestorage (= 7.0.5)
-      activesupport (= 7.0.5)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.0)
+      actionpack (= 7.1.0)
+      activejob (= 7.1.0)
+      activerecord (= 7.1.0)
+      activestorage (= 7.1.0)
+      activesupport (= 7.1.0)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.5)
-      actionpack (= 7.0.5)
-      actionview (= 7.0.5)
-      activejob (= 7.0.5)
-      activesupport (= 7.0.5)
+    actionmailer (7.1.0)
+      actionpack (= 7.1.0)
+      actionview (= 7.1.0)
+      activejob (= 7.1.0)
+      activesupport (= 7.1.0)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.5)
-      actionview (= 7.0.5)
-      activesupport (= 7.0.5)
-      rack (~> 2.0, >= 2.2.4)
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.0)
+      actionview (= 7.1.0)
+      activesupport (= 7.1.0)
+      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)
-    actiontext (7.0.5)
-      actionpack (= 7.0.5)
-      activerecord (= 7.0.5)
-      activestorage (= 7.0.5)
-      activesupport (= 7.0.5)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.0)
+      actionpack (= 7.1.0)
+      activerecord (= 7.1.0)
+      activestorage (= 7.1.0)
+      activesupport (= 7.1.0)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.5)
-      activesupport (= 7.0.5)
+    actionview (7.1.0)
+      activesupport (= 7.1.0)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.5)
-      activesupport (= 7.0.5)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.0)
+      activesupport (= 7.1.0)
       globalid (>= 0.3.6)
-    activemodel (7.0.5)
-      activesupport (= 7.0.5)
-    activerecord (7.0.5)
-      activemodel (= 7.0.5)
-      activesupport (= 7.0.5)
-    activestorage (7.0.5)
-      actionpack (= 7.0.5)
-      activejob (= 7.0.5)
-      activerecord (= 7.0.5)
-      activesupport (= 7.0.5)
+    activemodel (7.1.0)
+      activesupport (= 7.1.0)
+    activerecord (7.1.0)
+      activemodel (= 7.1.0)
+      activesupport (= 7.1.0)
+      timeout (>= 0.4.0)
+    activestorage (7.1.0)
+      actionpack (= 7.1.0)
+      activejob (= 7.1.0)
+      activerecord (= 7.1.0)
+      activesupport (= 7.1.0)
       marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.5)
+    activesupport (7.1.0)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
     builder (3.2.4)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.3)
+    drb (2.1.1)
+      ruby2_keywords
     erubi (1.12.0)
-    globalid (1.1.0)
-      activesupport (>= 5.0)
-    i18n (1.13.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.8.1)
+      rdoc
+      reline (>= 0.3.8)
     loofah (2.21.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -90,65 +107,84 @@ GEM
       net-pop
       net-smtp
     marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.18.0)
-    net-imap (0.3.4)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
+    net-imap (0.4.1)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
     net-protocol (0.2.1)
       timeout
-    net-smtp (0.3.3)
+    net-smtp (0.4.0)
       net-protocol
     nio4r (2.5.9)
-    nokogiri (1.15.2-arm64-darwin)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
       racc (~> 1.4)
-    racc (1.6.2)
-    rack (2.2.7)
+    psych (5.1.0)
+      stringio
+    racc (1.7.1)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
     rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.5)
-      actioncable (= 7.0.5)
-      actionmailbox (= 7.0.5)
-      actionmailer (= 7.0.5)
-      actionpack (= 7.0.5)
-      actiontext (= 7.0.5)
-      actionview (= 7.0.5)
-      activejob (= 7.0.5)
-      activemodel (= 7.0.5)
-      activerecord (= 7.0.5)
-      activestorage (= 7.0.5)
-      activesupport (= 7.0.5)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.0)
+      actioncable (= 7.1.0)
+      actionmailbox (= 7.1.0)
+      actionmailer (= 7.1.0)
+      actionpack (= 7.1.0)
+      actiontext (= 7.1.0)
+      actionview (= 7.1.0)
+      activejob (= 7.1.0)
+      activemodel (= 7.1.0)
+      activerecord (= 7.1.0)
+      activestorage (= 7.1.0)
+      activesupport (= 7.1.0)
       bundler (>= 1.15.0)
-      railties (= 7.0.5)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 7.1.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.0.5)
-      actionpack (= 7.0.5)
-      activesupport (= 7.0.5)
-      method_source
+    railties (7.1.0)
+      actionpack (= 7.1.0)
+      activesupport (= 7.1.0)
+      irb
+      rackup (>= 1.0.0)
       rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rake (13.0.6)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    reline (0.3.9)
+      io-console (~> 0.5)
+    ruby2_keywords (0.0.5)
+    stringio (3.0.8)
     thor (1.2.2)
-    timeout (0.3.2)
+    timeout (0.4.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.5)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.8)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   arm64-darwin
-  ruby
   x86_64-darwin
   x86_64-linux
 
@@ -156,4 +192,4 @@ DEPENDENCIES
   log_sanity!
 
 BUNDLED WITH
-   2.3.26
+   2.4.10

data/README.md

@@ -27,11 +27,16 @@ Example output: (Multi-line and extra whitespace added for readability; normally
 
 ### Installation
 
-Install the usual way:
+For Rails 7.1+, use log_sanity 2.x:
 ```ruby
 gem 'log_sanity'
 ```
 
+For Rails 5.2, 6.x, or 7.0, use log_sanity 1.x:
+```ruby
+gem 'log_sanity', '~> 1'
+```
+
 By default, LogSanity does not enable itself. To do so, in `config/environments/production.rb` add:
 ```ruby
 config.logsanity.enabled = true
@@ -47,7 +52,7 @@ LogSanity initializes after running `application.rb` and `config/environments/*.
 
 However, `initializers/*.rb` may be used to reduce the scope of what's logged. For example, to skip logging of ActiveJob requests only:
 ```ruby
-# initializers/logsanity.rb
+# initializers/log_sanity.rb
 LogSanity::LogSubscriber::ActiveJob.detach_from :active_job
 ```
 
@@ -130,7 +135,7 @@ However, if `true`, you'll see:
 
 ##### String formatting
 
-When LogSanity initializes, it replaces the Rails log formatter with its own, but saves the old one for outputting strings (assuming `json_strings` is `false`). This means you can still configure the formatting of those. For example, to use Logger's default formatting (instead of Rails' default):
+When LogSanity initializes, it replaces the Rails log formatter with its own, but saves the old one for outputting strings (used when `json_strings` is `false`). This means you can still configure the formatting of those. For example, to use Logger's default formatting (instead of Rails' default):
 
 ```ruby
 config.log_formatter = ::Logger::Formatter.new
@@ -152,7 +157,7 @@ LogSanity takes these and adds them to the default request log entry (but _not_
 
 ### Additional notes
 
-LogSanity is intended for production use at log_level info. At level debug, some logs are simply turned off. Others may continue to output as normal strings (such as ActiveRecord).
+LogSanity is intended for production use at log_level info. At level debug, some logs are simply turned off. Others may continue to output as normal strings (such as ActiveRecord queries).
 
 If not using tags, there is no need to use ActiveSupport::TaggedLogging with your logger. Just set the logger directly (if not using the default):
 ```ruby
@@ -161,8 +166,6 @@ config.logger = ActiveSupport::Logger.new(STDOUT)
 
 All default output includes the :uuid/:request_id using the key "rq". There is no need to add \[:uuid] to `config.log_tags`.
 
-`ActionController::RoutingError` exceptions are always silenced and turned into a simple 404 log entry.
-
 The request path is not included, as it mostly just duplicates `route` and `params`. If you need it, you could add it using `config.log_tags = [:filtered_path]`. Alternatively, consider adding X-Request-Id to your `nginx` (or other webserver) logs and correlating to those logs instead.
 
 The `total` duration may be longer than you're used to seeing. By default, Rails only counts the time inside the application controller. In contrast, LogSanity also includes all the middleware between itself and the application controller. While this isn't the entire picture, it is closer to the actual real time elapsed.
@@ -173,7 +176,6 @@ The `total` duration may be longer than you're used to seeing. By default, Rails
 In short:
 * Removes all default Rails logging, replacing it with its own
 * Replaces Rails::Rack::Logger middleware with its own
-* Adds middleware to intercept routing errors
 * Replaces the current logger's formatter
 
 

data/lib/log_sanity/extensions/broadcast_logger.rb

@@ -0,0 +1,13 @@
+module LogSanity
+  module Extensions
+    module BroadcastLogger
+      extend ActiveSupport::Concern
+
+      def initialize_copy(other)
+        super
+        @broadcasts = other.broadcasts.deep_dup
+      end
+
+    end
+  end
+end

data/lib/log_sanity/log_subscribers/action_dispatch.rb

@@ -35,6 +35,10 @@ module LogSanity
         end
       end
 
+      def redirect(event)
+        log 'redirect', event.payload[:location]
+      end
+
 
       private
 

data/lib/log_sanity/log_subscribers/active_job.rb

@@ -13,6 +13,11 @@ module LogSanity
             'queue' => job.queue_name
           }
           e['params'] = job.arguments if job.arguments.any?
+          if error = event.payload[:exception_object] || job.enqueue_error
+            e['error'] = error
+          elsif event.payload[:aborted]
+            e['callback_halt'] = 'before_enqueue'
+          end
           e
         end
       end
@@ -29,10 +34,27 @@ module LogSanity
             'start_at' => job.scheduled_at
           }
           e['params'] = job.arguments if job.arguments.any?
+          if error = event.payload[:exception_object] || job.enqueue_error
+            e['error'] = error
+          elsif event.payload[:aborted]
+            e['callback_halt'] = 'before_enqueue'
+          end
           e
         end
       end
 
+      def enqueue_all(event)
+        info do
+          total = event.payload[:jobs].size
+          enqueued = event.payload[:enqueued_count]
+          { 'at' => Time.now,
+            'event' => 'bulk_enqueue',
+            'enqueued' => enqueued,
+            'failed' => total - enqueued,
+          }
+        end
+      end
+
       # def perform_start(event)
       #   info do
       #     job = event.payload[:job]
@@ -60,6 +82,11 @@ module LogSanity
             'duration' => {'total' => event.duration.round}
           }
           e['params'] = job.arguments if job.arguments.any?
+          if error = event.payload[:exception_object]
+            e['error'] = error
+          elsif event.payload[:aborted]
+            e['callback_halt'] = 'before_perform'
+          end
           e
         end
       end

data/lib/log_sanity/middleware/request_logger.rb

@@ -9,15 +9,21 @@ module LogSanity
       request = ActionDispatch::Request.new(env)
 
       conditionally_silence(request) do |silence|
+        payload = {env: env, request: request, silence: silence}
+        handle = start(payload)
         begin
-          start(request: request)
-          resp = @app.call(env)
-          resp[2] = Rack::BodyProxy.new(resp[2]) do
-            finish(env: env, request: request, response: resp, silence: silence)
+          status, headers, body = response = @app.call(env)
+          payload[:response] = response
+          body = Rack::BodyProxy.new(body){ handle.finish }
+          if response.frozen?
+            [status, headers, body]
+          else
+            response[2] = body
+            response
           end
-          resp
         rescue Exception => e
-          finish(env: env, request: request, exception: e, silence: silence)
+          payload[:exception] = e
+          handle.finish
           raise e
         end
       end
@@ -39,15 +45,12 @@ module LogSanity
 
     private
 
-    def start(params)
+    def start(payload)
       LogSanity.reset_fields
       instrumenter = ActiveSupport::Notifications.instrumenter
-      instrumenter.start 'request.action_dispatch', params
-    end
-
-    def finish(params)
-      instrumenter = ActiveSupport::Notifications.instrumenter
-      instrumenter.finish 'request.action_dispatch', params
+      instrumenter.build_handle('request.action_dispatch', payload).tap do |handle|
+        handle.start
+      end
     end
 
     def silence_path?(request)

data/lib/log_sanity/railtie.rb

@@ -13,71 +13,72 @@ module LogSanity
     end
 
     initializer "log_sanity.configure", before: :load_config_initializers do |app|
+      ActiveSupport::BroadcastLogger.include LogSanity::Extensions::BroadcastLogger
       app.config.log_tags ||= []
+
       if app.config.logsanity.enabled
         orig_formatter = Rails.logger.formatter
         Rails.logger.formatter = LogSanity::Formatter.new
         if app.config.logsanity.json_strings
           Rails.logger.formatter.string_formatter = false
-        else
-          Rails.logger.formatter.string_formatter = orig_formatter if orig_formatter
+        elsif orig_formatter
+          Rails.logger.formatter.string_formatter = orig_formatter
         end
 
-        if defined?(ActionController)
-          require 'action_controller/log_subscriber'
-          ActionController::LogSubscriber.detach_from :action_controller
-        end
-        if defined?(ActionMailer)
-          require 'action_mailer/log_subscriber'
-          ActionMailer::LogSubscriber.detach_from :action_mailer
-        end
-        if defined?(ActionView)
-          require 'action_view/log_subscriber'
-          ActionView::LogSubscriber.detach_from :action_view
-        end
-        if defined?(ActiveJob)
-          require 'active_job/logging'
-          begin
-            require 'active_job/log_subscriber' # >= 6.1
-          rescue LoadError
-          end
-          if defined?(ActiveJob::LogSubscriber) # >= 6.1
-            ActiveJob::LogSubscriber.detach_from :active_job
-          else # < 6.1
-            ActiveJob::Logging::LogSubscriber.detach_from :active_job
-          end
-        end
-        if defined?(ActiveRecord)
-          # require 'active_record/log_subscriber'
-          # ActiveRecord::LogSubscriber.detach_from :active_record
-            # this turns off measurements too
-          if ActiveRecord::Base.logger.debug?
-            Rails.logger.info '[LogSanity] ActiveRecord::Base.logger in debug mode and will still log queries'
-          end
+        app.middleware.swap Rails::Rack::Logger, LogSanity::RequestLogger
+
+        ActiveSupport.on_load(:action_cable_connection) do
+          prepend LogSanity::Extensions::ActionCableConnection
         end
 
         ActiveSupport.on_load(:action_cable) do
+          # set just ActionCable's logger to :warn to silence several non-instrumented logs
           orig_logger = logger || Rails.logger
           if orig_logger.level < Logger::WARN
             self.logger = orig_logger.clone.tap do |l|
               l.level = Logger::WARN
             end
           end
+          LogSanity::LogSubscriber::ActionCable.attach_to :action_cable
         end
-        ActiveSupport.on_load(:action_cable_connection) do
-          prepend LogSanity::Extensions::ActionCableConnection
+
+        ActiveSupport.on_load(:action_controller, run_once: true) do
+          ActionController::LogSubscriber.detach_from :action_controller
+          LogSanity::LogSubscriber::ActionController.attach_to :action_controller
         end
 
-        LogSanity::LogSubscriber::ActionCable.attach_to :action_cable
-        LogSanity::LogSubscriber::ActionController.attach_to :action_controller
-        LogSanity::LogSubscriber::ActionDispatch.attach_to :action_dispatch
-        LogSanity::LogSubscriber::ActionMailer.attach_to :action_mailer
-        LogSanity::LogSubscriber::ActiveJob.attach_to :active_job
+        ActiveSupport.on_load(:action_dispatch_request) do
+          ActionDispatch::LogSubscriber.detach_from :action_dispatch
+          LogSanity::LogSubscriber::ActionDispatch.attach_to :action_dispatch
+        end
 
-        app.middleware.swap Rails::Rack::Logger, LogSanity::RequestLogger
+        ActiveSupport.on_load(:action_mailer) do
+          ActionMailer::LogSubscriber.detach_from :action_mailer
+          LogSanity::LogSubscriber::ActionMailer.attach_to :action_mailer
+        end
+
+        ActiveSupport.on_load(:action_view) do
+          ActionView::LogSubscriber.detach_from :action_view
+          if ActionView::LogSubscriber.logger.debug?
+            ActiveSupport::Notifications.unsubscribe 'render_template.action_view'
+            ActiveSupport::Notifications.unsubscribe 'render_layout.action_view'
+          end
+        end
+
+        ActiveSupport.on_load(:active_job) do
+          ActiveJob::LogSubscriber.detach_from :active_job
+          LogSanity::LogSubscriber::ActiveJob.attach_to :active_job
+        end
+
+        ActiveSupport.on_load(:active_record) do
+          # ActiveRecord::LogSubscriber.detach_from :active_record
+            # only logs at :debug level. since log_sanity offers no replacements, don't detach. if logging in
+            # production at :debug, may silence anyway by adding an initializer with the above detach_from.
+          if ActiveRecord::Base.logger.debug?
+            Rails.logger.info '[LogSanity] ActiveRecord::Base.logger in debug mode and will still log queries'
+          end
+        end
 
-        show_exceptions_app = app.config.exceptions_app || ActionDispatch::PublicExceptions.new(Rails.public_path)
-        app.middleware.use LogSanity::RoutingErrorCatcher, show_exceptions_app
       end
     end
 

data/lib/log_sanity/version.rb

@@ -1,3 +1,3 @@
 module LogSanity
-  VERSION = '1.3.1'
+  VERSION = '2.0.0'
 end

data/lib/log_sanity.rb

@@ -1,28 +1,25 @@
-%w( formatter
-    railtie
-    log_subscribers/base
-    log_subscribers/action_cable
-    log_subscribers/action_controller
-    log_subscribers/action_dispatch
-    log_subscribers/action_mailer
-    log_subscribers/active_job
-    middleware/request_logger
-    middleware/routing_error_catcher
-    extensions/action_cable_connection
-    extensions/action_controller_helper
-    extensions/active_support_subscriber
-  ).each do |fn|
+%w(
+  formatter
+  railtie
+  log_subscribers/base
+  log_subscribers/action_cable
+  log_subscribers/action_controller
+  log_subscribers/action_dispatch
+  log_subscribers/action_mailer
+  log_subscribers/active_job
+  middleware/request_logger
+  extensions/action_cable_connection
+  extensions/action_controller_helper
+  extensions/broadcast_logger
+).each do |fn|
   require_relative "log_sanity/#{fn}"
 end
 
-if Rails.version < '6'
-  ActiveSupport::Subscriber.include LogSanity::Extensions::ActiveSupportSubscriber
-end
-
 module LogSanity
   module_function
 
   def fields
+    # this is fiber-local
     Thread.current[:logsanity_fields] || reset_fields
   end
 

data/log_sanity.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency 'rails', '>= 5.2', '< 7.2'
+  s.add_dependency 'rails', '>= 7.1', '< 7.2'
 end

data/test/dummy/config/application.rb

@@ -12,6 +12,8 @@ require "log_sanity"
 
 module Dummy
   class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_sanity
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-27 00:00:00.000000000 Z
+date: 2023-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.2'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.2'
@@ -48,7 +48,7 @@ files:
 - lib/log_sanity.rb
 - lib/log_sanity/extensions/action_cable_connection.rb
 - lib/log_sanity/extensions/action_controller_helper.rb
-- lib/log_sanity/extensions/active_support_subscriber.rb
+- lib/log_sanity/extensions/broadcast_logger.rb
 - lib/log_sanity/formatter.rb
 - lib/log_sanity/log_subscribers/action_cable.rb
 - lib/log_sanity/log_subscribers/action_controller.rb
@@ -57,7 +57,6 @@ files:
 - lib/log_sanity/log_subscribers/active_job.rb
 - lib/log_sanity/log_subscribers/base.rb
 - lib/log_sanity/middleware/request_logger.rb
-- lib/log_sanity/middleware/routing_error_catcher.rb
 - lib/log_sanity/railtie.rb
 - lib/log_sanity/version.rb
 - lib/tasks/log_sanity_tasks.rake

data/lib/log_sanity/extensions/active_support_subscriber.rb

@@ -1,25 +0,0 @@
-module LogSanity
-  module Extensions
-    module ActiveSupportSubscriber
-      extend ActiveSupport::Concern
-
-      module ClassMethods
-        def detach_from(namespace, notifier=ActiveSupport::Notifications)
-          subscribers.select{|s| s.is_a? self}.each do |subscriber|
-            subscriber.public_methods(false).each do |event|
-              pattern = "#{event}.#{namespace}"
-              notifier.notifier.listeners_for(pattern).each do |listener|
-                if listener.instance_variable_get(:@delegate) == subscriber
-                  notifier.unsubscribe listener
-                  subscriber.patterns.delete pattern
-                end
-              end
-            end
-            subscribers.delete subscriber if subscriber.patterns.empty?
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/log_sanity/middleware/routing_error_catcher.rb

@@ -1,40 +0,0 @@
-# middleware to catch and sanely handle routing errors without treating them
-# like all other exceptions (that is, without verbose backtraces and other
-# such).
-# intended to be added to the end of the middleware stack (nearest the app).
-# while built on top of ShowExceptions to reuse its error rendering logic,
-# does not replace it.
-
-module LogSanity
-  class RoutingErrorCatcher < ActionDispatch::ShowExceptions
-
-    def call(env)
-      request = ActionDispatch::Request.new env
-      _, headers, body = response = @app.call(env)
-
-      if headers['X-Cascade'] == 'pass'
-        body.close if body.respond_to?(:close)
-        raise ActionController::RoutingError, "No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}"
-      end
-
-      response
-    rescue ActionController::RoutingError => exception
-      if Rails.version >= '7.1'
-        backtrace_cleaner = request.get_header('action_dispatch.backtrace_cleaner')
-        wrapper = ActionDispatch::ExceptionWrapper.new(backtrace_cleaner, exception)
-        if wrapper.show?(request)
-          render_exception(request, wrapper)
-        else
-          raise exception
-        end
-      else
-        if request.show_exceptions?
-          render_exception(request, exception)
-        else
-          raise exception
-        end
-      end
-    end
-
-  end
-end