geneva_drive 0.2.0 → 0.3.0

data/test/workflow/resume_and_skip_test.rb

@@ -0,0 +1,305 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ResumeAndSkipTest < ActiveSupport::TestCase
+  include GenevaDrive::TestHelpers
+
+  # Workflow that fails on a specific step
+  class FailingWorkflow < GenevaDrive::Workflow
+    step :step_one do
+      Thread.current[:step_one_ran] = true
+    end
+
+    step :step_two, on_exception: :pause! do
+      Thread.current[:step_two_attempts] ||= 0
+      Thread.current[:step_two_attempts] += 1
+      raise "Intentional failure" if Thread.current[:should_fail]
+      Thread.current[:step_two_completed] = true
+    end
+
+    step :step_three do
+      Thread.current[:step_three_ran] = true
+    end
+  end
+
+  # Workflow with a waiting step
+  class WaitingWorkflow < GenevaDrive::Workflow
+    step :step_one do
+      Thread.current[:step_one_ran] = true
+    end
+
+    step :step_two, wait: 2.days do
+      Thread.current[:step_two_ran] = true
+    end
+
+    step :step_three do
+      Thread.current[:step_three_ran] = true
+    end
+  end
+
+  setup do
+    @user = create_user
+    reset_thread_tracking!
+  end
+
+  teardown do
+    reset_thread_tracking!
+  end
+
+  def reset_thread_tracking!
+    Thread.current[:step_one_ran] = nil
+    Thread.current[:step_two_attempts] = nil
+    Thread.current[:step_two_completed] = nil
+    Thread.current[:step_three_ran] = nil
+    Thread.current[:should_fail] = nil
+    Thread.current[:step_two_ran] = nil
+  end
+
+  # ===========================================
+  # Tests for resume! retrying failed step
+  # ===========================================
+
+  test "resume! retries the failed step instead of skipping to next" do
+    workflow = FailingWorkflow.create!(hero: @user)
+
+    # Execute step_one successfully
+    perform_next_step(workflow)
+    assert Thread.current[:step_one_ran]
+    assert_equal "step_two", workflow.next_step_name
+
+    # Make step_two fail (exception is re-raised after workflow pauses)
+    Thread.current[:should_fail] = true
+    assert_raises(RuntimeError) { perform_next_step(workflow) }
+
+    assert_equal "paused", workflow.state
+    assert_equal 1, Thread.current[:step_two_attempts]
+    assert_equal "step_two", workflow.next_step_name, "next_step_name should still point to the failed step"
+
+    # Fix the issue and resume
+    Thread.current[:should_fail] = false
+    workflow.resume!
+
+    assert_equal "ready", workflow.state
+    assert_equal "step_two", workflow.next_step_name, "resume! should schedule the same step for retry"
+
+    # Execute the retried step
+    perform_next_step(workflow)
+
+    assert_equal 2, Thread.current[:step_two_attempts], "step_two should have been attempted twice"
+    assert Thread.current[:step_two_completed], "step_two should have completed on retry"
+    assert_equal "step_three", workflow.next_step_name
+  end
+
+  test "resume! creates new step execution for the failed step" do
+    workflow = FailingWorkflow.create!(hero: @user)
+
+    # Execute step_one
+    perform_next_step(workflow)
+
+    # Make step_two fail
+    Thread.current[:should_fail] = true
+    assert_raises(RuntimeError) { perform_next_step(workflow) }
+
+    assert_equal "paused", workflow.state
+    failed_execution = workflow.step_executions.where(step_name: "step_two", state: "failed").first
+    assert failed_execution, "Should have a failed step_two execution"
+
+    # Resume
+    Thread.current[:should_fail] = false
+    workflow.resume!
+
+    # Should have a new scheduled execution for step_two
+    new_execution = workflow.step_executions.where(step_name: "step_two", state: "scheduled").first
+    assert new_execution, "Should have a new scheduled step_two execution"
+    assert_not_equal failed_execution.id, new_execution.id, "Should be a different execution record"
+  end
+
+  test "next_step_name points to failed step after pause due to exception" do
+    workflow = FailingWorkflow.create!(hero: @user)
+
+    # Execute step_one
+    perform_next_step(workflow)
+    assert_equal "step_two", workflow.next_step_name
+
+    # Fail step_two
+    Thread.current[:should_fail] = true
+    assert_raises(RuntimeError) { perform_next_step(workflow) }
+
+    assert_equal "paused", workflow.state
+    assert_equal "step_two", workflow.next_step_name, "next_step_name should point to the failed step, not the next one"
+  end
+
+  # ===========================================
+  # Tests for skip! on paused workflows
+  # ===========================================
+
+  test "skip! on paused workflow advances past the failed step" do
+    workflow = FailingWorkflow.create!(hero: @user)
+
+    # Execute step_one
+    perform_next_step(workflow)
+
+    # Fail step_two
+    Thread.current[:should_fail] = true
+    assert_raises(RuntimeError) { perform_next_step(workflow) }
+
+    assert_equal "paused", workflow.state
+    assert_equal "step_two", workflow.next_step_name
+
+    # Skip the failed step
+    workflow.skip!
+    workflow.reload
+
+    assert_equal "ready", workflow.state
+    assert_equal "step_three", workflow.next_step_name, "skip! should advance to the next step"
+  end
+
+  test "skip! on paused workflow creates execution for the next step" do
+    workflow = FailingWorkflow.create!(hero: @user)
+
+    # Execute step_one
+    perform_next_step(workflow)
+
+    # Fail step_two
+    Thread.current[:should_fail] = true
+    assert_raises(RuntimeError) { perform_next_step(workflow) }
+
+    assert_equal "paused", workflow.state
+
+    # Skip the failed step
+    workflow.skip!
+    workflow.reload
+
+    # Should have a scheduled execution for step_three
+    step_three_execution = workflow.step_executions.where(step_name: "step_three", state: "scheduled").first
+    assert step_three_execution, "Should have a scheduled step_three execution"
+  end
+
+  test "skip! on paused workflow allows continuing execution" do
+    workflow = FailingWorkflow.create!(hero: @user)
+
+    # Execute step_one
+    perform_next_step(workflow)
+
+    # Fail step_two
+    Thread.current[:should_fail] = true
+    assert_raises(RuntimeError) { perform_next_step(workflow) }
+
+    # Skip the failed step and continue
+    workflow.skip!
+    perform_next_step(workflow)
+
+    assert Thread.current[:step_three_ran], "step_three should have run after skipping step_two"
+    assert_nil Thread.current[:step_two_completed], "step_two should not have completed"
+    assert_equal "finished", workflow.state
+  end
+
+  # ===========================================
+  # Tests for external pause (not due to failure)
+  # ===========================================
+
+  test "resume! after external_pause re-schedules the waiting step" do
+    workflow = WaitingWorkflow.create!(hero: @user)
+
+    # Execute step_one
+    perform_next_step(workflow)
+    assert_equal "step_two", workflow.next_step_name
+
+    # Externally pause while waiting for step_two
+    workflow.pause!
+
+    assert_equal "paused", workflow.state
+    assert_equal "step_two", workflow.next_step_name
+
+    # Resume - should re-schedule step_two
+    workflow.resume!
+
+    assert_equal "ready", workflow.state
+    assert_equal "step_two", workflow.next_step_name
+
+    # Verify a new execution was created
+    step_two_executions = workflow.step_executions.where(step_name: "step_two")
+    assert_equal 2, step_two_executions.count, "Should have original (canceled) and new (scheduled) executions"
+    assert step_two_executions.exists?(state: "scheduled")
+  end
+
+  test "skip! on externally paused workflow advances to next step" do
+    workflow = WaitingWorkflow.create!(hero: @user)
+
+    # Execute step_one
+    perform_next_step(workflow)
+    assert_equal "step_two", workflow.next_step_name
+
+    # Externally pause
+    workflow.pause!
+    assert_equal "paused", workflow.state
+
+    # Skip step_two
+    workflow.skip!
+    workflow.reload
+
+    assert_equal "ready", workflow.state
+    assert_equal "step_three", workflow.next_step_name
+  end
+
+  # ===========================================
+  # Error cases
+  # ===========================================
+
+  test "skip! raises error for finished workflow" do
+    workflow = FailingWorkflow.create!(hero: @user)
+    speedrun_workflow(workflow)
+    assert_equal "finished", workflow.state
+
+    error = assert_raises(GenevaDrive::InvalidStateError) do
+      workflow.skip!
+    end
+    assert_match(/Cannot skip on a finished workflow/, error.message)
+  end
+
+  test "skip! raises error for canceled workflow" do
+    workflow = FailingWorkflow.create!(hero: @user)
+    workflow.transition_to!("canceled")
+
+    error = assert_raises(GenevaDrive::InvalidStateError) do
+      workflow.skip!
+    end
+    assert_match(/Cannot skip on a canceled workflow/, error.message)
+  end
+
+  # ===========================================
+  # Integration: multiple retries then skip
+  # ===========================================
+
+  test "can retry multiple times then skip" do
+    workflow = FailingWorkflow.create!(hero: @user)
+
+    # Execute step_one
+    perform_next_step(workflow)
+
+    # Fail step_two multiple times
+    Thread.current[:should_fail] = true
+
+    3.times do |i|
+      assert_raises(RuntimeError) { perform_next_step(workflow) }
+      assert_equal "paused", workflow.state
+      assert_equal "step_two", workflow.next_step_name
+      assert_equal i + 1, Thread.current[:step_two_attempts]
+
+      workflow.resume! if i < 2 # Resume for first two attempts
+    end
+
+    # After 3 failures, decide to skip
+    workflow.skip!
+    workflow.reload
+
+    assert_equal "ready", workflow.state
+    assert_equal "step_three", workflow.next_step_name
+
+    # Complete the workflow
+    perform_next_step(workflow)
+    assert Thread.current[:step_three_ran]
+    assert_equal "finished", workflow.state
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geneva_drive
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -10,7 +10,49 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,13 +80,6 @@ files:
 - MANUAL.md
 - README.md
 - Rakefile
-- app/assets/stylesheets/geneva_drive/application.css
-- app/controllers/geneva_drive/application_controller.rb
-- app/helpers/geneva_drive/application_helper.rb
-- app/jobs/geneva_drive/application_job.rb
-- app/mailers/geneva_drive/application_mailer.rb
-- app/models/geneva_drive/application_record.rb
-- app/views/layouts/geneva_drive/application.html.erb
 - bin/md2html
 - bin/rails
 - bin/rubocop
@@ -77,7 +112,6 @@ files:
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/jobs/application_job.rb
-- test/dummy/app/mailers/application_mailer.rb
 - test/dummy/app/models/application_record.rb
 - test/dummy/app/models/user.rb
 - test/dummy/app/views/layouts/application.html.erb
@@ -105,7 +139,6 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/puma.rb
 - test/dummy/config/routes.rb
-- test/dummy/config/storage.yml
 - test/dummy/db/migrate/20241217000000_create_users.rb
 - test/dummy/db/migrate/20241217000001_create_geneva_drive_workflows.rb
 - test/dummy/db/migrate/20241217000002_create_geneva_drive_step_executions.rb
@@ -127,7 +160,6 @@ files:
 - test/dummy_install/app/controllers/application_controller.rb
 - test/dummy_install/app/helpers/application_helper.rb
 - test/dummy_install/app/jobs/application_job.rb
-- test/dummy_install/app/mailers/application_mailer.rb
 - test/dummy_install/app/models/application_record.rb
 - test/dummy_install/app/models/user.rb
 - test/dummy_install/app/views/layouts/application.html.erb
@@ -156,12 +188,11 @@ files:
 - test/dummy_install/config/locales/en.yml
 - test/dummy_install/config/puma.rb
 - test/dummy_install/config/routes.rb
-- test/dummy_install/config/storage.yml
 - test/dummy_install/db/migrate/20241217000000_create_users.rb
-- test/dummy_install/db/migrate/20260126091843_create_geneva_drive_workflows.rb
-- test/dummy_install/db/migrate/20260126091844_create_geneva_drive_step_executions.rb
-- test/dummy_install/db/migrate/20260126091845_add_finished_at_to_geneva_drive_step_executions.rb
-- test/dummy_install/db/migrate/20260126091846_add_error_class_name_to_geneva_drive_step_executions.rb
+- test/dummy_install/db/migrate/20260126164025_create_geneva_drive_workflows.rb
+- test/dummy_install/db/migrate/20260126164026_create_geneva_drive_step_executions.rb
+- test/dummy_install/db/migrate/20260126164027_add_finished_at_to_geneva_drive_step_executions.rb
+- test/dummy_install/db/migrate/20260126164028_add_error_class_name_to_geneva_drive_step_executions.rb
 - test/dummy_install/db/schema.rb
 - test/dummy_install/log/test.log
 - test/dummy_install/public/400.html
@@ -185,6 +216,7 @@ files:
 - test/workflow/missing_sti_class_resolution_test.rb
 - test/workflow/precondition_exception_test.rb
 - test/workflow/reattempt_on_exception_integration_test.rb
+- test/workflow/resume_and_skip_test.rb
 - test/workflow/step_definition_source_location_test.rb
 - test/workflow/workflow_test.rb
 homepage: https://github.com/julik/geneva_drive

data/app/assets/stylesheets/geneva_drive/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/geneva_drive/application_controller.rb

@@ -1,2 +0,0 @@
-class GenevaDrive::ApplicationController < ActionController::Base
-end

data/app/helpers/geneva_drive/application_helper.rb

@@ -1,2 +0,0 @@
-module GenevaDrive::ApplicationHelper
-end

data/app/jobs/geneva_drive/application_job.rb

@@ -1,2 +0,0 @@
-class GenevaDrive::ApplicationJob < ActiveJob::Base
-end

data/app/mailers/geneva_drive/application_mailer.rb

@@ -1,4 +0,0 @@
-class GenevaDrive::ApplicationMailer < ActionMailer::Base
-  default from: "from@example.com"
-  layout "mailer"
-end

data/app/models/geneva_drive/application_record.rb

@@ -1,3 +0,0 @@
-class GenevaDrive::ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end

data/app/views/layouts/geneva_drive/application.html.erb

@@ -1,17 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Tmp plugin</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= yield :head %>
-
-  <%= stylesheet_link_tag    "geneva_drive/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/test/dummy/app/mailers/application_mailer.rb

@@ -1,4 +0,0 @@
-class ApplicationMailer < ActionMailer::Base
-  default from: "from@example.com"
-  layout "mailer"
-end

data/test/dummy/config/storage.yml

@@ -1,34 +0,0 @@
-test:
-  service: Disk
-  root: <%= Rails.root.join("tmp/storage") %>
-
-local:
-  service: Disk
-  root: <%= Rails.root.join("storage") %>
-
-# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
-# amazon:
-#   service: S3
-#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
-#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
-#   region: us-east-1
-#   bucket: your_own_bucket-<%= Rails.env %>
-
-# Remember not to checkin your GCS keyfile to a repository
-# google:
-#   service: GCS
-#   project: your_project
-#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
-#   bucket: your_own_bucket-<%= Rails.env %>
-
-# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
-# microsoft:
-#   service: AzureStorage
-#   storage_account_name: your_account_name
-#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
-#   container: your_container_name-<%= Rails.env %>
-
-# mirror:
-#   service: Mirror
-#   primary: local
-#   mirrors: [ amazon, google, microsoft ]

data/test/dummy_install/app/mailers/application_mailer.rb

@@ -1,4 +0,0 @@
-class ApplicationMailer < ActionMailer::Base
-  default from: "from@example.com"
-  layout "mailer"
-end

data/test/dummy_install/config/storage.yml

@@ -1,34 +0,0 @@
-test:
-  service: Disk
-  root: <%= Rails.root.join("tmp/storage") %>
-
-local:
-  service: Disk
-  root: <%= Rails.root.join("storage") %>
-
-# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
-# amazon:
-#   service: S3
-#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
-#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
-#   region: us-east-1
-#   bucket: your_own_bucket-<%= Rails.env %>
-
-# Remember not to checkin your GCS keyfile to a repository
-# google:
-#   service: GCS
-#   project: your_project
-#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
-#   bucket: your_own_bucket-<%= Rails.env %>
-
-# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
-# microsoft:
-#   service: AzureStorage
-#   storage_account_name: your_account_name
-#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
-#   container: your_container_name-<%= Rails.env %>
-
-# mirror:
-#   service: Mirror
-#   primary: local
-#   mirrors: [ amazon, google, microsoft ]