active_job_log 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dba3c2ac8737c2eb3ca017c3076303b46007ce3b1d410377437f613d8840edbb
-  data.tar.gz: d1cb759e84634d425728e83d859e29ea9796386d1303340e9fc29060ec1fd81e
+  metadata.gz: f2a246cc523e487ca1aa839f1ecacffad9cd6459b8c66d7879e44808453d7e9b
+  data.tar.gz: d5042bfd7f44b07e521e978aa98fdda7d9ed5b3a27949cd85cf91a038dccb84b
 SHA512:
-  metadata.gz: 32a50d61161aead9971cd4e688260f57491955c83cf0076d59990b5df98396b4a3ad4632a9894f3044bc4386ddd3dbae7f50c1a6c5222b4b902a2bbc1e9c1d48
-  data.tar.gz: 7d32934735dd7218ea77237473e0e91872a6e129e32701b779089340cd5f019ffdec1864c9b7f7d590a52e89d0863401ebfd9e1fc7c059efac5fbf1ac1222c59
+  metadata.gz: add4582bcf93c72bee457d5d7c612ec9a801e187e34c6df9df657d7a0682b1a7fc17f28a4f9d3cdf1bdfa9a040c580f735c195fd03691c49fdf97a26338ab9b4
+  data.tar.gz: c6aef40bb57db3c35164531e1863f49ab3c93a6788b21dc7ed0aef3b6728de963e79180773cad69667440255fd3260deac89f935f13f4a7160f4d1d87b94d2ad

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### v2.1.0
+
+#### Added
+
+* Avoid logging using `disable_job_logs` class method.
+
 ### v2.0.0
 
 #### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_job_log (2.0.0)
+    active_job_log (2.1.0)
       enumerize (>= 1.0)
       rails (>= 6.0)
 

data/README.md

@@ -99,6 +99,20 @@ queued pending finished failed
 
 - `executions`: number of times this job has been executed (which increments on every retry, like after an exception.
 
+### Disable logging
+
+If you want to avoid logging a specific job you have to add `disable_job_logs` config option on that job. For example:
+
+```ruby
+class MyJob < ActiveJob::Base
+  disable_job_logs
+
+  def perform(param1, param2)
+    # ...
+  end
+end
+```
+
 ### Important
 
 If your job calls the `rescue_from` method, you will need to call the `fail_job` method explicitly to log the job completion. For example:

data/lib/active_job_log/log_ext.rb

@@ -3,6 +3,8 @@ module ActiveJobLog
     extend ActiveSupport::Concern
 
     included do
+      class_attribute :disabled_log
+
       before_enqueue { |job| enqueue_job(job) }
       before_perform { |job| execute_job(job) }
       after_perform { |job| finish_job(job) }
@@ -11,31 +13,48 @@ module ActiveJobLog
         fail_job(exception)
         raise exception
       end
+    end
 
-      def enqueue_job(job)
-        Job.update_job!(job.job_id, :queued, init_params(job))
+    class_methods do
+      def disable_job_logs
+        self.disabled_log = true
       end
+    end
 
-      def execute_job(job)
-        Job.update_job!(job.job_id, :pending, init_params(job))
-      end
+    def enqueue_job(job)
+      update_job!(job.job_id, :queued, init_params(job))
+    end
 
-      def finish_job(job)
-        Job.update_job!(job.job_id, :finished)
-      end
+    def execute_job(job)
+      update_job!(job.job_id, :pending, init_params(job))
+    end
 
-      def fail_job(exception)
-        Job.update_job!(job_id, :failed, error: exception.message, stack_trace: exception.backtrace)
-      end
+    def finish_job(job)
+      update_job!(job.job_id, :finished)
+    end
 
-      def init_params(job)
-        {
-          job_class: self.class.name,
-          params: job.arguments,
-          executions: job.try(:executions),
-          queue_name: job.queue_name
-        }
-      end
+    def fail_job(exception)
+      update_job!(
+        job_id,
+        :failed,
+        error: exception.message,
+        stack_trace: exception.backtrace
+      )
+    end
+
+    def update_job!(job_id, status, params = {})
+      return if self.class.disabled_log
+
+      Job.update_job!(job_id, status, params)
+    end
+
+    def init_params(job)
+      {
+        job_class: self.class.name,
+        params: job.arguments,
+        executions: job.try(:executions),
+        queue_name: job.queue_name
+      }
     end
   end
 end

data/lib/active_job_log/version.rb

@@ -1,3 +1,3 @@
 module ActiveJobLog
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/lib/active_job_log/log_ext_spec.rb

@@ -1,15 +1,9 @@
 require 'rails_helper'
 
 RSpec.describe ActiveJobLog::LogExt do
-  def remove_job_class
-    Object.send(:remove_const, :TestJob)
-  rescue
-    nil
-  end
-
-  def perform_now
-    TestJob.perform_now(*job_params)
-  rescue
+  def perform_now(job_class)
+    job_class.perform_now(*job_params)
+  rescue StandardError
     nil
   end
 
@@ -17,19 +11,21 @@ RSpec.describe ActiveJobLog::LogExt do
     %w{p1 p2}
   end
 
-  before { remove_job_class }
-
   it { expect(ActiveJobLog::Job.count).to eq(0) }
 
   context "with successful job" do
-    before do
-      class TestJob < ActiveJob::Base
+    let(:job_class) do
+      klass = Class.new(ApplicationJob) do
         def perform(param1, param2)
           "success with #{param1} and #{param2}"
         end
       end
 
-      perform_now
+      stub_const('TestJob', klass)
+    end
+
+    before do
+      perform_now(job_class)
       @job = ActiveJobLog::Job.last
     end
 
@@ -51,14 +47,18 @@ RSpec.describe ActiveJobLog::LogExt do
   end
 
   context "with failed job" do
-    before do
-      class TestJob < ActiveJob::Base
+    let(:job_class) do
+      klass = Class.new(ApplicationJob) do
         def perform(_param1, _param2)
           raise "error"
         end
       end
 
-      perform_now
+      stub_const('TestJob', klass)
+    end
+
+    before do
+      perform_now(job_class)
       @job = ActiveJobLog::Job.last
     end
 
@@ -78,4 +78,37 @@ RSpec.describe ActiveJobLog::LogExt do
     it { expect(@job.total_duration).not_to be_nil }
     it { expect(@job.executions).to eq(1) }
   end
+
+  context "with disabled jobs" do
+    let(:disabled_job_class) do
+      klass = Class.new(ApplicationJob) do
+        disable_job_logs
+
+        def perform(_param1, _param2)
+          # ...
+        end
+      end
+
+      stub_const('DisabledTestJob', klass)
+    end
+
+    let(:enabled_job_class) do
+      klass = Class.new(ApplicationJob) do
+        def perform(_param1, _param2)
+          # ...
+        end
+      end
+
+      stub_const('EnabledTestJob', klass)
+    end
+
+    before do
+      perform_now(disabled_job_class)
+      perform_now(enabled_job_class)
+      @job = ActiveJobLog::Job.last
+    end
+
+    it { expect(ActiveJobLog::Job.count).to eq(1) }
+    it { expect(@job.job_class).to eq('EnabledTestJob') }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_job_log
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Platanus
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails