chore: fix incorrect or missing 'await' usages

Author: bradenmacdonald

plugins/course-apps/live/Settings.jsx

@@ -72,6 +72,7 @@ const LiveSettings = ({
   };
 
   const handleSettingsSave = async (values) => {
+    // oxlint-disable-next-line @typescript-eslint/await-thenable - this IS a promise; it just has wrong type info.
     await dispatch(saveLiveConfiguration(courseId, values, navigate));
   };
 

plugins/course-apps/ora_settings/Settings.jsx

@@ -48,7 +48,7 @@ const ORASettings = ({ onClose }) => {
     event.preventDefault();
 
     success = success && await handleSettingsSave(formValues);
-    await setSaveError(!success);
+    setSaveError(!success);
     if ((initialFormValues.enableFlexiblePeerGrade !== formValues.enableFlexiblePeerGrade) && success) {
       success = await dispatch(updateModel({
         modelType: 'courseApps',

plugins/course-apps/ora_settings/Settings.test.jsx

@@ -128,7 +128,7 @@ describe('ORASettings', () => {
     await mockStore({ apiStatus: 200, enabled: true });
     renderComponent();
 
-    const checkbox = await screen.getByRole('checkbox', { name: /Flex Peer Grading/ });
+    const checkbox = screen.getByRole('checkbox', { name: /Flex Peer Grading/ });
     expect(checkbox).toBeChecked();
 
     await waitFor(() => {

plugins/course-apps/xpert_unit_summary/settings-modal/SettingsModal.jsx

@@ -239,8 +239,10 @@ const SettingsModal = ({
     const values = { ...rest, enabled: enabled ? checked === 'true' : undefined };
 
     if (enabled) {
+      // oxlint-disable-next-line @typescript-eslint/await-thenable - this IS a promise; it just has wrong type info.
       success = await dispatch(updateXpertSettings(courseId, values));
     } else {
+      // oxlint-disable-next-line @typescript-eslint/await-thenable - this IS a promise; it just has wrong type info.
       success = await dispatch(removeXpertSettings(courseId));
     }
 

src/certificates/certificates-list/hooks/useCertificatesList.jsx

@@ -25,6 +25,7 @@ const useCertificatesList = (courseId) => {
   }));
 
   const handleSubmit = async (values) => {
+    // oxlint-disable-next-line @typescript-eslint/await-thenable - this IS a promise; it just has wrong type info.
     await dispatch(updateCourseCertificate(courseId, values));
     setEditModes({});
     dispatch(setMode(MODE_STATES.view));

src/course-checklist/CourseChecklist.test.jsx

@@ -46,9 +46,9 @@ describe('CourseChecklistPage', () => {
   });
   describe('renders', () => {
     describe('if enable_quality prop is true', () => {
-      it('two checklist components ', () => {
+      it('two checklist components ', async () => {
         renderComponent();
-        mockStore(200);
+        await mockStore(200);
 
         expect(screen.getByText(messages.launchChecklistLabel.defaultMessage)).toBeVisible();
 
@@ -67,7 +67,7 @@ describe('CourseChecklistPage', () => {
 
         it('correct content when the launch checklist has loaded', async () => {
           renderComponent();
-          mockStore(404);
+          await mockStore(404);
           await waitFor(() => {
             const { launchChecklistStatus } = store.getState().courseChecklist.loadingStatus;
 
@@ -79,7 +79,7 @@ describe('CourseChecklistPage', () => {
 
         it('correct content when the best practices checklist is loading', async () => {
           renderComponent();
-          mockStore(404);
+          await mockStore(404);
           await waitFor(() => {
             const { bestPracticeChecklistStatus } = store.getState().courseChecklist.loadingStatus;
 
@@ -100,9 +100,9 @@ describe('CourseChecklistPage', () => {
         });
       });
 
-      it('one checklist components ', () => {
+      it('one checklist components ', async () => {
         renderComponent();
-        mockStore(200);
+        await mockStore(200);
 
         expect(screen.getByText(messages.launchChecklistLabel.defaultMessage)).toBeVisible();
 
@@ -112,7 +112,7 @@ describe('CourseChecklistPage', () => {
       describe('an aria-live region with', () => {
         it('correct content when the launch checklist has loaded', async () => {
           renderComponent();
-          mockStore(404);
+          await mockStore(404);
           await waitFor(() => {
             const { launchChecklistStatus } = store.getState().courseChecklist.loadingStatus;
 
@@ -124,7 +124,7 @@ describe('CourseChecklistPage', () => {
 
         it('correct content when the best practices checklist is loading', async () => {
           renderComponent();
-          mockStore(404);
+          await mockStore(404);
           await waitFor(() => {
             const { bestPracticeChecklistStatus } = store.getState().courseChecklist.loadingStatus;
 

src/course-unit/CourseUnit.test.jsx

@@ -7,7 +7,14 @@ import {
 import { cloneDeep, set } from 'lodash';
 
 import {
-  act, fireEvent, render, waitFor, within, screen, initializeMocks,
+  act,
+  cleanup,
+  fireEvent,
+  initializeMocks,
+  render,
+  waitFor,
+  within,
+  screen,
 } from '@src/testUtils';
 import { IFRAME_FEATURE_POLICY } from '@src/constants';
 import { mockWaffleFlags } from '@src/data/apiHooks.mock';
@@ -790,9 +797,10 @@ describe('<CourseUnit />', () => {
       .reply(200, {
         ...updatedCourseSectionVerticalData,
       });
+    cleanup(); // clear the first render before we create the second.
     render(<RootWrapper />);
     // to wait for loading
-    screen.findByTestId('unit-header-title');
+    await screen.findByTestId('unit-header-title');
     // The new unit button should not be visible when childAddable is false
     expect(
       screen.queryByRole('button', { name: courseSequenceMessages.newUnitBtnText.defaultMessage }),

src/library-authoring/hierarchy/ItemHierarchyPublisher.tsx

@@ -123,10 +123,10 @@ export const ItemHierarchyPublisher = ({
           {intl.formatMessage(messages.publishCancel)}
         </Button>
         <LoadingButton
-          onClick={async (e) => {
+          onClick={(e) => {
             e.preventDefault();
             e.stopPropagation();
-            await handlePublish();
+            handlePublish();
           }}
           variant="primary rounded-0"
           label={intl.formatMessage(messages.publishConfirm)}

src/optimizer-page/scan-results/ScanResults.tsx

@@ -460,6 +460,7 @@ const ScanResults: FC<Props> = ({
     const handleUpdateCompletion = async () => {
       if (rerunLinkUpdateInProgress === false && isUpdateAllInProgress) {
         try {
+          // oxlint-disable-next-line @typescript-eslint/await-thenable - this IS a promise; it just has wrong type info
           const updateStatusResponse = await dispatch(fetchRerunLinkUpdateStatus(courseId)) as any;
 
           if (!updateStatusResponse) {
@@ -590,13 +591,15 @@ const ScanResults: FC<Props> = ({
     try {
       setUpdatingLinkIds(prev => ({ ...prev, [uniqueId]: true }));
       const contentType = getContentType(sectionId || '');
+      // oxlint-disable-next-line @typescript-eslint/await-thenable - this IS a promise; it just has wrong type info.
       await dispatch(updateSinglePreviousRunLink(courseId, link, blockId, contentType));
 
       const pollForSingleLinkResult = async (attempts = 0): Promise<boolean> => {
         if (attempts > 30) { // Max 30 attempts (60 seconds)
           throw new Error('Timeout waiting for link update result');
         }
 
+        // oxlint-disable-next-line @typescript-eslint/await-thenable - this IS a promise; it just has wrong type info.
         const updateStatusResponse = await dispatch(fetchRerunLinkUpdateStatus(courseId)) as any;
         const pollStatus = updateStatusResponse?.status || updateStatusResponse?.updateStatus;
 
@@ -755,6 +758,7 @@ const ScanResults: FC<Props> = ({
     try {
       setProcessedResponseIds(new Set());
       setIsUpdateAllInProgress(true);
+      // oxlint-disable-next-line @typescript-eslint/await-thenable - this IS a promise; it just has wrong type info.
       await dispatch(updateAllPreviousRunLinks(courseId));
 
       return true;

src/pages-and-resources/app-settings-modal/AppSettingsModal.jsx

@@ -72,21 +72,22 @@ const AppSettingsModal = ({
   const handleFormSubmit = async (values) => {
     let success = true;
     if (appInfo.enabled !== values.enabled) {
+      // oxlint-disable-next-line @typescript-eslint/await-thenable - this IS a promise; it just has wrong type info.
       success = await dispatch(updateAppStatus(courseId, appInfo.id, values.enabled));
     }
     // Call the submit handler for the settings component to save its settings
     if (onSettingsSave) {
       success = success && await onSettingsSave(values);
     }
-    await setSaveError(!success);
+    setSaveError(!success);
     !success && alertRef?.current.scrollIntoView(); // eslint-disable-line @typescript-eslint/no-unused-expressions
   };
 
   const handleFormikSubmit = ({ handleSubmit, errors }) => async (event) => {
     // If submitting the form with errors, show the alert and scroll to it.
     await handleSubmit(event);
     if (Object.keys(errors).length > 0) {
-      await setSaveError(true);
+      setSaveError(true);
       alertRef?.current.scrollIntoView?.(); // eslint-disable-line no-unused-expressions
     }
   };