marj 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5fe8134484360b68c0cf69356f6a037897c6896be81bc393a9dfc0fb0684055
-  data.tar.gz: 4b7575b721d05681876846f3f06d47440d366bc875e02cadeae7de4582270114
+  metadata.gz: c4feb80230bafd2d67bdb0316598f4c46eabd01ca86c35fb8b01e04c865f91a8
+  data.tar.gz: be461234b8359c9f974dd4160d896cc048d0dcc1f4b7d74b57042d62f9950a18
 SHA512:
-  metadata.gz: dbfa1cd4cfb90ca4c47b039f0f320e5cc847aa9863b640cd52b445f5074c13aaa0f2679f4ec950001a086f0b981f58f6aa180a250a4790753691b249dc4fa19f
-  data.tar.gz: d1903bcb55c22522d270d950b316ee99ce05edca0c279cc055cb39a71ecfd389d02acd5d1bcc029e931636e26c4708bfd872a20ab71ecc9328e69928a3b535c2
+  metadata.gz: 31735c1c143a47ab490ed08eca12af6d8fce73b551637ed92e37bcb42e8b2560135ad674dfc832353988f4246c10f9ff2822f624bb10ba256070632dd35c209c
+  data.tar.gz: 7f19dee3c8b0510d27ca10eb8f9d64ecfc2e1174ae1cea71e17abf42f0ce8ef07be4f84e1eff9cf0150e6162bb3a790e066e36f17db131056e30ebbeada1bdc3

data/README.md

@@ -5,12 +5,14 @@ Marj is a Minimal ActiveRecord-based Jobs library.
 API docs: https://www.rubydoc.info/github/nicholasdower/marj <br>
 RubyGems: https://rubygems.org/gems/marj <br>
 Changelog: https://github.com/nicholasdower/marj/releases <br>
-Issues: https://github.com/nicholasdower/marj/issues
+Issues: https://github.com/nicholasdower/marj/issues <br>
+Development: https://github.com/nicholasdower/marj/blob/master/CONTRIBUTING.md
 
 For more information on ActiveJob, see:
 
 - https://edgeguides.rubyonrails.org/active_job_basics.html
 - https://www.rubydoc.info/gems/activejob
+- https://github.com/nicholasdower/marj/blob/master/README.md#activejob-cheatsheet
 
 ## Setup
 
@@ -22,9 +24,11 @@ Add the following to your Gemfile:
 gem 'marj', '~> 1.0'
 ```
 
-### 2. Create the jobs table
+```shell
+bundle install
+```
 
-Apply a database migration:
+### 2. Create the jobs table
 
 ```ruby
 class CreateJobs < ActiveRecord::Migration[7.1]
@@ -53,6 +57,14 @@ class CreateJobs < ActiveRecord::Migration[7.1]
 end
 ```
 
+To use a different table name:
+
+```ruby
+require 'marj'
+
+MarjConfig.table_name = 'some_name'
+```
+
 ### 3. Configure the queue adapter
 
 ```ruby
@@ -84,19 +96,84 @@ SomeJob.perform_later('foo')
 record = Marj.first
 record.execute
 
-# Run all available jobs:
-Marj.work_off
+# Run all ready jobs:
+while (record = Marj.ready.first)
+  record.execute
+end
 
-# Run all available jobs in a specific queue:
-Marj.work_off(source = -> { Marj.where(queue_name: 'foo').available.first })
+# Run all ready jobs in a specific queue:
+while (record = Marj.where(queue_name: 'foo').ready.first)
+  record.execute
+end
 
-# Run jobs as they become available:
+# Run jobs as they become ready:
 loop do
-  Marj.work_off
+  while (record = Marj.ready.first)
+    record.execute
+  end
   sleep 5.seconds
 end
 ```
 
+## Extension Examples
+
+### Timeouts
+
+```ruby
+class ApplicationJob < ActiveJob::Base
+  def self.timeout_after(duration)
+    @timeout = duration
+  end
+
+  around_perform do |job, block|
+    if (timeout = job.class.instance_variable_get(:@timeout))
+      ::Timeout.timeout(timeout, StandardError, 'execution expired') { block.call }
+    else
+      block.call
+    end
+  end
+end
+```
+
+### Last Error
+
+```ruby
+class AddLastErrorToJobs < ActiveRecord::Migration[7.1]
+  def self.up
+    add_column :jobs, :last_error, :text
+  end
+
+  def self.down
+    remove_column :jobs, :last_error
+  end
+end
+
+class ApplicationJob < ActiveJob::Base
+  attr_reader :last_error
+
+  def last_error=(error)
+    if error.is_a?(Exception)
+      backtrace = error.backtrace&.map { |line| "\t#{line}" }&.join("\n")
+      error = backtrace ? "#{error.class}: #{error.message}\n#{backtrace}" : "#{error.class}: #{error.message}"
+    end
+
+    @last_error = error&.truncate(10_000, omission: '… (truncated)')
+  end
+
+  def set(options = {})
+    super.tap { self.last_error = options[:error] if options[:error] }
+  end
+
+  def serialize
+    super.merge('last_error' => @last_error)
+  end
+
+  def deserialize(job_data)
+    super.tap { self.last_error = job_data['last_error'] }
+  end
+end
+```
+
 ## ActiveJob Cheatsheet
 
 ### Configuring a Queue Adapter

data/app/models/marj.rb

@@ -2,17 +2,18 @@
 
 require 'active_job'
 require 'active_record'
+require_relative '../../lib/marj_config'
 
 # Marj is a Minimal ActiveRecord-based Jobs library.
 #
 # See https://github.com/nicholasdower/marj
 class Marj < ActiveRecord::Base
   # The Marj version.
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 
   # Executes the job associated with this record and returns the result.
   def execute
-    # Normally we would call ActiveJob::Base#execute which has the following implemenation:
+    # Normally we would call ActiveJob::Base#execute which has the following implementation:
     #   ActiveJob::Callbacks.run_callbacks(:execute) do
     #     job = deserialize(job_data)
     #     job.perform_now
@@ -30,7 +31,11 @@ class Marj < ActiveRecord::Base
       job_data = job_data.to_h { |k, v| [k, %w[enqueued_at scheduled_at].include?(k) ? v&.iso8601 : v] }
       job.deserialize(job_data)
 
-      job.perform_now
+      new_executions = executions + 1
+      job.perform_now.tap do
+        # If no error was raised, the job should either be destroyed (success) or updated (retryable failure).
+        raise "job #{job_id} not destroyed or updated" unless destroyed? || (executions == new_executions && !changed?)
+      end
     end
   end
 
@@ -38,7 +43,7 @@ class Marj < ActiveRecord::Base
   # past. Jobs are ordered by +priority+ (+null+ last), then +scheduled_at+ (+null+ last), then +enqueued_at+.
   #
   # @return [ActiveRecord::Relation]
-  def self.available
+  def self.ready
     where('scheduled_at is null or scheduled_at <= ?', Time.now.utc).order(
       Arel.sql(<<~SQL.squish)
         CASE WHEN priority IS NULL THEN 1 ELSE 0 END, priority,
@@ -48,23 +53,7 @@ class Marj < ActiveRecord::Base
     )
   end
 
-  # Executes any available jobs from the specified source.
-  #
-  # @param source [Proc] a job source
-  # @return [NilClass]
-  def self.work_off(source = -> { Marj.available.first })
-    while (record = source.call)
-      executions = record.executions
-      begin
-        record.execute
-      rescue Exception
-        # The job should either be discarded or updated. Otherwise, something went wrong.
-        raise unless record.destroyed? || (record.executions == (executions + 1) && !record.changed?)
-      end
-    end
-  end
-
-  self.table_name = 'jobs'
+  self.table_name = MarjConfig.table_name
 
   # Order by +enqueued_at+ rather than +job_id+ (the default)
   self.implicit_order_column = 'enqueued_at'

data/lib/marj.rb

@@ -1,23 +1,6 @@
 # frozen_string_literal: true
 
-Kernel.autoload(:Marj, File.expand_path('../app/models/marj.rb', __dir__))
-
-# ActiveJob queue adapter for Marj.
-class MarjAdapter
-  # Enqueue a job for immediate execution.
-  #
-  # @param job [ActiveJob::Base] the job to enqueue
-  # @return [ActiveJob::Base] the enqueued job
-  def enqueue(job)
-    Marj.send(:enqueue, job)
-  end
+require_relative 'marj_adapter'
+require_relative 'marj_config'
 
-  # Enqueue a job for execution at the specified time.
-  #
-  # @param job [ActiveJob::Base] the job to enqueue
-  # @param timestamp [Numeric, NilClass] optional number of seconds since Unix epoch at which to execute the job
-  # @return [ActiveJob::Base] the enqueued job
-  def enqueue_at(job, timestamp)
-    Marj.send(:enqueue, job, timestamp ? Time.at(timestamp).utc : nil)
-  end
-end
+Kernel.autoload(:Marj, File.expand_path('../app/models/marj.rb', __dir__))

data/lib/marj_adapter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# ActiveJob queue adapter for Marj.
+class MarjAdapter
+  # Enqueue a job for immediate execution.
+  #
+  # @param job [ActiveJob::Base] the job to enqueue
+  # @return [ActiveJob::Base] the enqueued job
+  def enqueue(job)
+    Marj.send(:enqueue, job)
+  end
+
+  # Enqueue a job for execution at the specified time.
+  #
+  # @param job [ActiveJob::Base] the job to enqueue
+  # @param timestamp [Numeric, NilClass] optional number of seconds since Unix epoch at which to execute the job
+  # @return [ActiveJob::Base] the enqueued job
+  def enqueue_at(job, timestamp)
+    Marj.send(:enqueue, job, timestamp ? Time.at(timestamp).utc : nil)
+  end
+end

data/lib/marj_config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Marj configuration.
+class MarjConfig
+  @table_name = 'jobs'
+
+  class << self
+    # The name of the database table. Defaults to "jobs".
+    #
+    # @return [String]
+    attr_accessor :table_name
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marj
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Nick Dower
@@ -48,13 +48,15 @@ files:
 - README.md
 - app/models/marj.rb
 - lib/marj.rb
+- lib/marj_adapter.rb
+- lib/marj_config.rb
 homepage: https://github.com/nicholasdower/marj
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/nicholasdower/marj/issues
-  changelog_uri: https://github.com/nicholasdower/marj/releases/tag/v1.1.0
-  documentation_uri: https://www.rubydoc.info/github/nicholasdower/marj/v1.1.0
+  changelog_uri: https://github.com/nicholasdower/marj/releases/tag/v2.0.0
+  documentation_uri: https://www.rubydoc.info/github/nicholasdower/marj/v2.0.0
   homepage_uri: https://github.com/nicholasdower/marj
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/nicholasdower/marj