UIPFU-77 - Add 'User assignment status' filter group (#249)

* UIPFU-77 - Add 'User assignment status' filter group * UIPFU-77 - Update change log * UIPFU-77 - yarn.lock * UIPFU-77 - update test script * UIPFU-77 - refine complexity * UIPFU-77 - cleanup * UIPFU-77 - add comments * UIPFU-77 - fix review comments * UIPFU-77 - fix review comments * UIPFU-fix review comments * Update src/UserSearchContainer.js Co-authored-by: Artem Blazhko <[email protected]> --------- Co-authored-by: Artem Blazhko <[email protected]>
folio-org · Jan 16, 2024 · 32f0730 · 32f0730
1 parent 1e3f510
commit 32f0730
Show file tree

Hide file tree

Showing 15 changed files with 1,977 additions and 61 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -1,4 +1,27 @@
 {
   "parser": "@babel/eslint-parser",
-  "extends": "@folio/eslint-config-stripes"
+  "extends": "@folio/eslint-config-stripes",
+  "overrides": [
+    {
+      "files": [ "src/**/tests/*", "*.test.js", "test/**/*" ],
+      "rules": {
+        "react/prop-types": "off",
+        "import/prefer-default-export": "off"
+      }
+    }
+  ],
+  "env": {
+    "jest": true
+  },
+  "settings": {
+    "import/resolver": {
+      "alias": {
+        "map": [
+          ["__mock__", "./test/jest/__mock__"],
+          ["fixtures", "./test/jest/fixtures"],
+          ["helpers", "./test/jest/helpers"]
+        ]
+      }
+    }
+  }
 }
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 node_modules
-artifacts
+artifacts
+junit.xml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## 7.1.0 IN PROGRESS
 
+* Add "User assignment status" filter group. Refs UIPFU-77.
+
 ## [7.0.0](https://github.com/folio-org/ui-plugin-find-user/tree/v7.0.0) (2023-10-12)
 [Full Changelog](https://github.com/folio-org/ui-plugin-find-user/compare/v6.3.0...v7.0.0)
 

diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,10 @@
+const path = require('path');
+const config = require('@folio/jest-config-stripes');
+
+module.exports = {
+  ...config,
+  setupFiles: [
+    ...config.setupFiles,
+    path.join(__dirname, './test/jest/setupFiles.js'),
+  ],
+};
diff --git a/package.json b/package.json
@@ -25,7 +25,8 @@
     "lint": "eslint .",
     "build-mod-descriptor": "stripes mod descriptor --full --strict | jq '.[]' > module-descriptor.json ",
     "formatjs-compile": "formatjs compile-folder --ast --format simple ./translations/ui-plugin-find-user ./translations/ui-plugin-find-user/compiled",
-    "test": "stripes test karma"
+    "test": "stripes test karma",
+    "test:jest": "jest --ci --coverage --colors"
   },
   "okapiInterfaces": {
     "users": "16.0",
@@ -37,6 +38,7 @@
     "@bigtest/interactor": "^0.9.1",
     "@bigtest/mocha": "^0.5.2",
     "@folio/eslint-config-stripes": "^7.0.0",
+    "@folio/jest-config-stripes": "^2.0.0",
     "@folio/stripes": "^9.0.0",
     "@folio/stripes-cli": "^3.0.0",
     "@folio/stripes-core": "^10.0.0",

diff --git a/src/UserSearchContainer.js b/src/UserSearchContainer.js
@@ -8,7 +8,14 @@ import {
   StripesConnectedSource,
 } from '@folio/stripes/smart-components';
 
-import filterConfig from './filterConfig';
+import filterConfig, { filterConfigWithUserAssignedStatus } from './filterConfig';
+import { updateResourceData } from './utils';
+import {
+  ASSIGNED_FILTER_KEY,
+  UNASSIGNED_FILTER_KEY,
+  UAS,
+  ASSIGNED,
+} from './constants';
 
 const INITIAL_RESULT_COUNT = 30;
 const RESULT_COUNT_INCREMENT = 30;
@@ -32,6 +39,28 @@ const compileQuery = template(
   { interpolate: /%{([\s\S]+?)}/g }
 );
 
+export function buildQuery(queryParams, pathComponents, resourceData, logger, props) {
+  const filters = props.initialSelectedUsers ? filterConfigWithUserAssignedStatus : filterConfig;
+  const updatedResourceData = props.initialSelectedUsers && resourceData?.query?.filters?.includes(UAS) ? updateResourceData(resourceData) : resourceData;
+
+  return makeQueryFunction(
+    'cql.allRecords=1',
+    (parsedQuery, _, localProps) => localProps.query.query.trim().split(/\s+/).map(query => compileQuery({ query })).join(' and '),
+    {
+      // the keys in this object must match those passed to
+      // SearchAndSort's columnMapping prop
+      'active': 'active',
+      'name': 'personal.lastName personal.firstName',
+      'patronGroup': 'patronGroup.group',
+      'username': 'username',
+      'barcode': 'barcode',
+      'email': 'personal.email',
+    },
+    filters,
+    2,
+  )(queryParams, pathComponents, updatedResourceData, logger, props);
+}
+
 class UserSearchContainer extends React.Component {
   static manifest = Object.freeze({
     initializedFilterConfig: { initialValue: false },
@@ -46,24 +75,7 @@ class UserSearchContainer extends React.Component {
       perRequest: 100,
       path: 'users',
       GET: {
-        params: {
-          query: makeQueryFunction(
-            'cql.allRecords=1',
-            (parsedQuery, props, localProps) => localProps.query.query.trim().split(/\s+/).map(query => compileQuery({ query })).join(' and '),
-            {
-              // the keys in this object must match those passed to
-              // SearchAndSort's columnMapping prop
-              'active': 'active',
-              'name': 'personal.lastName personal.firstName',
-              'patronGroup': 'patronGroup.group',
-              'username': 'username',
-              'barcode': 'barcode',
-              'email': 'personal.email',
-            },
-            filterConfig,
-            2,
-          ),
-        },
+        params: { query: buildQuery },
         staticFallback: { params: {} },
       },
     },
@@ -113,6 +125,7 @@ class UserSearchContainer extends React.Component {
     */
     // eslint-disable-next-line react/no-unused-prop-types
     tenantId: PropTypes.string.isRequired,
+    initialSelectedUsers: PropTypes.object,
   }
 
   constructor(props) {
@@ -168,6 +181,35 @@ class UserSearchContainer extends React.Component {
     return get(this.props.resources, 'query', {});
   }
 
+  getUsers = () => {
+    const {
+      resources,
+      initialSelectedUsers,
+    } = this.props;
+    const fetchedUsers = get(resources, 'records.records', []);
+    const activeFilters = get(resources, 'query.filters', '');
+    const assignedUsers = Object.values(initialSelectedUsers);
+
+    if (activeFilters === ASSIGNED_FILTER_KEY) return assignedUsers;
+
+    if (activeFilters.includes(UAS)) {
+      const assignedUserIds = Object.keys(initialSelectedUsers);
+      const hasBothUASFilters = activeFilters.includes(ASSIGNED_FILTER_KEY) && activeFilters.includes(UNASSIGNED_FILTER_KEY);
+      const hasNoneOfUASFilters = !activeFilters.includes(ASSIGNED_FILTER_KEY) && !activeFilters.includes(UNASSIGNED_FILTER_KEY);
+      const uasFilterValue = activeFilters.split(',').filter(f => f.includes(UAS))[0].split('.')[1];
+
+      if (hasBothUASFilters || hasNoneOfUASFilters) {
+        return fetchedUsers;
+      }
+
+      if (uasFilterValue === ASSIGNED) {
+        return fetchedUsers.filter(u => assignedUserIds.includes(u.id));
+      }
+      return fetchedUsers.filter(u => !assignedUserIds.includes(u.id));
+    }
+    return fetchedUsers;
+  }
+
   render() {
     const {
       resources,
@@ -188,7 +230,7 @@ class UserSearchContainer extends React.Component {
       resultOffset,
       data: {
         patronGroups: (resources.patronGroups || {}).records || [],
-        users: get(resources, 'records.records', []),
+        users: this.getUsers(),
       },
     });
   }

diff --git a/src/UserSearchModal.js b/src/UserSearchModal.js
@@ -110,6 +110,7 @@ class UserSearchModal extends Component {
           {...this.props}
           onComponentWillUnmount={onCloseModal}
           tenantId={tenantId || stripes.okapi.tenant}
+          initialSelectedUsers={initialSelectedUsers}
         >
           {(viewProps) => <UserSearchView
             {...viewProps}

diff --git a/src/UserSearchView.js b/src/UserSearchView.js
@@ -24,7 +24,7 @@ import {
   SearchAndSortSearchButton as FilterPaneToggle,
 } from '@folio/stripes/smart-components';
 
-import filterConfig from './filterConfig';
+import filterConfig, { filterConfigWithUserAssignedStatus } from './filterConfig';
 import Filters from './Filters';
 
 import css from './UserSearch.css';
@@ -173,6 +173,13 @@ class UserSearchView extends React.Component {
 
   isSelected = ({ item }) => Boolean(this.state.checkedMap[item.id]);
 
+  getFilterConfig = () => {
+    if (this.props.initialSelectedUsers) {
+      return filterConfigWithUserAssignedStatus;
+    }
+    return filterConfig;
+  }
+
   render() {
     const {
       onSelectRow,
@@ -200,7 +207,7 @@ class UserSearchView extends React.Component {
     const builtVisibleColumns = isMultiSelect ? ['isChecked', ...visibleColumns] : visibleColumns;
 
     const query = queryGetter ? queryGetter() || {} : {};
-    const count = source ? source.totalCount() : 0;
+    const count = users?.length;
     const sortOrder = query.sort || '';
     const resultsStatusMessage = source ? (
       <div data-test-find-user-no-results-message>
@@ -339,7 +346,7 @@ class UserSearchView extends React.Component {
                               <Filters
                                 onChangeHandlers={getFilterHandlers()}
                                 activeFilters={activeFilters}
-                                config={filterConfig}
+                                config={this.getFilterConfig()}
                                 resultOffset={resultOffset}
                               />
                             </form>

diff --git a/src/constants.js b/src/constants.js
@@ -0,0 +1,5 @@
+/* eslint-disable import/prefer-default-export */
+export const UAS = 'uas';
+export const ASSIGNED_FILTER_KEY = 'uas.Assigned';
+export const UNASSIGNED_FILTER_KEY = 'uas.Unassigned';
+export const ASSIGNED = 'Assigned';
diff --git a/src/filterConfig.js b/src/filterConfig.js
@@ -27,4 +27,25 @@ const filterConfig = [
   },
 ];
 
+export const filterConfigWithUserAssignedStatus = [
+  ...filterConfig,
+  {
+    label: <FormattedMessage id="ui-plugin-find-user.userAssignmentStatus" />,
+    name: 'uas',
+    cql: 'uas',
+    values: [
+      {
+        name: 'Assigned',
+        cql: 'true',
+        displayName: <FormattedMessage id="ui-plugin-find-user.assigned" />,
+      },
+      {
+        name: 'Unassigned',
+        cql: 'false',
+        displayName: <FormattedMessage id="ui-plugin-find-user.unassigned" />,
+      },
+    ],
+  },
+];
+
 export default filterConfig;
diff --git a/src/utils.js b/src/utils.js
@@ -0,0 +1,26 @@
+import cloneDeep from 'lodash/cloneDeep';
+import {
+  ASSIGNED_FILTER_KEY,
+  UNASSIGNED_FILTER_KEY,
+  UAS,
+} from './constants';
+
+// eslint-disable-next-line import/prefer-default-export
+export const updateResourceData = (rData) => {
+  const filterString = rData?.query?.filters;
+  const newRData = cloneDeep(rData);
+  if (filterString === UNASSIGNED_FILTER_KEY || filterString === `${ASSIGNED_FILTER_KEY},${UNASSIGNED_FILTER_KEY}` || filterString === `${UNASSIGNED_FILTER_KEY},${ASSIGNED_FILTER_KEY}`) {
+  /*
+  * When Unassigned filter is selected on 'User assignment Status' filter group, with no other filter from other groups,
+  * fetch all the user records. The filter string is adjusted to include both active and inactive status filters. This will result in (cql.allRecords=1)
+  *
+  * The same applies when both Assigned and Unassigned are selected in any sequential order.
+  */
+    const alteredfilters = 'active.active,active.inactive';
+    newRData.query.filters = alteredfilters;
+  } else {
+    const alteredfilters = newRData.query.filters.split(',').filter(str => !str.startsWith(UAS)).join(',');
+    newRData.query.filters = alteredfilters;
+  }
+  return newRData;
+};
diff --git a/src/utils.test.js b/src/utils.test.js
@@ -0,0 +1,57 @@
+import { updateResourceData } from './utils';
+import { UNASSIGNED_FILTER_KEY, ASSIGNED_FILTER_KEY } from './constants';
+
+describe('updatedResourceData', () => {
+  describe('when only UnAssigned filter is selected', () => {
+    [UNASSIGNED_FILTER_KEY, `${ASSIGNED_FILTER_KEY},${UNASSIGNED_FILTER_KEY}`, `${UNASSIGNED_FILTER_KEY},${ASSIGNED_FILTER_KEY}`].forEach(filterStr => (
+      it(`should remove ${filterStr} from filter string and add active and inactive filter strings`, () => {
+        const resourceData = {
+          query: {
+            filters: filterStr,
+          }
+        };
+        const expectedResourceData = {
+          query: {
+            ...resourceData.query,
+            filters: 'active.active,active.inactive',
+          },
+        };
+        expect(updateResourceData(resourceData)).toMatchObject(expectedResourceData);
+      })
+    ));
+  });
+
+  describe('when Unassigned filter is selected along with filters from other filter groups', () => {
+    it('should remove Unassigned filter and return the rest', () => {
+      const resourceData = {
+        query: {
+          filters: `${UNASSIGNED_FILTER_KEY},active.active`,
+        }
+      };
+      const expectedResourceData = {
+        query: {
+          ...resourceData.query,
+          filters: 'active.active',
+        },
+      };
+      expect(updateResourceData(resourceData)).toMatchObject(expectedResourceData);
+    });
+  });
+
+  describe('when Assigned filter is selected with or without combination of filters from other filter groups', () => {
+    it('should remove assigned filter string', () => {
+      const resourceData = {
+        query: {
+          filters: `${ASSIGNED_FILTER_KEY},active.active`,
+        }
+      };
+      const expectedResourceData = {
+        query: {
+          ...resourceData.query,
+          filters: 'active.active',
+        },
+      };
+      expect(updateResourceData(resourceData)).toMatchObject(expectedResourceData);
+    });
+  });
+});
diff --git a/test/jest/setupFiles.js b/test/jest/setupFiles.js
@@ -0,0 +1,4 @@
+// See https://github.com/facebook/jest/issues/335#issuecomment-703691592
+// import './__mock__';
+
+import 'regenerator-runtime/runtime';
diff --git a/translations/ui-plugin-find-user/en.json b/translations/ui-plugin-find-user/en.json
@@ -14,5 +14,8 @@
   "information.username": "Username",
   "contact.email": "Email",
   "status": "Status",
-  "inactive": "Inactive"
+  "inactive": "Inactive",
+  "userAssignmentStatus": "User Assignment Status",
+  "assigned": "Assigned",
+  "unassigned": "Unassigned"
 }