disqualified 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9912dd95e6d0ffe2a78c0ac5e2d12683d16898d2ac329f7c50f1add7779ad3ea
-  data.tar.gz: 98ee2d4e7581fe04cbceed91904cb280b9a0042e6cb38ebe738103b441edecb8
+  metadata.gz: 6c792cca8195272d00f6f55adc0384d98d55b7b777ff20b151d9f712b4a0b3b2
+  data.tar.gz: cd93d8bc19cdcec9ff6824dcdbf16e8aeb445e29d21fb52352511b6463ee3eed
 SHA512:
-  metadata.gz: 3e27a52fd2e01580afcfdac1a66511ddb2fa70faf4f67caccefde8343fabffa4f7e527ec7257e2c9b2f5d7d9e8680b5f614846332c084c2311fd7c3f8548b806
-  data.tar.gz: 3242e97e5e18fa7ff0ea60199ba8abbeb504277e26dfab3cbf2896e63eee53b7fda96c152ea76ed49c01c317492c361f4699c94478c1aa428260eb526ce2c2ef
+  metadata.gz: f6e7ef1182d6889dc023dadc50b0813a345cf11a2760bdf639607f0a0ec2d3ec92f448f79b2c564fa36a53fd3cc17fcd867b2aab91778bc0823fe7849ebacc47
+  data.tar.gz: 9cb2967ff78a215111a013823f6da72833d185a2b8876aaa44926317ad2adf6d7fdaf50a409254f0dc37dc5566579144cee3db54aa058d00dc2c7de2e8b89479

data/README.md

@@ -62,6 +62,10 @@ bundle exec rails generate disqualified:install
 bundle binstub disqualified
 ```
 
+Please remember to run `rails generate disqualified:install` when upgrading
+Disqualified! It is mostly an idempotent command and will prepare any necessary
+database migrations.
+
 
 ### ActiveJob
 

data/app/models/disqualified/record.rb

@@ -1,7 +1,18 @@
 class Disqualified::Record < Disqualified::BaseRecord
   self.table_name = "disqualified_jobs"
 
-  scope :runnable, -> { where(finished_at: nil, run_at: (..Time.now), locked_by: nil) }
+  belongs_to :disqualified_sequence,
+    class_name: "Disqualified::SequenceRecord",
+    foreign_key: "sequence_uuid",
+    primary_key: "uuid",
+    optional: true
+
+  scope :with_sequence, -> {
+    joins("LEFT OUTER JOIN disqualified_sequences ds ON ds.uuid = sequence_uuid AND ds.current_step = sequence_step")
+      .where("ds.uuid = sequence_uuid OR (ds.uuid IS NULL AND sequence_uuid IS NULL)")
+  }
+  scope :pending, -> { where(finished_at: nil, run_at: (..Time.now), locked_by: nil) }
+  scope :runnable, -> { with_sequence.pending }
 
   def self.claim_one!(id: nil)
     run_id = SecureRandom.uuid
@@ -22,31 +33,52 @@ class Disqualified::Record < Disqualified::BaseRecord
       attempts: Arel.sql("attempts + 1")
     )
 
-    raise ActiveRecord::RecordNotFound if claimed_count == 0
+    raise Disqualified::Error::NoClaimableJob if claimed_count == 0
 
     Disqualified::Record.find_by!(locked_by: run_id)
+  rescue ActiveRecord::RecordNotFound
+    raise Disqualified::Error::NoClaimableJob
   end
 
   def run!
     record = self.class.claim_one!(id:)
-    record.send(:instantiate_handler_and_perform_with_args)
-    record.finish
+    begin
+      record.send(:instantiate_handler_and_perform_with_args)
+    rescue => e
+      record.unclaim
+      raise e
+    else
+      record.finish
+    end
     record
   end
 
   def finish
-    update!(locked_by: nil, locked_at: nil, finished_at: Time.now)
+    transaction do
+      update!(locked_by: nil, locked_at: nil, finished_at: Time.now)
+      if sequence_uuid && sequence_step
+        Disqualified::SequenceRecord
+          .where(uuid: sequence_uuid, current_step: sequence_step)
+          .update_all(
+            current_step: sequence_step + 1,
+            updated_at: Time.now
+          )
+      end
+    end
   end
 
   def requeue
     retry_count = attempts - 1
     sleep = (retry_count**4) + 15 + (rand(10) * (retry_count + 1))
-    unqueue(run_at: Time.now + sleep)
+    unclaim(next_run_at: Time.now + sleep)
   end
 
-  def unqueue(run_at: nil)
-    run_at ||= Time.now
-    update!(locked_by: nil, locked_at: nil, run_at:)
+  def unclaim(next_run_at: nil)
+    if next_run_at
+      update!(locked_by: nil, locked_at: nil, run_at: next_run_at)
+    else
+      update!(locked_by: nil, locked_at: nil)
+    end
   end
 
   private def instantiate_handler_and_perform_with_args

data/app/models/disqualified/sequence_record.rb

@@ -0,0 +1,3 @@
+class Disqualified::SequenceRecord < Disqualified::BaseRecord
+  self.table_name = "disqualified_sequences"
+end

data/disqualified.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 3.1.0"
 
+  spec.post_install_message = "Remember to update! Run `rails g disqualified:install`"
+
   spec.add_dependency "rails", ">= 7.0.0"
   spec.add_dependency "concurrent-ruby", "~> 1.0"
 end

data/lib/disqualified/error.rb

@@ -8,5 +8,8 @@ module Disqualified
 
     class JobNotClaimed < DisqualifiedError
     end
+
+    class NoClaimableJob < DisqualifiedError
+    end
   end
 end

data/lib/disqualified/job.rb

@@ -1,11 +1,19 @@
 module Disqualified::Job
   module ClassMethods
     def perform_at(the_time, *args)
+      if Thread.current[Disqualified::Sequence::UUID]
+        Thread.current[Disqualified::Sequence::COUNT] += 1
+        sequence_uuid = Thread.current[Disqualified::Sequence::UUID]
+        sequence_step = Thread.current[Disqualified::Sequence::COUNT]
+      end
+
       Disqualified::Record.create!(
         handler: name,
         arguments: JSON.dump(args),
         queue: "default",
-        run_at: the_time
+        run_at: the_time,
+        sequence_uuid:,
+        sequence_step:
       )
     end
 
@@ -18,7 +26,7 @@ module Disqualified::Job
     end
   end
 
-  def self.included(klass)
-    klass.extend(ClassMethods)
+  def self.included(other)
+    other.extend(ClassMethods)
   end
 end

data/lib/disqualified/main.rb

@@ -8,28 +8,21 @@ class Disqualified::Main
 
   def call
     Rails.application.reloader.wrap do
-      begin
-        record = Disqualified::Record.claim_one!
-        run_id = record.locked_by
-      rescue ActiveRecord::RecordNotFound
-        @logger.warn do
-          format_log("Disqualified::Main#call", "Job not found")
-        end
-        next
+      record = Disqualified::Record.claim_one!
+      run_id = record.locked_by
+      record.send(:instantiate_handler_and_perform_with_args)
+      record.finish
+      @logger.info do
+        format_log("Disqualified::Main#call", "Runner #{run_id}", "Done")
       end
-
-      begin
-        record.send(:instantiate_handler_and_perform_with_args)
-        record.finish
-
-        @logger.info do
-          format_log("Disqualified::Main#call", "Runner #{run_id}", "Done")
-        end
-      rescue => e
-        handle_error(@error_hooks, e, {record: record.attributes})
-        @logger.error { format_log("Disqualified::Main#run", "Runner #{run_id}", "Rescued Record ##{record.id}") }
-        record.requeue
+    rescue Disqualified::Error::NoClaimableJob
+      @logger.warn do
+        format_log("Disqualified::Main#call", "No claimable jobs")
       end
+    rescue => e
+      handle_error(@error_hooks, e, {record: record.attributes})
+      @logger.error { format_log("Disqualified::Main#run", "Runner #{run_id}", "Rescued Record ##{record.id}") }
+      record.requeue
     end
   end
 end

data/lib/disqualified/sequence.rb

@@ -0,0 +1,21 @@
+class Disqualified::Sequence
+  UUID = :disqualified_sequence_uuid
+  COUNT = :disqualified_sequence_count
+
+  def self.queue(description: nil, &block)
+    Disqualified::SequenceRecord.transaction do
+      Thread.current[UUID] = SecureRandom.uuid
+      Thread.current[COUNT] = 0
+      yield
+      Disqualified::SequenceRecord.create!(
+        uuid: Thread.current[UUID],
+        current_step: 1,
+        final_step: Thread.current[COUNT],
+        description:
+      )
+    end
+  ensure
+    Thread.current[UUID] = nil
+    Thread.current[COUNT] = nil
+  end
+end

data/lib/disqualified/version.rb

@@ -1,3 +1,3 @@
 module Disqualified
-  VERSION = "0.4.0"
+  VERSION = "0.5.1"
 end

data/lib/disqualified.rb

@@ -17,4 +17,5 @@ require_relative "disqualified/engine"
 require_relative "disqualified/job"
 require_relative "disqualified/main"
 require_relative "disqualified/pool"
+require_relative "disqualified/sequence"
 require_relative "disqualified/version"

data/lib/generators/disqualified/install/USAGE

@@ -3,6 +3,8 @@ Description:
 
 Example:
     bin/rails generate disqualified:install
+    bin/rails generate disqualified:install --database primary
+    bin/rails g disqualified:install --db=animals
 
     This will create:
         db/migrate/20220703062536_create_disqualified_jobs.rb

data/lib/generators/disqualified/install/install_generator.rb

@@ -1,8 +1,20 @@
+require "rails/generators/active_record"
+
 class Disqualified::InstallGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+
   source_root File.expand_path("templates", __dir__)
 
+  class_option :database,
+    type: :string,
+    aliases: %i[--db],
+    desc: "The database for your migration. By default, the current environment's primary database is used."
+
   def copy_migration_file
     basename = "20220703062536_create_disqualified_jobs.rb"
-    copy_file basename, "db/migrate/#{basename}"
+    copy_file(basename, File.join(db_migrate_path, basename))
+
+    basename = "20241119023328_create_disqualified_sequences.rb"
+    copy_file(basename, File.join(db_migrate_path, basename))
   end
 end

data/lib/generators/disqualified/install/templates/20241119023328_create_disqualified_sequences.rb

@@ -0,0 +1,17 @@
+class CreateDisqualifiedSequences < ActiveRecord::Migration[7.2]
+  def change
+    create_table :disqualified_sequences do |t|
+      t.text :uuid, null: false
+      t.integer :current_step, null: false
+      t.integer :final_step, null: false
+      t.text :description
+      t.timestamps
+
+      t.index :uuid, unique: true
+    end
+
+    add_column :disqualified_jobs, :sequence_uuid, :text
+    add_column :disqualified_jobs, :sequence_step, :integer
+    add_index :disqualified_jobs, [:sequence_uuid, :sequence_step], unique: true
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: disqualified
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Zach Ahn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-11 00:00:00.000000000 Z
+date: 2024-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,6 +50,7 @@ files:
 - README.md
 - app/models/disqualified/base_record.rb
 - app/models/disqualified/record.rb
+- app/models/disqualified/sequence_record.rb
 - disqualified.gemspec
 - exe/disqualified
 - lib/disqualified.rb
@@ -63,10 +64,12 @@ files:
 - lib/disqualified/logging.rb
 - lib/disqualified/main.rb
 - lib/disqualified/pool.rb
+- lib/disqualified/sequence.rb
 - lib/disqualified/version.rb
 - lib/generators/disqualified/install/USAGE
 - lib/generators/disqualified/install/install_generator.rb
 - lib/generators/disqualified/install/templates/20220703062536_create_disqualified_jobs.rb
+- lib/generators/disqualified/install/templates/20241119023328_create_disqualified_sequences.rb
 homepage: https://github.com/zachahn/disqualified
 licenses:
 - LGPL-3.0-only
@@ -74,7 +77,7 @@ metadata:
   homepage_uri: https://github.com/zachahn/disqualified
   source_code_uri: https://github.com/zachahn/disqualified
   changelog_uri: https://github.com/zachahn/disqualified/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: Remember to update! Run `rails g disqualified:install`
 rdoc_options: []
 require_paths:
 - lib