From 75eb0c307e3fece5ff6ae16ad43c879d77569cc9 Mon Sep 17 00:00:00 2001
From: Raymond Zhou <56318341+rayzhou-bit@users.noreply.github.com>
Date: Fri, 15 Dec 2023 11:52:59 -0800
Subject: [PATCH] fix: datatable state persistence issues (#746)

---
 src/files-and-videos/generic/FileTable.jsx    | 13 +++++++++---
 .../generic/table-components/TableActions.jsx | 12 ++++++++++-
 .../SortAndFilterModal.jsx                    |  5 ++++-
 .../generic/table-components/utils.js         |  4 ++--
 .../generic/table-components/utils.test.js    | 21 ++++++++++++++++---
 5 files changed, 45 insertions(+), 10 deletions(-)

diff --git a/src/files-and-videos/generic/FileTable.jsx b/src/files-and-videos/generic/FileTable.jsx
index f50eae6b5..f58f5c29f 100644
--- a/src/files-and-videos/generic/FileTable.jsx
+++ b/src/files-and-videos/generic/FileTable.jsx
@@ -62,6 +62,14 @@ const FileTable = ({
   const [isAddOpen, setAddOpen, setAddClose] = useToggle(false);
   const [selectedRows, setSelectedRows] = useState([]);
   const [isDeleteConfirmationOpen, openDeleteConfirmation, closeDeleteConfirmation] = useToggle(false);
+  const [initialState, setInitialState] = useState({
+    filters: [],
+    hiddenColumns: [],
+    pageIndex: 0,
+    pageSize: 50,
+    selectedRowIds: {},
+    sortBy: [],
+  });
 
   const {
     loadingStatus,
@@ -143,6 +151,7 @@ const FileTable = ({
         handleOpenDeleteConfirmation,
         supportedFileFormats,
         fileType,
+        setInitialState,
       }}
     />
   );
@@ -193,9 +202,7 @@ const FileTable = ({
           defaultActiveStateValue: defaultVal,
           togglePlacement: 'left',
         }}
-        initialState={{
-          pageSize: 50,
-        }}
+        initialState={initialState}
         tableActions={headerActions}
         bulkActions={headerActions}
         columns={tableColumns}
diff --git a/src/files-and-videos/generic/table-components/TableActions.jsx b/src/files-and-videos/generic/table-components/TableActions.jsx
index 6e775f51c..36d64f587 100644
--- a/src/files-and-videos/generic/table-components/TableActions.jsx
+++ b/src/files-and-videos/generic/table-components/TableActions.jsx
@@ -1,10 +1,11 @@
-import React from 'react';
+import React, { useContext, useEffect } from 'react';
 import _ from 'lodash';
 import { PropTypes } from 'prop-types';
 import { injectIntl, intlShape, FormattedMessage } from '@edx/frontend-platform/i18n';
 import { getConfig } from '@edx/frontend-platform';
 import {
   Button,
+  DataTableContext,
   Dropdown,
   useToggle,
 } from '@edx/paragon';
@@ -20,10 +21,18 @@ const TableActions = ({
   handleOpenDeleteConfirmation,
   encodingsDownloadUrl,
   fileType,
+  setInitialState,
   // injected
   intl,
 }) => {
   const [isSortOpen, openSort, closeSort] = useToggle(false);
+  const { state } = useContext(DataTableContext);
+
+  // This useEffect saves DataTable state so it can persist after table re-renders due to data reload.
+  useEffect(() => {
+    setInitialState(state);
+  }, [state]);
+
   return (
     <>
       <Button variant="outline-primary" onClick={openSort} iconBefore={Tune}>
@@ -95,6 +104,7 @@ TableActions.propTypes = {
   encodingsDownloadUrl: PropTypes.string,
   handleSort: PropTypes.func.isRequired,
   fileType: PropTypes.string.isRequired,
+  setInitialState: PropTypes.func.isRequired,
   intl: intlShape.isRequired,
 };
 
diff --git a/src/files-and-videos/generic/table-components/sort-and-filter-modal/SortAndFilterModal.jsx b/src/files-and-videos/generic/table-components/sort-and-filter-modal/SortAndFilterModal.jsx
index 2739f9d41..8c5796e83 100644
--- a/src/files-and-videos/generic/table-components/sort-and-filter-modal/SortAndFilterModal.jsx
+++ b/src/files-and-videos/generic/table-components/sort-and-filter-modal/SortAndFilterModal.jsx
@@ -20,7 +20,9 @@ const SortAndFilterModal = ({
   // injected
   intl,
 }) => {
-  const { state, setAllFilters, columns } = useContext(DataTableContext);
+  const {
+    state, setAllFilters, columns, gotoPage,
+  } = useContext(DataTableContext);
   const filterOptions = getFilterOptions(columns);
   const currentFilters = getCheckedFilters(state);
   const [sortBy, setSortBy] = useState('dateAdded,desc');
@@ -47,6 +49,7 @@ const SortAndFilterModal = ({
   const handleApply = async () => {
     await handleSort(sortBy);
     processFilters(filterBy, columns, setAllFilters);
+    gotoPage(0);
     closeSort();
   };
 
diff --git a/src/files-and-videos/generic/table-components/utils.js b/src/files-and-videos/generic/table-components/utils.js
index 15dc4ea86..b99118074 100644
--- a/src/files-and-videos/generic/table-components/utils.js
+++ b/src/files-and-videos/generic/table-components/utils.js
@@ -24,8 +24,8 @@ export const getFilters = (state, columns) => {
     if (filterColumn) {
       currentFilters = getFilterDisplayName(filterColumn, value);
     } else {
-      const [serachValue] = value;
-      currentFilters = [{ name: serachValue, value: serachValue }];
+      const searchValue = Array.isArray(value) ? value[0] : value;
+      currentFilters = [{ name: searchValue, value: searchValue }];
     }
     allFilters.push(...currentFilters);
   });
diff --git a/src/files-and-videos/generic/table-components/utils.test.js b/src/files-and-videos/generic/table-components/utils.test.js
index cd9fd1063..126b2986c 100644
--- a/src/files-and-videos/generic/table-components/utils.test.js
+++ b/src/files-and-videos/generic/table-components/utils.test.js
@@ -35,8 +35,8 @@ describe('getCurrentViewRange', () => {
 });
 
 describe('getFilters', () => {
-  it('should return filter when columns is empty', () => {
-    const state = { filters: [{ id: 'test', value: ['unknown'] }] };
+  it('should return filter object for text search with no filters', () => {
+    const state = { filters: [{ id: 'test', value: 'unknown' }] };
     const columns = [];
     const expected = [{ name: 'unknown', value: 'unknown' }];
     const actual = getFilters(state, columns);
@@ -44,7 +44,22 @@ describe('getFilters', () => {
     expect(actual).toEqual(expected);
   });
 
-  it('should return filtern for specific column', () => {
+  it('should return filter object for text search with filters', () => {
+    const state = { filters: [{ id: 'test', value: ['unknown'] }, { id: 'validColumn', value: ['filter1'] }] };
+    const columns = [{
+      id: 'validColumn',
+      filterChoices: [
+        { name: 'Filter 1', value: 'filter1' },
+        { name: 'Filter 2', value: 'filter2' },
+      ],
+    }];
+    const expected = [{ name: 'unknown', value: 'unknown' }, { name: 'Filter 1', value: 'filter1' }];
+    const actual = getFilters(state, columns);
+
+    expect(actual).toEqual(expected);
+  });
+
+  it('should return filter object for no text search with filters', () => {
     const state = { filters: [{ id: 'validColumn', value: ['filter1'] }] };
     const columns = [{
       id: 'validColumn',