rails_band 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84c17289076af2e04e037b011c18c6ff3d0206401b67c1e68354979410e545a7
-  data.tar.gz: 3133417c2eecf067f8e5f402a49b6143ee7e2944f92d95567289262c85af02ea
+  metadata.gz: 2068455c0eab607cbdc32392362c6a181b0789d8bd41e77201c7bb06e3eb8ba8
+  data.tar.gz: c27bcf5e8dcd06c7f87f164ca1a7f58e537b5910bba7b0a98a7ea3a003649fad
 SHA512:
-  metadata.gz: 90f9b92421330c436f3968219be3a7ebf936d4b3b3a47f1906fdf3d1a9c65b4615fb2a3e6c8b76bdaa5f7dc2596c1e67d28f347bc5262420e66a72c69bdb087b
-  data.tar.gz: 5d852e1baafe0632013fede3b0278deb886f9cf0347848e3cb960b9e153c79096384bc9d8449b974cfbb7c54d576f2d13e60583e5b0be5993ec2a815ae8449ff
+  metadata.gz: 936e787242f04a6d7d81bf29993d87bba1187cf27d3e706cb0de672dd27100e99ab029da802871bd044ad722801a4fa6f4f6f22b33e3f1c160935dce10c9b369
+  data.tar.gz: 549f64623c4374c3067d0e82a853eace86c14873a89c5e894118ca8e4c1122377d89d55c10c7816b86db391d0130df423c68db25d9d898e4de769947554c1e54

data/README.md

@@ -116,13 +116,13 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 
 | Event name                                                                                                                | Supported |
 | ------------------------------------------------------------------------------------------------------------------------- | --------- |
-| [`enqueue_at.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-at-active-job)       |           |
-| [`enqueue.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-active-job)             |           |
-| [`enqueue_retry.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-retry-active-job) |           |
-| [`perform_start.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-start-active-job) |           |
-| [`perform.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-active-job)             |           |
-| [`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_at.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-at-active-job)       | ✅        |
+| [`enqueue.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-active-job)             | ✅        |
+| [`enqueue_retry.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-retry-active-job) | ✅        |
+| [`perform_start.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-start-active-job) | ✅        |
+| [`perform.active_job`](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-active-job)             | ✅        |
+| [`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)             | ✅        |
 
 ### Action Cable
 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/rails_band/active_job/log_subscriber.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'rails_band/active_job/event/enqueue_at'
+require 'rails_band/active_job/event/enqueue'
+require 'rails_band/active_job/event/enqueue_retry'
+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'
+
+module RailsBand
+  module ActiveJob
+    # The custom LogSubscriber for ActiveJob.
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      mattr_accessor :consumers
+
+      def enqueue_at(event)
+        consumer_of(__method__)&.call(Event::EnqueueAt.new(event))
+      end
+
+      def enqueue(event)
+        consumer_of(__method__)&.call(Event::Enqueue.new(event))
+      end
+
+      def enqueue_retry(event)
+        consumer_of(__method__)&.call(Event::EnqueueRetry.new(event))
+      end
+
+      def perform_start(event)
+        consumer_of(__method__)&.call(Event::PerformStart.new(event))
+      end
+
+      def perform(event)
+        consumer_of(__method__)&.call(Event::Perform.new(event))
+      end
+
+      def retry_stopped(event)
+        consumer_of(__method__)&.call(Event::RetryStopped.new(event))
+      end
+
+      def discard(event)
+        consumer_of(__method__)&.call(Event::Discard.new(event))
+      end
+
+      private
+
+      def consumer_of(sub_event)
+        consumers[:"#{sub_event}.active_job"] || consumers[:active_job] || consumers[:default]
+      end
+    end
+  end
+end

data/lib/rails_band/railtie.rb

@@ -31,6 +31,17 @@ module RailsBand
       end
 
       RailsBand::ActiveSupport::LogSubscriber.attach_to :active_support
+
+      if defined?(::ActiveJob)
+        require 'active_job/logging'
+
+        if defined?(::ActiveJob::Logging::LogSubscriber)
+          swap.call(::ActiveJob::Logging::LogSubscriber, RailsBand::ActiveJob::LogSubscriber, :active_job)
+        else
+          require 'active_job/log_subscriber'
+          swap.call(::ActiveJob::LogSubscriber, RailsBand::ActiveJob::LogSubscriber, :active_job)
+        end
+      end
     end
   end
 end

data/lib/rails_band/version.rb

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

data/lib/rails_band.rb

@@ -27,4 +27,8 @@ module RailsBand
   module ActiveSupport
     autoload :LogSubscriber, 'rails_band/active_support/log_subscriber'
   end
+
+  module ActiveJob
+    autoload :LogSubscriber, 'rails_band/active_job/log_subscriber'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_band
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -55,6 +55,14 @@ files:
 - lib/rails_band/action_view/event/render_template.rb
 - lib/rails_band/action_view/from_views.rb
 - lib/rails_band/action_view/log_subscriber.rb
+- lib/rails_band/active_job/event/discard.rb
+- lib/rails_band/active_job/event/enqueue.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/perform.rb
+- lib/rails_band/active_job/event/perform_start.rb
+- lib/rails_band/active_job/event/retry_stopped.rb
+- lib/rails_band/active_job/log_subscriber.rb
 - lib/rails_band/active_record/event/instantiation.rb
 - lib/rails_band/active_record/event/sql.rb
 - lib/rails_band/active_record/event/strict_loading_violation.rb