foreman-tasks 12.0.0 → 12.1.1

data/app/assets/javascripts/foreman-tasks/locale/zh_CN/foreman_tasks.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_tasks": {
       "": {
-        "Project-Id-Version": "foreman-tasks 11.0.5",
+        "Project-Id-Version": "foreman-tasks 12.0.0",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2016-02-12 14:04+0000",
         "Last-Translator": "FULL NAME <EMAIL@ADDRESS>",
@@ -23,9 +23,6 @@
       "%(older)s Older %(time)s": [
         "%(older)s 较老 %(time)s"
       ],
-      "%s Selected Tasks": [
-        "%s 选择的任务"
-      ],
       "%s is not valid format of cron line": [
         "%s 不是正确的 cron 行"
       ],
@@ -63,13 +60,13 @@
         "操作"
       ],
       "Action with sub plans": [
-        ""
+        "有子计划的操作"
       ],
       "Active": [
         "活跃"
       ],
-      "Active Filters:": [
-        "活跃的过滤器："
+      "Active Filters": [
+        ""
       ],
       "Active or disabled recurring logic with purpose %s already exists": [
         "带有目的 %s 的活跃或禁用的周期性逻辑已存在"
@@ -98,6 +95,9 @@
       "Backtrace": [
         "回溯"
       ],
+      "Blocks": [
+        ""
+      ],
       "Bulk action": [
         "批量操作"
       ],
@@ -107,6 +107,12 @@
       "Cancel Selected": [
         "取消选择"
       ],
+      "Cancel Selected Tasks": [
+        ""
+      ],
+      "Cancel Task": [
+        ""
+      ],
       "Cancel enforced: the task might be still running on the proxy": [
         "强制取消：任务可能仍在代理服务器上运行"
       ],
@@ -116,9 +122,6 @@
       "Cancel selected cancellable tasks": [
         "取消所选的可取消的任务"
       ],
-      "Cancel selected tasks": [
-        "取消选择的任务"
-      ],
       "Cancel specific tasks by ID": [
         "根据 ID 取消特定任务"
       ],
@@ -152,9 +155,6 @@
       "Check for long running tasks": [
         "检查长时间运行的任务"
       ],
-      "Clear All Filters": [
-        "清除所有过滤器"
-      ],
       "Clear Cancelled": [
         "清除取消"
       ],
@@ -197,6 +197,12 @@
       "Deliver notifications about long running tasks": [
         "提供有关长时间运行的任务的通知"
       ],
+      "Dependencies": [
+        ""
+      ],
+      "Depends on": [
+        ""
+      ],
       "Details": [
         "详情"
       ],
@@ -275,12 +281,15 @@
       "Force Cancel Selected": [
         "强制取消选择"
       ],
-      "Force Cancel selected tasks": [
-        "强制取消选择的任务"
-      ],
       "Force Unlock": [
         "强制解除锁定"
       ],
+      "Force Unlock Selected Tasks": [
+        ""
+      ],
+      "Force Unlock Task": [
+        ""
+      ],
       "Foreman Tasks": [
         "Foreman 任务"
       ],
@@ -315,7 +324,7 @@
         "输入"
       ],
       "Invalid URL": [
-        ""
+        "无效 URL"
       ],
       "Iteration limit": [
         "重述限制"
@@ -395,6 +404,9 @@
       "No. of Tasks": [
         "任务号"
       ],
+      "None": [
+        ""
+      ],
       "Not all the selected tasks can be cancelled": [
         "并非所有选定的任务都可以取消"
       ],
@@ -518,12 +530,15 @@
       "Resume Selected": [
         "恢复选择"
       ],
+      "Resume Selected Tasks": [
+        ""
+      ],
+      "Resume Task": [
+        ""
+      ],
       "Resume all paused error tasks": [
         "恢复所有暂停的错误任务"
       ],
-      "Resume selected tasks": [
-        "恢复选择的任务"
-      ],
       "Resume specific tasks by ID": [
         "根据 ID 恢复特定任务"
       ],
@@ -557,9 +572,6 @@
       "See %{link} for more details on how to resolve the issue": [
         "有关如何解决此问题的更多详细信息，请参见%{link}"
       ],
-      "Select Action": [
-        "选择操作"
-      ],
       "Select all {count} tasks": [
         "选择所有 {count} 任务"
       ],
@@ -617,6 +629,9 @@
       "Stopped": [
         "停止"
       ],
+      "Stopped tasks by result": [
+        ""
+      ],
       "Sub tasks": [
         "子任务"
       ],
@@ -650,6 +665,9 @@
       "Task count": [
         "任务计数"
       ],
+      "Task dependencies": [
+        ""
+      ],
       "Task group common": [
         "任务组一般事项"
       ],
@@ -701,8 +719,26 @@
       "This action will delete all cancelled recurring logics. Please note that this action can't be reversed.": [
         "此操作将删除所有取消的重复逻辑。请注意，此操作无法撤消。"
       ],
-      "This will %(action)s %(number)s task(s), putting them in the %(state)s state. Are you sure?": [
-        "这将 %(action)s %(number)s 任务，把它们置于 %(state)s 状态。确定吗？"
+      "This task may have dependencies on other tasks or may be blocking other tasks from executing. Dependencies are established through task chaining relationships.": [
+        ""
+      ],
+      "This will cancel %(number)s task(s), putting them in the stopped state. Are you sure?": [
+        ""
+      ],
+      "This will cancel task \\\\\\\"%(taskName)s\\\\\\\", putting it in the stopped state. Are you sure?": [
+        ""
+      ],
+      "This will force unlock %(number)s task(s). This may cause harm and should be used with caution. Are you sure?": [
+        ""
+      ],
+      "This will force unlock task \\\\\\\"%(taskName)s\\\\\\\". This may cause harm and should be used with caution. Are you sure?": [
+        ""
+      ],
+      "This will resume %(number)s task(s), putting them in the running state. Are you sure?": [
+        ""
+      ],
+      "This will resume task \\\\\\\"%(taskName)s\\\\\\\", putting it in the running state. Are you sure?": [
+        ""
       ],
       "This will unlock the resources that the task is running against. Please note that this might lead to inconsistent state and should be used with caution, after making sure that the task can't be resumed.": [
         "这将解锁任务正在针对其运行的资源。请注意，这可能会导致状态不一致，应该谨慎使用，然后再确保任务无法恢复。"

data/app/assets/javascripts/foreman-tasks/locale/zh_TW/foreman_tasks.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_tasks": {
       "": {
-        "Project-Id-Version": "foreman-tasks 11.0.5",
+        "Project-Id-Version": "foreman-tasks 12.0.0",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2016-02-12 14:04+0000",
         "Last-Translator": "FULL NAME <EMAIL@ADDRESS>",
@@ -23,9 +23,6 @@
       "%(older)s Older %(time)s": [
         ""
       ],
-      "%s Selected Tasks": [
-        ""
-      ],
       "%s is not valid format of cron line": [
         "%s 不是 cron 行的正確格式"
       ],
@@ -68,7 +65,7 @@
       "Active": [
         "啟用中"
       ],
-      "Active Filters:": [
+      "Active Filters": [
         ""
       ],
       "Active or disabled recurring logic with purpose %s already exists": [
@@ -98,6 +95,9 @@
       "Backtrace": [
         "追蹤"
       ],
+      "Blocks": [
+        ""
+      ],
       "Bulk action": [
         "批次動作"
       ],
@@ -107,6 +107,12 @@
       "Cancel Selected": [
         ""
       ],
+      "Cancel Selected Tasks": [
+        ""
+      ],
+      "Cancel Task": [
+        ""
+      ],
       "Cancel enforced: the task might be still running on the proxy": [
         "強制取消：任務可能還在代理伺服器上執行"
       ],
@@ -116,9 +122,6 @@
       "Cancel selected cancellable tasks": [
         ""
       ],
-      "Cancel selected tasks": [
-        ""
-      ],
       "Cancel specific tasks by ID": [
         ""
       ],
@@ -152,9 +155,6 @@
       "Check for long running tasks": [
         ""
       ],
-      "Clear All Filters": [
-        ""
-      ],
       "Clear Cancelled": [
         ""
       ],
@@ -197,6 +197,12 @@
       "Deliver notifications about long running tasks": [
         ""
       ],
+      "Dependencies": [
+        ""
+      ],
+      "Depends on": [
+        ""
+      ],
       "Details": [
         "詳細資訊"
       ],
@@ -275,12 +281,15 @@
       "Force Cancel Selected": [
         ""
       ],
-      "Force Cancel selected tasks": [
-        ""
-      ],
       "Force Unlock": [
         "強制解除鎖定"
       ],
+      "Force Unlock Selected Tasks": [
+        ""
+      ],
+      "Force Unlock Task": [
+        ""
+      ],
       "Foreman Tasks": [
         ""
       ],
@@ -395,6 +404,9 @@
       "No. of Tasks": [
         "任務編號"
       ],
+      "None": [
+        ""
+      ],
       "Not all the selected tasks can be cancelled": [
         ""
       ],
@@ -518,12 +530,15 @@
       "Resume Selected": [
         ""
       ],
-      "Resume all paused error tasks": [
-        "繼續所有處於暫停狀態的錯誤任務"
+      "Resume Selected Tasks": [
+        ""
       ],
-      "Resume selected tasks": [
+      "Resume Task": [
         ""
       ],
+      "Resume all paused error tasks": [
+        "繼續所有處於暫停狀態的錯誤任務"
+      ],
       "Resume specific tasks by ID": [
         "透過 ID 繼續特定任務"
       ],
@@ -557,9 +572,6 @@
       "See %{link} for more details on how to resolve the issue": [
         ""
       ],
-      "Select Action": [
-        "選擇動作"
-      ],
       "Select all {count} tasks": [
         ""
       ],
@@ -617,6 +629,9 @@
       "Stopped": [
         ""
       ],
+      "Stopped tasks by result": [
+        ""
+      ],
       "Sub tasks": [
         "子任務"
       ],
@@ -650,6 +665,9 @@
       "Task count": [
         "工作數量"
       ],
+      "Task dependencies": [
+        ""
+      ],
       "Task group common": [
         "任務群組的一般事項"
       ],
@@ -702,7 +720,25 @@
       "This action will delete all cancelled recurring logics. Please note that this action can't be reversed.": [
         ""
       ],
-      "This will %(action)s %(number)s task(s), putting them in the %(state)s state. Are you sure?": [
+      "This task may have dependencies on other tasks or may be blocking other tasks from executing. Dependencies are established through task chaining relationships.": [
+        ""
+      ],
+      "This will cancel %(number)s task(s), putting them in the stopped state. Are you sure?": [
+        ""
+      ],
+      "This will cancel task \\\\\\\"%(taskName)s\\\\\\\", putting it in the stopped state. Are you sure?": [
+        ""
+      ],
+      "This will force unlock %(number)s task(s). This may cause harm and should be used with caution. Are you sure?": [
+        ""
+      ],
+      "This will force unlock task \\\\\\\"%(taskName)s\\\\\\\". This may cause harm and should be used with caution. Are you sure?": [
+        ""
+      ],
+      "This will resume %(number)s task(s), putting them in the running state. Are you sure?": [
+        ""
+      ],
+      "This will resume task \\\\\\\"%(taskName)s\\\\\\\", putting it in the running state. Are you sure?": [
         ""
       ],
       "This will unlock the resources that the task is running against. Please note that this might lead to inconsistent state and should be used with caution, after making sure that the task can't be resumed.": [

data/app/controllers/foreman_tasks/api/tasks_controller.rb

@@ -179,24 +179,12 @@ module ForemanTasks
       param :parent_task_id, :identifier, desc: 'UUID of the task'
       param_group :search_and_pagination, ::Api::V2::BaseController
       def index
-        if params[:sort_by] || params[:sort_order]
-          Foreman::Deprecation.api_deprecation_warning(
-            "The sort params sort_by and sort_order are deprecated.
-            Please use the order param instead as one string 'order=started_at desc'"
-          )
-
-          ordering_params = {
-            sort_by: params[:sort_by] || 'started_at',
-            sort_order: params[:sort_order] || 'DESC',
-          }
-          params[:order] = "#{ordering_params[:sort_by]} #{ordering_params[:sort_order]}"
-        end
         params[:order] ||= 'started_at DESC'
-        @tasks = resource_scope_for_index.order(params[:order].to_s)
+        @tasks = resource_scope_for_index
       end
 
       def search_options
-        [search_query, {}]
+        [search_query, { :order => params[:order] }]
       end
 
       def_param_group :callback_target do
@@ -320,19 +308,16 @@ module ForemanTasks
       end
 
       def find_task
-        @task = resource_scope.with_duration.find(params[:id])
+        @task = resource_scope.select_duration.find(params[:id])
       end
 
       def resource_scope(_options = {})
         scope = ForemanTasks::Task.authorized("#{action_permission}_foreman_tasks")
         scope = scope.where(:parent_task_id => params[:parent_task_id]) if params[:parent_task_id]
+        scope = scope.select_duration if params[:action] == 'index'
         scope
       end
 
-      def resource_scope_for_index(*args)
-        super.with_duration.distinct
-      end
-
       def controller_permission
         'foreman_tasks'
       end

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -4,7 +4,7 @@ module ForemanTasks
     include Foreman::Controller::CsvResponder
     include ForemanTasks::FindTasksCommon
 
-    before_action :find_dynflow_task, only: [:unlock, :force_unlock, :cancel, :cancel_step, :resume]
+    before_action :find_dynflow_task, only: [:unlock, :force_unlock, :cancel, :abort, :cancel_step, :resume]
 
     def show
       @task = resource_base.find(params[:id])
@@ -51,11 +51,10 @@ module ForemanTasks
 
     def abort
       if @dynflow_task.abort
-        flash[:info] = _('Trying to abort the task')
+        render json: { statusText: 'OK' }
       else
-        flash[:warning] = _('The task cannot be aborted at the moment.')
+        render json: {}, status: :bad_request
       end
-      redirect_back(:fallback_location => foreman_tasks_task_path(@dynflow_task))
     end
 
     def resume
@@ -98,7 +97,7 @@ module ForemanTasks
     private
 
     def respond_with_tasks(scope)
-      @tasks = filter(scope, paginate: false).with_duration
+      @tasks = filter(scope, paginate: false).select_duration
       csv_response(@tasks, [:id, :action, :state, :result, 'started_at.in_time_zone', 'ended_at.in_time_zone', :duration, :username], ['Id', 'Action', 'State', 'Result', 'Started At', 'Ended At', 'Duration', 'User'])
     end
 

data/app/lib/actions/helpers/lock.rb

@@ -13,12 +13,6 @@ module Actions
         end
       end
 
-      # @see Lock.lock!
-      def lock!(resource, *_lock_names)
-        Foreman::Deprecation.deprecation_warning('2.4', 'locking in foreman-tasks was reworked, please use a combination of exclusive_lock! and link! instead.')
-        exclusive_lock!(resource)
-      end
-
       # @see Lock.link!
       def link!(resource)
         phase! Dynflow::Action::Plan

data/app/lib/actions/middleware/keep_current_user.rb

@@ -12,26 +12,20 @@ module Actions
       end
 
       def run(*args)
-        restore_curent_user { pass(*args) }
+        restore_current_user { pass(*args) }
       end
 
       def finalize
-        current_id = User.current.try(:id)
-        saved_id = action.input[:current_user_id]
-        if User.current && saved_id && current_id != saved_id
-          Foreman::Deprecation.deprecation_warning('2.5', 'relying on per-step setting of current user in finalize phase')
-        end
-
-        restore_curent_user { pass }
+        restore_current_user { pass }
       end
 
       def finalize_phase(execution_plan, *args)
-        restore_curent_user(execution_plan.entry_action) { pass(execution_plan, *args) }
+        restore_current_user(execution_plan.entry_action) { pass(execution_plan, *args) }
       end
 
       # Run all execution plan lifecycle hooks as the original user
       def hook(*args)
-        restore_curent_user { pass(*args) }
+        restore_current_user { pass(*args) }
       end
 
       private
@@ -40,7 +34,7 @@ module Actions
         if User.current || action.input[:current_user_id].nil?
           yield
         else
-          restore_curent_user { yield }
+          restore_current_user { yield }
         end
       end
 
@@ -48,7 +42,7 @@ module Actions
         action.input[:current_user_id] = User.current.try(:id)
       end
 
-      def restore_curent_user(action = self.action)
+      def restore_current_user(action = self.action)
         old_user = User.current
         User.current = User.unscoped.find(action.input[:current_user_id]) if action.input[:current_user_id].present?
         yield

data/app/models/foreman_tasks/task.rb

@@ -78,7 +78,7 @@ module ForemanTasks
                                  :"foreman_tasks_links.resource_type" => resource.class.name)
            end)
     scope :for_action_types, (->(action_types) { where('foreman_tasks_tasks.label IN (?)', Array(action_types)) })
-    scope :with_duration, -> { select("foreman_tasks_tasks.*, coalesce(ended_at, current_timestamp) - coalesce(coalesce(started_at, ended_at), current_timestamp) as duration") }
+    virtual_column_scope :select_duration, -> { select("foreman_tasks_tasks.*, coalesce(ended_at, current_timestamp) - coalesce(coalesce(started_at, ended_at), current_timestamp) as duration") }
 
     apipie :class, "A class representing #{model_name.human} object" do
       name 'Task'

data/app/views/foreman_tasks/api/tasks/dependency_summary.json.rabl

@@ -1,4 +1,2 @@
-object @task
-
 attributes :id, :action, :state, :result
-node(:humanized) { @task.humanized[:action] }
+node(:humanized, &:to_label)

data/app/views/foreman_tasks/api/tasks/show.json.rabl

@@ -3,6 +3,9 @@ object @task if @task
 extends 'api/v2/layouts/permissions'
 
 attributes :id, :label, :pending, :action
-attributes :username, :started_at, :ended_at, :duration, :state, :result, :progress
+attributes :username, :started_at, :ended_at, :state, :result, :progress
+
+# A workaround for https://github.com/ruby/json/issues/957
+node(:duration) { |t| t.duration&.in_seconds&.to_s if t.respond_to?(:duration) }
 attributes :input, :output, :humanized, :cli_example, :start_at
 node(:available_actions) { |t| { cancellable: t.execution_plan&.cancellable?, resumable: t.resumable? } }

data/config/routes.rb

@@ -34,9 +34,9 @@ Foreman::Application.routes.draw do
     end
     resources :tasks, :only => [:index], constraints: ->(req) { req.format == :csv }
 
-    match '/tasks' => 'react#index', :via => [:get]
-    match '/tasks/:id/sub_tasks' => 'react#index', :via => [:get]
-    match '/ex_tasks/:id' => 'react#index', :via => [:get]
+    match '/tasks', to: '/react#index', via: :get
+    match '/tasks/:id/sub_tasks', to: '/react#index', via: :get
+    match '/ex_tasks/:id', to: '/react#index', via: :get
 
     namespace :api do
       resources :recurring_logics, :only => [:index, :show, :update] do

data/foreman-tasks.gemspec

@@ -23,10 +23,12 @@ same resource. It also optionally provides Dynflow infrastructure for using it f
     file.end_with?("test.rake") || file == '.packit.yaml'
   end
 
+  s.required_ruby_version = '>= 3.0', '< 4'
+
   s.test_files = `git ls-files test`.split("\n")
   s.extra_rdoc_files = Dir['README*', 'LICENSE']
 
-  s.add_dependency "dynflow", '>= 1.9.0'
+  s.add_dependency "dynflow", '>= 2.0.0'
   s.add_dependency 'fugit', '~> 1.8'
   s.add_dependency "get_process_mem" # for memory polling
   s.add_dependency "sinatra" # for Dynflow web console

data/lib/foreman_tasks/engine.rb

@@ -21,6 +21,7 @@ module ForemanTasks
 
       Foreman::Plugin.register :"foreman-tasks" do
         requires_foreman '>= 3.19'
+        register_global_js_file 'global'
         divider :top_menu, :parent => :monitor_menu, :last => true, :caption => N_('Foreman Tasks')
         menu :top_menu, :tasks,
              :url_hash => { :controller => 'foreman_tasks/tasks', :action => :index },
@@ -36,7 +37,6 @@ module ForemanTasks
 
         security_block :foreman_tasks do |_map|
           permission :view_foreman_tasks, { :'foreman_tasks/tasks' => [:auto_complete_search, :sub_tasks, :index, :summary, :summary_sub_tasks, :show],
-                                            :'foreman_tasks/react' => [:index],
                                             :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary, :summary_sub_tasks, :details, :sub_tasks] }, :resource_type => 'ForemanTasks::Task'
           permission :edit_foreman_tasks, { :'foreman_tasks/tasks' => [:resume, :unlock, :force_unlock, :cancel_step, :cancel, :abort],
                                             :'foreman_tasks/api/tasks' => [:bulk_resume, :bulk_cancel, :bulk_stop] }, :resource_type => 'ForemanTasks::Task'

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -324,7 +324,7 @@ namespace :foreman_tasks do
     format = ENV['TASK_FORMAT'] || 'html'
     export_filename = ENV['TASK_FILE'] || generate_filename(format)
 
-    task_scope = ForemanTasks::Task.search_for(filter).with_duration.order(:started_at => :desc)
+    task_scope = ForemanTasks::Task.search_for(filter).select_duration.order(:started_at => :desc)
     id_scope = task_scope.group(:id, :started_at)
 
     puts _("Exporting all tasks matching filter #{filter}")

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '12.0.0'.freeze
+  VERSION = '12.1.1'.freeze
 end