stepper_motor 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7846dbc38d7f5d10b018f8e052e33f2347598e59bcf04dfcc4b49c3bcd247fd6
-  data.tar.gz: 947b3810bff07dd61b72c86319d83f1ef93341986541a8b8ff9bfd8fe0230461
+  metadata.gz: dfb7061ca792fe914c363ae586ba322df95147dc832c39852af36809f0013e73
+  data.tar.gz: cbc8583f27710cc4d800dd7d380b527c1382c021cfed1430c2eb10afa2c4b591
 SHA512:
-  metadata.gz: eab053515d0672cdd23065e0c7c13276cd6c972d07df6340755052cc8412e447d5d37ad31a34fac9c0ddb587c73b050a0571bab7a521544963c2a2149f1c069d
-  data.tar.gz: d4041d89eb0cb2abf39721ff426ea99f33548576cd510fd8cbf5b5723f1f920075dbda0b692323afc89715eb266957d0d21907219c0a06aab7848237d1db1ddf
+  metadata.gz: 99e9981596319a6c18856536b0f9889b2eb5cf2c69b1306bb762a7ea9af3d95b746882c4af7f20f39c45068c81fe1134f157b773121edef016163e2831bec754
+  data.tar.gz: 54c83aa39398e84bf34640301f1258aef437f4e1dfd6a3e2b08b0f70ab8e76bc59b9aa8f032681185c8635528d4be9f67c247be468f98c718bcadd2524c6c3e3

data/lib/generators/stepper_motor_migration_002.rb.erb

@@ -0,0 +1,6 @@
+class StepperMotorMigration002 < ActiveRecord::Migration[<%= migration_version %>]
+  def change
+    # An index is needed to recover stuck journeys
+    add_index :stepper_motor_journeys, [:updated_at], name: "stuck_journeys_index", where: "state = 'performing'"
+  end
+end

data/lib/stepper_motor/journey.rb

@@ -52,6 +52,33 @@ module StepperMotor
       where(hero: hero)
     }
 
+    # Allows querying for Journeys which are stuck in "performing" state since a certain
+    # timestamp. These Journeys have likely been stuck because the worker that was performing
+    # the step has crashed or was forcibly restarted.
+    scope :stuck, ->(since) {
+      where(updated_at: ..since).performing
+    }
+
+    # Sets the behavior when a Journey gets stuck in "performing" state. The default us "reattempt" -
+    # it is going to try to restart the step the Journey got stuck on
+    class_attribute :when_stuck, default: :reattempt, instance_accessor: false, instance_reader: true
+
+    def recover!
+      case when_stuck
+      when :reattempt
+        with_lock do
+          return unless performing?
+          ready!
+          schedule!
+        end
+      else
+        with_lock do
+          return unless performing?
+          canceled!
+        end
+      end
+    end
+
     after_create do |journey|
       journey.step_definitions.any? ? journey.set_next_step_and_enqueue(journey.step_definitions.first) : journey.finished!
     end

data/lib/stepper_motor/railtie.rb

@@ -7,7 +7,7 @@ module StepperMotor
     end
 
     generators do
-      require "generators/install_generator"
+      require_relative "../generators/install_generator"
     end
 
     # The `to_prepare` block which is executed once in production

data/lib/stepper_motor/{reap_hung_journeys_job.rb → recover_stuck_journeys_job_v1.rb}

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
+require "active_job"
+
 # The purpose of this job is to find journeys which have, for whatever reason, remained in the
 # `performing` state for far longer than the journey is supposed to. At the moment it assumes
 # any journey that stayed in `performing` for longer than 1 hour has hung. Add this job to your
 # cron table and perform it regularly.
-class StepperMotor::ReapHungJourneysJob < ActiveJob::Base
-  def perform
-    StepperMotor::Journey.where("state = 'performing' AND updated_at < ?", 1.hour.ago).find_each do |hung_journey|
-      hung_journey.update!(state: "ready")
-      StepperMotor.scheduler.schedule(hung_journey)
+class StepperMotor::RecoverStuckJourneysJobV1 < ActiveJob::Base
+  def perform(stuck_for: 2.days)
+    StepperMotor::Journey.stuck(stuck_for.ago).find_each do |journey|
+      journey.recover!
+    rescue => e
+      Rails&.error&.report(e)
     end
   end
 end

data/lib/stepper_motor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StepperMotor
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

data/lib/stepper_motor.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "stepper_motor/version"
+require_relative "stepper_motor/railtie" if defined?(Rails::Railtie)
 require "active_support"
 
 module StepperMotor
@@ -14,12 +15,12 @@ module StepperMotor
   autoload :Step, File.dirname(__FILE__) + "/stepper_motor/step.rb"
   autoload :PerformStepJob, File.dirname(__FILE__) + "/stepper_motor/perform_step_job.rb"
   autoload :PerformStepJobV2, File.dirname(__FILE__) + "/stepper_motor/perform_step_job_v2.rb"
+  autoload :RecoverStuckJourneysJobV1, File.dirname(__FILE__) + "/stepper_motor/recover_stuck_journeys_job_v1.rb"
   autoload :InstallGenerator, File.dirname(__FILE__) + "/generators/install_generator.rb"
   autoload :ForwardScheduler, File.dirname(__FILE__) + "/stepper_motor/forward_scheduler.rb"
   autoload :CyclicScheduler, File.dirname(__FILE__) + "/stepper_motor/cyclic_scheduler.rb"
   autoload :TestHelper, File.dirname(__FILE__) + "/stepper_motor/test_helper.rb"
 
-  require_relative "stepper_motor/railtie" if defined?(Rails::Railtie)
 
   mattr_accessor :scheduler, default: ForwardScheduler.new
 end

data/spec/spec_helper.rb

@@ -56,7 +56,7 @@ end
 module JourneyDefinitionHelper
   def create_journey_subclass(&blk)
     # https://stackoverflow.com/questions/4113479/dynamic-class-definition-with-a-class-name
-    random_component = Random.hex(8)
+    random_component = Random.hex(2)
     random_name = "JourneySubclass#{random_component}"
     klass = Class.new(StepperMotor::Journey, &blk)
     Object.const_set(random_name, klass)

data/spec/stepper_motor/recover_stuck_journeys_job_spec.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require_relative "../spec_helper"
+
+RSpec.describe "RecoveryStuckJourneysJobV1" do
+  before do
+    StepperMotor::Journey.delete_all
+  end
+
+  it "handles recovery from a background job" do
+    stuck_journey_class1 = create_journey_subclass do
+      self.when_stuck = :cancel
+
+      step :first do
+      end
+
+      step :second, wait: 4.days do
+        Fiber.yield # Simulate the journey hanging
+      end
+    end
+
+    stuck_journey_class2 = create_journey_subclass do
+      self.when_stuck = :reattempt
+
+      step :first do
+      end
+
+      step :second, wait: 4.days do
+        Fiber.yield # Simulate the journey hanging
+      end
+    end
+
+    freeze_time
+
+    journey_to_cancel = stuck_journey_class1.create!
+    journey_to_reattempt = stuck_journey_class2.create!
+
+    journey_to_cancel.perform_next_step!
+    journey_to_reattempt.perform_next_step!
+
+    travel_to Time.now + 5.days
+
+    # Get both stuck
+    Fiber.new do
+      journey_to_cancel.perform_next_step!
+    end.resume
+
+    Fiber.new do
+      journey_to_reattempt.perform_next_step!
+    end.resume
+
+    expect(journey_to_cancel.reload).to be_performing
+    expect(journey_to_reattempt.reload).to be_performing
+
+    StepperMotor::RecoverStuckJourneysJobV1.perform_now(stuck_for: 2.days)
+    expect(journey_to_cancel.reload).to be_performing
+    expect(journey_to_reattempt.reload).to be_performing
+
+    travel_to Time.now + 2.days + 1.second
+    StepperMotor::RecoverStuckJourneysJobV1.perform_now(stuck_for: 2.days)
+
+    expect(journey_to_cancel.reload).to be_canceled
+    expect(journey_to_reattempt.reload).to be_ready
+  end
+
+  it "does not raise when the class of the journey is no longer present" do
+    stuck_journey_class1 = create_journey_subclass do
+      self.when_stuck = :cancel
+
+      step :first do
+        Fiber.yield # Simulate the journey hanging
+      end
+    end
+
+    freeze_time
+
+    journey_to_cancel = stuck_journey_class1.create!
+    Fiber.new do
+      journey_to_cancel.perform_next_step!
+    end.resume
+    expect(journey_to_cancel.reload).to be_performing
+
+    journey_to_cancel.class.update_all(type: "UnknownJourneySubclass")
+
+    expect {
+      StepperMotor::RecoverStuckJourneysJobV1.perform_now(stuck_for: 2.days)
+    }.not_to raise_error
+  end
+end

data/spec/stepper_motor/recovery_spec.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative "../spec_helper"
+
+RSpec.describe "Recovery of stuck journeys" do
+  before do
+    StepperMotor::Journey.delete_all
+  end
+
+  it "recovers a journey by reattempting it" do
+    stuck_journey_class = create_journey_subclass do
+      step :first do
+      end
+
+      step :second, wait: 4.days do
+        Fiber.yield # Simulate the journey hanging
+      end
+
+      step :third, wait: 4.days do
+      end
+    end
+
+    freeze_time
+    journey = stuck_journey_class.create!
+
+    journey.perform_next_step!
+    expect(journey.next_step_name).to eq("second")
+
+    travel_to Time.now + 5.days
+
+    expect(stuck_journey_class.when_stuck).to eq(:reattempt)
+    expect(journey.when_stuck).to eq(:reattempt)
+
+    # Hang the journey in "performing"
+    stuck_fiber = Fiber.new do
+      journey.perform_next_step!
+    end
+    stuck_fiber.resume
+
+    expect(journey).to be_persisted
+    expect(journey).to be_performing
+    expect(journey.updated_at).to eq(Time.now)
+
+    expect(StepperMotor::Journey.stuck(1.days.ago)).not_to include(journey)
+
+    travel_to Time.now + 2.days
+    expect(StepperMotor::Journey.stuck(2.days.ago)).to include(journey)
+
+    perform_at_before_recovery = journey.next_step_to_be_performed_at
+    expect {
+      journey.reload.recover!
+    }.not_to raise_error
+
+    journey.reload
+    expect(journey.next_step_to_be_performed_at).to eq(perform_at_before_recovery)
+    expect(journey.next_step_name).to eq("second")
+  end
+
+  it "recovers a journey by canceling it" do
+    stuck_journey_class = create_journey_subclass do
+      self.when_stuck = :cancel
+
+      step :first do
+      end
+
+      step :second, wait: 4.days do
+        Fiber.yield # Simulate the journey hanging
+      end
+
+      step :third, wait: 4.days do
+      end
+    end
+
+    freeze_time
+    journey = stuck_journey_class.create!
+
+    journey.perform_next_step!
+    expect(journey.next_step_name).to eq("second")
+
+    travel_to Time.now + 5.days
+
+    expect(stuck_journey_class.when_stuck).to eq(:cancel)
+    expect(journey.when_stuck).to eq(:cancel)
+
+    # Hang the journey in "performing"
+    stuck_fiber = Fiber.new do
+      journey.perform_next_step!
+    end
+    stuck_fiber.resume
+
+    expect(journey).to be_persisted
+    expect(journey).to be_performing
+    expect(journey.updated_at).to eq(Time.now)
+
+    travel_to Time.now + 2.days
+    expect(StepperMotor::Journey.stuck(2.days.ago)).to include(journey)
+
+    expect {
+      journey.reload.recover!
+    }.not_to raise_error
+
+    journey.reload
+    expect(journey).to be_canceled
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepper_motor
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-17 00:00:00.000000000 Z
+date: 2025-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -197,6 +197,7 @@ files:
 - bin/setup
 - lib/generators/install_generator.rb
 - lib/generators/stepper_motor_migration_001.rb.erb
+- lib/generators/stepper_motor_migration_002.rb.erb
 - lib/stepper_motor.rb
 - lib/stepper_motor/cyclic_scheduler.rb
 - lib/stepper_motor/forward_scheduler.rb
@@ -204,7 +205,7 @@ files:
 - lib/stepper_motor/perform_step_job.rb
 - lib/stepper_motor/perform_step_job_v2.rb
 - lib/stepper_motor/railtie.rb
-- lib/stepper_motor/reap_hung_journeys_job.rb
+- lib/stepper_motor/recover_stuck_journeys_job_v1.rb
 - lib/stepper_motor/step.rb
 - lib/stepper_motor/test_helper.rb
 - lib/stepper_motor/version.rb
@@ -215,6 +216,8 @@ files:
 - spec/stepper_motor/forward_scheduler_spec.rb
 - spec/stepper_motor/generator_spec.rb
 - spec/stepper_motor/journey_spec.rb
+- spec/stepper_motor/recover_stuck_journeys_job_spec.rb
+- spec/stepper_motor/recovery_spec.rb
 - spec/stepper_motor/test_helper_spec.rb
 - spec/stepper_motor_spec.rb
 homepage: https://steppermotor.dev