katello 4.5.0.rc1 → 4.5.0.rc2

data/webpack/components/extensions/HostDetails/Tabs/PackagesTab/PackagesTab.js

@@ -12,6 +12,7 @@ import {
   Skeleton,
   Split,
   SplitItem,
+  Spinner,
 } from '@patternfly/react-core';
 import { TableVariant, Thead, Tbody, Tr, Th, Td } from '@patternfly/react-table';
 import { translate as __ } from 'foremanReact/common/I18n';
@@ -32,13 +33,22 @@ import { selectHostPackagesStatus } from './HostPackagesSelectors';
 import {
   HOST_PACKAGES_KEY, PACKAGES_VERSION_STATUSES, VERSION_STATUSES_TO_PARAM,
 } from './HostPackagesConstants';
-import { removePackage, updatePackage, removePackages, updatePackages } from '../RemoteExecutionActions';
+import { removePackage, updatePackage, removePackages, updatePackages, installPackageBySearch } from '../RemoteExecutionActions';
 import { katelloPackageUpdateUrl, packagesUpdateUrl } from '../customizedRexUrlHelpers';
 import './PackagesTab.scss';
 import hostIdNotReady from '../../HostDetailsActions';
 import PackageInstallModal from './PackageInstallModal';
-import { defaultRemoteActionMethod, KATELLO_AGENT } from '../../hostDetailsHelpers';
+import { defaultRemoteActionMethod,
+  hasRequiredPermissions as can,
+  missingRequiredPermissions as cannot,
+  KATELLO_AGENT,
+  userPermissionsFromHostDetails } from '../../hostDetailsHelpers';
 import SortableColumnHeaders from '../../../../Table/components/SortableColumnHeaders';
+import { useRexJobPolling } from '../RemoteExecutionHooks';
+
+const invokeRexJobs = ['create_job_invocations'];
+const doKatelloAgentActions = ['edit_hosts'];
+const createBookmarks = ['create_bookmarks'];
 
 export const PackagesTab = () => {
   const hostDetails = useSelector(state => selectAPIResponse(state, 'HOST_DETAILS'));
@@ -58,6 +68,9 @@ export const PackagesTab = () => {
   const [isModalOpen, setIsModalOpen] = useState(false);
   const closeModal = () => setIsModalOpen(false);
   const showKatelloAgent = (defaultRemoteActionMethod({ hostDetails }) === KATELLO_AGENT);
+  const showActions = showKatelloAgent ?
+    can(doKatelloAgentActions, userPermissionsFromHostDetails({ hostDetails })) :
+    can(invokeRexJobs, userPermissionsFromHostDetails({ hostDetails }));
 
   const [isActionOpen, setIsActionOpen] = useState(false);
   const onActionSelect = () => {
@@ -128,6 +141,62 @@ export const PackagesTab = () => {
     initialSearchQuery: searchParam || '',
   });
 
+  const packageRemoveAction = packageName => removePackage({
+    hostname,
+    packageName,
+  });
+
+  const {
+    triggerJobStart: triggerPackageRemove, lastCompletedJob: lastCompletedPackageRemove,
+    isPolling: isRemoveInProgress,
+  } = useRexJobPolling(packageRemoveAction);
+
+  const packageBulkRemoveAction = bulkParams => removePackages({
+    hostname,
+    search: bulkParams,
+  });
+
+  const {
+    triggerJobStart: triggerBulkPackageRemove,
+    lastCompletedJob: lastCompletedBulkPackageRemove,
+    isPolling: isBulkRemoveInProgress,
+  } = useRexJobPolling(packageBulkRemoveAction);
+
+  const packageUpgradeAction = packageName => updatePackage({
+    hostname,
+    packageName,
+  });
+
+  const {
+    triggerJobStart: triggerPackageUpgrade,
+    lastCompletedJob: lastCompletedPackageUpgrade,
+    isPolling: isUpgradeInProgress,
+  } = useRexJobPolling(packageUpgradeAction);
+
+  const packageBulkUpgradeAction = bulkParams => updatePackages({
+    hostname,
+    search: bulkParams,
+  });
+
+  const {
+    triggerJobStart: triggerBulkPackageUpgrade,
+    lastCompletedJob: lastCompletedBulkPackageUpgrade,
+    isPolling: isBulkUpgradeInProgress,
+  } = useRexJobPolling(packageBulkUpgradeAction);
+
+  const packageInstallAction
+    = bulkParams => installPackageBySearch({ hostname, search: bulkParams });
+
+  const {
+    triggerJobStart: triggerPackageInstall,
+    lastCompletedJob: lastCompletedPackageInstall,
+    isPolling: isInstallInProgress,
+  } = useRexJobPolling(packageInstallAction);
+
+  const actionInProgress = (isRemoveInProgress || isUpgradeInProgress
+    || isBulkRemoveInProgress || isBulkUpgradeInProgress || isInstallInProgress);
+  const disabledReason = __('A remote execution job is in progress.');
+
   if (!hostId) return <Skeleton />;
 
   const handleInstallPackagesClick = () => {
@@ -135,10 +204,7 @@ export const PackagesTab = () => {
     setIsModalOpen(true);
   };
 
-  const removePackageViaRemoteExecution = packageName => dispatch(removePackage({
-    hostname,
-    packageName,
-  }));
+  const removePackageViaRemoteExecution = packageName => triggerPackageRemove(packageName);
 
   const removeViaKatelloAgent = (packageName) => {
     dispatch(removePackageViaKatelloAgent(hostId, { packages: [packageName] }));
@@ -149,7 +215,7 @@ export const PackagesTab = () => {
     const selected = fetchBulkParams();
     setIsBulkActionOpen(false);
     selectNone();
-    dispatch(removePackages({ hostname, search: selected }));
+    triggerBulkPackageRemove(selected);
   };
 
   const selectedPackageNames = () => selectedResults.map(({ name }) => name);
@@ -178,19 +244,13 @@ export const PackagesTab = () => {
     }
   };
 
-  const upgradeViaRemoteExecution = packageName => dispatch(updatePackage({
-    hostname,
-    packageName,
-  }));
+  const upgradeViaRemoteExecution = packageName => triggerPackageUpgrade(packageName);
 
   const upgradeBulkViaRemoteExecution = () => {
     const selected = fetchBulkParams();
     setIsBulkActionOpen(false);
     selectNone();
-    dispatch(updatePackages({
-      hostname,
-      search: selected,
-    }));
+    triggerBulkPackageUpgrade(selected);
   };
 
   const upgradeBulkViaKatelloAgent = () => {
@@ -223,6 +283,9 @@ export const PackagesTab = () => {
     (defaultRemoteAction === KATELLO_AGENT && selectAllMode && !areAllRowsSelected()) ||
     (!selectAllMode && !allUpgradable());
 
+  const readOnlyBookmarks =
+  cannot(createBookmarks, userPermissionsFromHostDetails({ hostDetails }));
+
   const dropdownUpgradeItems = [
     <DropdownItem
       aria-label="bulk_upgrade_rex"
@@ -270,7 +333,7 @@ export const PackagesTab = () => {
     return newStatus;
   });
 
-  const actionButtons = (
+  const actionButtons = showActions ? (
     <Split hasGutter>
       <SplitItem>
         <ActionList isIconList>
@@ -284,7 +347,7 @@ export const PackagesTab = () => {
                       {__('Upgrade')}
                     </DropdownToggleAction>,
                   ]}
-                  isDisabled={disableUpgrade()}
+                  isDisabled={actionInProgress || disableUpgrade()}
                   splitButtonVariant="action"
                   toggleVariant="primary"
                   onToggle={onActionToggle}
@@ -295,17 +358,19 @@ export const PackagesTab = () => {
             />
           </ActionListItem>
           <ActionListItem>
-            <Dropdown
-              toggle={<KebabToggle aria-label="bulk_actions" onToggle={toggleBulkAction} />}
-              isOpen={isBulkActionOpen}
-              isPlain
-              dropdownItems={dropdownRemoveItems}
-            />
+            {actionInProgress ? <Spinner size="lg" style={{ marginLeft: '1em', marginTop: '4px' }} /> : (
+              <Dropdown
+                toggle={<KebabToggle aria-label="bulk_actions" onToggle={toggleBulkAction} />}
+                isOpen={isBulkActionOpen}
+                isPlain
+                dropdownItems={dropdownRemoveItems}
+              />
+            )}
           </ActionListItem>
         </ActionList>
       </SplitItem>
     </Split>
-  );
+  ) : null;
 
   const statusFilters = (
     <Split hasGutter>
@@ -348,15 +413,18 @@ export const PackagesTab = () => {
           }
           ouiaId="host-packages-table"
           additionalListeners={[hostId, packageStatusSelected,
-            activeSortDirection, activeSortColumn]}
+            activeSortDirection, activeSortColumn, lastCompletedPackageUpgrade,
+            lastCompletedPackageRemove, lastCompletedBulkPackageRemove,
+            lastCompletedBulkPackageUpgrade, lastCompletedPackageInstall]}
           fetchItems={fetchItems}
           bookmarkController="katello_host_installed_packages"
+          readOnlyBookmarks={readOnlyBookmarks}
           autocompleteEndpoint={`/hosts/${hostId}/packages/auto_complete_search`}
           foremanApiAutoComplete
           rowsCount={results?.length}
           variant={TableVariant.compact}
           {...selectAll}
-          displaySelectAllCheckbox
+          displaySelectAllCheckbox={showActions}
         >
           <Thead>
             <Tr>
@@ -382,6 +450,7 @@ export const PackagesTab = () => {
               const rowActions = [
                 {
                   title: __('Remove'),
+                  isDisabled: actionInProgress,
                   onClick: () => handlePackageRemove(packageName),
                 },
               ];
@@ -391,6 +460,7 @@ export const PackagesTab = () => {
                   {
                     title: __('Upgrade via remote execution'),
                     onClick: () => upgradeViaRemoteExecution(upgradableVersion),
+                    isDisabled: actionInProgress,
                   },
                   {
                     title: __('Upgrade via customized remote execution'),
@@ -402,14 +472,18 @@ export const PackagesTab = () => {
 
               return (
                 <Tr key={`${id}`}>
-                  <Td select={{
-                    disable: false,
-                    isSelected: isSelected(id),
-                    onSelect: (event, selected) => selectOne(selected, id, pkg),
-                    rowIndex,
-                    variant: 'checkbox',
-                  }}
-                  />
+                  {showActions ? (
+                    <Td
+                      select={{
+                        disable: actionInProgress,
+                        isSelected: isSelected(id),
+                        onSelect: (event, selected) => selectOne(selected, id, pkg),
+                        rowIndex,
+                        variant: 'checkbox',
+                      }}
+                      title={actionInProgress ? disabledReason : undefined}
+                    />
+                  ) : <Td>&nbsp;</Td>}
                   <Td>
                     {rpmId
                       ? <a href={urlBuilder(`packages/${rpmId}`, '')}>{packageName}</a>
@@ -419,12 +493,14 @@ export const PackagesTab = () => {
                   <Td><PackagesStatus {...pkg} /></Td>
                   <Td>{installedVersion.replace(`${packageName}-`, '')}</Td>
                   <Td><PackagesLatestVersion {...pkg} /></Td>
-                  <Td
-                    key={`rowActions-${id}`}
-                    actions={{
-                      items: rowActions,
-                    }}
-                  />
+                  {showActions ? (
+                    <Td
+                      key={`rowActions-${id}`}
+                      actions={{
+                        items: rowActions,
+                      }}
+                    />
+                  ) : null}
                 </Tr>
               );
             })
@@ -440,6 +516,7 @@ export const PackagesTab = () => {
           key={hostId}
           hostName={hostname}
           showKatelloAgent={showKatelloAgent}
+          triggerPackageInstall={triggerPackageInstall}
         />
       }
     </div>

data/webpack/components/extensions/HostDetails/Tabs/RemoteExecutionActions.js

@@ -1,4 +1,5 @@
-import { API_OPERATIONS, post } from 'foremanReact/redux/API';
+import { API_OPERATIONS, get, post } from 'foremanReact/redux/API';
+import { stopInterval, withInterval } from 'foremanReact/redux/middlewares/IntervalMiddleware';
 import { REX_JOB_INVOCATIONS_KEY, REX_FEATURES } from './RemoteExecutionConstants';
 import { foremanApi } from '../../../../services/api';
 import { errorToast, renderRexJobStartedToast } from '../../../../scenes/Tasks/helpers';
@@ -7,6 +8,7 @@ import { TRACES_SEARCH_QUERY } from './TracesTab/HostTracesConstants';
 import { PACKAGE_SEARCH_QUERY } from './PackagesTab/YumInstallablePackagesConstants';
 import { PACKAGES_SEARCH_QUERY } from './PackagesTab/HostPackagesConstants';
 
+// PARAM BUILDING
 const baseParams = ({ feature, hostname, inputs = {} }) => ({
   job_invocation: {
     feature,
@@ -83,12 +85,32 @@ const katelloModuleStreamActionsParams = ({ hostname, action, moduleSpec }) =>
 
 const showRexToast = response => renderRexJobStartedToast(response.data);
 
-export const installPackage = ({ hostname, packageName }) => post({
+// JOB POLLING
+const pollJobKey = key => `${key}_POLL_REX_JOB`;
+
+export const getJob = (key, jobId, handleSuccess) => get({
+  key,
+  url: foremanApi.getApiUrl(`/job_invocations/${jobId}`),
+  handleSuccess,
+});
+
+export const startPollingJob = ({
+  key, jobId, handleSuccess, interval = 1000,
+}) =>
+  withInterval(getJob(pollJobKey(key), jobId, handleSuccess), interval);
+
+export const stopPollingJob = ({ key }) => stopInterval(pollJobKey(key));
+
+// JOB INVOCATIONS
+export const installPackage = ({ hostname, packageName, handleSuccess }) => post({
   type: API_OPERATIONS.POST,
   key: REX_JOB_INVOCATIONS_KEY,
   url: foremanApi.getApiUrl('/job_invocations'),
   params: katelloPackageInstallParams({ hostname, packageName }),
-  handleSuccess: showRexToast,
+  handleSuccess: (response) => {
+    showRexToast(response);
+    if (handleSuccess) handleSuccess(response);
+  },
   errorToast,
 });
 

data/webpack/components/extensions/HostDetails/Tabs/RemoteExecutionHooks.js

@@ -0,0 +1,85 @@
+import { useState, useEffect, useCallback } from 'react';
+import { useDispatch } from 'react-redux';
+import { propsToCamelCase } from 'foremanReact/common/helpers';
+import { deleteToast } from 'foremanReact/components/ToastsList/slice';
+import { startPollingJob, stopPollingJob } from './RemoteExecutionActions';
+import { renderRexJobFailedToast, renderRexJobStartedToast, renderRexJobSucceededToast } from '../../../../scenes/Tasks/helpers';
+
+export const useRexJobPolling = (initialAction, successAction = null, failureAction = null) => {
+  const [isPolling, setIsPolling] = useState(null);
+  const [succeeded, setSucceeded] = useState(null);
+  const [rexJobId, setRexJobId] = useState(null);
+  // A value that only changes when the job succeeds. Pass to TableWrapper as an additionalListener
+  // to reload results.
+  const [lastCompletedJob, setLastCompletedJob] = useState(null);
+  const dispatch = useDispatch();
+
+  const stopRexJobPolling = useCallback(({ jobId, statusLabel }) => {
+    if (statusLabel) setIsPolling(false);
+    if (statusLabel === 'succeeded') {
+      setSucceeded(true);
+      setLastCompletedJob(jobId);
+    } else {
+      setSucceeded(false);
+    }
+    dispatch(stopPollingJob({ key: `REX_JOB_POLLING_${jobId}` }));
+    dispatch(deleteToast(`REX_TOAST_${jobId}`));
+  }, [dispatch]);
+
+  const tick = (resp) => {
+    const { data } = resp;
+    const { statusLabel, id, description } = propsToCamelCase(data);
+    setRexJobId(id);
+    if (statusLabel && statusLabel !== 'running') {
+      stopRexJobPolling({ jobId: id, statusLabel });
+      if (statusLabel === 'succeeded') {
+        renderRexJobSucceededToast({ id, description });
+        if (successAction) dispatch(typeof successAction === 'function' ? successAction() : successAction);
+      } else {
+        renderRexJobFailedToast({ id, description });
+        if (failureAction) dispatch(typeof failureAction === 'function' ? failureAction() : failureAction);
+      }
+    }
+  };
+  const startRexJobPolling = ({ jobId }) => {
+    dispatch(startPollingJob({ key: `REX_JOB_POLLING_${jobId}`, jobId, handleSuccess: tick }));
+  };
+  const pollingStarted = !!(isPolling || succeeded);
+
+  const dispatchInitialAction = (...args) => {
+    const originalAction = typeof initialAction === 'function' ? initialAction(...args) : initialAction;
+    const modifiedAction = {
+      ...originalAction,
+      payload: {
+        ...originalAction.payload,
+        handleSuccess: (resp) => {
+          const jobId = resp?.data?.id;
+          if (!jobId) return;
+          renderRexJobStartedToast({ key: `REX_TOAST_${jobId}`, ...resp.data });
+          startRexJobPolling({ jobId });
+        },
+      },
+    };
+    setIsPolling(true);
+    dispatch(modifiedAction);
+  };
+
+  // eslint-disable-next-line arrow-body-style
+  useEffect(() => {
+    // clean up polling when component unmounts
+    return function cleanupRexPolling() {
+      if (rexJobId) stopRexJobPolling({ jobId: rexJobId });
+    };
+  }, [rexJobId, stopRexJobPolling]);
+  return ({
+    pollingStarted,
+    isPolling,
+    succeeded,
+    rexJobId,
+    lastCompletedJob,
+    startRexJobPolling,
+    triggerJobStart: dispatchInitialAction,
+  });
+};
+
+export default useRexJobPolling;

data/webpack/components/extensions/HostDetails/Tabs/RepositorySetsTab/RepositorySetsTab.js

@@ -59,7 +59,22 @@ import { selectRepositorySetsStatus } from './RepositorySetsSelectors';
 import './RepositorySetsTab.scss';
 import SortableColumnHeaders from '../../../../Table/components/SortableColumnHeaders';
 import SelectableDropdown from '../../../../SelectableDropdown';
+import { hasRequiredPermissions as can,
+  missingRequiredPermissions as cannot,
+  userPermissionsFromHostDetails } from '../../hostDetailsHelpers';
 
+const viewRepoSets = [
+  'view_hosts', 'view_activation_keys', 'view_products',
+];
+const createBookmarks = ['create_bookmarks'];
+
+export const hideRepoSetsTab = ({ hostDetails }) =>
+  cannot(
+    viewRepoSets,
+    userPermissionsFromHostDetails({ hostDetails }),
+  );
+
+const editHosts = ['edit_hosts'];
 const getEnabledValue = ({ enabled, enabledContentOverride }) => {
   const isOverridden = (enabledContentOverride !== null);
   return {
@@ -96,6 +111,29 @@ EnabledIcon.propTypes = {
   isOverridden: PropTypes.bool.isRequired,
 };
 
+const OsRestrictedIcon = ({ osRestricted }) => (
+  <Tooltip
+    position="right"
+    content={<FormattedMessage
+      id="os-restricted-tooltip"
+      defaultMessage={__('OS restricted to {osRestricted}. If host OS does not match, the repository will not be available on this host.')}
+      values={{ osRestricted }}
+    />}
+  >
+    <Label color="blue" className="os-restricted-label" style={{ marginLeft: '8px' }}>
+      {__(osRestricted)}
+    </Label>
+  </Tooltip>
+);
+
+OsRestrictedIcon.propTypes = {
+  osRestricted: PropTypes.string,
+};
+
+OsRestrictedIcon.defaultProps = {
+  osRestricted: null,
+};
+
 const RepositorySetsTab = () => {
   const hostDetails = useSelector(state => selectAPIResponse(state, 'HOST_DETAILS'));
   const {
@@ -103,6 +141,10 @@ const RepositorySetsTab = () => {
     subscription_status: subscriptionStatus,
     content_facet_attributes: contentFacetAttributes,
   } = hostDetails;
+  const canDoContentOverrides = can(
+    editHosts,
+    userPermissionsFromHostDetails({ hostDetails }),
+  );
   const STATUS_LABEL = __('Status');
 
   const contentFacet = propsToCamelCase(contentFacetAttributes ?? {});
@@ -260,6 +302,9 @@ const RepositorySetsTab = () => {
     singular: true,
   });
 
+  const readOnlyBookmarks =
+  cannot(createBookmarks, userPermissionsFromHostDetails({ hostDetails }));
+
   const dropdownItems = [
     <DropdownItem aria-label="bulk_enable" key="bulk_enable" component="button" onClick={enableRepoSets} isDisabled={selectedCount === 0}>
       {__('Override to enabled')}
@@ -307,7 +352,7 @@ const RepositorySetsTab = () => {
     </Split>
   );
 
-  const actionButtons = (
+  const actionButtons = canDoContentOverrides ? (
     <Split hasGutter>
       <SplitItem>
         <ActionList isIconList>
@@ -322,7 +367,7 @@ const RepositorySetsTab = () => {
         </ActionList>
       </SplitItem>
     </Split>
-  );
+  ) : null;
 
   const hostEnvText = 'the "{contentViewName}" content view and "{lifecycleEnvironmentName}" environment';
 
@@ -400,10 +445,11 @@ const RepositorySetsTab = () => {
           fetchItems={fetchItems}
           autocompleteEndpoint="/repository_sets/auto_complete_search"
           bookmarkController="katello_product_contents" // Katello::ProductContent.table_name
+          readOnlyBookmarks={readOnlyBookmarks}
           rowsCount={results?.length}
           variant={TableVariant.compact}
           {...selectAll}
-          displaySelectAllCheckbox
+          displaySelectAllCheckbox={canDoContentOverrides}
         >
           <Thead>
             <Tr>
@@ -426,19 +472,22 @@ const RepositorySetsTab = () => {
                 enabled_content_override: enabledContentOverride,
                 contentUrl: repoPath,
                 product: { name: productName, id: productId },
+                osRestricted,
               } = repoSet;
               const { isEnabled, isOverridden } =
                 getEnabledValue({ enabled, enabledContentOverride });
               return (
                 <Tr key={id}>
-                  <Td select={{
-                    disable: !isSelectable(id),
-                    isSelected: isSelected(id),
-                    onSelect: (event, selected) => selectOne(selected, id),
-                    rowIndex,
-                    variant: 'checkbox',
-                  }}
-                  />
+                  {canDoContentOverrides ? (
+                    <Td select={{
+                      disable: !isSelectable(id),
+                      isSelected: isSelected(id),
+                      onSelect: (event, selected) => selectOne(selected, id),
+                      rowIndex,
+                      variant: 'checkbox',
+                    }}
+                    />
+                  ) : <Td>&nbsp;</Td>}
                   <Td>
                     <span>{repoName}</span>
                   </Td>
@@ -450,29 +499,34 @@ const RepositorySetsTab = () => {
                   </Td>
                   <Td>
                     <span><EnabledIcon key={`enabled-icon-${id}`} {...{ isEnabled, isOverridden }} /></span>
+                    {osRestricted &&
+                      <span><OsRestrictedIcon key={`os-restricted-icon-${id}`} {...{ osRestricted }} /></span>
+                    }
                   </Td>
-                  <Td
-                    key={`rowActions-${id}`}
-                    actions={{
-                      items: [
-                        {
-                          title: __('Override to disabled'),
-                          isDisabled: isOverridden && !isEnabled,
-                          onClick: () => disableRepoSet(id),
-                        },
-                        {
-                          title: __('Override to enabled'),
-                          isDisabled: isOverridden && isEnabled,
-                          onClick: () => enableRepoSet(id),
-                        },
-                        {
-                          title: __('Reset to default'),
-                          isDisabled: !isOverridden,
-                          onClick: () => resetToDefaultRepoSet(id),
-                        },
-                      ],
-                    }}
-                  />
+                  {canDoContentOverrides ? (
+                    <Td
+                      key={`rowActions-${id}`}
+                      actions={{
+                        items: [
+                          {
+                            title: __('Override to disabled'),
+                            isDisabled: isOverridden && !isEnabled,
+                            onClick: () => disableRepoSet(id),
+                          },
+                          {
+                            title: __('Override to enabled'),
+                            isDisabled: isOverridden && isEnabled,
+                            onClick: () => enableRepoSet(id),
+                          },
+                          {
+                            title: __('Reset to default'),
+                            isDisabled: !isOverridden,
+                            onClick: () => resetToDefaultRepoSet(id),
+                          },
+                        ],
+                      }}
+                    />
+                  ) : <Td />}
                 </Tr>
               );
             })