Fixes #39369 - Job Wizard should send bookmark_id

webpack/JobWizard/JobWizard.js

@@ -62,10 +62,12 @@ export const JobWizard = ({ rerunData }) => {
     hostGroups: [],
   });
   const [hostsSearchQuery, setHostsSearchQuery] = useState('');
+  const [selectedBookmark, setSelectedBookmark] = useState(null);
   const [fills, setFills] = useState(
     rerunData
       ? {
           search: rerunData?.targeting?.search_query,
+          bookmark_id: rerunData?.targeting?.bookmark_id,
           ...rerunData.inputs,
           ...routerSearch,
         }
@@ -251,6 +253,7 @@ export const JobWizard = ({ rerunData }) => {
     setFills,
     setSelectedTargets,
     setHostsSearchQuery,
+    setSelectedBookmark,
     setJobTemplateID,
     setTemplateValues,
     setAdvancedValues,
@@ -298,6 +301,8 @@ export const JobWizard = ({ rerunData }) => {
           setSelected={setSelectedTargets}
           hostsSearchQuery={hostsSearchQuery}
           setHostsSearchQuery={setHostsSearchQuery}
+          selectedBookmark={selectedBookmark}
+          setSelectedBookmark={setSelectedBookmark}
         />
       ),
       canJumpTo: isTemplate,
@@ -474,6 +479,7 @@ export const JobWizard = ({ rerunData }) => {
       dispatch,
       selectedTargets,
       hostsSearchQuery,
+      selectedBookmark,
       location,
       organization,
       feature,
@@ -507,6 +513,7 @@ JobWizard.propTypes = {
     job_category: PropTypes.string,
     targeting: PropTypes.shape({
       search_query: PropTypes.string,
+      bookmark_id: PropTypes.number,
       targeting_type: PropTypes.string,
       randomized_ordering: PropTypes.bool,
     }),

webpack/JobWizard/JobWizardConstants.js

@@ -1,5 +1,6 @@
 import { translate as __ } from 'foremanReact/common/I18n';
 import { foremanUrl } from 'foremanReact/common/helpers';
+import { getControllerSearchProps } from 'foremanReact/constants';
 
 export const JOB_TEMPLATES = 'JOB_TEMPLATES';
 export const JOB_CATEGORIES = 'JOB_CATEGORIES';
@@ -61,6 +62,10 @@ export const hostMethods = {
 
 export const hostQuerySearchID = 'mainHostQuery';
 export const hostsController = 'hosts';
+export const hostsSearchProps = getControllerSearchProps(
+  hostsController,
+  hostQuerySearchID
+);
 
 export const dataName = {
   [HOSTS]: 'hosts',

webpack/JobWizard/JobWizardSelectors.js

@@ -9,6 +9,8 @@ import {
 } from 'foremanReact/redux/API/APISelectors';
 import { STATUS } from 'foremanReact/constants';
 import { selectRouterLocation } from 'foremanReact/routes/RouterSelector';
+import { BOOKMARKS } from 'foremanReact/components/PF4/Bookmarks/BookmarksConstants';
+import { selectBookmarksResults } from 'foremanReact/components/PF4/Bookmarks/BookmarksSelectors';
 
 import {
   JOB_TEMPLATES,
@@ -134,3 +136,9 @@ export const selectRouterSearch = state => {
   const { search } = selectRouterLocation(state) || {};
   return URI.parseQuery(search);
 };
+
+const HOSTS_CONTROLLER = 'hosts';
+const BOOKMARKS_HOSTS_KEY = `${BOOKMARKS}_${HOSTS_CONTROLLER.toUpperCase()}`;
+
+export const selectHostBookmarks = state =>
+  selectBookmarksResults(state, BOOKMARKS_HOSTS_KEY, HOSTS_CONTROLLER);

webpack/JobWizard/__tests__/JobWizardPageRerun.test.js

@@ -3,21 +3,19 @@ import { Provider } from 'react-redux';
 import { render, fireEvent, screen, act } from '@testing-library/react';
 import { MockedProvider } from '@apollo/client/testing';
 
-import * as APIHooks from 'foremanReact/common/hooks/API/APIHooks';
 import * as api from 'foremanReact/redux/API';
 import JobWizardPageRerun from '../JobWizardPageRerun';
 import * as selectors from '../JobWizardSelectors';
-import { testSetup, mockApi, gqlMock, jobInvocation } from './fixtures';
+import {
+  testSetup,
+  mockApi,
+  gqlMock,
+  jobInvocation,
+  bookmarksList,
+} from './fixtures';
 
 const store = testSetup(selectors, api);
 mockApi(api);
-jest.spyOn(APIHooks, 'useAPI');
-APIHooks.useAPI.mockImplementation((action, url) => {
-  if (url === '/ui_job_wizard/job_invocation?id=57') {
-    return { response: jobInvocation, status: 'RESOLVED' };
-  }
-  return {};
-});
 
 describe('Job wizard fill', () => {
   it('fill defaults into fields', async () => {
@@ -76,4 +74,50 @@ describe('Job wizard fill', () => {
       }).value
     ).toBe('6');
   });
+
+  it('fills bookmark on rerun when job used a bookmark', async () => {
+    const bookmark = bookmarksList[0];
+    const jobWithBookmark = {
+      ...jobInvocation,
+      job: {
+        ...jobInvocation.job,
+        targeting: {
+          ...jobInvocation.job.targeting,
+          bookmark_id: bookmark.id,
+          search_query: null,
+        },
+      },
+    };
+
+    selectors.selectRerunJobInvocationResponse.mockImplementation(
+      () => jobWithBookmark
+    );
+
+    render(
+      <MockedProvider mocks={gqlMock} addTypename={false}>
+        <Provider store={store}>
+          <JobWizardPageRerun
+            match={{
+              params: { id: '99' },
+            }}
+          />
+        </Provider>
+      </MockedProvider>
+    );
+
+    await act(async () => {
+      fireEvent.click(screen.getByText('Target hosts and inputs'));
+    });
+
+    const hostMethodSelect = screen.getByRole('button', {
+      name: 'host method',
+    });
+    expect(hostMethodSelect.textContent).toContain('Search query');
+
+    expect(screen.queryAllByText(bookmark.query)).toHaveLength(1);
+
+    selectors.selectRerunJobInvocationResponse.mockImplementation(
+      () => jobInvocation
+    );
+  });
 });

webpack/JobWizard/__tests__/fixtures.js

@@ -116,6 +116,22 @@ export const jobTemplateResponse = {
   ],
 };
 
+export const bookmarksList = [
+  { id: 19, name: 'my hosts', query: 'name ~ myhost', controller: 'hosts' },
+  {
+    id: 23,
+    name: 'active hosts',
+    query: 'last_report > "1 hour ago"',
+    controller: 'hosts',
+  },
+  {
+    id: 31,
+    name: 'dashboard default',
+    query: 'os = centos',
+    controller: 'dashboard',
+  },
+];
+
 export const jobCategories = ['Services', 'Ansible Commands', 'Puppet'];
 
 export const testSetup = (selectors, api) => {
@@ -176,6 +192,14 @@ export const testSetup = (selectors, api) => {
         subtotal: 3,
       },
     },
+    bookmarksPF4: {
+      hosts: {
+        results: bookmarksList,
+      },
+    },
+    API: {
+      BOOKMARKS_HOSTS: { status: 'RESOLVED', results: [] },
+    },
   });
   return store;
 };

webpack/JobWizard/autofill.js

@@ -1,19 +1,43 @@
-import { useEffect } from 'react';
-import { useDispatch } from 'react-redux';
+import { useEffect, useState } from 'react';
+import { useDispatch, useSelector } from 'react-redux';
 import { get } from 'foremanReact/redux/API';
-import { HOST_IDS, REX_FEATURE } from './JobWizardConstants';
+import { getBookmarks } from 'foremanReact/components/PF4/Bookmarks/BookmarksActions';
+import {
+  HOST_IDS,
+  REX_FEATURE,
+  hostsController,
+  hostsSearchProps,
+} from './JobWizardConstants';
+import { selectHostBookmarks } from './JobWizardSelectors';
 import './JobWizard.scss';
 
 export const useAutoFill = ({
   fills,
   setFills,
   setSelectedTargets,
   setHostsSearchQuery,
+  setSelectedBookmark,
   setJobTemplateID,
   setTemplateValues,
   setAdvancedValues,
 }) => {
   const dispatch = useDispatch();
+  const bookmarks = useSelector(selectHostBookmarks);
+  const [pendingBookmarkId, setPendingBookmarkId] = useState(null);
+
+  useEffect(() => {
+    if (pendingBookmarkId === null || bookmarks.length === 0) return;
+    const bookmark = bookmarks.find(bm => bm.id === pendingBookmarkId);
+    if (bookmark) {
+      setSelectedBookmark({
+        id: bookmark.id,
+        name: bookmark.name,
+        query: bookmark.query,
+      });
+      setHostsSearchQuery(bookmark.query);
+    }
+    setPendingBookmarkId(null);
+  }, [bookmarks, pendingBookmarkId, setSelectedBookmark, setHostsSearchQuery]);
 
   useEffect(() => {
     if (Object.keys(fills).length) {
@@ -22,10 +46,12 @@ export const useAutoFill = ({
         search,
         feature,
         template_id: templateID,
+        bookmark_id: bookmarkId,
         ...rest
       } = { ...fills };
       setFills({});
       if (hostIds) {
+        setSelectedBookmark(null);
         const hostSearch = Array.isArray(hostIds)
           ? `id = ${hostIds.join(' or id = ')}`
           : `id = ${hostIds}`;
@@ -52,9 +78,34 @@ export const useAutoFill = ({
           })
         );
       }
-      if ((search || search === '') && !hostIds?.length) {
+      if (bookmarkId) {
+        setSelectedTargets({
+          hosts: [],
+          hostCollections: [],
+          hostGroups: [],
+        });
+        const numericId = Number(bookmarkId);
+        if (bookmarks.length > 0) {
+          const bookmark = bookmarks.find(bm => bm.id === numericId);
+          if (bookmark) {
+            setSelectedBookmark({
+              id: bookmark.id,
+              name: bookmark.name,
+              query: bookmark.query,
+            });
+            setHostsSearchQuery(bookmark.query);
+          }
+        } else {
+          setPendingBookmarkId(numericId);
+          dispatch(
+            getBookmarks(hostsSearchProps.bookmarks.url, hostsController)
+          );
+        }
+      } else if ((search || search === '') && !hostIds?.length) {
         // replace an empty string search with a dummy search query to match all hosts
         // but only if search query was entered (based on presence of :search parameter)
+
+        setSelectedBookmark(null);
         const hostSearch = search === '' ? "name != ''" : search;
         setHostsSearchQuery(hostSearch);
       }
@@ -100,9 +151,11 @@ export const useAutoFill = ({
     setFills,
     setSelectedTargets,
     setHostsSearchQuery,
+    setSelectedBookmark,
     setJobTemplateID,
     setTemplateValues,
     setAdvancedValues,
     dispatch,
+    bookmarks,
   ]);
 };

webpack/JobWizard/steps/AdvancedFields/__tests__/AdvancedFields.test.js

@@ -125,7 +125,7 @@ describe('AdvancedFields', () => {
     const resourceSelectField = screen.getByLabelText(
       'adv resource select toggle'
     );
-    const searchField = screen.getByPlaceholderText('Filter...');
+    const searchField = screen.getByPlaceholderText('Search');
     const dateField = screen.getByLabelText('adv date datepicker');
     const timeField = screen.getByLabelText('adv date timepicker');
 
@@ -403,6 +403,11 @@ describe('AdvancedFields', () => {
 
       jest.advanceTimersByTime(10000);
     });
-    expect(newStore.getActions()).toMatchSnapshot('resource search');
+    const actions = newStore.getActions();
+    const resourceSearchAction = actions.filter(
+      action => action.key === 'ForemanTasksTask'
+    );
+    expect(resourceSearchAction).toHaveLength(2);
+    expect(String(resourceSearchAction[1].url)).toContain('name=some+search');
   });
 });