active_job_store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f576f48581d1561a8deb8c41fdbc1f89070bc7d48b5f3c6ece7e6de39c33747
+  data.tar.gz: a7807764c2199023daf083ee48ea3c5ded230f566bc07e25664e420ed048725c
+SHA512:
+  metadata.gz: aa62be0ecc3e9ff53ccc8d3e1ff02202383323b0fba7075493bd5c5ca010e2393a627a7bd9e9b04edadc59c799d4fd7d630b81dbfcb3058d05601dce520777c8
+  data.tar.gz: 9436383c18415b52c7226816d62040cd8b8846c3385bac23681fa9730aadc98deebe086dfdfd2b8b33cedcbc5bdcffa951ae6f96725a3a49e74aa45770c0810e

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2022 Mattia Roccoberton
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,127 @@
+# ActiveJob Store
+
+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.
+
+## Installation
+
+- Add to your Gemfile `gem 'active_job_store'` (and execute: `bundle`)
+- Copy the gem migrations: `bundle exec rails active_job_store:install:migrations`
+- Apply the new migrations: `bundle exec rails db:migrate`
+- Add to your job `include ActiveJobStore` (or to your `ApplicationJob` class if you prefer)
+- Access to the job executions data using the class method `job_executions` on your job (ex. `YourJob.job_executions`)
+
+## Usage examples
+
+```rb
+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,
+#  job_id: "58daef7c-6b78-4d90-8043-39116eb9fe77",
+#  job_class: "SomeJob",
+#  state: "completed",
+#  arguments: [123],
+#  custom_data: nil,
+#  details: {"queue_name"=>"default", "priority"=>nil, "executions"=>1, "exception_executions"=>{}, "timezone"=>"UTC"},
+#  result: "some_result",
+#  exception: nil,
+#  enqueued_at: nil,
+#  started_at: Wed, 09 Nov 2022 21:09:50.611355000 UTC +00:00,
+#  completed_at: Wed, 09 Nov 2022 21:09:50.622797000 UTC +00:00,
+#  created_at: Wed, 09 Nov 2022 21:09:50.611900000 UTC +00:00>
+```
+
+Extract some logs:
+
+```rb
+puts ::ActiveJobStore::Record.order(id: :desc).pluck(:created_at, :job_class, :arguments, :state, :completed_at).map { _1.join(', ') }
+# 2022-11-09 21:20:57 UTC, SomeJob, 123, completed, 2022-11-09 21:20:58 UTC
+# 2022-11-09 21:18:26 UTC, AnotherJob, another test 2, completed, 2022-11-09 21:18:26 UTC
+# 2022-11-09 21:13:18 UTC, SomeJob, Some test 3, completed, 2022-11-09 21:13:19 UTC
+# 2022-11-09 21:12:18 UTC, SomeJob, Some test 2, error,
+# 2022-11-09 21:10:13 UTC, AnotherJob, another test, completed, 2022-11-09 21:10:13 UTC
+# 2022-11-09 21:09:50 UTC, SomeJob, Some test, completed, 2022-11-09 21:09:50 UTC
+```
+
+Query jobs in a specific range of time:
+
+```rb
+SomeJob.job_executions.where(started_at: 16.minutes.ago...).pluck(:job_id, :result, :started_at)
+# => [["02beb3d6-a4eb-442c-8d78-29103ab894dc", "some_result", Wed, 09 Nov 2022 21:20:57.576018000 UTC +00:00],
+#  ["267e087e-cfa7-4c88-8d3b-9d40f912733f", "some_result", Wed, 09 Nov 2022 21:13:18.011484000 UTC +00:00]]
+```
+
+Some statistics:
+
+```rb
+SomeJob.job_executions.completed.map { |job| { id: job.id, execution_time: job.completed_at - job.started_at, started_at: job.started_at } }
+# => [{:id=>6, :execution_time=>1.005239, :started_at=>Wed, 09 Nov 2022 21:20:57.576018000 UTC +00:00},
+#  {:id=>4, :execution_time=>1.004485, :started_at=>Wed, 09 Nov 2022 21:13:18.011484000 UTC +00:00},
+#  {:id=>1, :execution_time=>0.011442, :started_at=>Wed, 09 Nov 2022 21:09:50.611355000 UTC +00:00}]
+```
+
+## Customizations
+
+If you need to store custom data, use `active_job_store_custom_data` accessor:
+
+```rb
+class AnotherJob < ApplicationJob
+  include ActiveJobStore
+
+  def perform(some_id)
+    self.active_job_store_custom_data = []
+
+    active_job_store_custom_data << { time: Time.current, message: 'SomeJob step 1' }
+    sleep 1
+    active_job_store_custom_data << { time: Time.current, message: 'SomeJob step 2' }
+
+    'some_result'
+  end
+end
+
+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"}]
+```
+
+If for any reason it's needed to process the result before storing it, just override `active_job_store_format_result`:
+
+```rb
+class AnotherJob < ApplicationJob
+  include ActiveJobStore
+
+  def perform(some_id)
+    42
+  end
+
+  def active_job_store_format_result(result)
+    result * 2
+  end
+end
+
+AnotherJob.perform_now(123)
+AnotherJob.job_executions.last.result
+# => 84
+```
+
+## 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.
+
+Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
+
+## Contributors
+
+- [Mattia Roccoberton](https://blocknot.es/): author
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/models/active_job_store/record.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveJobStore
+  class Record < ApplicationRecord
+    self.table_name = 'active_job_store'
+
+    serialize :arguments, JSON
+    serialize :custom_data, JSON
+    serialize :details, JSON
+    serialize :result, JSON
+
+    enum state: { initialized: 0, enqueued: 1, started: 2, completed: 3, error: 4 }
+
+    scope :by_arguments, ->(*args) { where('arguments = ?', args.to_json) }
+    scope :performing, -> { where(state: %i[enqueued started]) }
+  end
+end

data/db/migrate/20221101010101_create_active_job_store.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class CreateActiveJobStore < ActiveRecord::Migration[6.0]
+  def change
+    create_table :active_job_store do |t|
+      t.string :job_id, null: false
+      t.string :job_class, null: false
+      t.integer :state, null: false
+      t.text :arguments
+      t.text :custom_data
+      t.text :details
+      t.text :result
+      t.string :exception
+      t.datetime :enqueued_at
+      t.datetime :started_at
+      t.datetime :completed_at
+      t.datetime :created_at
+    end
+
+    add_index :active_job_store, [:job_class, :job_id], unique: true
+    add_index :active_job_store, [:job_class, :state]
+  end
+end

data/lib/active_job_store/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveJobStore
+  class Engine < ::Rails::Engine
+    engine_name 'active_job_store'
+  end
+end

data/lib/active_job_store/version.rb

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

data/lib/active_job_store.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'active_job_store/engine'
+
+module ActiveJobStore
+  IGNORE_ATTRS = %w[arguments job_id successfully_enqueued].freeze
+
+  attr_accessor :active_job_store_custom_data
+
+  class << self
+    def included(base)
+      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
+        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)
+        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)
+      rescue StandardError => e
+        store_record.update!(state: :error, exception: e.inspect)
+        raise
+      end
+    end
+  end
+
+  def active_job_store_format_result(result)
+    result
+  end
+
+  def active_job_store_reference
+    { job_id: job_id, job_class: self.class.to_s }
+  end
+
+  module ClassMethods
+    def job_executions
+      ::ActiveJobStore::Record.where(job_class: to_s)
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: active_job_store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: ActiveJob Store permits to store jobs state and custom data on a database
+email: mat@blocknot.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- app/models/active_job_store/record.rb
+- db/migrate/20221101010101_create_active_job_store.rb
+- lib/active_job_store.rb
+- lib/active_job_store/engine.rb
+- lib/active_job_store/version.rb
+homepage: https://github.com/blocknotes/active_job_store
+licenses:
+- MIT
+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
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Persist jobs information on DB
+test_files: []