Refactor filter criteria management and enhance task analysis table

Author: CollinBeczak

src/components/HOCs/WithFilterCriteria/WithFilterCriteria.jsx

@@ -15,8 +15,9 @@ import {
   buildSearchURL,
 } from "../../../services/SearchCriteria/SearchCriteria";
 
-const DEFAULT_PAGE_SIZE = 20;
-const DEFAULT_CRITERIA = {
+export const DEFAULT_PAGE_SIZE = 20;
+
+export const DEFAULT_CRITERIA = {
   sortCriteria: { sortBy: "name", direction: "DESC" },
   pageSize: DEFAULT_PAGE_SIZE,
   filters: {
@@ -28,6 +29,61 @@ const DEFAULT_CRITERIA = {
   invertFields: {},
 };
 
+/**
+ * Parse a criteria string (URL search params) into a criteria object.
+ * Shared utility for both HOC and hook implementations.
+ *
+ * @param {string} criteriaString - The URL search string to parse
+ * @returns {Object|null} - The parsed criteria object or null
+ */
+export const parseCriteriaString = (criteriaString) => {
+  if (!criteriaString) return null;
+
+  const criteria = buildSearchCriteriafromURL(criteriaString);
+  if (!criteria) return null;
+
+  const keysToSplit = ["status", "reviewStatus", "metaReviewStatus", "priorities", "boundingBox"];
+
+  for (const key of keysToSplit) {
+    if (criteria[key] !== undefined && key === "boundingBox") {
+      if (typeof criteria[key] === "string") {
+        criteria[key] = criteria[key].split(",").map((x) => parseFloat(x));
+      }
+    } else if (criteria?.filters?.[key] !== undefined) {
+      if (typeof criteria.filters[key] === "string") {
+        criteria.filters[key] = criteria.filters[key].split(",").map((x) => _toInteger(x));
+      }
+    }
+  }
+
+  return criteria;
+};
+
+/**
+ * Build included filters from props.
+ * Shared utility for both HOC and hook implementations.
+ * Only includes filter values if the corresponding props exist,
+ * otherwise returns empty object to preserve defaults.
+ */
+export const buildIncludedFilters = (props) => {
+  const filters = {};
+
+  if (props.includeTaskStatuses) {
+    filters.status = _keys(_pickBy(props.includeTaskStatuses, (s) => s));
+  }
+  if (props.includeTaskReviewStatuses) {
+    filters.reviewStatus = _keys(_pickBy(props.includeTaskReviewStatuses, (r) => r));
+  }
+  if (props.includeMetaReviewStatuses) {
+    filters.metaReviewStatus = _keys(_pickBy(props.includeMetaReviewStatuses, (r) => r));
+  }
+  if (props.includeTaskPriorities) {
+    filters.priorities = _keys(_pickBy(props.includeTaskPriorities, (p) => p));
+  }
+
+  return filters;
+};
+
 /**
  * WithFilterCriteria keeps track of the current criteria being used
  * to filter, sort and page the tasks. If a use case requires user app settings for
@@ -52,16 +108,32 @@ export default function WithFilterCriteria(
     };
 
     updateCriteria = (newCriteria) => {
-      const criteria = _cloneDeep(this.state.criteria);
-      criteria.sortCriteria = newCriteria.sortCriteria;
-      criteria.page = newCriteria.page;
-      criteria.filters = newCriteria.filters;
-      criteria.includeTags = newCriteria.includeTags;
+      this.setState(
+        (prevState) => {
+          const criteria = _cloneDeep(prevState.criteria);
 
-      this.setState({ criteria });
-      if (this.props.setSearchFilters) {
-        this.props.setSearchFilters(criteria);
-      }
+          if (newCriteria.sortCriteria !== undefined) {
+            criteria.sortCriteria = newCriteria.sortCriteria;
+          }
+          if (newCriteria.page !== undefined) {
+            criteria.page = newCriteria.page;
+          }
+          if (newCriteria.includeTags !== undefined) {
+            criteria.includeTags = newCriteria.includeTags;
+          }
+
+          if (newCriteria.filters && typeof newCriteria.filters === "object") {
+            criteria.filters = { ...criteria.filters, ...newCriteria.filters };
+          }
+
+          return { criteria };
+        },
+        () => {
+          if (this.props.setSearchFilters) {
+            this.props.setSearchFilters(this.state.criteria);
+          }
+        },
+      );
     };
 
     updateTaskFilterBounds = (bounds, zoom) => {
@@ -101,21 +173,12 @@ export default function WithFilterCriteria(
       const newCriteria = _cloneDeep(DEFAULT_CRITERIA);
       newCriteria.boundingBox = usePersistedFilters ? this.state.criteria.boundingBox : null;
       newCriteria.zoom = this.state.zoom;
-      newCriteria.filters["status"] = _keys(_pickBy(this.props.includeTaskStatuses, (s) => s));
-      newCriteria.filters["reviewStatus"] = _keys(
-        _pickBy(this.props.includeReviewStatuses, (r) => r),
-      );
-      newCriteria.filters["metaReviewStatus"] = _keys(
-        _pickBy(this.props.includeMetaReviewStatuses, (r) => r),
-      );
-      newCriteria.filters["priorities"] = _keys(
-        _pickBy(this.props.includeTaskPriorities, (p) => p),
-      );
 
       if (!ignoreURL) {
         this.props.history.push({
           pathname: this.props.history.location.pathname,
-          state: { refresh: true },
+          search: "",
+          state: {},
         });
       }
 
@@ -131,23 +194,22 @@ export default function WithFilterCriteria(
     setFiltered = (column, value) => {
       const typedCriteria = _cloneDeep(this.state.criteria);
       typedCriteria.filters[column] = value;
-
-      //Reset Page so it goes back to 0
       typedCriteria.page = 0;
       this.setState({ criteria: typedCriteria });
     };
 
     updateIncludedFilters(props, criteria = {}) {
+      const includedFilters = buildIncludedFilters(props);
+
+      this.setState((prevState) => {
+        const typedCriteria = _merge({}, criteria, _cloneDeep(prevState.criteria));
+        typedCriteria.filters = { ...typedCriteria.filters, ...includedFilters };
+        typedCriteria.page = 0;
+        return { criteria: typedCriteria };
+      });
+
       const typedCriteria = _merge({}, criteria, _cloneDeep(this.state.criteria));
-      typedCriteria.filters["status"] = _keys(_pickBy(props.includeTaskStatuses, (s) => s));
-      typedCriteria.filters["reviewStatus"] = _keys(
-        _pickBy(props.includeTaskReviewStatuses, (r) => r),
-      );
-      typedCriteria.filters["metaReviewStatus"] = _keys(
-        _pickBy(props.includeMetaReviewStatuses, (r) => r),
-      );
-      typedCriteria.filters["priorities"] = _keys(_pickBy(props.includeTaskPriorities, (p) => p));
-      this.setState({ criteria: typedCriteria });
+      typedCriteria.filters = { ...typedCriteria.filters, ...includedFilters };
       return typedCriteria;
     }
 
@@ -173,8 +235,6 @@ export default function WithFilterCriteria(
 
       if (!ignoreURL) {
         const searchURL = this.updateURL(this.props, typedCriteria);
-        // If our search on the URL hasn't changed then don't do another
-        // update as we could receive a second update when we change the URL.
         if (_isEqual(this.props.history.location.search, searchURL) && this.state.loading) {
           return;
         }
@@ -188,13 +248,49 @@ export default function WithFilterCriteria(
 
       const criteria = typedCriteria || _cloneDeep(this.state.criteria);
 
+      if (!criteria.boundingBox && this.props.challenge?.bounding) {
+        try {
+          const bounding = this.props.challenge.bounding;
+          if (bounding.bbox) {
+            criteria.boundingBox = bounding.bbox;
+          } else if (bounding.coordinates) {
+            const coords = bounding.coordinates.flat(3);
+            const lngs = coords.filter((_, i) => i % 2 === 0);
+            const lats = coords.filter((_, i) => i % 2 === 1);
+            criteria.boundingBox = [
+              Math.min(...lngs),
+              Math.min(...lats),
+              Math.max(...lngs),
+              Math.max(...lats),
+            ];
+          }
+        } catch (e) {
+          console.warn("Could not extract bounding box from challenge:", e);
+        }
+      }
+
+      if (this.props.includeTaskStatuses) {
+        criteria.filters.status = _keys(_pickBy(this.props.includeTaskStatuses, (s) => s));
+      }
+      if (this.props.includeTaskPriorities) {
+        criteria.filters.priorities = _keys(_pickBy(this.props.includeTaskPriorities, (p) => p));
+      }
+      if (this.props.includeTaskReviewStatuses) {
+        criteria.filters.reviewStatus = _keys(
+          _pickBy(this.props.includeTaskReviewStatuses, (r) => r),
+        );
+      }
+      if (this.props.includeMetaReviewStatuses) {
+        criteria.filters.metaReviewStatus = _keys(
+          _pickBy(this.props.includeMetaReviewStatuses, (r) => r),
+        );
+      }
+
       criteria.filters.archived = true;
 
       this.debouncedTasksFetch(challengeId, criteria, this.state.criteria.pageSize);
     };
 
-    // Debouncing to give a chance for filters and bounds to all be applied before
-    // making the server call.
     debouncedTasksFetch = _debounce((challengeId, criteria, pageSize) => {
       this.props
         .augmentClusteredTasks(challengeId, false, criteria, pageSize, false, ignoreLocked)
@@ -205,30 +301,9 @@ export default function WithFilterCriteria(
 
     updateCriteriaFromURL(props) {
       const criteria = props.history.location.search
-        ? buildSearchCriteriafromURL(props.history.location.search)
+        ? parseCriteriaString(props.history.location.search)
         : _cloneDeep(props.history.location.state);
 
-      // These values will come in as comma-separated strings and need to be turned
-      // into number arrays
-      const keysToSplit = [
-        "status",
-        "reviewStatus",
-        "metaReviewStatus",
-        "priorities",
-        "boundingBox",
-      ];
-      for (const key of keysToSplit) {
-        if (criteria[key] !== undefined && key === "boundingBox") {
-          if (typeof criteria[key] === "string") {
-            criteria[key] = criteria[key].split(",").map((x) => parseFloat(x));
-          }
-        } else if (criteria?.filters?.[key] !== undefined) {
-          if (typeof criteria.filters[key] === "string") {
-            criteria.filters[key] = criteria.filters[key].split(",").map((x) => _toInteger(x));
-          }
-        }
-      }
-
       if (!criteria?.filters?.status) {
         this.updateIncludedFilters(props);
       } else {
@@ -243,36 +318,14 @@ export default function WithFilterCriteria(
           : "";
       const criteria =
         savedFilters && savedFilters.length > 0
-          ? buildSearchCriteriafromURL(savedFilters)
+          ? parseCriteriaString(savedFilters)
           : _cloneDeep(props.history.location.state);
 
-      //Use default filter values if no saved values are present
       if (!criteria) {
         this.updateIncludedFilters(props);
         return;
       }
 
-      // These values will come in as comma-separated strings and need to be turned
-      // into number arrays
-      const keysToSplit = [
-        "status",
-        "reviewStatus",
-        "metaReviewStatus",
-        "priorities",
-        "boundingBox",
-      ];
-      for (const key of keysToSplit) {
-        if (criteria[key] !== undefined && key === "boundingBox") {
-          if (typeof criteria[key] === "string") {
-            criteria[key] = criteria[key].split(",").map((x) => parseFloat(x));
-          }
-        } else if (criteria?.filters?.[key] !== undefined) {
-          if (typeof criteria.filters[key] === "string") {
-            criteria.filters[key] = criteria.filters[key].split(",").map((x) => _toInteger(x));
-          }
-        }
-      }
-
       if (!criteria?.filters?.status) {
         this.updateIncludedFilters(props);
       } else {
@@ -281,6 +334,8 @@ export default function WithFilterCriteria(
     }
 
     componentDidMount() {
+      this.initialLoadTriggered = false;
+
       if (
         !ignoreURL &&
         (!_isEmpty(this.props.history.location.search) ||
@@ -296,10 +351,14 @@ export default function WithFilterCriteria(
 
     componentDidUpdate(prevProps, prevState) {
       const challengeId = this.props.challenge?.id || this.props.challengeId;
+      const prevChallengeId = prevProps?.challenge?.id || prevProps?.challengeId;
+
       if (!challengeId) {
         return;
       }
 
+      const challengeIdJustBecameAvailable = !prevChallengeId && challengeId;
+
       if (!ignoreURL && this.props.history.location?.state?.refresh) {
         this.props.history.push({
           pathname: this.props.history.location.pathname,
@@ -316,22 +375,23 @@ export default function WithFilterCriteria(
 
       let typedCriteria = _cloneDeep(this.state.criteria);
 
-      if (
+      const filterPropsChanged =
         prevProps.includeTaskStatuses !== this.props.includeTaskStatuses ||
         prevProps.includeTaskReviewStatuses !== this.props.includeTaskReviewStatuses ||
         prevProps.includeMetaReviewStatuses !== this.props.includeMetaReviewStatuses ||
-        prevProps.includeTaskPriorities !== this.props.includeTaskPriorities
-      ) {
-        typedCriteria = this.updateIncludedFilters(this.props);
+        prevProps.includeTaskPriorities !== this.props.includeTaskPriorities;
+
+      if (filterPropsChanged) {
+        this.updateIncludedFilters(this.props);
         return;
       }
 
       if (!_isEqual(prevState.criteria, this.state.criteria)) {
         this.refreshTasks(typedCriteria);
-      } else if (
-        prevProps?.challenge?.id !== this.props.challenge?.id ||
-        this.props.challengeId !== prevProps.challengeId
-      ) {
+      } else if (challengeIdJustBecameAvailable || challengeId !== prevChallengeId) {
+        this.refreshTasks(typedCriteria);
+      } else if (!this.initialLoadTriggered) {
+        this.initialLoadTriggered = true;
         this.refreshTasks(typedCriteria);
       } else if (this.props.history.location?.state?.refreshAfterSave) {
         this.refreshTasks(typedCriteria);
@@ -345,6 +405,23 @@ export default function WithFilterCriteria(
     render() {
       const criteria = _cloneDeep(this.state.criteria) || DEFAULT_CRITERIA;
 
+      if (this.props.includeTaskStatuses) {
+        criteria.filters.status = _keys(_pickBy(this.props.includeTaskStatuses, (s) => s));
+      }
+      if (this.props.includeTaskPriorities) {
+        criteria.filters.priorities = _keys(_pickBy(this.props.includeTaskPriorities, (p) => p));
+      }
+      if (this.props.includeTaskReviewStatuses) {
+        criteria.filters.reviewStatus = _keys(
+          _pickBy(this.props.includeTaskReviewStatuses, (r) => r),
+        );
+      }
+      if (this.props.includeMetaReviewStatuses) {
+        criteria.filters.metaReviewStatus = _keys(
+          _pickBy(this.props.includeMetaReviewStatuses, (r) => r),
+        );
+      }
+
       return (
         <WrappedComponent
           defaultPageSize={DEFAULT_PAGE_SIZE}