rails_band 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25195f352d9f1105a0dc497aff31a087310185a09133674516ec77e1f44b00ab
-  data.tar.gz: 62a96059041df354354cbb871997bc367c0fd5132e526c3888ac955796b326df
+  metadata.gz: 8cdd316cd8ffd879ac92f37192896d33d5e64929fec0fedecc2c872f69c30826
+  data.tar.gz: 289a57c8e09f7fa4d8e07689c2efe8c822d229b664eb23b027cb7b9a666458a0
 SHA512:
-  metadata.gz: a4518ad9565c64461de711c8d73e6567046e81385ed5b05fb17a63e35495b767b02d6177ca6952a6496a7152e6c75a82351d805fdcbbc9e977cd348dffe14db9
-  data.tar.gz: d8b7090706903ba8dc95bd7e1ff7823c1354577483407829fc94ed5194d6e9443b6f1c36de106998641be1549834fdb2c135002b5981f4fa0e83b19bd97bd521
+  metadata.gz: 3696c07b0669153d9eee9fd5850aca0da0bc74f9f93122ec33ed7f271f2d1432713ff8a61454ceadc7189779561ba192d9c90267b843692a1b17ae33c8c3239a
+  data.tar.gz: 1bf5d9273fb54cff96f8f2fd02ba103802a2e3d48140b01492b5fb54f366429d7ec02c2617c4a3024234cba862c0f6e06ff6e438a45fd749fd5232c0dd2bc3d1

data/README.md

@@ -69,6 +69,7 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 | [`redirect_to.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#redirect-to-action-controller)                       | ✅        |
 | [`halted_callback.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#halted-callback-action-controller)               | ✅        |
 | [`unpermitted_parameters.action_controller`](https://guides.rubyonrails.org/active_support_instrumentation.html#unpermitted-parameters-action-controller) | ✅        |
+| [`rate_limit.action_controller`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#rate-limit-action-controller)                     | ✅        |
 
 ### Action Dispatch
 
@@ -95,7 +96,8 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 | [`sql.active_record`](https://guides.rubyonrails.org/active_support_instrumentation.html#sql-active-record)                                 | ✅        |
 | [`instantiation.active_record`](https://guides.rubyonrails.org/active_support_instrumentation.html#instantiation-active-record)             | ✅        |
 | [`start_transaction.active_record`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#start-transaction-active-record) | ✅        |
-| [`transaction.active_record`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#transaction-active-record)             |           |
+| [`transaction.active_record`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#transaction-active-record)             | ✅        |
+| [`deprecated_association.active_record`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#deprecated-association-active-record) | ✅        |
 
 ### Action Mailer
 
@@ -115,7 +117,7 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 | [`cache_write.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-write-active-support)                       | ✅        |
 | [`cache_write_multi.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-write-multi-active-support)       | ✅        |
 | [`cache_increment.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-increment-active-support)           | ✅        |
-| [`cache_decrement.active_support `](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-decrement-active-support)          | ✅        |
+| [`cache_decrement.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-decrement-active-support)           | ✅        |
 | [`cache_delete.active_support`](https://guides.rubyonrails.org/active_support_instrumentation.html#cache-delete-active-support)                     | ✅        |
 | [`cache_delete_multi.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-delete-multi-active-support)     | ✅        |
 | [`cache_delete_matched.active_support`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-delete-matched-active-support) | ✅        |
@@ -141,6 +143,11 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 | [`retry_stopped.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#retry-stopped-active-job) | ✅        |
 | [`discard.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#discard-active-job)             | ✅        |
 | [`enqueue_all.active_job`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#enqueue-all-active-job) | ✅        |
+| [`interrupt.active_job`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#interrupt-active-job) | ✅        |
+| [`resume.active_job`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#resume-active-job) | ✅        |
+| [`step.active_job`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#step-active-job) | ✅        |
+| [`step_skipped.active_job`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#step-skipped-active-job) | ✅        |
+| [`step_started.active_job`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#step-started-active-job) | ✅        |
 
 ### Action Cable
 
@@ -179,7 +186,7 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 
 | Event name                                                                                                                                    | Supported |
 | --------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
-| [`load_config_initializer.railties`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#load-config-initializer-railties) |           |
+| [`load_config_initializer.railties`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#load-config-initializer-railties) | ✅        |
 
 ### Rails
 

data/lib/rails_band/active_job/event/interrupt.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveJob
+    module Event
+      # A wrapper for the event that is passed to `interrupt.active_job`.
+      class Interrupt < BaseEvent
+        def adapter
+          @adapter ||= @event.payload.fetch(:adapter)
+        end
+
+        def job
+          @job ||= @event.payload.fetch(:job)
+        end
+
+        def reason
+          @reason ||= @event.payload.fetch(:reason)
+        end
+
+        def description
+          @description ||= @event.payload.fetch(:description)
+        end
+
+        def completed_steps
+          @completed_steps ||= @event.payload.fetch(:completed_steps)
+        end
+
+        def current_step
+          @current_step ||= @event.payload[:current_step]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_job/event/resume.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveJob
+    module Event
+      # A wrapper for the event that is passed to `resume.active_job`.
+      class Resume < BaseEvent
+        def adapter
+          @adapter ||= @event.payload.fetch(:adapter)
+        end
+
+        def job
+          @job ||= @event.payload.fetch(:job)
+        end
+
+        def description
+          @description ||= @event.payload.fetch(:description)
+        end
+
+        def completed_steps
+          @completed_steps ||= @event.payload.fetch(:completed_steps)
+        end
+
+        def current_step
+          @current_step ||= @event.payload[:current_step]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_job/event/step.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveJob
+    module Event
+      # A wrapper for the event that is passed to `step.active_job`.
+      # Unlike `StepSkipped#step`, this is the step itself, not the step name.
+      class Step < BaseEvent
+        def adapter
+          @adapter ||= @event.payload.fetch(:adapter)
+        end
+
+        def job
+          @job ||= @event.payload.fetch(:job)
+        end
+
+        def step
+          @step ||= @event.payload.fetch(:step)
+        end
+
+        def interrupted
+          return @interrupted if defined?(@interrupted)
+
+          @interrupted = @event.payload.fetch(:interrupted)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_job/event/step_skipped.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveJob
+    module Event
+      # A wrapper for the event that is passed to `step_skipped.active_job`.
+      class StepSkipped < BaseEvent
+        def adapter
+          @adapter ||= @event.payload.fetch(:adapter)
+        end
+
+        def job
+          @job ||= @event.payload.fetch(:job)
+        end
+
+        def step
+          @step ||= @event.payload.fetch(:step)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_job/event/step_started.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveJob
+    module Event
+      # A wrapper for the event that is passed to `step_started.active_job`.
+      class StepStarted < BaseEvent
+        def adapter
+          @adapter ||= @event.payload.fetch(:adapter)
+        end
+
+        def job
+          @job ||= @event.payload.fetch(:job)
+        end
+
+        def step
+          @step ||= @event.payload.fetch(:step)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_job/log_subscriber.rb

@@ -8,6 +8,11 @@ require 'rails_band/active_job/event/perform_start'
 require 'rails_band/active_job/event/perform'
 require 'rails_band/active_job/event/retry_stopped'
 require 'rails_band/active_job/event/discard'
+require 'rails_band/active_job/event/interrupt'
+require 'rails_band/active_job/event/resume'
+require 'rails_band/active_job/event/step'
+require 'rails_band/active_job/event/step_skipped'
+require 'rails_band/active_job/event/step_started'
 
 module RailsBand
   module ActiveJob
@@ -47,6 +52,26 @@ module RailsBand
         consumer_of(__method__)&.call(Event::EnqueueAll.new(event))
       end
 
+      def interrupt(event)
+        consumer_of(__method__)&.call(Event::Interrupt.new(event))
+      end
+
+      def resume(event)
+        consumer_of(__method__)&.call(Event::Resume.new(event))
+      end
+
+      def step(event)
+        consumer_of(__method__)&.call(Event::Step.new(event))
+      end
+
+      def step_skipped(event)
+        consumer_of(__method__)&.call(Event::StepSkipped.new(event))
+      end
+
+      def step_started(event)
+        consumer_of(__method__)&.call(Event::StepStarted.new(event))
+      end
+
       private
 
       def consumer_of(sub_event)

data/lib/rails_band/active_record/event/deprecated_association.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveRecord
+    module Event
+      # A wrapper for the event that is passed to `deprecated_association.active_record`.
+      class DeprecatedAssociation < BaseEvent
+        def reflection
+          @reflection ||= @event.payload.fetch(:reflection)
+        end
+
+        def message
+          @message ||= @event.payload.fetch(:message)
+        end
+
+        def location
+          @location ||= @event.payload.fetch(:location)
+        end
+
+        # `:backtrace` is only present when the option is enabled; `fetch` would
+        # raise KeyError in the default configuration.
+        def backtrace
+          @backtrace ||= @event.payload[:backtrace]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_record/event/transaction.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveRecord
+    module Event
+      # A wrapper for the event that is passed to `transaction.active_record`.
+      class Transaction < BaseEvent
+        # The `:transaction` key was added in Rails 7.2. It is absent on Rails 7.1,
+        # where this event is also emitted with only `:connection` and `:outcome`.
+        def transaction
+          @transaction ||= @event.payload[:transaction]
+        end
+
+        def outcome
+          @outcome ||= @event.payload.fetch(:outcome)
+        end
+
+        def connection
+          @connection ||= @event.payload.fetch(:connection)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_record/log_subscriber.rb

@@ -4,6 +4,8 @@ require 'rails_band/active_record/event/sql'
 require 'rails_band/active_record/event/instantiation'
 require 'rails_band/active_record/event/strict_loading_violation'
 require 'rails_band/active_record/event/start_transaction'
+require 'rails_band/active_record/event/transaction'
+require 'rails_band/active_record/event/deprecated_association'
 
 module RailsBand
   module ActiveRecord
@@ -27,6 +29,14 @@ module RailsBand
         consumer_of(__method__)&.call(Event::StartTransaction.new(event))
       end
 
+      def transaction(event)
+        consumer_of(__method__)&.call(Event::Transaction.new(event))
+      end
+
+      def deprecated_association(event)
+        consumer_of(__method__)&.call(Event::DeprecatedAssociation.new(event))
+      end
+
       private
 
       def consumer_of(sub_event)

data/lib/rails_band/base_event.rb

@@ -24,8 +24,8 @@ module RailsBand
         name: @name, time: @time, end: @end, transaction_id: @transaction_id,
         cpu_time: @cpu_time, idle_time: @idle_time, allocations: @allocations, duration: @duration
       }.merge!(
-        public_methods(false).reject { |meth| non_hash_keys.include?(meth) }.each_with_object({}) do |meth, h|
-          h[meth] = public_send(meth)
+        public_methods(false).reject { |meth| non_hash_keys.include?(meth) }.to_h do |meth|
+          [meth, public_send(meth)]
         end
       )
     end

data/lib/rails_band/railtie.rb

@@ -8,7 +8,7 @@ module RailsBand
   class Railtie < ::Rails::Railtie
     config.rails_band = Configuration.new
 
-    config.before_initialize do
+    config.before_initialize do |app|
       # NOTE: `ActionDispatch::MiddlewareStack::InstrumentationProxy` will be called
       #       only when `ActionDispatch::MiddlewareStack#build` detects `process_middleware.action_dispatch`
       #       is listened to. So, `attach_to` must be called before Rack middlewares will be loaded.
@@ -16,6 +16,12 @@ module RailsBand
         detach_log_subscriber(::ActionDispatch::LogSubscriber, :action_dispatch)
       end
       RailsBand::ActionDispatch::LogSubscriber.attach_to :action_dispatch
+
+      # NOTE: `load_config_initializer.railties` is emitted while Rails loads
+      #       config/initializers/*. So, the subscriber must be attached before
+      #       Rails loads them.
+      RailsBand::Railties::LogSubscriber.consumers = app.config.rails_band.consumers
+      RailsBand::Railties::LogSubscriber.attach_to :railties
     end
 
     config.after_initialize do |app|
@@ -58,6 +64,8 @@ module RailsBand
       RailsBand::DeprecationSubscriber.consumers = consumers
       RailsBand::DeprecationSubscriber.attach_to :rails
 
+      RailsBand::Railties::LogSubscriber.consumers = consumers
+
       if defined?(::ActiveJob)
         require 'active_job/logging'
 

data/lib/rails_band/railties/event/load_config_initializer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module Railties
+    module Event
+      # A wrapper for the event that is passed to `load_config_initializer.railties`.
+      class LoadConfigInitializer < BaseEvent
+        def initializer
+          @initializer ||= @event.payload.fetch(:initializer)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/railties/log_subscriber.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_band/railties/event/load_config_initializer'
+
+module RailsBand
+  module Railties
+    # LogSubscriber is responsible for calling the user-specified consumer for railties events.
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      mattr_accessor :consumers
+
+      def load_config_initializer(event)
+        consumer&.call(Event::LoadConfigInitializer.new(event))
+      end
+
+      private
+
+      def consumer
+        # HACK: ActiveSupport::Subscriber has the instance variable @namespace, but it's not documented.
+        #       This hack might possibly break in the future.
+        namespace = self.class.instance_variable_get(:@namespace)
+        consumers[:"load_config_initializer.#{namespace}"] || consumers[:railties] || consumers[:default]
+      end
+    end
+  end
+end

data/lib/rails_band/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsBand
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 end

data/lib/rails_band.rb

@@ -58,4 +58,9 @@ module RailsBand
   module ActionMailbox
     autoload :LogSubscriber, 'rails_band/action_mailbox/log_subscriber'
   end
+
+  # RailsBand::Railties is responsible for subscribing notifications from Railties.
+  module Railties
+    autoload :LogSubscriber, 'rails_band/railties/log_subscriber'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_band
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Yutaka Kamei
@@ -80,14 +80,21 @@ files:
 - lib/rails_band/active_job/event/enqueue_all.rb
 - lib/rails_band/active_job/event/enqueue_at.rb
 - lib/rails_band/active_job/event/enqueue_retry.rb
+- lib/rails_band/active_job/event/interrupt.rb
 - lib/rails_band/active_job/event/perform.rb
 - lib/rails_band/active_job/event/perform_start.rb
+- lib/rails_band/active_job/event/resume.rb
 - lib/rails_band/active_job/event/retry_stopped.rb
+- lib/rails_band/active_job/event/step.rb
+- lib/rails_band/active_job/event/step_skipped.rb
+- lib/rails_band/active_job/event/step_started.rb
 - lib/rails_band/active_job/log_subscriber.rb
+- lib/rails_band/active_record/event/deprecated_association.rb
 - lib/rails_band/active_record/event/instantiation.rb
 - lib/rails_band/active_record/event/sql.rb
 - lib/rails_band/active_record/event/start_transaction.rb
 - lib/rails_band/active_record/event/strict_loading_violation.rb
+- lib/rails_band/active_record/event/transaction.rb
 - lib/rails_band/active_record/log_subscriber.rb
 - lib/rails_band/active_storage/event/analyze.rb
 - lib/rails_band/active_storage/event/preview.rb
@@ -122,6 +129,8 @@ files:
 - lib/rails_band/configuration.rb
 - lib/rails_band/deprecation_subscriber.rb
 - lib/rails_band/railtie.rb
+- lib/rails_band/railties/event/load_config_initializer.rb
+- lib/rails_band/railties/log_subscriber.rb
 - lib/rails_band/version.rb
 homepage: https://github.com/yykamei/rails_band
 licenses: