Update tests for listType change

mikejritter · mikejritter · commit 454850473e7d · 2025-08-29T14:35:03.000-06:00
diff --git a/src/components/record/RecordTitleBar.jsx b/src/components/record/RecordTitleBar.jsx
@@ -84,7 +84,6 @@ export default function RecordTitleBar(props, context) {
       <SearchResultTraverserContainer
         config={config}
         csid={csid}
-        listType={listType}
         searchName={searchName}
         searchDescriptor={searchDescriptor}
         originSearchPageState={originSearchPageState}
diff --git a/src/components/search/SearchResultSummary.jsx b/src/components/search/SearchResultSummary.jsx
@@ -11,6 +11,7 @@ import styles from '../../../styles/cspace-ui/SearchResultSummary.css';
 import { setSearchPageRecordType, setSearchPageVocabulary } from '../../actions/prefs';
 import { setSearchPageAdvanced, setSearchPageKeyword } from '../../actions/searchPage';
 import { getSearchError, getSearchResult } from '../../reducers';
+import { getListTypeForResult } from '../../helpers/searchHelpers';
 
 const messages = defineMessages({
   error: {
@@ -91,20 +92,13 @@ const defaultProps = {
 export default function SearchResultSummary(props) {
   const {
     config,
-    listType,
     searchDescriptor,
     searchName,
     renderEditLink,
     onEditSearchLinkClick,
     onPageSizeChange,
   } = props;
 
-  // let {
-  // searchError,
-  // searchResult,
-  // } = props;
-
-  // support both workflows for the time being (prop/hook based)
   const searchError = useSelector((state) => getSearchError(state, searchName, searchDescriptor));
   const searchResult = useSelector((state) => getSearchResult(state, searchName, searchDescriptor));
 
@@ -137,6 +131,7 @@ export default function SearchResultSummary(props) {
   let pageSize = null;
 
   if (searchResult) {
+    const listType = getListTypeForResult(config, searchResult);
     const listTypeConfig = config.listTypes[listType];
     const { listNodeName } = listTypeConfig;
 
diff --git a/src/components/search/SearchResultTraverser.jsx b/src/components/search/SearchResultTraverser.jsx
@@ -40,7 +40,6 @@ const propTypes = {
     listTypes: PropTypes.object,
   }),
   csid: PropTypes.string,
-  listType: PropTypes.string,
   searchName: PropTypes.string,
   searchDescriptor: PropTypes.instanceOf(Immutable.Map),
   searchState: PropTypes.instanceOf(Immutable.Map),
@@ -76,7 +75,6 @@ export default class SearchResultTraverser extends Component {
       search,
     } = this.props;
 
-    const { listType } = deriveSearchType(config, searchName, searchDescriptor);
     if (search) {
       if (searchDescriptor && !searchState) {
         // We have a search descriptor, but it's not associated with any state. This happens when
@@ -88,6 +86,7 @@ export default class SearchResultTraverser extends Component {
       }
 
       if (searchState && !searchState.get('isPending') && searchState.get('result')) {
+        const { listType } = deriveSearchType(config, searchName, searchDescriptor);
         const listTypeConfig = config.listTypes[listType];
         const { listNodeName, itemNodeName } = listTypeConfig;
 
diff --git a/test/helpers/providerHelpers.jsx b/test/helpers/providerHelpers.jsx
@@ -0,0 +1,82 @@
+import React from 'react';
+import { render } from 'react-dom';
+import { act } from 'react-dom/test-utils';
+import { IntlProvider } from 'react-intl';
+import { Provider } from 'react-redux';
+import { MemoryRouter } from 'react-router-dom/cjs/react-router-dom.min';
+import { applyMiddleware, compose, createStore as reduxCreateStore } from 'redux';
+import thunk from 'redux-thunk';
+import ConfigProvider from '../../src/components/config/ConfigProvider';
+import reducers from '../../src/reducers';
+import createConfigContext from '../../src/helpers/createConfigContext';
+import { evaluatePlugin, finalizeRecordTypes, mergeConfig } from '../../src/helpers/configHelpers';
+import plugins from '../../src/plugins';
+
+/**
+ * @returns the CSpace configuration object
+ */
+export function createCSpaceConfig() {
+  const configContext = createConfigContext();
+
+  const defaultConfig = mergeConfig({
+    structDateOptionListNames: ['dateQualifiers'],
+    structDateVocabNames: ['dateera', 'datecertainty', 'datequalifier'],
+    tags: {
+      defaultGroup: {
+        sortOrder: 0,
+      },
+      nagpra: {
+        sortOrder: 1,
+      },
+      legacy: {
+        sortOrder: 3,
+      },
+    },
+    tenantId: '1',
+  }, {
+    plugins: plugins.map((plugin) => plugin()),
+  }, configContext);
+
+  const resolvedUiConfig = evaluatePlugin({}, createConfigContext());
+  return finalizeRecordTypes(mergeConfig(defaultConfig, resolvedUiConfig, configContext));
+}
+
+/**
+ * @returns a redux store
+ */
+export function createStore() {
+  return reduxCreateStore(reducers, compose(
+    applyMiddleware(thunk),
+  ));
+}
+
+/**
+ * Render a React component/function with all expected providers
+ *
+ * @param {*} element the React component to render
+ * @param {*} config the CollectionSpace configuration for the ConfigProvider
+ * @param {*} store the Redux store for the Redux Provider
+ * @param {*} container the container to render to
+ * @returns
+ */
+export function renderWithProviders(element, config, store, container) {
+  let resultTree;
+
+  const fullTree = (
+    <IntlProvider locale="en">
+      <Provider store={store}>
+        <ConfigProvider config={config}>
+          <MemoryRouter>
+            {element}
+          </MemoryRouter>
+        </ConfigProvider>
+      </Provider>
+    </IntlProvider>
+  );
+
+  act(() => {
+    resultTree = render(fullTree, container);
+  });
+
+  return resultTree;
+}
diff --git a/test/specs/actions/search.spec.js b/test/specs/actions/search.spec.js
@@ -98,6 +98,7 @@ describe('search action creator', () => {
       },
       subresources: {
         terms: {
+          listType: 'common',
           serviceConfig: {
             servicePath: termsServicePath,
           },
diff --git a/test/specs/components/media/MediaViewerPanel.spec.jsx b/test/specs/components/media/MediaViewerPanel.spec.jsx
@@ -158,16 +158,14 @@ describe('MediaViewerPanel', () => {
     let searchedConfig = null;
     let searchedSearchName = null;
     let searchedSearchDescriptor = null;
-    let searchedListType = null;
     let searchedColumnSetName = null;
 
     const search = (
-      configArg, searchNameArg, searchDescriptorArg, listTypeArg, columnSetNameArg,
+      configArg, searchNameArg, searchDescriptorArg, columnSetNameArg,
     ) => {
       searchedConfig = configArg;
       searchedSearchName = searchNameArg;
       searchedSearchDescriptor = searchDescriptorArg;
-      searchedListType = listTypeArg;
       searchedColumnSetName = columnSetNameArg;
     };
 
@@ -185,24 +183,21 @@ describe('MediaViewerPanel', () => {
     searchedConfig.should.equal(config);
     searchedSearchName.should.equal(searchName);
     searchedSearchDescriptor.should.equal(searchDescriptor);
-    searchedListType.should.equal('common');
     searchedColumnSetName.should.equal('default');
   });
 
   it('should call search when a new search descriptor is supplied', function test() {
     let searchedConfig = null;
     let searchedSearchName = null;
     let searchedSearchDescriptor = null;
-    let searchedListType = null;
     let searchedColumnSetName = null;
 
     const search = (
-      configArg, searchNameArg, searchDescriptorArg, listTypeArg, columnSetNameArg,
+      configArg, searchNameArg, searchDescriptorArg, columnSetNameArg,
     ) => {
       searchedConfig = configArg;
       searchedSearchName = searchNameArg;
       searchedSearchDescriptor = searchDescriptorArg;
-      searchedListType = listTypeArg;
       searchedColumnSetName = columnSetNameArg;
     };
 
@@ -239,7 +234,6 @@ describe('MediaViewerPanel', () => {
     searchedConfig.should.equal(config);
     searchedSearchName.should.equal(searchName);
     searchedSearchDescriptor.should.equal(newSearchDescriptor);
-    searchedListType.should.equal('common');
     searchedColumnSetName.should.equal('default');
   });
 });
diff --git a/test/specs/components/pages/SearchResultPage.spec.jsx b/test/specs/components/pages/SearchResultPage.spec.jsx
@@ -184,14 +184,16 @@ const searchDescriptor = Immutable.fromJS({
   },
 });
 
+const optionList = Immutable.Map({
+  searchResultPagePageSizes: [
+    { value: '10' },
+    { value: '20' },
+    { value: '40' },
+  ],
+});
+
 const store = mockStore({
-  optionList: Immutable.Map({
-    searchResultPagePageSizes: [
-      { value: '10' },
-      { value: '20' },
-      { value: '40' },
-    ],
-  }),
+  optionList,
   prefs: Immutable.Map(),
   search: Immutable.fromJS({
     [SEARCH_RESULT_PAGE_SEARCH_NAME]: {
@@ -640,9 +642,25 @@ describe('SearchResultPage', () => {
         'ns2:abstract-common-list': {},
       });
 
+      const updatedStore = mockStore({
+        optionList,
+        prefs: Immutable.Map(),
+        search: Immutable.fromJS({
+          [SEARCH_RESULT_PAGE_SEARCH_NAME]: {
+            byKey: {
+              [searchKey(searchDescriptor)]: {
+                result: noTotalItemsSearchResult,
+              },
+            },
+          },
+        }),
+        searchToSelect: Immutable.Map(),
+        user: Immutable.Map(),
+      });
+
       render(
         <IntlProvider locale="en">
-          <StoreProvider store={store}>
+          <StoreProvider store={updatedStore}>
             <ConfigProvider config={config}>
               <Router>
                 {searchResultPage.renderHeader({ searchResult: noTotalItemsSearchResult })}
@@ -659,10 +677,6 @@ describe('SearchResultPage', () => {
     });
 
     it('should render an error message if the search has an error', () => {
-      const searchError = Immutable.Map({
-        code: 'ERROR_CODE',
-      });
-
       const pageContainer = document.createElement('div');
 
       document.body.appendChild(pageContainer);
@@ -689,9 +703,29 @@ describe('SearchResultPage', () => {
 
       document.body.appendChild(headerContainer);
 
+      const searchError = Immutable.Map({
+        code: 'ERROR_CODE',
+      });
+
+      const updatedStore = mockStore({
+        optionList,
+        prefs: Immutable.Map(),
+        search: Immutable.fromJS({
+          [SEARCH_RESULT_PAGE_SEARCH_NAME]: {
+            byKey: {
+              [searchKey(searchDescriptor)]: {
+                error: searchError,
+              },
+            },
+          },
+        }),
+        searchToSelect: Immutable.Map(),
+        user: Immutable.Map(),
+      });
+
       render(
         <IntlProvider locale="en">
-          <StoreProvider store={store}>
+          <StoreProvider store={updatedStore}>
             <ConfigProvider config={config}>
               <Router>
                 {searchResultPage.renderHeader({ searchError })}
diff --git a/test/specs/components/pages/search/SearchResults.spec.jsx b/test/specs/components/pages/search/SearchResults.spec.jsx
diff --git a/test/specs/components/search/SearchPanel.spec.jsx b/test/specs/components/search/SearchPanel.spec.jsx
@@ -172,16 +172,14 @@ describe('SearchPanel', () => {
     let searchedConfig = null;
     let searchedSearchName = null;
     let searchedSearchDescriptor = null;
-    let searchedListType = null;
     let searchedColumnSetName = null;
 
     const search = (
-      configArg, searchNameArg, searchDescriptorArg, listTypeArg, columnSetNameArg,
+      configArg, searchNameArg, searchDescriptorArg, columnSetNameArg,
     ) => {
       searchedConfig = configArg;
       searchedSearchName = searchNameArg;
       searchedSearchDescriptor = searchDescriptorArg;
-      searchedListType = listTypeArg;
       searchedColumnSetName = columnSetNameArg;
     };
 
@@ -212,7 +210,6 @@ describe('SearchPanel', () => {
     searchedConfig.should.equal(config);
     searchedSearchName.should.equal(searchName);
     searchedSearchDescriptor.should.equal(searchDescriptor);
-    searchedListType.should.equal('common');
     searchedColumnSetName.should.equal('default');
 
     changedToSearchDescriptor.should.equal(searchDescriptor);
@@ -222,16 +219,14 @@ describe('SearchPanel', () => {
     let searchedConfig = null;
     let searchedSearchName = null;
     let searchedSearchDescriptor = null;
-    let searchedListType = null;
     let searchedColumnSetName = null;
 
     const search = (
-      configArg, searchNameArg, searchDescriptorArg, listTypeArg, columnSetNameArg,
+      configArg, searchNameArg, searchDescriptorArg, columnSetNameArg,
     ) => {
       searchedConfig = configArg;
       searchedSearchName = searchNameArg;
       searchedSearchDescriptor = searchDescriptorArg;
-      searchedListType = listTypeArg;
       searchedColumnSetName = columnSetNameArg;
     };
 
@@ -286,7 +281,6 @@ describe('SearchPanel', () => {
     searchedConfig.should.equal(config);
     searchedSearchName.should.equal(searchName);
     searchedSearchDescriptor.should.equal(newSearchDescriptor);
-    searchedListType.should.equal('common');
     searchedColumnSetName.should.equal('default');
 
     changedToSearchDescriptor.should.equal(newSearchDescriptor);
diff --git a/test/specs/components/search/SearchResultSummary.spec.jsx b/test/specs/components/search/SearchResultSummary.spec.jsx
@@ -8,6 +8,7 @@ import { ERR_API } from '../../../../src/constants/errorCodes';
 import createTestContainer from '../../../helpers/createTestContainer';
 import { render } from '../../../helpers/renderHelpers';
 import SearchResultSummary from '../../../../src/components/search/SearchResultSummary';
+import { searchKey } from '../../../../src/reducers/search';
 
 chai.should();
 
@@ -51,6 +52,7 @@ describe('SearchResultSummary', () => {
   });
 
   it('should render a not allowed message if a 401 search error is supplied', function test() {
+    const searchName = 'search-summary-test';
     const searchError = Immutable.fromJS({
       code: ERR_API,
       error: {
@@ -60,11 +62,24 @@ describe('SearchResultSummary', () => {
       },
     });
 
+    const storeWithError = mockStore({
+      search: Immutable.fromJS({
+        [searchName]: {
+          byKey: {
+            [searchKey(searchDescriptor)]: {
+              error: searchError,
+            },
+          },
+        },
+      }),
+    });
+
     render(
       <IntlProvider locale="en">
-        <StoreProvider store={store}>
+        <StoreProvider store={storeWithError}>
           <Router>
             <SearchResultSummary
+              searchName={searchName}
               searchDescriptor={searchDescriptor}
               searchError={searchError}
             />
diff --git a/test/specs/components/search/SearchResultTable.spec.jsx b/test/specs/components/search/SearchResultTable.spec.jsx
diff --git a/test/specs/components/search/SearchResultTraverser.spec.jsx b/test/specs/components/search/SearchResultTraverser.spec.jsx
