DRYD-1832: New API Usage

src/actions/search.js

@@ -1,7 +1,7 @@
 import get from 'lodash/get';
 import { getSearchResult, isSearchDirty, isSearchPending } from '../reducers';
 import getSession from '../helpers/session';
-import { convertAdvancedSearchConditionToNXQL } from '../helpers/searchHelpers';
+import { convertAdvancedSearchConditionToNXQL, deriveSearchType } from '../helpers/searchHelpers';
 
 import {
   ERR_UNKNOWN_RECORD_TYPE,
@@ -94,7 +94,16 @@ const buildSearchPath = (csid, subresource, config, recordServicePath, vocabular
  */
 const buildAdvancedSearchPath = () => '/advancedsearch';
 
-export const search = (config, searchName, searchDescriptor, listType = 'common', columnSetName = 'default', isNewSearch = false) => (dispatch, getState) => {
+/**
+ * Build and dispatch a search
+ *
+ * @param {*} config The cspace configuration
+ * @param {*} searchName The search being executed (e.g. SEARCH_RESULT_PAGE_SEARCH_NAME)
+ * @param {*} searchDescriptor The search descriptor (record type, query params, etc)
+ * @param {*} columnSetName The columns for the view being returned, used for sort fields
+ * @returns
+ */
+export const search = (config, searchName, searchDescriptor, columnSetName = 'default') => (dispatch, getState) => {
   const recordType = searchDescriptor.get('recordType');
   const vocabulary = searchDescriptor.get('vocabulary');
   const csid = searchDescriptor.get('csid');
@@ -121,6 +130,11 @@ export const search = (config, searchName, searchDescriptor, listType = 'common'
     return Promise.resolve();
   }
 
+  const {
+    listType,
+    searchType,
+  } = deriveSearchType(config, searchName, searchDescriptor);
+
   const listTypeConfig = config.listTypes[listType];
 
   dispatch({
@@ -269,7 +283,7 @@ export const search = (config, searchName, searchDescriptor, listType = 'common'
     pathParts.push(subresourceServicePath);
   }
 
-  const path = isNewSearch
+  const path = searchType === 'advanced'
     ? buildAdvancedSearchPath()
     : buildSearchPath(csid, subresource, config, recordTypeServicePath, vocabularyServicePath);
 

src/components/media/MediaViewerPanel.jsx

@@ -65,14 +65,13 @@ export default class MediaViewerPanel extends Component {
     const {
       columnSetName,
       config,
-      listType,
       name,
       search,
       searchDescriptor,
     } = this.props;
 
     if (search) {
-      search(config, name, searchDescriptor, listType, columnSetName);
+      search(config, name, searchDescriptor, columnSetName);
     }
   }
 

src/components/pages/AccountPage.jsx

@@ -12,6 +12,7 @@ import { canCreate, canRead } from '../../helpers/permissionHelpers';
 import AdminTabButtonBar from '../admin/AdminTabButtonBar';
 import AccountSearchBar from '../admin/AccountSearchBar';
 import styles from '../../../styles/cspace-ui/AdminTab.css';
+import { SEARCH_RESULT_ACCOUNT_PAGE } from '../../constants/searchNames';
 
 const propTypes = {
   history: PropTypes.shape({
@@ -295,7 +296,7 @@ export default class AccountPage extends Component {
             isFiltered={!!filterValue}
             linkItems={false}
             listType="account"
-            name="accountPage"
+            name={SEARCH_RESULT_ACCOUNT_PAGE}
             pageSizeOptionListName="searchResultPagePageSizes"
             searchDescriptor={searchDescriptor}
             title={title}

src/components/pages/AuthRolePage.jsx

@@ -12,6 +12,7 @@ import { canCreate, canRead } from '../../helpers/permissionHelpers';
 import AdminTabButtonBar from '../admin/AdminTabButtonBar';
 import AuthRoleSearchBar from '../admin/AuthRoleSearchBar';
 import styles from '../../../styles/cspace-ui/AdminTab.css';
+import { SEARCH_RESULT_AUTH_ROLE_PAGE } from '../../constants/searchNames';
 
 const propTypes = {
   history: PropTypes.shape({
@@ -282,7 +283,7 @@ export default class AuthRolePage extends Component {
             isFiltered={!!filterValue}
             linkItems={false}
             listType="role"
-            name="authRolePage"
+            name={SEARCH_RESULT_AUTH_ROLE_PAGE}
             pageSizeOptionListName="searchResultPagePageSizes"
             searchDescriptor={searchDescriptor}
             title={title}

src/components/pages/SearchResultPage.jsx

@@ -19,7 +19,7 @@ import ExportModalContainer from '../../containers/search/ExportModalContainer';
 import WatchedSearchResultTableContainer from '../../containers/search/WatchedSearchResultTableContainer';
 import SearchToRelateModalContainer from '../../containers/search/SearchToRelateModalContainer';
 import { canRelate } from '../../helpers/permissionHelpers';
-import { getListType } from '../../helpers/searchHelpers';
+import { deriveSearchType, getListTypeFromResult } from '../../helpers/searchHelpers';
 import { SEARCH_RESULT_PAGE_SEARCH_NAME } from '../../constants/searchNames';
 
 import {
@@ -206,8 +206,11 @@ export default class SearchResultPage extends Component {
     } = this.context;
 
     if (onItemSelectChange) {
+      // certainly we could use the search result at this point
       const searchDescriptor = this.getSearchDescriptor();
-      const listType = this.getListType(searchDescriptor);
+      const {
+        listType,
+      } = deriveSearchType(config, SEARCH_RESULT_PAGE_SEARCH_NAME, searchDescriptor);
 
       onItemSelectChange(
         config, SEARCH_RESULT_PAGE_SEARCH_NAME, searchDescriptor, listType, index, selected,
@@ -366,14 +369,6 @@ export default class SearchResultPage extends Component {
     }
   }
 
-  getListType(searchDescriptor) {
-    const {
-      config,
-    } = this.context;
-
-    return getListType(config, searchDescriptor);
-  }
-
   getSearchDescriptor() {
     // FIXME: Refactor this into a wrapper component that calculates the search descriptor from
     // location and params, and passes it into a child. This will eliminate the multiple calls to
@@ -574,9 +569,7 @@ export default class SearchResultPage extends Component {
     // has set them to the defaults.
 
     if (!Number.isNaN(searchQuery.get('p')) && !Number.isNaN(searchQuery.get('size')) && search) {
-      const listType = this.getListType(searchDescriptor);
-
-      search(config, SEARCH_RESULT_PAGE_SEARCH_NAME, searchDescriptor, listType);
+      search(config, SEARCH_RESULT_PAGE_SEARCH_NAME, searchDescriptor);
     }
   }
 
@@ -663,7 +656,7 @@ export default class SearchResultPage extends Component {
     } = this.context;
 
     const searchDescriptor = this.getSearchDescriptor();
-    const listType = this.getListType(searchDescriptor);
+    const { listType } = deriveSearchType(config, SEARCH_RESULT_PAGE_SEARCH_NAME, searchDescriptor);
 
     let selectBar;
 
@@ -715,9 +708,8 @@ export default class SearchResultPage extends Component {
         <SearchResultSummary
           config={config}
           listType={listType}
+          searchName={SEARCH_RESULT_PAGE_SEARCH_NAME}
           searchDescriptor={searchDescriptor}
-          searchError={searchError}
-          searchResult={searchResult}
           onEditSearchLinkClick={this.handleEditSearchLinkClick}
           onPageSizeChange={this.handlePageSizeChange}
         />
@@ -732,8 +724,7 @@ export default class SearchResultPage extends Component {
         config,
       } = this.context;
 
-      const searchDescriptor = this.getSearchDescriptor();
-      const listType = this.getListType(searchDescriptor);
+      const listType = getListTypeFromResult(config, searchResult);
       const listTypeConfig = config.listTypes[listType];
       const { listNodeName } = listTypeConfig;
 
@@ -784,7 +775,7 @@ export default class SearchResultPage extends Component {
 
     const searchDescriptor = this.getSearchDescriptor();
 
-    const listType = this.getListType(searchDescriptor);
+    const { listType } = deriveSearchType(config, SEARCH_RESULT_PAGE_SEARCH_NAME, searchDescriptor);
 
     const recordType = searchDescriptor.get('recordType');
     const vocabulary = searchDescriptor.get('vocabulary');

src/components/pages/search/SearchResultRoute.jsx

@@ -13,10 +13,10 @@ import { useConfig } from '../../config/ConfigProvider';
  * @returns the component to render
  */
 export default function SearchResultRoute(props) {
-  const { recordType } = useParams();
+  const { recordType, subresource } = useParams();
   const config = useConfig();
 
-  const isNewSearch = get(config,
+  const isNewSearch = !subresource && get(config,
     ['recordTypes', recordType, 'serviceConfig', 'features', 'updatedSearch']);
 
   return isNewSearch

src/components/pages/search/SearchResults.jsx

@@ -21,14 +21,9 @@ import styles from '../../../../styles/cspace-ui/SearchResults.css';
 import selectStyles from '../../../../styles/cspace-ui/SelectBar.css';
 import buttonBarStyles from '../../../../styles/cspace-ui/ButtonBar.css';
 
-import {
-  setSearchResultPagePageSize,
-} from '../../../actions/prefs';
-
-import {
-  search,
-} from '../../../actions/search';
-import { getSearchError, getSearchResult, isSearchResultSidebarOpen } from '../../../reducers';
+import { setSearchResultPagePageSize } from '../../../actions/prefs';
+import { search } from '../../../actions/search';
+import { isSearchResultSidebarOpen } from '../../../reducers';
 
 const selectBarPropTypes = {
   toggleBar: PropTypes.object,
@@ -183,6 +178,19 @@ function normalizeQuery(props, config) {
   return query;
 }
 
+/**
+ * The page for displaying Search Results. Before rendering it first executes the search based on
+ * the query parameters provided by encapsulating them in a search descriptor and calling the search
+ * action in redux.
+ *
+ * Currently this is more for the new search views on CollectionObjects which includes a grid and
+ * detail based view compared to the older table based view. Ideally this be the only component for
+ * displaying search results but we first would need to make sure we only display the views which
+ * are supported for a given procedure or authority.
+ *
+ * @param {*} props
+ * @returns the SearchResults page component
+ */
 export default function SearchResults(props) {
   const [display, setDisplay] = useState('table');
   const [sidebarPosition, setSidebarPosition] = useState('right');
@@ -194,17 +202,9 @@ export default function SearchResults(props) {
   const searchDescriptor = getSearchDescriptor(normalizedQuery, props);
   useEffect(() => {
     setPreferredPageSize(props, dispatch);
-    dispatch(search(config, SEARCH_RESULT_PAGE_SEARCH_NAME, searchDescriptor, 'common')); // , 'common', true));
+    dispatch(search(config, SEARCH_RESULT_PAGE_SEARCH_NAME, searchDescriptor));
   }, [normalizedQuery, searchDescriptor]);
 
-  // todo: should these be called in each component? they're at the top level for now
-  // as to not make too many changes at once
-  const searchResults = useSelector((state) => getSearchResult(state,
-    SEARCH_RESULT_PAGE_SEARCH_NAME,
-    searchDescriptor));
-  const searchErrors = useSelector((state) => getSearchError(state,
-    SEARCH_RESULT_PAGE_SEARCH_NAME,
-    searchDescriptor));
   const isSidebarOpen = useSelector((state) => isSearchResultSidebarOpen(state));
 
   const toggles = [
@@ -241,7 +241,7 @@ export default function SearchResults(props) {
 
   let searchDisplay;
   if (display === 'table') {
-    searchDisplay = <SearchResultTable searchDescriptor={searchDescriptor} listType="common" />;
+    searchDisplay = <SearchResultTable searchDescriptor={searchDescriptor} />;
   } else if (display === 'list') {
     searchDisplay = <SearchDetailList searchDescriptor={searchDescriptor} />;
   } else {
@@ -272,10 +272,8 @@ export default function SearchResults(props) {
         <div className={styles.results}>
           <header>
             <SearchResultSummary
-              listType="common"
               config={config}
-              searchResult={searchResults}
-              searchError={searchErrors}
+              searchName={SEARCH_RESULT_PAGE_SEARCH_NAME}
               searchDescriptor={searchDescriptor}
             />
             <SimpleSelectBar toggleBar={displayToggles} />

src/components/record/TermsUsedPanel.jsx

@@ -4,6 +4,7 @@ import Immutable from 'immutable';
 import { defineMessages, FormattedMessage } from 'react-intl';
 import { getUpdatedTimestamp } from '../../helpers/recordDataHelpers';
 import SearchPanelContainer from '../../containers/search/SearchPanelContainer';
+import { SEARCH_RESULT_TERMS_USED_PANEL } from '../../constants/searchNames';
 
 const messages = defineMessages({
   title: {
@@ -121,7 +122,7 @@ export default class TermsUsedPanel extends Component {
         config={config}
         csid={csid}
         listType="authRef"
-        name="termsUsedPanel"
+        name={SEARCH_RESULT_TERMS_USED_PANEL}
         searchDescriptor={searchDescriptor}
         recordType={recordType}
         vocabulary={vocabulary}

src/components/record/UsedByPanel.jsx

@@ -4,6 +4,7 @@ import Immutable from 'immutable';
 import { defineMessages, FormattedMessage } from 'react-intl';
 import { getUpdatedTimestamp } from '../../helpers/recordDataHelpers';
 import SearchPanelContainer from '../../containers/search/SearchPanelContainer';
+import { SEARCH_RESULT_USED_BY_PANEL } from '../../constants/searchNames';
 
 const messages = defineMessages({
   title: {
@@ -142,7 +143,7 @@ export default class UsedByPanel extends Component {
         config={config}
         csid={csid}
         listType="refDoc"
-        name="usedByPanel"
+        name={SEARCH_RESULT_USED_BY_PANEL}
         searchDescriptor={searchDescriptor}
         recordType={recordType}
         vocabulary={vocabulary}

src/components/search/SearchPanel.jsx

@@ -8,7 +8,7 @@ import { baseComponents as inputComponents } from 'cspace-input';
 import { ConnectedPanel as Panel } from '../../containers/layout/PanelContainer';
 import SearchResultTableContainer from '../../containers/search/SearchResultTableContainer';
 import SearchToRelateModalContainer from '../../containers/search/SearchToRelateModalContainer';
-import { searchDescriptorToLocation } from '../../helpers/searchHelpers';
+import { getListTypeFromResult, searchDescriptorToLocation } from '../../helpers/searchHelpers';
 import Pager from './Pager';
 import styles from '../../../styles/cspace-ui/SearchPanel.css';
 
@@ -235,14 +235,13 @@ export default class SearchPanel extends Component {
     const {
       columnSetName,
       config,
-      listType,
       name,
       search,
       searchDescriptor,
     } = this.props;
 
     if (search) {
-      search(config, name, searchDescriptor, listType, columnSetName);
+      search(config, name, searchDescriptor, columnSetName);
     }
   }
 
@@ -285,16 +284,17 @@ export default class SearchPanel extends Component {
     const {
       config,
       isFiltered,
-      listType,
       searchResult,
       title,
     } = this.props;
 
-    const listTypeConfig = config.listTypes[listType];
+    let totalItems = null;
+    if (searchResult) {
+      const listType = getListTypeFromResult(config, searchResult);
+      const listTypeConfig = config.listTypes[listType];
 
-    const totalItems = searchResult
-      ? searchResult.getIn([listTypeConfig.listNodeName, 'totalItems'])
-      : null;
+      totalItems = searchResult.getIn([listTypeConfig.listNodeName, 'totalItems']);
+    }
 
     let headerContent;
 
@@ -322,11 +322,11 @@ export default class SearchPanel extends Component {
   renderFooter({ searchResult }) {
     const {
       config,
-      listType,
       pageSizeOptionListName,
     } = this.props;
 
     if (searchResult) {
+      const listType = getListTypeFromResult(config, searchResult);
       const listTypeConfig = config.listTypes[listType];
       const list = searchResult.get(listTypeConfig.listNodeName);
 

src/components/search/SearchResultFooter.jsx

@@ -5,10 +5,10 @@ import { useHistory, useLocation } from 'react-router-dom';
 import qs from 'qs';
 import Pager from './Pager';
 import { useConfig } from '../config/ConfigProvider';
-import { getListType } from '../../helpers/searchHelpers';
 import { SEARCH_RESULT_PAGE_SEARCH_NAME } from '../../constants/searchNames';
 import { getSearchResult } from '../../reducers';
 import { setSearchResultPagePageSize } from '../../actions/prefs';
+import { getListTypeFromResult } from '../../helpers/searchHelpers';
 
 const propTypes = {
   searchDescriptor: PropTypes.object,
@@ -72,7 +72,7 @@ export default function SearchResultFooter({ searchDescriptor }) {
     });
   }
 
-  const listType = getListType(searchDescriptor);
+  const listType = getListTypeFromResult(config, results);
   const listTypeConfig = config.listTypes[listType];
   const { listNodeName } = listTypeConfig;