active_job_store 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9fd49a85e50473450a09a741acaf01d5e6565116cb6f945f314bd6e4dd74f6d
-  data.tar.gz: d5655ec674b4a86d99b267c8a851e2a8d1cd687e188c58c8a292bf5120cffc3b
+  metadata.gz: 2a53200d7e5f4f9654d3e8db62ef8a92014a78d264f43cece9486228a3ff03c9
+  data.tar.gz: b703fe5f1183d8c0718eb45e651580f02d41d0efae9eb81cc9e1a59c10e788a4
 SHA512:
-  metadata.gz: f9e1a166e181d32afb0265ac062b954930b8d748af36b21e837d2ee6fe28a7d57edc2f9ad590339e49fefbc3256e6b43317d19ab4e9ff1de36e7f2aa67d0dac4
-  data.tar.gz: a407a4446dec032e4bf6f7b5f55536dadd703c0d1d1a75d61cdf37ace3388e09c836c520ffde6c0b31043867bd92c82ad04c57b54d7398ca126baa080715e0a5
+  metadata.gz: 819a6339762b27117d43cf52075896611c5e83818018546a04c0727a03daad4f3a77b60c71030ef8218940ea1883223b4bf016b2a3e787f9b4fd810c2ded8f6b
+  data.tar.gz: a1bcf57d7b6f670dd90231abc21ed241a532a8ad7985b6e68b40b4b3c29001f8a23408f676ac4c0b45fb81e3102f33b8b2e3e7a9089add9410eb710465607cc0

data/README.md

@@ -11,6 +11,8 @@ It can be useful to:
 - query historical data about job executions / extract job's statistical data;
 - improve jobs' logging capabilities.
 
+By default gem's internal errors are sent to stderr without compromising the job's perform.
+
 Please ⭐ if you like it.
 
 ## Installation
@@ -28,6 +30,7 @@ attr_accessor on the jobs:
 
 Instance methods on the jobs:
 - `active_job_store_format_result(result) => result2`: to format / manipulate / serialize the job result
+- `active_job_store_internal_error(context, exception)`: handler for internal errors
 - `active_job_store_record => store record`: returns the store's record
 - `save_job_custom_data(custom_data = nil)`: to persist custom data while the job is performing
 
@@ -87,7 +90,7 @@ puts ::ActiveJobStore::Record.order(id: :desc).pluck(:created_at, :job_class, :a
 # 2022-11-09 21:09:50 UTC, SomeJob, Some test, completed, 2022-11-09 21:09:50 UTC
 ```
 
-Query information from a job (even when it's performing):
+Query information from a job (even while performing):
 
 ```rb
 job = SomeJob.perform_later 123
@@ -102,9 +105,9 @@ job.active_job_store_record.reload.custom_data
 # => {"progress"=>1.0}
 ```
 
-## Features' details
+## Features' examples
 
-To store the custom data (ex. a progress value):
+To persist some custom data during the perform (ex. a progress value):
 
 ```rb
 class AnotherJob < ApplicationJob
@@ -125,7 +128,7 @@ AnotherJob.perform_later(456)
 AnotherJob.job_executions.last.custom_data['progress'] # 1.0 (at the end)
 ```
 
-To manipulate the custom data, there is the `active_job_store_custom_data` accessor:
+To manipulate the custom data persisted only at the end:
 
 ```rb
 class AnotherJob < ApplicationJob
@@ -148,7 +151,7 @@ AnotherJob.job_executions.last.custom_data
 # => [{"time"=>"2022-11-09T21:20:57.580Z", "message"=>"SomeJob step 1"}, {"time"=>"2022-11-09T21:20:58.581Z", "message"=>"SomeJob step 2"}]
 ```
 
-To process the result before storing it (ex. for serialization), override `active_job_store_format_result`:
+To process the job's result before storing it (ex. for serialization):
 
 ```rb
 class AnotherJob < ApplicationJob
@@ -169,6 +172,21 @@ AnotherJob.job_executions.last.result
 # => 84
 ```
 
+To raise an exception also when there is a gem's internal error:
+
+```rb
+class AnotherJob < ApplicationJob
+  include ActiveJobStore
+
+  # ...
+
+  def active_job_store_internal_error(context, exception)
+    raise exception
+    # Or simply monitor these errors using services like Sentry/Honeybadger/etc.
+  end
+end
+```
+
 ## Do you like it? Star it!
 
 If you use this component just star it. A developer is more motivated to improve a project when there is some interest.

data/app/models/active_job_store/record.rb

@@ -4,10 +4,10 @@ module ActiveJobStore
   class Record < ApplicationRecord
     self.table_name = 'active_job_store'
 
-    serialize :arguments, JSON
-    serialize :custom_data, JSON
-    serialize :details, JSON
-    serialize :result, JSON
+    serialize :arguments, coder: JSON
+    serialize :custom_data, coder: JSON
+    serialize :details, coder: JSON
+    serialize :result, coder: JSON
 
     enum state: { initialized: 0, enqueued: 1, started: 2, completed: 3, error: 4 }
 

data/lib/active_job_store/store.rb

@@ -8,9 +8,11 @@ module ActiveJobStore
 
     def around_enqueue(job)
       prepare_record_on_enqueue(job)
-      record.lock! # NOTE: needed to avoid update conflicts with perform when setting the state to enqueued
-      yield
+      lock_record!
+      result = yield
       job_enqueued!
+      job.active_job_store_internal_error('ActiveJobStore::Store around_enqueue', internal_error) if internal_error
+      result
     end
 
     def around_perform(job)
@@ -19,51 +21,71 @@ module ActiveJobStore
       result = yield
       formatted_result = job.active_job_store_format_result(result)
       job_competed!(custom_data: job.active_job_store_custom_data, result: formatted_result)
+      job.active_job_store_internal_error('ActiveJobStore::Store around_perform', internal_error) if internal_error
+      result
     rescue StandardError => e
       job_failed!(exception: e, custom_data: job.active_job_store_custom_data)
       raise
     end
 
     def update_job_custom_data(custom_data)
-      record.update!(custom_data: custom_data)
+      wrap_errors do
+        record.update!(custom_data: custom_data)
+      end
     end
 
     private
 
+    attr_accessor :internal_error
+
     def job_competed!(result:, custom_data:)
-      record.update!(state: :completed, completed_at: Time.current, result: result, custom_data: custom_data)
-      record
+      wrap_errors do
+        record.update!(state: :completed, completed_at: Time.current, result: result, custom_data: custom_data)
+      end
     end
 
     def job_enqueued!
-      record.update!(state: :enqueued, enqueued_at: Time.current)
-      record
+      wrap_errors do
+        record.update!(state: :enqueued, enqueued_at: Time.current)
+      end
     end
 
     def job_failed!(exception:, custom_data:)
-      record.update!(state: :error, exception: exception.inspect, custom_data: custom_data)
-      record
+      wrap_errors do
+        record.update!(state: :error, exception: exception.inspect, custom_data: custom_data)
+      end
     end
 
     def job_started!
-      record.update!(state: :started, started_at: Time.current)
-      record
+      wrap_errors do
+        record.update!(state: :started, started_at: Time.current)
+      end
+    end
+
+    def lock_record!
+      wrap_errors do
+        record.lock! # NOTE: needed to avoid update conflicts with perform when setting the state to enqueued
+      end
     end
 
     def prepare_record_on_enqueue(job)
-      @record = ::ActiveJobStore::Record.find_or_create_by!(record_reference(job)) do |record|
-        record.arguments = job.arguments
-        record.details = DETAILS_ATTRS.zip(DETAILS_ATTRS.map { job.send(_1) }).to_h
-        record.state = :initialized
+      wrap_errors do
+        @record = ::ActiveJobStore::Record.find_or_create_by!(record_reference(job)) do |record|
+          record.arguments = job.arguments
+          record.details = DETAILS_ATTRS.zip(DETAILS_ATTRS.map { job.send(_1) }).to_h
+          record.state = :initialized
+        end
       end
     end
 
     def prepare_record_on_perform(job)
-      @record = ::ActiveJobStore::Record.find_or_initialize_by(record_reference(job)) do |record|
-        record.arguments = job.arguments
+      wrap_errors do
+        @record = ::ActiveJobStore::Record.find_or_initialize_by(record_reference(job)) do |record|
+          record.arguments = job.arguments
+        end
+        record.details = DETAILS_ATTRS.zip(DETAILS_ATTRS.map { job.send(_1) }).to_h
+        record
       end
-      record.details = DETAILS_ATTRS.zip(DETAILS_ATTRS.map { job.send(_1) }).to_h
-      record
     end
 
     def record_reference(job)
@@ -72,5 +94,13 @@ module ActiveJobStore
         job_class: job.class.to_s
       }
     end
+
+    def wrap_errors
+      return if internal_error
+
+      yield
+    rescue StandardError => e
+      self.internal_error = e
+    end
   end
 end

data/lib/active_job_store/version.rb

@@ -2,6 +2,6 @@
 
 # :nocov:
 module ActiveJobStore
-  VERSION = '0.3.0'
+  VERSION = '0.5.0'
 end
 # :nocov:

data/lib/active_job_store.rb

@@ -31,6 +31,13 @@ module ActiveJobStore
     store.record
   end
 
+  # Internal errors handler method
+  #
+  # @param exception [exception] The internal exception
+  def active_job_store_internal_error(context, exception)
+    warn("#{context}: #{exception}")
+  end
+
   module ClassMethods
     # Query the list of job executions for the current job class
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job_store
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -58,7 +58,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/blocknotes/active_job_store
   source_code_uri: https://github.com/blocknotes/active_job_store
-  changelog_uri: https://github.com/blocknotes/active_job_store/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/blocknotes/active_job_store/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -68,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Persist jobs information on DB