web47command 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 964c4beeac4360b088953ffefa4accfff297bf115db494ae1f48374a1f3bc749
-  data.tar.gz: 5b3abd477f99613639344b0da59f2fc9499550b07298dbbbc6691c2870b60039
+  metadata.gz: e4c9af98c7b86e879a9885c598141652ba58bf95a2c356067d55e3af5e8178c3
+  data.tar.gz: cc1fcf8e729041d1273908c1da76bbd9810af5206d234335aab5b56fd7ff0587
 SHA512:
-  metadata.gz: 10d7cf516421d02777e981bf78a5fd7d16259df6b3bf2b91ff58657eebf3e84f37ead93e1f18f5c9bf3f913ddf868c2d3a085a68c9f2304c93bc07d137b27a2d
-  data.tar.gz: d6e185ef29dfc1da47cce099da1826462c454601e1f5ab335ad81e79e7cdd25ff9c78776a965a786ef749534ef529a6be8638b0084a1722a421a32c09d6045c2
+  metadata.gz: d36c06edcaf174da4ff360a2842e86c6bd1c6c47ced6cb60567fa0623c279bbffda43bee966f479226b1928434aa62309964f5b7214d27236d232a86adb570c0
+  data.tar.gz: d4a92dd44cd66e1f352dcdc64bd076c32453c09989ef693d15601710584eec3d8f2b7e690ec4f636d0b2404013428c89510157f00597b3093a41374769c59b12

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

@@ -41,7 +41,7 @@ class CommandJob
   # Who started this job
   #
   def display_started_by
-    started_by.present? ? started_by.display_name : 'System'
+    started_by.present? ? started_by.name : 'System'
   end
 
   #
@@ -62,113 +62,158 @@ 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.failed? || 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 failed?
-      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
+    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, started_at: Time.now.utc
-    # Run the job
-    run!
-    set error_message: '', state: STATE_SUCCESS, finished_at: Time.now.utc
+    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}", finished_at: Time.now.utc
+      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
   #
@@ -311,4 +356,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.6'
+  VERSION = '0.0.8'
 end

metadata

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