active_job_store 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f576f48581d1561a8deb8c41fdbc1f89070bc7d48b5f3c6ece7e6de39c33747
-  data.tar.gz: a7807764c2199023daf083ee48ea3c5ded230f566bc07e25664e420ed048725c
+  metadata.gz: 913b4d81b0dfb938f013f907696dc04354a106818140d25003ae44ab4e4ed9f9
+  data.tar.gz: 39874892b9ee2443311d54cfedf7589697959c5ccb4184d8d934d67960838c7d
 SHA512:
-  metadata.gz: aa62be0ecc3e9ff53ccc8d3e1ff02202383323b0fba7075493bd5c5ca010e2393a627a7bd9e9b04edadc59c799d4fd7d630b81dbfcb3058d05601dce520777c8
-  data.tar.gz: 9436383c18415b52c7226816d62040cd8b8846c3385bac23681fa9730aadc98deebe086dfdfd2b8b33cedcbc5bdcffa951ae6f96725a3a49e74aa45770c0810e
+  metadata.gz: 18b9c5696a4b4092ae9ea5d6ae8ed74ed45aaef567804f53a7b59fee306038f6ce2e63f0832b9bdc6f6ad61dbb7d69b81239c5801fe39db2b163be50f0e468ad
+  data.tar.gz: 0ad46829f63b6a6347812df19f0b0a3ef8b9e0c092ecf6f8f1743b08ddfeef9077735cdcb19690421222ca9557b2c6338b9e122d7e747f76a50d3357d62e3534

data/README.md

@@ -1,11 +1,20 @@
 # ActiveJob Store
 
+[![Gem Version](https://badge.fury.io/rb/active_job_store.svg)](https://badge.fury.io/rb/active_job_store)
+[![Specs Rails 7.0](https://github.com/blocknotes/active_job_store/actions/workflows/specs_70.yml/badge.svg)](https://github.com/blocknotes/active_job_store/actions/workflows/specs_70.yml)
+[![Linters](https://github.com/blocknotes/active_job_store/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/active_job_store/actions/workflows/linters.yml)
+
 Persist job execution information on a support model `ActiveJobStore::Record`.
 
 It can be useful to:
 - improve jobs logging capabilities;
 - query historical data about job executions;
-- extract job's statistical data.
+- extract job's statistical data;
+- track a job's state / set progress value / add custom data to the jobs.
+
+Support some customizations:
+- set custom data attributes (via `active_job_store_custom_data` accessor);
+- format the job result to store (overriding `active_job_store_format_result` method).
 
 ## Installation
 
@@ -21,7 +30,7 @@ It can be useful to:
 SomeJob.perform_now(123)
 SomeJob.perform_later(456)
 SomeJob.set(wait: 1.minute).perform_later(789)
-"SomeJob", "completed"]]
+
 SomeJob.job_executions.first
 # => #<ActiveJobStore::Record:0x00000001120f6320
 #  id: 1,
@@ -59,7 +68,7 @@ SomeJob.job_executions.where(started_at: 16.minutes.ago...).pluck(:job_id, :resu
 #  ["267e087e-cfa7-4c88-8d3b-9d40f912733f", "some_result", Wed, 09 Nov 2022 21:13:18.011484000 UTC +00:00]]
 ```
 
-Some statistics:
+Some statistics on completed jobs:
 
 ```rb
 SomeJob.job_executions.completed.map { |job| { id: job.id, execution_time: job.completed_at - job.started_at, started_at: job.started_at } }
@@ -70,7 +79,28 @@ SomeJob.job_executions.completed.map { |job| { id: job.id, execution_time: job.c
 
 ## Customizations
 
-If you need to store custom data, use `active_job_store_custom_data` accessor:
+To store the custom data (ex. a progress value):
+
+```rb
+class AnotherJob < ApplicationJob
+  include ActiveJobStore
+
+  def perform
+    # do something...
+    save_job_custom_data(progress: 0.5)
+    # do something else...
+    save_job_custom_data(progress: 1.0)
+
+    'some_result'
+  end
+end
+
+# Usage example:
+AnotherJob.perform_later(456)
+AnotherJob.job_executions.last.custom_data['progress'] # 1.0 (at the end)
+```
+
+If you need to manipulate the custom data, there is the `active_job_store_custom_data` accessor:
 
 ```rb
 class AnotherJob < ApplicationJob
@@ -87,6 +117,7 @@ class AnotherJob < ApplicationJob
   end
 end
 
+# Usage example:
 AnotherJob.perform_now(123)
 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"}]
@@ -107,6 +138,7 @@ class AnotherJob < ApplicationJob
   end
 end
 
+# Usage example:
 AnotherJob.perform_now(123)
 AnotherJob.job_executions.last.result
 # => 84

data/lib/active_job_store/store.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ActiveJobStore
+  class Store
+    DETAILS_ATTRS = %w[exception_executions executions priority queue_name scheduled_at timezone].freeze
+
+    attr_reader :record
+
+    def job_competed!(result:, custom_data:)
+      record.update!(state: :completed, completed_at: Time.current, result: result, custom_data: custom_data)
+      record
+    end
+
+    def job_enqueued!
+      record.lock! # NOTE: needed to avoid update conflicts with perform when setting the state to enqueued
+      yield
+      record.update!(state: :enqueued, enqueued_at: Time.current)
+      record
+    end
+
+    def job_failed!(exception:, custom_data:)
+      record.update!(state: :error, exception: exception.inspect, custom_data: custom_data)
+      record
+    end
+
+    def job_started!
+      record.update!(state: :started, started_at: Time.current)
+      record
+    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
+      end
+    end
+
+    def prepare_record_on_perform(job)
+      @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
+
+    def update_job_custom_data(custom_data)
+      record.update!(custom_data: custom_data)
+    end
+
+    private
+
+    def record_reference(job)
+      {
+        job_id: job.job_id,
+        job_class: job.class.to_s
+      }
+    end
+  end
+end

data/lib/active_job_store/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :nocov:
 module ActiveJobStore
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end
+# :nocov:

data/lib/active_job_store.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 require_relative 'active_job_store/engine'
+require_relative 'active_job_store/store'
 
 module ActiveJobStore
-  IGNORE_ATTRS = %w[arguments job_id successfully_enqueued].freeze
-
   attr_accessor :active_job_store_custom_data
 
   class << self
@@ -12,26 +11,20 @@ module ActiveJobStore
       base.extend(ClassMethods)
 
       base.around_enqueue do |job, block|
-        store_record = ::ActiveJobStore::Record.find_or_create_by!(job.active_job_store_reference) do |record|
-          record.arguments = job.arguments
-          record.details = job.as_json.except(*IGNORE_ATTRS)
-          record.state = :initialized
+        store.prepare_record_on_enqueue(job)
+        store.job_enqueued! do
+          block.call
         end
-        store_record.lock! # NOTE: needed to avoid update conflicts with perform when setting the state to enqueued
-        block.call
-        store_record.update!(state: :enqueued, enqueued_at: Time.current)
       end
 
       base.around_perform do |job, block|
-        store_record = ::ActiveJobStore::Record.find_or_initialize_by(job.active_job_store_reference) do |record|
-          record.arguments = job.arguments
-        end
-        store_record.update!(details: job.as_json.except(*IGNORE_ATTRS), state: :started, started_at: Time.current)
+        store.prepare_record_on_perform(job)
+        store.job_started!
         result = block.call
-        result_data = job.active_job_store_format_result(result)
-        store_record.update!(state: :completed, completed_at: Time.current, result: result_data, custom_data: active_job_store_custom_data)
+        formatted_result = job.active_job_store_format_result(result)
+        store.job_competed!(custom_data: active_job_store_custom_data, result: formatted_result)
       rescue StandardError => e
-        store_record.update!(state: :error, exception: e.inspect)
+        store.job_failed!(exception: e, custom_data: active_job_store_custom_data)
         raise
       end
     end
@@ -41,8 +34,9 @@ module ActiveJobStore
     result
   end
 
-  def active_job_store_reference
-    { job_id: job_id, job_class: self.class.to_s }
+  def save_job_custom_data(custom_data = nil)
+    self.active_job_store_custom_data = custom_data if custom_data
+    store.update_job_custom_data(active_job_store_custom_data)
   end
 
   module ClassMethods
@@ -50,4 +44,10 @@ module ActiveJobStore
       ::ActiveJobStore::Record.where(job_class: to_s)
     end
   end
+
+  private
+
+  def store
+    @store ||= ::ActiveJobStore::Store.new
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job_store
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-09 00:00:00.000000000 Z
+date: 2022-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -36,6 +36,7 @@ files:
 - db/migrate/20221101010101_create_active_job_store.rb
 - lib/active_job_store.rb
 - lib/active_job_store/engine.rb
+- lib/active_job_store/store.rb
 - lib/active_job_store/version.rb
 homepage: https://github.com/blocknotes/active_job_store
 licenses: