foreman-tasks 4.1.2 → 4.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 676dae1bc60b1633da496445b980e4b5fb491931bb227a70f2dcec4c44a9ae9e
-  data.tar.gz: 98d4f9798338d20bf7885a9e11b40d492eeeca4d30e2a7f84c4734e4f83e30d7
+  metadata.gz: ba89e76b07357c27678169c5350b13a80ea346896e681e7061da8c9ff5c6d2ce
+  data.tar.gz: c0a597c5a7db439fcd6627460b0fa91ed9e5bf0ef2d5308f356d35582c141b9d
 SHA512:
-  metadata.gz: 8482b8a8e5ce147f2bd81d1eea004ba9507c95ecf5d83d0ebd50b7c74cc467a561f035d0049f0d1b44c3d63a29c35f3e55792705d37dfc0b4431e02d2370732a
-  data.tar.gz: c317248a7e396b2d556f397ba1fd91d162b5d38b75a593a7f8a28f555ef77ca15ec097f548162edd6c7a7198bfa7e84c6a902bbde6d7515c17b585f7632e9add
+  metadata.gz: 3f873f26387eb89860543bca5f888b017c2ac692c986873b97b48506f30429172d49e926450937262a9dcb06c26c45d7eefabdb7f3cce0b8c70ce6786ea7e4ad
+  data.tar.gz: b021241e11f9db347960eb55e2497112cf996f1e77e48d92f593fa47b735c0268532ec61e2779bd35fc01768178037eaedf8248b59dfc178031dd56fb1340b6f

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

@@ -192,7 +192,7 @@ module ForemanTasks
           params[:order] = "#{ordering_params[:sort_by]} #{ordering_params[:sort_order]}"
         end
         params[:order] ||= 'started_at DESC'
-        @tasks = DashboardTableFilter.new(resource_scope_for_index, params).scope.order(params[:order].to_s)
+        @tasks = resource_scope_for_index.order(params[:order].to_s)
       end
 
       def search_options

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -127,8 +127,9 @@ module ForemanTasks
     end
 
     def filter(scope, paginate: true)
-      scope = DashboardTableFilter.new(scope, params).scope
-      scope = scope.search_for(search_query, order: params[:order])
+      search = current_taxonomy_search
+      search = [search, params[:search]].select(&:present?).join(' AND ')
+      scope = scope.search_for(search, order: params[:order])
       scope = scope.paginate(page: params[:page], per_page: params[:per_page]) if paginate
       scope.distinct
     end

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

@@ -20,9 +20,7 @@ module Actions
       private
 
       def set_clock
-        action.world.clock.ping action.send(:suspended_action),
-                                POLL_INTERVAL,
-                                CheckOnProxyActions
+        action.plan_event(CheckOnProxyActions, POLL_INTERVAL, optional: true)
       end
 
       def check_triggered
@@ -44,9 +42,7 @@ module Actions
 
       def notify(event, tasks)
         tasks.each do |task|
-          action.world.event task.execution_plan_id,
-                             task.step_id,
-                             event
+          action.plan_event(event, execution_plan_id: task.execution_plan_id, step_id: task.step_id)
         end
       end
 

data/app/models/foreman_tasks/task/dynflow_task.rb

@@ -140,12 +140,17 @@ module ForemanTasks
 
     def main_action
       return @main_action if defined?(@main_action)
+
+      @main_action = execution_plan && execution_plan.root_plan_step.try(:action, execution_plan)
       if active_job?
         job_data = active_job_data
-        @main_action = active_job_action(job_data['job_class'], job_data['arguments'])
-      else
-        @main_action = execution_plan && execution_plan.root_plan_step.try(:action, execution_plan)
+        begin
+          @main_action = active_job_action(job_data['job_class'], job_data['arguments'])
+        rescue => e
+          Foreman::Logging.exception("Failed to load ActiveJob for task #{id}", e, :logger => 'foreman-tasks')
+        end
       end
+      @main_action
     end
 
     # The class for ActiveJob jobs in Dynflow, JobWrapper is not expected to

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -12,7 +12,7 @@ namespace :foreman_tasks do
 
       * TASK_SEARCH     : scoped search filter (example: 'label = "Actions::Foreman::Host::ImportFacts"')
       * TASK_FILE       : file to export to
-      * TASK_FORMAT     : format to use for the export (either html or csv)
+      * TASK_FORMAT     : format to use for the export (either html, html-dir or csv)
       * TASK_DAYS       : number of days to go back
 
     If TASK_SEARCH is not defined, it defaults to all tasks in the past 7 days and
@@ -185,23 +185,27 @@ namespace :foreman_tasks do
     end
 
     class PageHelper
-      def self.pagify(template)
-        pre = <<-HTML
-       <html>
-       <head>
-       <title>Dynflow Console</title>
-       <script src="jquery.js"></script>
-       <link rel="stylesheet" type="text/css" href="bootstrap.css">
-       <link rel="stylesheet" type="text/css" href="application.css">
-       <script src="bootstrap.js"></script>
-       <script src="run_prettify.js"></script>
-       <script src="application.js"></script>
-       </head>
-       <body>
-          #{template}
-       <body>
-       </html>
+      def self.pagify(io, template = nil)
+        io.write <<~HTML
+          <html>
+            <head>
+              <title>Dynflow Console</title>
+              <script src="jquery.js"></script>
+              <link rel="stylesheet" type="text/css" href="bootstrap.css">
+              <link rel="stylesheet" type="text/css" href="application.css">
+              <script src="bootstrap.js"></script>
+              <script src="run_prettify.js"></script>
+              <script src="application.js"></script>
+            </head>
+          <body>
         HTML
+        if block_given?
+          yield io
+        else
+          io.write template
+        end
+      ensure
+        io.write '</body></html>'
       end
 
       def self.copy_assets(tmp_dir)
@@ -216,13 +220,64 @@ namespace :foreman_tasks do
         end
       end
 
-      def self.generate_index(tasks)
-        html = '<div><table class="table">'
-        tasks.order('started_at desc').all.each do |task|
-          html << "<tr><td><a href=\"#{task.id}.html\">#{task.label}</a></td><td>#{task.started_at}</td>\
-                   <td>#{task.state}</td><td>#{task.result}</td></tr>"
+      def self.generate_with_index(io)
+        io.write '<div><table class="table">'
+        yield io
+      ensure
+        io.write '</table></div>'
+      end
+
+      def self.generate_index_entry(io, task)
+        io << <<~HTML
+          <tr>
+            <td><a href=\"#{task.id}.html\">#{task.label}</a></td>
+            <td>#{task.started_at}</td>
+            <td>#{task.state}</td>
+            <td>#{task.result}</td>
+          </tr>
+        HTML
+      end
+    end
+
+    def csv_export(export_filename, tasks)
+      CSV.open(export_filename, 'wb') do |csv|
+        csv << %w[id state type label result parent_task_id started_at ended_at]
+        tasks.find_each do |task|
+          csv << [task.id, task.state, task.type, task.label, task.result,
+                  task.parent_task_id, task.started_at, task.ended_at]
         end
-        html << '</table></div>'
+      end
+    end
+
+    def html_export(workdir, tasks)
+      PageHelper.copy_assets(workdir)
+
+      renderer = TaskRender.new
+      total = tasks.count
+      index = File.open(File.join(workdir, 'index.html'), 'w')
+
+      File.open(File.join(workdir, 'index.html'), 'w') do |index|
+        PageHelper.pagify(index) do |io|
+          PageHelper.generate_with_index(io) do |index|
+            tasks.find_each.each_with_index do |task, count|
+              File.open(File.join(workdir, "#{task.id}.html"), 'w') { |file| PageHelper.pagify(file, renderer.render_task(task)) }
+              PageHelper.generate_index_entry(index, task)
+              puts "#{count + 1}/#{total}"
+            end
+          end
+        end
+      end
+    end
+
+    def generate_filename(format)
+      base = "/tmp/task-export-#{Time.now.to_i}"
+      case format
+      when 'html'
+        base + '.tar.gz'
+      when 'csv'
+        base + '.csv'
+      when 'html-dir'
+        base
       end
     end
 
@@ -239,36 +294,25 @@ namespace :foreman_tasks do
     end
 
     format = ENV['TASK_FORMAT'] || 'html'
-    export_filename = ENV['TASK_FILE'] || "/tmp/task-export-#{Time.now.to_i}.#{format == 'csv' ? 'csv' : 'tar.gz'}"
+    export_filename = ENV['TASK_FILE'] || generate_filename(format)
 
-    tasks = ForemanTasks::Task.search_for(filter)
+    tasks = ForemanTasks::Task.search_for(filter).order(:started_at => :desc)
 
     puts _("Exporting all tasks matching filter #{filter}")
     puts _("Gathering #{tasks.count} tasks.")
-    if format == 'html'
+    case format
+    when 'html'
       Dir.mktmpdir('task-export') do |tmp_dir|
-        PageHelper.copy_assets(tmp_dir)
-
-        renderer = TaskRender.new
-        total = tasks.count
-
-        tasks.find_each.with_index do |task, count|
-          File.open(File.join(tmp_dir, "#{task.id}.html"), 'w') { |file| file.write(PageHelper.pagify(renderer.render_task(task))) }
-          puts "#{count + 1}/#{total}"
-        end
-
-        File.open(File.join(tmp_dir, 'index.html'), 'w') { |file| file.write(PageHelper.pagify(PageHelper.generate_index(tasks))) }
-
+        html_export(tmp_dir, tasks)
         system("tar", "czf", export_filename, tmp_dir)
       end
-    elsif format == 'csv'
-      CSV.open(export_filename, 'wb') do |csv|
-        csv << %w[id state type label result parent_task_id started_at ended_at]
-        tasks.find_each do |task|
-          csv << [task.id, task.state, task.type, task.label, task.result,
-                  task.parent_task_id, task.started_at, task.ended_at]
-        end
-      end
+    when 'html-dir'
+      FileUtils.mkdir_p(export_filename)
+      html_export(export_filename, tasks)
+    when 'csv'
+      csv_export(export_filename, tasks)
+    else
+      raise "Unkonwn export format '#{format}'"
     end
 
     puts "Created #{export_filename}"

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '4.1.2'.freeze
+  VERSION = '4.1.3'.freeze
 end

data/webpack/ForemanTasks/Components/TaskActions/TaskActionHelpers.js

@@ -15,22 +15,29 @@ export const convertDashboardQuery = query => {
     state,
     result,
     search,
+    ...rest
   } = query;
 
   const hours = timeToHoursNumber(timeHorizon);
   const timestamp = new Date(new Date() - hours * 60 * 60 * 1000);
   let dashboardTime = '';
   const stateQuery = state ? `state=${state}` : '';
-  const resultQuery = result ? `result=${result}` : '';
+  let resultQuery = '';
+  if (result === 'other') {
+    resultQuery = 'result ^ (pending, cancelled)';
+  } else {
+    resultQuery = result ? `result=${result}` : '';
+  }
   if (timeMode === TASKS_DASHBOARD_JS_QUERY_MODES.RECENT) {
-    dashboardTime = `(state_updated_at>${timestamp.toISOString()} or state_updated_at = NULL)`;
+    dashboardTime = `state_updated_at>${timestamp.toISOString()} or null? state_updated_at`;
   } else if (timeMode === TASKS_DASHBOARD_JS_QUERY_MODES.OLDER) {
-    dashboardTime = `(state_updated_at>${timestamp.toISOString()})`;
+    dashboardTime = `state_updated_at<=${timestamp.toISOString()}`;
   }
   const newQuery = [stateQuery, resultQuery, search, dashboardTime]
     .filter(Boolean)
+    .map(q => `(${q})`)
     .join(' and ');
-  return newQuery;
+  return newQuery ? { search: newQuery, ...rest } : rest;
 };
 
 export const resumeToastInfo = {

data/webpack/ForemanTasks/Components/TaskActions/TaskActionHelpers.test.js

@@ -27,9 +27,18 @@ describe('convertDashboardQuery', () => {
       result: 'error',
       search: 'action~job',
     };
-    expect(convertDashboardQuery(query)).toEqual(
-      'state=stopped and result=error and action~job and (state_updated_at>2020-05-01T11:01:58.135Z or state_updated_at = NULL)'
-    );
+    const expected =
+      '(state=stopped) and (result=error) and (action~job) and (state_updated_at>2020-05-01T11:01:58.135Z or null? state_updated_at)';
+
+    expect(convertDashboardQuery(query)).toEqual({ search: expected });
+
+    const query2 = {
+      ...query,
+      time_mode: TASKS_DASHBOARD_JS_QUERY_MODES.OLDER,
+    };
+    const expected2 =
+      '(state=stopped) and (result=error) and (action~job) and (state_updated_at<=2020-05-01T11:01:58.135Z)';
+    expect(convertDashboardQuery(query2)).toEqual({ search: expected2 });
     // Cleanup
     global.Date = realDate;
   });
@@ -37,10 +46,23 @@ describe('convertDashboardQuery', () => {
     const query = {
       search: 'action~job',
     };
-    expect(convertDashboardQuery(query)).toEqual('action~job');
+    expect(convertDashboardQuery(query)).toEqual({ search: '(action~job)' });
   });
   it('convertDashboardQuery should work with no query', () => {
     const query = {};
-    expect(convertDashboardQuery(query)).toEqual('');
+    expect(convertDashboardQuery(query)).toEqual({});
+  });
+  it('convertDashboardQuery should not override unknown keys', () => {
+    const query = { weather: 'nice', search: 'okay', number: 7 };
+    expect(convertDashboardQuery(query)).toEqual({
+      ...query,
+      search: '(okay)',
+    });
+  });
+  it('convertDashboardQuery should expand other result', () => {
+    const query = { result: 'other' };
+    expect(convertDashboardQuery(query)).toEqual({
+      search: '(result ^ (pending, cancelled))',
+    });
   });
 });

data/webpack/ForemanTasks/Components/TasksTable/TasksTableActions.js

@@ -18,9 +18,14 @@ import {
   resumeTaskRequest,
   forceCancelTaskRequest,
 } from '../TaskActions';
+import { convertDashboardQuery } from '../TaskActions/TaskActionHelpers';
 
 export const getTableItems = url =>
-  getTableItemsAction(TASKS_TABLE_ID, getURIQuery(url), getApiPathname(url));
+  getTableItemsAction(
+    TASKS_TABLE_ID,
+    convertDashboardQuery(getURIQuery(url)),
+    getApiPathname(url)
+  );
 
 export const reloadPage = (url, parentTaskID) => dispatch => {
   dispatch(getTableItems(url));

data/webpack/ForemanTasks/Components/TasksTable/TasksTableHelpers.js

@@ -2,6 +2,7 @@ import URI from 'urijs';
 import { translate as __, documentLocale } from 'foremanReact/common/I18n';
 import humanizeDuration from 'humanize-duration';
 import { isoCompatibleDate } from 'foremanReact/common/helpers';
+import { convertDashboardQuery } from '../TaskActions/TaskActionHelpers';
 
 export const updateURlQuery = (query, history) => {
   const uri = new URI(history.location.pathname + history.location.search);
@@ -17,7 +18,7 @@ export const getApiPathname = url => {
 export const getCSVurl = (path, query) => {
   let url = new URI(path);
   url = url.pathname(`${url.pathname()}.csv`);
-  url.addSearch(query);
+  url.addSearch(convertDashboardQuery(query));
   return url.toString();
 };
 

data/webpack/ForemanTasks/Components/TasksTable/TasksTablePage.js

@@ -77,7 +77,7 @@ const TasksTablePage = ({
             </Button>
             {props.status === STATUS.PENDING && <Spinner size="md" loading />}
             <ExportButton
-              url={getCSVurl(url, uriQuery)}
+              url={getCSVurl(history.location.pathname, uriQuery)}
               title={__('Export All')}
             />
             <ActionSelectButton

data/webpack/ForemanTasks/Components/TasksTable/__tests__/TasksTableHelpers.test.js

@@ -32,7 +32,7 @@ describe('getCSVurl', () => {
     const url = '/foreman_tasks/tasks';
     const query = { state: 'stopped' };
     expect(getCSVurl(url, query)).toEqual(
-      '/foreman_tasks/tasks.csv?state=stopped'
+      '/foreman_tasks/tasks.csv?search=%28state%3Dstopped%29'
     );
   });
   it('should return currect url for subtasks', () => {

data/webpack/ForemanTasks/Components/TasksTable/__tests__/__snapshots__/TasksTablePage.test.js.snap

@@ -92,7 +92,7 @@ exports[`TasksTablePage rendering render with Breadcrubs and edit permissions 1`
         />
         <ExportButton
           title="Export All"
-          url="/foreman_tasks/tasks.csv?action=%22some-name%22&state=stopped"
+          url="/foreman_tasks/tasks.csv?search=%28state%3Dstopped%29"
         />
         <ActionSelectButton
           disabled={true}
@@ -227,7 +227,7 @@ exports[`TasksTablePage rendering render with minimal props 1`] = `
         />
         <ExportButton
           title="Export All"
-          url="/foreman_tasks/tasks.csv?action=%22some-name%22&state=stopped"
+          url="/foreman_tasks/tasks.csv?search=%28state%3Dstopped%29"
         />
         <ActionSelectButton
           disabled={true}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.1.3
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -198,7 +198,6 @@ files:
 - app/models/foreman_tasks/task_groups/recurring_logic_task_group.rb
 - app/models/foreman_tasks/triggering.rb
 - app/models/setting/foreman_tasks.rb
-- app/services/foreman_tasks/dashboard_table_filter.rb
 - app/services/foreman_tasks/proxy_selector.rb
 - app/services/foreman_tasks/troubleshooting_help_generator.rb
 - app/services/ui_notifications/tasks.rb
@@ -335,7 +334,6 @@ files:
 - test/unit/actions/recurring_action_test.rb
 - test/unit/cleaner_test.rb
 - test/unit/config/environment.rb
-- test/unit/dashboard_table_filter_test.rb
 - test/unit/dynflow_console_authorizer_test.rb
 - test/unit/locking_test.rb
 - test/unit/otp_manager_test.rb
@@ -650,7 +648,6 @@ test_files:
 - test/unit/actions/recurring_action_test.rb
 - test/unit/cleaner_test.rb
 - test/unit/config/environment.rb
-- test/unit/dashboard_table_filter_test.rb
 - test/unit/dynflow_console_authorizer_test.rb
 - test/unit/locking_test.rb
 - test/unit/otp_manager_test.rb

data/app/services/foreman_tasks/dashboard_table_filter.rb

@@ -1,56 +0,0 @@
-module ForemanTasks
-  # narrows the scope for the tasks table based on params coming from tasks dashboard
-  #
-  # Supported filters:
-  #
-  #  * :result
-  #  * :state
-  #  * :time_horizon - expected format of Hxy, where the xy is the time horizon in hours we're interested in
-  #      :time_mode can be set to 'recent' to filter the recent tasks, or 'older' (default) to filter earlier ones
-  class DashboardTableFilter
-    def initialize(scope, params)
-      @scope = scope
-      @params = params
-    end
-
-    def scope
-      @new_scope = @scope
-      scope_by(:result)
-      scope_by(:state)
-      scope_by_time
-      @new_scope
-    end
-
-    private
-
-    def scope_by(field)
-      if (field == :result) && (@params[field] == 'other')
-        @new_scope = @new_scope.where(:result => ['cancelled', 'pending'])
-      elsif @params[field].present?
-        @new_scope = @new_scope.where(field => @params[field])
-      end
-    end
-
-    def scope_by_time
-      return if @params[:time_horizon].blank?
-      hours = if @params[:time_horizon].casecmp('week') == 0
-                24 * 7
-              else
-                @params[:time_horizon][/\AH(\d{1,2})$/i, 1]
-              end
-
-      unless hours
-        raise Foreman::Exception, 'Unexpected format of time: should be in form of "H24" or equal to "week"'
-      end
-      timestamp = Time.now.utc - hours.to_i.hours
-      case @params[:time_mode]
-      when 'recent'
-        operator = '>'
-      else
-        operator = '<'
-        search_suffix = 'OR state_updated_at IS NULL'
-      end
-      @new_scope = @new_scope.where("state_updated_at #{operator} ? #{search_suffix}", timestamp)
-    end
-  end
-end

data/test/unit/dashboard_table_filter_test.rb

@@ -1,77 +0,0 @@
-require 'foreman_tasks_test_helper'
-
-class DashboardTableFilterTest < ActiveSupport::TestCase
-  before do
-    ::ForemanTasks::Task.delete_all
-  end
-
-  describe ForemanTasks::DashboardTableFilter do
-    before do
-      @tasks_builder = HistoryTasksBuilder.new
-      @scope = ForemanTasks::Task.all
-      @tasks_builder.build
-    end
-
-    let :subject do
-      ForemanTasks::DashboardTableFilter.new(@scope, params)
-    end
-
-    let :filtered_scope do
-      subject.scope
-    end
-
-    describe 'by result' do
-      let(:params) { { result: 'warning' } }
-
-      it 'filters' do
-        _(filtered_scope.count).must_equal @tasks_builder.distribution['stopped'][:by_result]['warning'][:total]
-      end
-    end
-
-    describe 'by state' do
-      let(:params) { { state: 'running' } }
-
-      it 'filters' do
-        _(filtered_scope.count).must_equal @tasks_builder.distribution['running'][:total]
-      end
-    end
-
-    describe 'recent' do
-      let(:params) do
-        { state: 'running',
-          time_horizon: 'H24',
-          time_mode: 'recent' }
-      end
-
-      it 'filters' do
-        _(filtered_scope.count).must_equal @tasks_builder.distribution['running'][:recent]
-      end
-    end
-
-    describe 'recent week time horizon' do
-      let(:params) do
-        { state: 'running',
-          time_horizon: 'week',
-          time_mode: 'recent' }
-      end
-
-      it 'filters' do
-        _(filtered_scope.count).must_equal @tasks_builder.distribution['running'][:recent]
-      end
-    end
-
-    describe 'older' do
-      let(:params) do
-        { state: 'running',
-          time_horizon: 'H24',
-          time_mode: 'older' }
-      end
-
-      it 'filters' do
-        old_tasks_count = @tasks_builder.distribution['running'][:total] -
-                          @tasks_builder.distribution['running'][:recent]
-        _(filtered_scope.count).must_equal old_tasks_count
-      end
-    end
-  end
-end