feature/dep315: Fixed api linting errors, fixed failing web unit test.

Author: jareth-whitney

api/src/api/models/engagement.py

@@ -275,7 +275,7 @@ def _filter_by_engagement_status(query, search_options):
                     for status in search_options.get('engagement_status', [])]
         if not statuses:
             return query
-        
+
         allowed_statuses = [
             Status.Draft.value,
             Status.Published.value,
@@ -307,7 +307,7 @@ def _filter_by_engagement_status(query, search_options):
                     Engagement.end_date < datetime.now()
                 )
             )
-        
+
         if EngagementDisplayStatus.Unpublished.value in statuses:
             status_filter.append(Engagement.status_id ==
                                  Status.Unpublished.value)

web/src/components/engagement/admin/create/authoring/AuthoringFeedback.tsx

@@ -14,10 +14,10 @@ import { getEditorStateFromRaw } from 'components/common/RichTextEditor/utils';
 import ConfirmModal from 'components/common/Modals/ConfirmModal';
 import { EngagementStatus } from 'constants/engagementStatus';
 import { AuthoringFormContainer, AuthoringFormSection } from './AuthoringFormLayout';
-import { tryParse } from './utils';
 import { getEngagementTranslationByCode } from 'services/engagementService';
 import { useAuthoringPageHydration } from './useAuthoringPageHydration';
 import { AppConfig } from 'config';
+import { tryParse } from 'helper';
 
 type SelectOption = { label: string; value: number };
 
@@ -56,7 +56,7 @@ const AuthoringFeedback = () => {
             ...defaultValuesObject,
             form_source: pageName,
             id: Number(loadedEngagement.id),
-            status_id: Number(loadedEngagement.id),
+            status_id: Number(loadedEngagement.status_id),
             feedback_heading: feedbackHeading || '',
             feedback_body: tryParse(feedbackBody) ? getEditorStateFromRaw(feedbackBody) || '' : '',
             selected_survey_id: loadedEngagement.surveys?.find(

web/src/components/engagement/admin/create/authoring/AuthoringSummary.tsx

@@ -13,10 +13,10 @@ import WidgetPicker from '../widgets';
 import { WidgetLocation } from 'models/widget';
 import { getEditorStateFromRaw } from 'components/common/RichTextEditor/utils';
 import { AuthoringFormContainer, AuthoringFormSection } from './AuthoringFormLayout';
-import { tryParse } from './utils';
 import { getEngagementTranslationByCode } from 'services/engagementService';
 import { useAuthoringPageHydration } from './useAuthoringPageHydration';
 import { AppConfig } from 'config';
+import { tryParse } from 'helper';
 
 const AuthoringSummary = () => {
     const { setDefaultValues, fetcher, pageName }: AuthoringTemplateOutletContext = useOutletContext(); // Access the form functions and values from the authoring template.

web/src/components/engagement/admin/create/authoring/utils.ts

@@ -16,9 +16,9 @@ import { CustomTextField, Select } from 'components/common/Input';
 import { When } from 'react-if';
 import { BodyText } from 'components/common/Typography/Body';
 import { LandingDataContext } from '.';
-import { tryParse } from 'engagements/admin/create/authoring/utils';
 import { getSearchParamObject, updateSearchParams } from './utils';
 import { EngagementDisplayStatus } from 'constants/engagementStatus';
+import { tryParse } from 'helper';
 
 const FilterBlock = () => {
     const { searchParams, setSearchParams, clearFilters, setFiltersOpen } = useContext(LandingDataContext);

web/src/components/landing/FilterBlock.tsx

@@ -3,8 +3,8 @@ import { defaultLandingStatuses, defaultSearchFilters, validSortOrders } from '.
 import { getMetadataFilters } from 'services/engagementMetadataService';
 import { LandingLoaderData, SortOrder } from './types';
 import { LoaderFunctionArgs } from 'react-router';
-import { tryParse } from 'engagements/admin/create/authoring/utils';
 import { EngagementStatus } from 'constants/engagementStatus';
+import { tryParse } from 'helper';
 
 const landingLoader = ({ request }: LoaderFunctionArgs): LandingLoaderData => {
     // Retrieve params

web/src/components/landing/landingLoader.tsx

@@ -1,4 +1,4 @@
-import { tryParse } from 'engagements/admin/create/authoring/utils';
+import { tryParse } from 'helper';
 import { SearchFilters } from './types';
 
 export const updateSearchParams = (newFilters: SearchFilters, searchParams: URLSearchParams) => {

web/src/components/landing/utils.ts

@@ -58,3 +58,17 @@ export const levenshteinDistance = (string1: string, string2: string): number =>
     }
     return previousRow[string2.length];
 };
+
+// Determines whether a string is JSON parseable and returns the JSON if it is.
+export const tryParse = (json: string | null | undefined) => {
+    if (!json || typeof json !== 'string') {
+        return false;
+    }
+    try {
+        const object = JSON.parse(json);
+        if (object && typeof object === 'object') {
+            return object;
+        }
+    } catch {}
+    return false;
+};

web/src/helper/index.ts

@@ -27,6 +27,10 @@ jest.mock('react-router', () => ({
     ...jest.requireActual('react-router'),
     useLoaderData: jest.fn(),
     useSearchParams: () => [new URLSearchParams(), jest.fn()],
+    useRevalidator: () => ({
+        revalidate: jest.fn(),
+        state: 'idle',
+    }),
 }));
 
 jest.mock('hooks', () => ({
@@ -87,7 +91,7 @@ const populateLoaderData = () => {
             items: [openEngagement, closedEngagement],
             total: 2,
         }),
-        filters: Promise.resolve([]),
+        allMetaFilters: Promise.resolve([]),
     });
 };
 
@@ -170,7 +174,7 @@ describe('Landing page tests', () => {
                 items: [],
                 total: 0,
             }),
-            filters: Promise.resolve([]),
+            allMetaFilters: Promise.resolve([]),
         });
 
         renderLanding();