tasks_scheduler 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89877b670ebd68e63175333d60bce49d90de7c4e04737189f5c73a6a277f0595
-  data.tar.gz: 18d4d5224dcabd9dd2238d0cc8a5dea03689d58323de808b5bb4622664a2cc01
+  metadata.gz: f297d8aab57fc0f8e97be84ea5ca71a1dda0623a9231f124866f066a65a96703
+  data.tar.gz: be6470159ccbc01e0953b40f4560e1543b3a2687f75c17147fda86d492f0523f
 SHA512:
-  metadata.gz: 6bb72a00e15bd394f6baa9cbae395e8737295ff72f1177315fd15937b2b60189901b7db0cfe3c2b7b9daf08599023c694558231539d1f6e2b92ea4f6fd0bd2a4
-  data.tar.gz: 766a81812effee371317d38ee615e0e5b57400abac7d6a376a6a5971bc98fc301bdca3e03dbfa3c8f1d3f1c7903ddbdf479fc7b89451292880c386c813311b69
+  metadata.gz: cf3db7dde7ceb96ece05b878c725eda9bdd3642e0c7ec229f248de845aea79028454533eb49692cbe772d892daaef40cb6f08153606dd489f4b50786e0275d11
+  data.tar.gz: cc9a7644b4447216bdc692eea253f39c9183ddc4f24b44e5994b61a84cad0bf093b96607f9d80cc7bb9c33b08ed38292394affc28b49a0a03a85890210f98b62

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,7 +16,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
 load 'rails/tasks/statistics.rake'

data/app/assets/javascripts/tasks_scheduler.js

@@ -4,112 +4,5 @@
 function TasksScheduler() {
 }
 
-TasksScheduler.Status = function () {
-};
-
-// Shortcut
-var _S = TasksScheduler.Status;
-
-_S.initialized = false;
-
-_S.init = function (url, interval_max) {
-  if (!_S.initialized) {
-    _S.initialized = true;
-    _S.url = url;
-    _S.interval_max = interval_max;
-    _S.update();
-  }
-};
-
-_S.content = function () {
-  return $('#TaskScheduler_Status_Content');
-};
-
-_S.status = function () {
-  return $('#TaskScheduler_Status_Status');
-};
-
-_S.update_status = function () {
-  _S.status().html(
-    "Updating in " + _S.interval + " seconds..."
-  );
-};
-
-_S.check = function () {
-  if (_S.interval <= 0) {
-    _S.update();
-  } else {
-    _S.interval--;
-    _S.update_status();
-    setTimeout(_S.check, 1000);
-  }
-};
-
-_S.update = function () {
-  $.ajax({
-    url: _S.url,
-    success: function (result) {
-      _S.content().html(result);
-    },
-    complete: function (result) {
-      _S.interval = _S.interval_max + 1;
-      _S.last_update = new Date();
-      _S.check();
-    }
-  });
-};
-
-TasksScheduler.Alert = function () {
-};
-
-_A = TasksScheduler.Alert;
-
-_A.DEFAULT_REFRESH_INTERVAL = 5000;
-_A.DEFAULT_ELEMENT_SELECTOR = '#tasks_scheduler_alert';
-_A.CSS_CLASSES_PREFIX = 'alert_';
-_A.url = Routes.status_tasks_scheduler_daemon_path();
-
-_A.init = function (options) {
-  options = typeof options !== 'undefined' ? options : {};
-  $(document).ready(function () {
-    _A.options = options;
-    if (!_A.options.refresh_interval) {
-      _A.options.refresh_interval = _A.DEFAULT_REFRESH_INTERVAL;
-    }
-    if (!_A.options.element_selector) {
-      _A.options.element_selector = _A.DEFAULT_ELEMENT_SELECTOR;
-    }
-    _A.refresh();
-  });
-};
-
-_A.setNextRefresh = function () {
-  setTimeout(_A.refresh, _A.options.refresh_interval);
-};
-
-_A.refresh = function () {
-  $.ajax({
-    url: _A.url,
-    success: function (result) {
-      var alert = $(_A.options.element_selector);
-      var pattern = new RegExp('(^|\\s)' + _A.CSS_CLASSES_PREFIX + "\\S+", 'g');
-      alert.removeClass (function (index, className) {
-        return (className.match (pattern) || []).join(' ');
-      });
-      alert.addClass(_A.resultToCssClass(result));
-    },
-    complete: function (result) {
-      _A.setNextRefresh();
-    }
-  });
-};
-
-_A.resultToCssClass = function(result) {
-  var suffix = "ok"
-  if (!result.daemon_running) {
-    suffix = "daemon_stopped";
-  } else if (!result.tasks_all_ok) {
-    suffix = "task_failed";
-  }
-  return _A.CSS_CLASSES_PREFIX + suffix;
-};
+//= require tasks_scheduler/alert
+//= require tasks_scheduler/status

data/app/assets/javascripts/tasks_scheduler/alert.js

@@ -0,0 +1,58 @@
+TasksScheduler.Alert = function () {
+};
+
+_A = TasksScheduler.Alert;
+
+_A.DEFAULT_REFRESH_INTERVAL = 5000;
+_A.DEFAULT_ELEMENT_SELECTOR = '#tasks_scheduler_alert';
+_A.CSS_CLASSES_PREFIX = 'alert_';
+_A.url = Routes.status_tasks_scheduler_daemon_path();
+
+_A.init = function (options) {
+  options = typeof options !== 'undefined' ? options : {};
+  $(document).ready(function () {
+    _A.options = options;
+    if (!_A.options.refresh_interval) {
+      _A.options.refresh_interval = _A.DEFAULT_REFRESH_INTERVAL;
+    }
+    if (!_A.options.element_selector) {
+      _A.options.element_selector = _A.DEFAULT_ELEMENT_SELECTOR;
+    }
+    _A.refresh();
+  });
+};
+
+_A.setNextRefresh = function () {
+  setTimeout(_A.refresh, _A.options.refresh_interval);
+};
+
+_A.refresh = function () {
+  $.ajax(_A.refreshAjaxData());
+};
+
+_A.refreshAjaxData = function () {
+  return {
+    url: _A.url,
+    success: function (result) {
+      var alert = $(_A.options.element_selector);
+      var pattern = new RegExp('(^|\\s)' + _A.CSS_CLASSES_PREFIX + "\\S+", 'g');
+      alert.removeClass (function (index, className) {
+        return (className.match (pattern) || []).join(' ');
+      });
+      alert.addClass(_A.resultToCssClass(result));
+    },
+    complete: function (result) {
+      _A.setNextRefresh();
+    }
+  };
+};
+
+_A.resultToCssClass = function(result) {
+  var suffix = "ok"
+  if (!result.daemon_running) {
+    suffix = "daemon_stopped";
+  } else if (!result.tasks_all_ok) {
+    suffix = "task_failed";
+  }
+  return _A.CSS_CLASSES_PREFIX + suffix;
+};

data/app/assets/javascripts/tasks_scheduler/status.js

@@ -0,0 +1,58 @@
+TasksScheduler.Status = function () {
+};
+
+// Shortcut
+var _S = TasksScheduler.Status;
+
+_S.initialized = false;
+
+_S.init = function (url, interval_max) {
+  if (!_S.initialized) {
+    _S.initialized = true;
+    _S.url = url;
+    _S.interval_max = interval_max;
+    _S.update();
+  }
+};
+
+_S.content = function () {
+  return $('#TaskScheduler_Status_Content');
+};
+
+_S.status = function () {
+  return $('#TaskScheduler_Status_Status');
+};
+
+_S.update_status = function () {
+  _S.status().html(
+    "Updating in " + _S.interval + " seconds..."
+  );
+};
+
+_S.check = function () {
+  if (_S.interval <= 0) {
+    _S.update();
+  } else {
+    _S.interval--;
+    _S.update_status();
+    setTimeout(_S.check, 1000);
+  }
+};
+
+_S.update = function () {
+  $.ajax(_S.updateAjaxData());
+};
+
+_S.updateAjaxData = function() {
+  return {
+    url: _S.url,
+    success: function (result) {
+      _S.content().html(result);
+    },
+    complete: function (result) {
+      _S.interval = _S.interval_max + 1;
+      _S.last_update = new Date();
+      _S.check();
+    }
+  };
+};

data/app/assets/stylesheets/tasks_scheduler.scss

@@ -39,6 +39,10 @@
     td.status_disabled {
       color: lightgrey;
     }
+
+    td.status_task_not_found {
+      color: violet;
+    }
   }
 
   .last_run {

data/app/controllers/scheduled_tasks_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ScheduledTasksController < ApplicationController
   class << self
     private
@@ -8,7 +10,7 @@ class ScheduledTasksController < ApplicationController
   end
 
   active_scaffold :scheduled_task do |conf|
-    [:create, :update, :list].each do |action|
+    %i[create update list].each do |action|
       conf.send(action).columns.exclude(:next_run, :last_fail_status, :last_run_start,
                                         :last_run_successful_start, :last_run_unsuccessful_start,
                                         :last_run_successful_end, :last_run_unsuccessful_end,
@@ -26,8 +28,7 @@ class ScheduledTasksController < ApplicationController
     @log_file = record.log_file(params[:identifier])
   end
 
-  def status
-  end
+  def status; end
 
   def status_content
     @scheduled_tasks = ::ScheduledTask.order(task: :asc, scheduling: :asc)
@@ -36,7 +37,7 @@ class ScheduledTasksController < ApplicationController
 
   def run_now
     process_action_link_action do |record|
-      record.update_attributes!(next_run: Time.zone.now)
+      record.update!(next_run: Time.zone.now)
       record.reload
       flash[:info] = "Next run adjusted to #{record.next_run}"
     end

data/app/controllers/tasks_scheduler_daemon_controller.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'tasks_scheduler/checker'
 
 class TasksSchedulerDaemonController < ApplicationController
   require_relative 'tasks_scheduler_daemon_controller/_download_log'
 
-  def index
-  end
+  def index; end
 
   def execute
     @result = ::TasksScheduler::Daemon.execute(params[:tasks_scheduler_execute_action])
@@ -13,6 +14,6 @@ class TasksSchedulerDaemonController < ApplicationController
 
   def status
     render json: { daemon_running: ::TasksScheduler::Daemon.running?,
-                   tasks_all_ok: !::ScheduledTask.all.any?(&:failed?) }
+                   tasks_all_ok: ::ScheduledTask.all.none?(&:failed?) }
   end
 end

data/app/controllers/tasks_scheduler_daemon_controller/_download_log.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 class TasksSchedulerDaemonController < ApplicationController
   def download_log
     return unless download_log_validate_log_key
+
     log = ::TasksScheduler::Checker.instance.send("#{download_log_key}_log")
     return unless download_log_validate_log_exist(log)
+
     send_log_file(log)
   end
 
@@ -14,6 +18,7 @@ class TasksSchedulerDaemonController < ApplicationController
 
   def download_log_validate_log_key
     return true if ::TasksScheduler::Checker::LOGS_KEYS.include?(download_log_key)
+
     redirect_to(tasks_scheduler_daemon_path,
                 notice: "Invalid log key: \"#{download_log_key}\"")
     false
@@ -21,6 +26,7 @@ class TasksSchedulerDaemonController < ApplicationController
 
   def download_log_validate_log_exist(log)
     return true if log.exist?
+
     redirect_to(tasks_scheduler_daemon_path, notice: "Log \"#{log.key}\" does not exist.")
     false
   end

data/app/helpers/scheduled_tasks_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ScheduledTasksHelper
   def scheduled_tasks_status_time(time)
     if time.present?

data/app/models/scheduled_task.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
 require 'rake'
 
 class ScheduledTask < ActiveRecord::Base
@@ -6,7 +9,7 @@ class ScheduledTask < ActiveRecord::Base
   include ::ScheduledTask::Runner
   include ::ScheduledTask::Status
 
-  DEFAULT_TIMEOUT_ENVVAR_NAME = 'TASKS_SCHEDULER_TIMEOUT'.freeze
+  DEFAULT_TIMEOUT_ENVVAR_NAME = 'TASKS_SCHEDULER_TIMEOUT'
   DEFAULT_TIMEOUT = 12.hours
 
   class << self
@@ -20,21 +23,18 @@ class ScheduledTask < ActiveRecord::Base
     def timeout
       @timeout ||= begin
         r = Integer(ENV[DEFAULT_TIMEOUT_ENVVAR_NAME])
-        r > 0 ? r.seconds : DEFAULT_TIMEOUT
-      rescue ArgumentError, TypeError
-        DEFAULT_TIMEOUT
+        r.positive? ? r.seconds : DEFAULT_TIMEOUT
+                   rescue ArgumentError, TypeError
+                     DEFAULT_TIMEOUT
       end
     end
   end
 
-  STATUS_RUNNING = 'running'
-  STATUS_FAILED = 'failed'
-  STATUS_WAITING = 'waiting'
-  STATUS_ABORTED = 'aborted'
-  STATUS_TIMEOUT = 'timeout'
-  STATUS_DISABLED = 'disabled'
+  enable_listable
+  lists.add_string :status, 'aborted', 'disabled', 'failed', 'running', 'task_not_found', 'timeout',
+                   'waiting'
 
-  LAST_FAIL_STATUSES = [STATUS_FAILED, STATUS_ABORTED, STATUS_TIMEOUT]
+  LAST_FAIL_STATUSES = [STATUS_FAILED, STATUS_ABORTED, STATUS_TASK_NOT_FOUND, STATUS_TIMEOUT].freeze
 
   validates :scheduling, presence: true, 'tasks_scheduler/cron_scheduling': true
   validates :task, presence: true
@@ -69,13 +69,14 @@ class ScheduledTask < ActiveRecord::Base
 
   def process_running?
     return false if pid.nil?
+
     Process.kill(0, pid)
-    return true
+    true
   rescue Errno::EPERM
     raise "No permission to query #{pid}!"
   rescue Errno::ESRCH
-    return false
-  rescue
+    false
+  rescue StandardError
     raise "Unable to determine status for #{pid}"
   end
 
@@ -87,6 +88,7 @@ class ScheduledTask < ActiveRecord::Base
     return if task.blank?
     return unless task_changed?
     return if self.class.rake_tasks.include?(task)
+
     errors.add(:task, "Task \"#{task}\" not found")
   end
 end

data/app/models/scheduled_task/checker.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'rake'
+require 'eac_ruby_utils/ruby'
 
 class ScheduledTask < ActiveRecord::Base
   module Checker
@@ -34,6 +37,7 @@ class ScheduledTask < ActiveRecord::Base
 
     def check_on_pid_not_present
       return unless enabled?
+
       if next_run.present?
         check_task_with_next_run
       else
@@ -41,6 +45,12 @@ class ScheduledTask < ActiveRecord::Base
       end
     end
 
+    def check_on_task_not_exist
+      message = "Task does not exist: #{task}"
+      check_log(message)
+      on_end_running(::StandardError.new(message), STATUS_TASK_NOT_FOUND)
+    end
+
     def check_log(message, method = :info)
       Rails.logger.send(method, "TASK_CHECK(#{id}): #{message}")
     end
@@ -55,13 +65,13 @@ class ScheduledTask < ActiveRecord::Base
 
     def check_task_without_next_run
       check_log('Next run blank')
-      update_attributes!(next_run: calculate_next_run)
+      update!(next_run: calculate_next_run)
       check_log("Next run scheduled: #{next_run.in_time_zone}")
     end
 
     def check_task_with_next_run
       if !task_exist?
-        check_log("Task does not exist: #{task}")
+        check_on_task_not_exist
       elsif next_run < Time.zone.now
         check_log('Next run reached. Running...')
         spawn_task
@@ -74,11 +84,13 @@ class ScheduledTask < ActiveRecord::Base
       params = ['bundle', 'exec', 'tasks_scheduler_run_task', id.to_s]
       check_log("Spawn command: #{params} (Task: #{task})")
       spawn_pid = nil
-      Dir.chdir(Rails.root) do
-        spawn_pid = Process.spawn(*params)
+      ::EacRubyUtils::Ruby.on_clean_environment do
+        Dir.chdir(Rails.root) do
+          spawn_pid = ::Process.spawn(*params)
+        end
       end
       Process.detach(spawn_pid)
-      update_attributes!(pid: spawn_pid, last_fail_status: nil)
+      update!(pid: spawn_pid, last_fail_status: nil)
     end
 
     def timeout?