Class: MaintenanceTasks::RunStatusValidator Private

Inherits:
ActiveModel::Validator
  • Object
show all
Defined in:
app/validators/maintenance_tasks/run_status_validator.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Custom validator class responsible for ensuring that transitions between Run statuses are valid.

Constant Summary collapse

VALID_STATUS_TRANSITIONS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Valid status transitions a Run can make.

{
  # enqueued -> running occurs when the task starts performing.
  # enqueued -> pausing occurs when the task is paused before starting.
  # enqueued -> cancelling occurs when the task is cancelled
  #   before starting.
  # enqueued -> errored occurs when the task job fails to be enqueued, or
  #   if the Task is deleted before is starts running.
  "enqueued" => ["running", "pausing", "cancelling", "errored"],
  # pausing -> paused occurs when the task actually halts performing and
  #   occupies a status of paused.
  # pausing -> cancelling occurs when the user cancels a task immediately
  #   after it was paused, such that the task had not actually halted yet.
  # pausing -> succeeded occurs when the task completes immediately after
  #   being paused. This can happen if the task is on its last iteration
  #   when it is paused, or if the task is paused after enqueue but has
  #   nothing in its collection to process.
  # pausing -> errored occurs when the job raises an exception after the
  #   user has paused it.
  "pausing" => ["paused", "cancelling", "succeeded", "errored"],
  # cancelling -> cancelled occurs when the task actually halts performing
  #   and occupies a status of cancelled.
  # cancelling -> succeeded occurs when the task completes immediately after
  #   being cancelled. See description for pausing -> succeeded.
  # cancelling -> errored occurs when the job raises an exception after the
  #   user has cancelled it.
  "cancelling" => ["cancelled", "succeeded", "errored"],
  # running -> succeeded occurs when the task completes successfully.
  # running -> pausing occurs when a user pauses the task as
  #   it's performing.
  # running -> cancelling occurs when a user cancels the task as
  #   it's performing.
  # running -> interrupted occurs when the job infra shuts down the task as
  #   it's performing.
  # running -> errored occurs when the job raises an exception when running.
  "running" => [
    "succeeded",
    "pausing",
    "cancelling",
    "interrupted",
    "errored",
  ],
  # paused -> enqueued occurs when the task is resumed after being paused.
  # paused -> cancelled when the user cancels the task after it is paused.
  "paused" => ["enqueued", "cancelled"],
  # interrupted -> running occurs when the task is resumed after being
  #   interrupted by the job infrastructure.
  # interrupted -> pausing occurs when the task is paused by the user while
  #   it is interrupted.
  # interrupted -> cancelling occurs when the task is cancelled by the user
  #   while it is interrupted.
  # interrupted -> errored occurs when the task is deleted while it is
  #   interrupted.
  "interrupted" => ["running", "pausing", "cancelling", "errored"],
  # errored -> enqueued occurs when the task is retried after encounting an
  #   error.
  "errored" => ["enqueued"],
}

Instance Method Summary collapse

Instance Method Details

#validate(record) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Validate whether a transition from one Run status to another is acceptable.

@param record [MaintenanceTasks::Run] the Run object being validated.



72
73
74
75
76
77
78
79
80
 
# File 'app/validators/maintenance_tasks/run_status_validator.rb', line 72

def validate(record)
  return unless (previous_status, new_status = record.status_change)

  valid_new_statuses = VALID_STATUS_TRANSITIONS.fetch(previous_status, [])

  unless valid_new_statuses.include?(new_status)
    add_invalid_status_error(record, previous_status, new_status)
  end
end