foreman-tasks 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 933e58fce5919b151351e1a148a2360faea964f688a79b5db85223dd62653f51
-  data.tar.gz: 53b98db8cf8f6dc19c489a78a4eb923389413464dcb9fa4ca732888a032063ee
+  metadata.gz: c5c591217c85cb51b8bfa6372cac7b6eca2010a6b574da5f85c970ad83392641
+  data.tar.gz: 49e5c517005966476ee6ffca2d61998a8fb9ce89f5c621e8fcecb8ed5dc6917c
 SHA512:
-  metadata.gz: e3a7334ab5a5efb4dd3957ead30a520836311def55777ffba66b60c272b93137ab1fbdad7a9c32ab70c23a9b5308442a6a0c1a48da00dc4d4eb8868cd9c931e9
-  data.tar.gz: df1a0dc013edb5c5baebb3e97a275b8ac9075963546cbb318743c368db9d373fc3277739a690a346b79db72397f437be86c1159cfd78cf2ae407ab7ecde8ee75
+  metadata.gz: c31a093250bca2a31d50c5d9f85dd2c80cb35cfaa4d48a24c96a471c3d218cf0f6cf2b1511074b0bd5c1349d738e49a0cd5f0d5ffeba1d98035958eb02c39fbb
+  data.tar.gz: a548fb2f051c5173066e009539a17d768b353a52ddd66b43816b4d308b910d173b1264b525745621b18023a0111e9c2b25e4508668f406c4df1f82f6c0ec8801

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

@@ -95,7 +95,8 @@ module ForemanTasks
         resumed = []
         failed = []
         skipped = []
-        bulk_scope.each do |task|
+        filtered_scope = bulk_scope
+        filtered_scope.each do |task|
           if task.resumable?
             begin
               ForemanTasks.dynflow.world.execute(task.execution_plan.id)
@@ -107,7 +108,10 @@ module ForemanTasks
             skipped << task_hash(task)
           end
         end
-
+        if params[:search]
+          notification = UINotifications::Tasks::TaskBulkResume.new(filtered_scope.first, resumed.length, failed.length, skipped.length)
+          notification.deliver!
+        end
         render :json => {
           total: resumed.length + failed.length + skipped.length,
           resumed: resumed,
@@ -123,10 +127,13 @@ module ForemanTasks
         if params[:search].nil? && params[:task_ids].nil?
           raise BadRequest, _('Please provide at least one of search or task_ids parameters in the request')
         end
-
-        cancelled, skipped = bulk_scope.partition(&:cancellable?)
-
+        filtered_scope = bulk_scope
+        cancelled, skipped = filtered_scope.partition(&:cancellable?)
         cancelled.each(&:cancel)
+        if params[:search]
+          notification = UINotifications::Tasks::TaskBulkCancel.new(filtered_scope.first, cancelled.length, skipped.length)
+          notification.deliver!
+        end
         render :json => {
           total: cancelled.length + skipped.length,
           cancelled: cancelled,

data/app/lib/foreman_tasks/concerns/polling_action_extensions.rb

@@ -0,0 +1,12 @@
+module ForemanTasks
+  module Concerns
+    module PollingActionExtensions
+      def poll_intervals
+        multiplier = Setting[:foreman_tasks_polling_multiplier] || 1
+
+        # Prevent the intervals from going below 0.5 seconds
+        super.map { |interval| [interval * multiplier, 0.5].max }
+      end
+    end
+  end
+end

data/app/models/setting/foreman_tasks.rb

@@ -13,7 +13,12 @@ class Setting::ForemanTasks < Setting
           N_('Url pointing to the task troubleshooting documentation. '\
              'It should contain %{label} placeholder, that will be replaced with normalized task label '\
              '(restricted to only alphanumeric characters)). %{version} placeholder is also available.'),
-          nil)
+          nil),
+      set('foreman_tasks_polling_multiplier',
+          N_('Polling multiplier which is used to multiply the default polling intervals. '\
+             'This can be used to prevent polling too frequently for long running tasks.'),
+          1,
+          N_("Polling intervals multiplier"))
     ]
   end
 

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

@@ -0,0 +1,36 @@
+module UINotifications
+  module Tasks
+    class TaskBulkCancel < ::UINotifications::Base
+      def initialize(task, cancelled_length, skipped_length)
+        @subject = task
+        @cancelled_length = cancelled_length
+        @skipped_length = skipped_length
+      end
+
+      def create
+        Notification.create!(
+          initiator: initiator,
+          audience: audience,
+          subject: subject,
+          notification_blueprint: blueprint,
+          message: message,
+          notification_recipients: [NotificationRecipient.create({ :user => User.current })]
+        )
+      end
+
+      def audience
+        Notification::AUDIENCE_GLOBAL
+      end
+
+      def message
+        ('%{cancelled} Tasks were cancelled. %{skipped} Tasks were skipped. ' %
+          { cancelled: @cancelled_length,
+          skipped: @skipped_length })
+      end
+
+      def blueprint
+        @blueprint ||= NotificationBlueprint.find_by(name: 'tasks_bulk_cancel')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module UINotifications
+  module Tasks
+    class TaskBulkResume < ::UINotifications::Base
+      def initialize(task, resumed_length, failed_length, skipped_length)
+        @subject = task
+        @resumed_length = resumed_length
+        @failed_length = failed_length
+        @skipped_length = skipped_length
+      end
+
+      def create
+        Notification.create!(
+          initiator: initiator,
+          audience: audience,
+          subject: subject,
+          notification_blueprint: blueprint,
+          message: message,
+          notification_recipients: [NotificationRecipient.create({ :user => User.current })]
+        )
+      end
+
+      def audience
+        Notification::AUDIENCE_USER
+      end
+
+      def message
+        ('%{resumed} Tasks were resumed. %{failed} Tasks failed to resume. %{skipped} Tasks were skipped. ' %
+          { resumed: @resumed_length,
+          failed: @failed_length,
+          skipped: @skipped_length })
+      end
+
+      def blueprint
+        @blueprint ||= NotificationBlueprint.find_by(name: 'tasks_bulk_resume')
+      end
+    end
+  end
+end

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

@@ -27,6 +27,20 @@ blueprints = [
             title: N_('Task Details')
           ]
       }
+  },
+
+  {
+    group: N_('Tasks'),
+    name: 'tasks_bulk_resume',
+    level: 'info',
+    message: "DYNAMIC",
+  },
+
+  {
+    group: N_('Tasks'),
+    name: 'tasks_bulk_cancel',
+    level: 'info',
+    message: "DYNAMIC",
   }
 ]
 

data/foreman-tasks.gemspec

@@ -34,4 +34,5 @@ same resource. It also optionally provides Dynflow infrastructure for using it f
   s.add_dependency "sinatra" # for Dynflow web console
 
   s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
+  s.add_development_dependency 'sqlite3'
 end

data/gemfile.d/foreman-tasks.rb

@@ -0,0 +1 @@
+gem 'sqlite3'

data/lib/foreman_tasks/engine.rb

@@ -145,6 +145,7 @@ module ForemanTasks
 
       Authorizer.prepend AuthorizerExt
       User.include ForemanTasks::Concerns::UserExtensions
+      ::Dynflow::Action::Polling.prepend ForemanTasks::Concerns::PollingActionExtensions
     end
 
     rake_tasks do

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/script/travis_run_js_tests.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -ev
-if [[ $( git diff --name-only HEAD~1..HEAD webpack/ .travis.yml .babelrc .eslintrc package.json | wc -l ) -ne 0 ]]; then
+if [[ $( git diff --name-only HEAD~1..HEAD webpack/ .travis.yml babel.config.js .eslintrc package.json | wc -l ) -ne 0 ]]; then
   npm run test;
-  npm run coveralls;
+  npm run publish-coverage;
   npm run lint;
 fi

data/test/lib/concerns/polling_action_extensions_test.rb

@@ -0,0 +1,34 @@
+require 'foreman_tasks_test_helper'
+
+module ForemanTasks
+  module Concerns
+    class PollingActionExtensionsTest < ::ActiveSupport::TestCase
+      class Action < ::Dynflow::Action
+        include ::Dynflow::Action::Polling
+      end
+
+      describe 'polling interval tuning' do
+        let(:default_intervals) { [0.5, 1, 2, 4, 8, 16] }
+
+        it 'is extends the polling action module' do
+          _(::Dynflow::Action::Polling.ancestors.first).must_equal ForemanTasks::Concerns::PollingActionExtensions
+        end
+
+        it 'does not modify polling intervals by default' do
+          _(Action.allocate.poll_intervals).must_equal default_intervals
+        end
+
+        it 'cannot make intervals shorter than 0.5 seconds' do
+          Setting.expects(:[]).with(:foreman_tasks_polling_multiplier).returns 0
+          _(Action.allocate.poll_intervals).must_equal(default_intervals.map { 0.5 })
+        end
+
+        it 'can be used to make the intervals longer' do
+          value = 5
+          Setting.expects(:[]).with(:foreman_tasks_polling_multiplier).returns value
+          _(Action.allocate.poll_intervals).must_equal(default_intervals.map { |i| i * value })
+        end
+      end
+    end
+  end
+end

data/webpack/ForemanTasks/Components/TaskDetails/Components/__tests__/__snapshots__/TaskInfo.test.js.snap

@@ -292,9 +292,7 @@ exports[`TaskInfo rendering render with Props 1`] = `
       </p>
       <p>
         A paused task represents a process that has not finished properly. Any task in paused state can lead to potential inconsistency and needs to be resolved.
-        <br />
-        The recommended approach is to investigate the error messages below and in 'errors' tab, address the primary cause of the issue and resume the task.
-        <br />
+The recommended approach is to investigate the error messages below and in 'errors' tab, address the primary cause of the issue and resume the task.
       </p>
     </Col>
   </Row>

data/webpack/ForemanTasks/Components/TasksDashboard/TasksDashboardConstants.js

@@ -18,6 +18,11 @@ export const TASKS_DASHBOARD_AVAILABLE_QUERY_MODES = {
   OLDER: 'older',
 };
 
+export const TASKS_DASHBOARD_JS_QUERY_MODES = {
+  RECENT: 'recent',
+  OLDER: 'older',
+};
+
 export const TASKS_DASHBOARD_AVAILABLE_TIMES = {
   H24: 'H24',
   H12: 'H12',

data/webpack/ForemanTasks/Components/TasksDashboard/TasksDashboardHelper.js

@@ -4,6 +4,7 @@ import {
   TASKS_DASHBOARD_AVAILABLE_TIMES,
   TASKS_DASHBOARD_QUERY_KEYS_TEXT,
   TASKS_DASHBOARD_QUERY_VALUES_TEXT,
+  TASKS_DASHBOARD_JS_QUERY_MODES,
 } from './TasksDashboardConstants';
 import { updateURlQuery } from '../TasksTable/TasksTableHelpers';
 
@@ -39,8 +40,8 @@ const queryFromUriQuery = uriQuery => {
     if (uriQuery[uriField]) query[queryField] = uriQuery[uriField];
   });
 
-  if (query.mode === 'recent') {
-    query.mode = 'last';
+  if (query.mode === TASKS_DASHBOARD_JS_QUERY_MODES.RECENT) {
+    query.mode = TASKS_DASHBOARD_QUERY_VALUES_TEXT.LAST;
   }
 
   return query;

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

@@ -0,0 +1,43 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Alert, Button } from 'patternfly-react';
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+
+export const SelectAllAlert = ({
+  itemCount,
+  perPage,
+  selectAllRows,
+  unselectAllRows,
+  allRowsSelected,
+}) => {
+  const selectAllText = (
+    <React.Fragment>
+      {sprintf(
+        'All %s tasks on this page are selected',
+        Math.min(itemCount, perPage)
+      )}
+      <Button bsStyle="link" onClick={selectAllRows}>
+        {__('Select All')}
+        <b> {itemCount} </b> {__('tasks.')}
+      </Button>
+    </React.Fragment>
+  );
+  const undoSelectText = (
+    <React.Fragment>
+      {sprintf(__(`All %s tasks are selected. `), itemCount)}
+      <Button bsStyle="link" onClick={unselectAllRows}>
+        {__('Undo selection')}
+      </Button>
+    </React.Fragment>
+  );
+  const selectAlertText = allRowsSelected ? undoSelectText : selectAllText;
+  return <Alert type="info">{selectAlertText}</Alert>;
+};
+
+SelectAllAlert.propTypes = {
+  allRowsSelected: PropTypes.bool.isRequired,
+  itemCount: PropTypes.number.isRequired,
+  perPage: PropTypes.number.isRequired,
+  selectAllRows: PropTypes.func.isRequired,
+  unselectAllRows: PropTypes.func.isRequired,
+};

data/webpack/ForemanTasks/Components/TasksTable/Components/__test__/SelectAllAlert.test.js

@@ -0,0 +1,29 @@
+import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
+
+import { SelectAllAlert } from '../SelectAllAlert';
+
+const baseProps = {
+  itemCount: 7,
+  perPage: 5,
+  selectAllRows: jest.fn(),
+  unselectAllRows: jest.fn(),
+};
+const fixtures = {
+  'renders SelectAllAlert with perPage > itemCout': {
+    allRowsSelected: false,
+    itemCount: 7,
+    perPage: 10,
+    ...baseProps,
+  },
+  'renders SelectAllAlert without all rows selected': {
+    allRowsSelected: false,
+    ...baseProps,
+  },
+  'renders SelectAllAlert with all rows selected': {
+    allRowsSelected: true,
+    ...baseProps,
+  },
+};
+
+describe('SelectAllAlert', () =>
+  testComponentSnapshotsWithFixtures(SelectAllAlert, fixtures));

data/webpack/ForemanTasks/Components/TasksTable/Components/__test__/__snapshots__/SelectAllAlert.test.js.snap

@@ -0,0 +1,75 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`SelectAllAlert renders SelectAllAlert with all rows selected 1`] = `
+<Alert
+  className=""
+  onDismiss={null}
+  type="info"
+>
+  All 7 tasks are selected. 
+  <Button
+    active={false}
+    block={false}
+    bsClass="btn"
+    bsStyle="link"
+    disabled={false}
+    onClick={[MockFunction]}
+  >
+    Undo selection
+  </Button>
+</Alert>
+`;
+
+exports[`SelectAllAlert renders SelectAllAlert with perPage > itemCout 1`] = `
+<Alert
+  className=""
+  onDismiss={null}
+  type="info"
+>
+  All 5 tasks on this page are selected
+  <Button
+    active={false}
+    block={false}
+    bsClass="btn"
+    bsStyle="link"
+    disabled={false}
+    onClick={[MockFunction]}
+  >
+    Select All
+    <b>
+       
+      7
+       
+    </b>
+     
+    tasks.
+  </Button>
+</Alert>
+`;
+
+exports[`SelectAllAlert renders SelectAllAlert without all rows selected 1`] = `
+<Alert
+  className=""
+  onDismiss={null}
+  type="info"
+>
+  All 5 tasks on this page are selected
+  <Button
+    active={false}
+    block={false}
+    bsClass="btn"
+    bsStyle="link"
+    disabled={false}
+    onClick={[MockFunction]}
+  >
+    Select All
+    <b>
+       
+      7
+       
+    </b>
+     
+    tasks.
+  </Button>
+</Alert>
+`;

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

@@ -15,7 +15,8 @@ export const SubTasksPage = props => {
       { caption: __('Sub tasks') },
     ],
   });
-  const createHeader = actionName => actionName ? sprintf(__('Sub tasks of %s'), actionName) : __('Sub tasks');
+  const createHeader = actionName =>
+    actionName ? sprintf(__('Sub tasks of %s'), actionName) : __('Sub tasks');
   return (
     <TasksTablePage
       getBreadcrumbs={getBreadcrumbs}