web47command 0.0.3 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ec04e840dab56171aaa7e29aab015888e461d1f2487f53dc854b86baebe799f
-  data.tar.gz: 2cf3644fbd84c46a0caaf5c271ebe293a4a608181bc3ef7ecf189a6090490e63
+  metadata.gz: 4265d833318b6297e0ac77b126602c7fe90a32f9a840c92c1029795502bd0fdd
+  data.tar.gz: 608abfe1fe0fe4984383174154a8be71f8d4949c173650c2652717126c0c8270
 SHA512:
-  metadata.gz: 1840d4ca423bb53b9b86e091f51ee146a444b7bf44dc2904a073f3e9fb8a3cbca247a93dc4d409177f83098ae4ae1ab8e371918f59671e524e054b0aecdb8180
-  data.tar.gz: 4fe65ce773a652b7cd77954fa35a2aff89d58e54dc00b72ef701f10303b6186b86595b6489560e75132610edc48fa935510702f8fe447d85fe31668a9d78d510
+  metadata.gz: c6a5f1c5cb1d0370ee03360f736d71f5c837beeb9eebcc44753266075b50a6eb97c3d91b862383862ce2b8c227c63e3aa7e1ea430b6faf1c818ab2b5b34ec74d
+  data.tar.gz: 795a1a37742073f7e4f9663853e27e19b7972a4c83d07a94040e109060dbe128800ca1a3308410e12bfd7fc87f1195a3bdfe5055b3cd52a929a28c64129ab2f9

data/README.md

@@ -73,3 +73,5 @@ _Please do not ship to production code using the git repo, as the production ser
 2.  `JobLog` 
 3.  `CommandLogLog` 
 4.  `TrimJobs` 
+### Remove the following files
+1. Change `status` on a job to `current_status`

data/lib/app/models/command_job.rb

@@ -25,15 +25,25 @@ class CommandJob
   field :max_retries, type: Integer, default: 5
   field :result, type: String
   field :error_message, type: String
+  field :started_at, type: Time
+  field :finished_at, type: Time
   #
   # Relationships
   #
   has_many :logs, class_name: 'CommandJobLog', dependent: :destroy
+  belongs_to :started_by, class_name: 'User', optional: true
   #
   # Validations
   #
   validates :state, inclusion: { in: ALL_STATES }
 
+  #
+  # Who started this job
+  #
+  def display_started_by
+    started_by.present? ? started_by.name : 'System'
+  end
+
   #
   # Default time to keep a job before auto archiving it
   #
@@ -52,113 +62,165 @@ class CommandJob
   # True if in new status
   #
   def new_job?
-    STATE_NEW.eql?(state)
+    job_state?(STATE_NEW)
   end
 
   #
   # True if in WIP status
   #
   def work_in_progress?
-    [STATE_RETRYING, STATE_WIP].include?(state)
+    job_state?([STATE_WIP, STATE_RETRYING])
   end
 
   #
   # True if in success status
   #
   def succeeded?
-    STATE_SUCCESS.eql?(state)
+    job_state?(STATE_SUCCESS)
   end
 
   #
   # True if in fail status
   #
-  def failed?
-    STATE_FAIL.eql?(state)
+  def failure?
+    job_state?(STATE_FAIL)
   end
 
   #
   # If we is finished, failed or success
   #
   def completed?
-    [STATE_CANCELLED, STATE_FAIL, STATE_SUCCESS].include?(state)
+    job_state?([STATE_CANCELLED, STATE_FAIL, STATE_SUCCESS])
   end
 
   #
   # Job has not finished, failure or success
   #
-  def incomplete?
+  def running?
     !completed?
   end
 
-  alias running? incomplete?
+  alias incomplete? running?
 
   #
   # If we are cancelled
   #
   def cancelled?
-    STATE_CANCELLED.eql?(state)
+    job_state?(STATE_CANCELLED)
   end
 
-  def job_cancelled?(job = self)
-    job.reload
-    job.cancelled?
-  rescue StandardError => error
-    App47Logger.log_warn "Unable to check job cancelled #{job}", error
-    true
+  def failure_or_cancelled?
+    job_state?([STATE_FAIL, STATE_CANCELLED], true)
   end
 
-  def failure_or_cancelled?(job = self)
-    job.reload
-    job.failure? || job.cancelled?
+  #
+  # Fetch the latest version of this instance from the database and check the state against the required
+  # state. If there is a match, then return true, otherwise return false.
+  # If there is an error, return the default.
+  #
+  def job_state?(states, default = false)
+    states.is_a?(Array) ? states.include?(state) : states.eql?(state)
   rescue StandardError => error
-    App47Logger.log_warn "Unable to check job cancelled #{job}", error
-    true
+    App47Logger.log_warn "Unable to check job failed or cancelled #{self.inspect}", error
+    default
   end
 
   #
   # Return the job's status and information in a hash that could be used to return to a calling
   # api
   #
-  def status
+  def current_status
     status = { state: state }
     status[:message] = error_message if error_message.present?
     status
   end
 
-  def perform
-    if fail?
-      self.retries = 0
-      self.error_message = 'Retrying'
+  #
+  # Perform this job in the background
+  #
+  def perform_later
+    perform
+  end
+
+  handle_asynchronously :perform_later
+
+  #
+  # Steps to execute before a run
+  #
+  def before_run
+    case state
+    when STATE_NEW
+      set retries: 0,
+          started_at: Time.now.utc,
+          finished_at: nil,
+          error_message: nil,
+          result: nil,
+          state: STATE_WIP
+    when STATE_RETRYING
+      set retries: 0,
+          started_at: Time.now.utc,
+          finished_at: nil,
+          error_message: nil,
+          result: nil
+    when STATE_FAIL
+      set retries: 0,
+          started_at: Time.now.utc,
+          finished_at: nil,
+          error_message: nil,
+          state: STATE_RETRYING,
+          result: nil
+    else
+      set retries: 0, started_at: Time.now.utc, finished_at: nil, result: nil
     end
+  end
 
-    begin
-      save!
-      run
-    rescue StandardError => error
-      log_error 'Unable to start job', error
-      set state: STATE_FAIL, error_message: error.message
+  #
+  # Steps to execute after a run
+  #
+  def after_run
+    case state
+    when STATE_RETRYING, STATE_WIP
+      set finished_at: Time.now.utc, error_message: nil, state: STATE_SUCCESS
+    when STATE_SUCCESS
+      set finished_at: Time.now.utc, error_message: nil
+    else
+      set finished_at: Time.now.utc
     end
   end
 
+  #
+  #
+  # Perform the command job
+  #
+  def perform
+    before_run
+    run
+    after_run
+  rescue StandardError => error
+    log_error 'Unable to start job', error
+    set state: STATE_FAIL, error_message: error.message
+  end
+
+  alias perform_now perform
+
+
+  #
+  # Run the job, handling any failures that might happen
+  #
   def run
-    set state: STATE_WIP
-    # Run the job
-    run!
-    set error_message: '', state: STATE_SUCCESS
+    run! unless cancelled?
   rescue StandardError => error
-    if retries >= max_retries
+    if (retries + 1) >= max_retries
       log_error "Unable to run job id: #{id}, done retrying", error
       set state: STATE_FAIL, error_message: "Failed final attempt: #{error.message}"
     else
       log_error "Unable to run job id: #{id}, retrying!!", error
       add_log "Unable to run job: #{error.message}, retrying!!"
-      set error_message: "Failed attempt # #{retries}: #{error.message}", retries: retries + 1
-      delay(run_at: 10.seconds.from_now).run
+      set error_message: "Failed attempt # #{retries}: #{error.message}", retries: retries + 1, state: STATE_RETRYING
+      run
     end
   end
 
-  handle_asynchronously :run if Delayed::Worker.delay_jobs
-
   #
   # Determine the correct action to take and get it started
   #
@@ -253,7 +315,11 @@ class CommandJob
     end
     output = 'Success' if output.blank?
     command = mask_keywords(command, options[:mask_texts])
-    logs.create!(dir: dir, command: command, message: output)
+    if block_given?
+      yield output
+    else
+      logs.create!(dir: dir, command: command, message: output)
+    end
     check_for_text(output, options[:error_texts], true)
     check_for_text(output, options[:required_texts], false)
     output
@@ -301,4 +367,5 @@ class CommandJob
   def sort_fields
     %i[created_at]
   end
+
 end

data/lib/web47command/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Web47command
-  VERSION = '0.0.3'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web47command
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.9
 platform: ruby
 authors:
 - Chris Schroeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-11 00:00:00.000000000 Z
+date: 2020-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport