fix: resolve incorrect or missing 'await' usages (#2592)

* chore: fix incorrect or missing 'await' usages
* test: fix broken test
* chore: ignore lines causing patch coverage to fail

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 dispatch() IS returning a promise.
     await dispatch(saveLiveConfiguration(courseId, values, navigate));
   };
 

plugins/course-apps/ora_settings/Settings.jsx

@@ -48,8 +48,9 @@ const ORASettings = ({ onClose }) => {
     event.preventDefault();
 
     success = success && await handleSettingsSave(formValues);
-    await setSaveError(!success);
+    setSaveError(!success);
     if ((initialFormValues.enableFlexiblePeerGrade !== formValues.enableFlexiblePeerGrade) && success) {
+      // oxlint-disable-next-line @typescript-eslint/await-thenable - this dispatch() IS returning a promise.
       success = await dispatch(updateModel({
         modelType: 'courseApps',
         model: {

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 dispatch() IS returning a promise.
       success = await dispatch(updateXpertSettings(courseId, values));
     } else {
+      // oxlint-disable-next-line @typescript-eslint/await-thenable - this dispatch() IS returning a promise.
       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 dispatch() IS returning a promise.
     await dispatch(updateCourseCertificate(courseId, values));
     setEditModes({});
     dispatch(setMode(MODE_STATES.view));

src/content-tags-drawer/data/apiHooks.ts

@@ -172,6 +172,7 @@ export const useContentTaxonomyTagsUpdater = (contentId: string) => {
         // feature to support the legacy Django template courseware page.
 
         // Sends content tags.
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         getContentTaxonomyTagsData(contentId).then((data) => {
           const contentData = { contentId, ...data };
 
@@ -187,6 +188,7 @@ export const useContentTaxonomyTagsUpdater = (contentId: string) => {
         });
 
         // Sends tags count.
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         getContentTaxonomyTagsCount(contentId).then((count) => {
           const contentData = { contentId, count };
 

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-libraries/LegacyLibContentBlockAlert.tsx

@@ -31,11 +31,13 @@ const LegacyLibContentBlockAlert = ({ courseId }: Props) => {
     if (taskStatus.data?.state === UserTaskStatus.Succeeded) {
       showToast(intl.formatMessage(messages.legacyLibReadyToMigrateTaskCompleted));
       setTaskId(undefined);
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       refetch();
     } else if (taskStatus.data?.state === UserTaskStatus.Failed
       || taskStatus.data?.state === UserTaskStatus.Cancelled) {
       showToast(intl.formatMessage(messages.legacyLibReadyToMigrateTaskFailed));
       setTaskId(undefined);
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       refetch();
     } else if (taskId) {
       showToast(intl.formatMessage(messages.legacyLibReadyToMigrateTaskInProgress));

src/course-outline/CourseOutline.test.tsx

@@ -471,11 +471,11 @@ describe('<CourseOutline />', () => {
     const dummyBtn = await screen.findByRole('button', { name: 'Dummy button' });
     fireEvent.click(dummyBtn);
 
-    waitFor(() => expect(axiosMock.history.post.length).toBe(3));
+    await waitFor(() => expect(axiosMock.history.post.length).toBe(3));
 
     const [section] = courseOutlineIndexMock.courseStructure.childInfo.children;
     const [subsection] = section.childInfo.children;
-    waitFor(() => {
+    await waitFor(() => {
       expect(axiosMock.history.post[2].data).toBe(JSON.stringify({
         type: COMPONENT_TYPES.libraryV2,
         category: 'vertical',
@@ -509,10 +509,10 @@ describe('<CourseOutline />', () => {
     const dummyBtn = await screen.findByRole('button', { name: 'Dummy button' });
     fireEvent.click(dummyBtn);
 
-    waitFor(() => expect(axiosMock.history.post.length).toBe(3));
+    await waitFor(() => expect(axiosMock.history.post.length).toBe(3));
 
     const [section] = courseOutlineIndexMock.courseStructure.childInfo.children;
-    waitFor(() => {
+    await waitFor(() => {
       expect(axiosMock.history.post[2].data).toBe(JSON.stringify({
         type: COMPONENT_TYPES.libraryV2,
         category: 'sequential',
@@ -545,10 +545,10 @@ describe('<CourseOutline />', () => {
     const dummyBtn = await screen.findByRole('button', { name: 'Dummy button' });
     fireEvent.click(dummyBtn);
 
-    waitFor(() => expect(axiosMock.history.post.length).toBe(3));
+    await waitFor(() => expect(axiosMock.history.post.length).toBe(3));
 
     const courseUsageKey = courseOutlineIndexMock.courseStructure.id;
-    waitFor(() => {
+    await waitFor(() => {
       expect(axiosMock.history.post[2].data).toBe(JSON.stringify({
         type: COMPONENT_TYPES.libraryV2,
         category: 'chapter',

src/course-outline/OutlineAddChildButtons.tsx

@@ -321,6 +321,7 @@ const LegacyOutlineAddChildButtons = ({
   }
 
   const handleOnComponentSelected = (selected: SelectedComponent) => {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     onUseLibraryContent(selected);
     closeAddLibrarySectionModal();
   };