foreman-tasks 8.0.2 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461b481178e5ad353de2b1476ffb71cc716fa516a451396e3ff9d40466a892b6
-  data.tar.gz: 2c8a4689eed2d7b3e14369c92a252cb01267c0e4c4ff83343c20fd2335bdc335
+  metadata.gz: 8cbc85cc5038629927d1204242995f7a8ffa0074caaa56fcc7886f6f2093dff1
+  data.tar.gz: 4f848db967c1791278c0fc9cebe3ddaa3a7fd3500208995ae84289496710db4d
 SHA512:
-  metadata.gz: a1f044567563379a76ad6a059d7e2357a4c7d1600f23a62a156abbbb1f0fc8b521719a75c4a52ffc4541933bff508c85b21d97ad4ee5026c93a90a4da15e85ac
-  data.tar.gz: d0ef48cc17a0202e40c053b158a1ba89fedcc8f318eab700cb46c68fd412b25b3fbf9fb7d094bf1522ef371c99eefd54c776b9318156c6b2bae1ee50a035334b
+  metadata.gz: ba8c8768bdaef20f5750b1052e9d43b525fee4260c81c0e61e0847cab958fc534129065d24f556920f2f5270fd8aad7192f808e60ee5fd693eedb54b8afdb77c
+  data.tar.gz: 0e8628e1db3a0a7fb800ae92fc722d7c7af1feaf9cebf659117f08686f0dae70f376ffe7236a7a99b2c6d1e20ed47e40194f52d37a3b5b0a653a23879460738e

data/app/lib/actions/check_long_running_tasks.rb

@@ -0,0 +1,45 @@
+module Actions
+  class CheckLongRunningTasks < ::Actions::EntryAction
+    include Actions::RecurringAction
+
+    INTERVAL = 2.days
+    STATES = ['running', 'paused'].freeze
+
+    def plan
+      time = Time.now.utc
+      cutoff = time - INTERVAL
+      notification = ::ForemanTasks::TasksMailNotification.find_by(name: "long_running_tasks")
+      org_admin_role = Role.find_by(name: 'Organization admin')
+      users = User.left_joins(:roles)
+                  .where(id: UserMailNotification.where(mail_notification_id: notification.id).select(:host_id))
+                  .or(User.where(admin: true))
+                  .or(User.where(id: UserRole.where(id: [org_admin_role.id] + org_admin_role.cloned_role_ids).select(:owner_id)))
+
+      query = "state ^ (#{STATES.join(', ')}) AND state_updated_at <= \"#{cutoff}\""
+      users.each do |user|
+        User.as(user) do
+          tasks = ForemanTasks::Task.authorized
+                                    .search_for(query)
+                                    .select(:id)
+                                    .pluck(:id)
+          plan_action(DeliverLongRunningTasksNotification,
+                      OpenStruct.new(
+                        user_id: User.current.id,
+                        time: time,
+                        interval: INTERVAL,
+                        states: STATES,
+                        task_uuids: tasks,
+                        query: query,
+                        # Non serializable fields
+                        user: nil,
+                        tasks: nil
+                      ))
+        end
+      end
+    end
+
+    def humanized_name
+      _('Check for long running tasks')
+    end
+  end
+end

data/app/lib/actions/deliver_long_running_tasks_notification.rb

@@ -0,0 +1,22 @@
+module Actions
+  class DeliverLongRunningTasksNotification < EntryAction
+    def plan(report)
+      return if report.task_uuids.empty?
+
+      plan_self report: report
+    end
+
+    def run
+      report = OpenStruct.new(input[:report])
+      tasks = ForemanTasks::Task.where(id: report.task_uuids)
+      report.user = User.current
+      report.tasks = tasks
+      ::UINotifications::Tasks::TasksRunningLong.new.deliver!
+      TasksMailer.long_tasks(report).deliver_now
+    end
+
+    def humanized_name
+      _('Deliver notifications about long running tasks')
+    end
+  end
+end

data/app/mailers/tasks_mailer.rb

@@ -0,0 +1,12 @@
+class TasksMailer < ApplicationMailer
+  helper ApplicationHelper
+
+  def long_tasks(report, opts = {})
+    return if report.tasks.empty?
+
+    @report = report
+    @subject = opts[:subject]
+    @subject ||= _('Tasks pending since %s') % (@report.time - @report.interval)
+    mail(to: report.user.mail, subject: @subject)
+  end
+end

data/app/models/foreman_tasks/tasks_mail_notification.rb

@@ -0,0 +1,9 @@
+module ForemanTasks
+  class TasksMailNotification < MailNotification
+    ALL = N_("Subscribe")
+
+    def subscription_options
+      [ALL]
+    end
+  end
+end

data/app/services/ui_notifications/tasks/tasks_running_long.rb

@@ -0,0 +1,33 @@
+module UINotifications
+  module Tasks
+    class TasksRunningLong < Tasks::Base
+      include Rails.application.routes.url_helpers
+
+      def deliver!
+        notification = ::Notification.new(
+          :audience => Notification::AUDIENCE_GLOBAL,
+          :notification_blueprint => blueprint,
+          :initiator => initiator,
+          :message => message,
+          :subject => nil,
+          :notification_recipients => [NotificationRecipient.create(:user => User.current)]
+        )
+        notification.actions['links'] ||= []
+        notification.actions['links'] << {
+          href: foreman_tasks_tasks_path(search: subject.query),
+          title: N_('Long running tasks'),
+        }
+        notification.save!
+        notification
+      end
+
+      def blueprint
+        @blueprint ||= NotificationBlueprint.unscoped.find_by(:name => 'tasks_running_long')
+      end
+
+      def message
+        _("%{count} tasks are in running or paused state for more than a day") % { count: subject.task_uuids.count }
+      end
+    end
+  end
+end

data/app/views/tasks_mailer/long_tasks.html.erb

@@ -0,0 +1,29 @@
+<p>
+<%= _("Tasks lingering in states %{states} since %{time}") % {
+  time: @report.time - @report.interval,
+  states: @report.states.join(', ')
+} %>
+</p>
+
+<div class="dashboard">
+  <table>
+    <tr>
+      <th>_("ID")</th>
+      <th>_("Action")</th>
+      <th>_("Label")</th>
+      <th>_("State")</th>
+      <th>_("State updated at")</th>
+    </tr>
+    <% @report.tasks.each do |task| %>
+      <tr>
+        <td><%= link_to task.id, foreman_tasks_task_url(task) %></td>
+        <td><%= task.action %></td>
+        <td><%= task.label %></td>
+        <td><%= task.state %></td>
+        <td><%= task.state_updated_at %></td>
+      </tr>
+    <% end %>
+  </table>
+</div>
+
+<%= link_to 'More details', foreman_tasks_tasks_url(search: @report.query) %>

data/app/views/tasks_mailer/long_tasks.text.erb

@@ -0,0 +1,16 @@
+<%= _("Tasks lingering in states %{states} since %{time}") % {
+  time: @report.time - @report.interval,
+  states: @report.states.join(', ')
+} %>
+
+More details: <%= foreman_tasks_tasks_url(search: @report.query) %>
+
+<% @report.tasks.each do |task| %>
+ID: <%= task.id %>
+Action: <%= task.action %>
+Label: <%= task.label %>
+State: <%= task.state %>
+State updated at: <%= task.state_updated_at %>
+Details: <%= foreman_tasks_task_url(task) %>
+
+<% end %>

data/db/seeds.d/30-notification_blueprints.rb

@@ -49,6 +49,13 @@ blueprints = [
     level: 'info',
     message: "DYNAMIC",
   },
+
+  {
+    group: N_('Tasks'),
+    name: 'tasks_running_long',
+    message: 'DYNAMIC',
+    level: 'warning',
+  },
 ]
 
 blueprints.each { |blueprint| UINotifications::Seed.new(blueprint).configure }

data/db/seeds.d/95-mail_notifications.rb

@@ -0,0 +1,24 @@
+N_('Long running tasks')
+
+notifications = [
+  {
+    :name               => 'long_running_tasks',
+    :description        => N_('A notification when tasks run for suspiciously long time'),
+    :mailer             => 'TasksMailer',
+    :method             => 'long_tasks',
+    :subscription_type  => 'alert',
+  },
+]
+
+notifications.each do |notification|
+  if (mail = ForemanTasks::TasksMailNotification.find_by(name: notification[:name]))
+    mail.attributes = notification
+    mail.save! if mail.changed?
+  else
+    created_notification = ForemanTasks::TasksMailNotification.create(notification)
+    if created_notification.nil? || created_notification.errors.any?
+      raise ::Foreman::Exception.new(N_("Unable to create mail notification: %s"),
+                                     SeedHelper.format_errors(created_notification))
+    end
+  end
+end

data/lib/foreman_tasks/engine.rb

@@ -162,6 +162,7 @@ module ForemanTasks
         world.middleware.use Actions::Middleware::KeepCurrentTimezone
         world.middleware.use Actions::Middleware::KeepCurrentRequestID
         world.middleware.use ::Actions::Middleware::LoadSettingValues
+        ForemanTasks.register_scheduled_task(Actions::CheckLongRunningTasks, ENV['FOREMAN_TASKS_CHECK_LONG_RUNNING_TASKS_CRONLINE'] || '0 0 * * *')
       end
       ::ForemanTasks.dynflow.config.on_init(true) do
         ::ForemanTasks::Task::DynflowTask.consistency_check
@@ -186,7 +187,7 @@ module ForemanTasks
     end
 
     rake_tasks do
-      %w[dynflow.rake test.rake export_tasks.rake cleanup.rake generate_task_actions.rake].each do |rake_file|
+      %w[dynflow.rake test.rake export_tasks.rake cleanup.rake generate_task_actions.rake reschedule_long_running_tasks_checker.rake].each do |rake_file|
         full_path = File.expand_path("../tasks/#{rake_file}", __FILE__)
         load full_path if File.exist?(full_path)
       end

data/lib/foreman_tasks/tasks/reschedule_long_running_tasks_checker.rake

@@ -0,0 +1,21 @@
+namespace :foreman_tasks do
+  desc <<~DESC
+    Reschedules the long running task checker recurring logic to run at a different schedule. ENV variables:
+
+      * FOREMAN_TASKS_CHECK_LONG_RUNNING_TASKS_CRONLINE : A cron line describing the schedule, defaults to 0 0 * * *
+  DESC
+  task :reschedule_long_running_tasks_checker => ['environment', 'dynflow:client'] do
+    User.as_anonymous_admin do
+      task_class = Actions::CheckLongRunningTasks
+      cronline = ENV['FOREMAN_TASKS_CHECK_LONG_RUNNING_TASKS_CRONLINE'] || '0 0 * * *'
+      rl = ForemanTasks::RecurringLogic.joins(:tasks)
+                                       .where(state: 'active')
+                                       .merge(ForemanTasks::Task.where(label: task_class.name))
+                                       .first
+      if rl&.cron_line != cronline
+        rl.cancel
+        ForemanTasks.register_scheduled_task(task_class, cronline)
+      end
+    end
+  end
+end

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '8.0.2'.freeze
+  VERSION = '8.1.0'.freeze
 end

data/lib/foreman_tasks.rb

@@ -61,4 +61,20 @@ module ForemanTasks
     result = dynflow.world.delay action, delay_options, *args
     ForemanTasks::Task::DynflowTask.where(:external_id => result.id).first!
   end
+
+  def self.register_scheduled_task(task_class, cronline)
+    ForemanTasks::RecurringLogic.transaction(isolation: :serializable) do
+      return if ForemanTasks::RecurringLogic.joins(:tasks)
+                                            .where(state: 'active')
+                                            .merge(ForemanTasks::Task.where(label: task_class.name))
+                                            .exists?
+
+      User.as_anonymous_admin do
+        recurring_logic = ForemanTasks::RecurringLogic.new_from_cronline(cronline)
+        recurring_logic.save!
+        recurring_logic.start(task_class)
+      end
+    end
+  rescue ActiveRecord::TransactionIsolationError # rubocop:disable Lint/SuppressedException
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 8.0.2
+  version: 8.1.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -153,6 +153,8 @@ files:
 - app/lib/actions/action_with_sub_plans.rb
 - app/lib/actions/base.rb
 - app/lib/actions/bulk_action.rb
+- app/lib/actions/check_long_running_tasks.rb
+- app/lib/actions/deliver_long_running_tasks_notification.rb
 - app/lib/actions/entry_action.rb
 - app/lib/actions/foreman/host/import_facts.rb
 - app/lib/actions/foreman/puppetclass/import.rb
@@ -181,6 +183,7 @@ files:
 - app/lib/actions/trigger_proxy_batch.rb
 - app/lib/foreman_tasks/concerns/polling_action_extensions.rb
 - app/lib/proxy_api/foreman_dynflow/dynflow_proxy.rb
+- app/mailers/tasks_mailer.rb
 - app/models/foreman_tasks/concerns/action_subject.rb
 - app/models/foreman_tasks/concerns/action_triggering.rb
 - app/models/foreman_tasks/concerns/host_action_subject.rb
@@ -199,6 +202,7 @@ files:
 - app/models/foreman_tasks/task_group.rb
 - app/models/foreman_tasks/task_group_member.rb
 - app/models/foreman_tasks/task_groups/recurring_logic_task_group.rb
+- app/models/foreman_tasks/tasks_mail_notification.rb
 - app/models/foreman_tasks/triggering.rb
 - app/services/foreman_tasks/proxy_selector.rb
 - app/services/foreman_tasks/troubleshooting_help_generator.rb
@@ -208,6 +212,7 @@ files:
 - app/services/ui_notifications/tasks/task_bulk_stop.rb
 - app/services/ui_notifications/tasks/task_paused_admin.rb
 - app/services/ui_notifications/tasks/task_paused_owner.rb
+- app/services/ui_notifications/tasks/tasks_running_long.rb
 - app/views/common/_trigger_form.html.erb
 - app/views/foreman_tasks/api/locks/show.json.rabl
 - app/views/foreman_tasks/api/recurring_logics/base.json.rabl
@@ -230,6 +235,8 @@ files:
 - app/views/foreman_tasks/tasks/dashboard/_latest_tasks_in_error_warning.html.erb
 - app/views/foreman_tasks/tasks/dashboard/_tasks_status.html.erb
 - app/views/foreman_tasks/tasks/show.html.erb
+- app/views/tasks_mailer/long_tasks.html.erb
+- app/views/tasks_mailer/long_tasks.text.erb
 - babel.config.js
 - bin/dynflow-executor
 - bin/foreman-tasks
@@ -268,6 +275,7 @@ files:
 - db/seeds.d/30-notification_blueprints.rb
 - db/seeds.d/60-dynflow_proxy_feature.rb
 - db/seeds.d/61-foreman_tasks_bookmarks.rb
+- db/seeds.d/95-mail_notifications.rb
 - deploy/foreman-tasks.service
 - deploy/foreman-tasks.sysconfig
 - extra/dynflow-debug.sh
@@ -290,6 +298,7 @@ files:
 - lib/foreman_tasks/tasks/dynflow.rake
 - lib/foreman_tasks/tasks/export_tasks.rake
 - lib/foreman_tasks/tasks/generate_task_actions.rake
+- lib/foreman_tasks/tasks/reschedule_long_running_tasks_checker.rake
 - lib/foreman_tasks/test_extensions.rb
 - lib/foreman_tasks/test_helpers.rb
 - lib/foreman_tasks/triggers.rb
@@ -633,7 +642,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Foreman plugin for showing tasks information for resources and users