refactor: fix reveiw issues

openedx · Feb 1, 2024 · 67feee5 · 67feee5
1 parent 837ac4e
commit 67feee5
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 61 deletions.
diff --git a/src/notification-preferences/NotificationPreferenceApp.jsx b/src/notification-preferences/NotificationPreferenceApp.jsx
@@ -41,7 +41,7 @@ const NotificationPreferenceApp = ({ appId }) => {
     return null;
   }
   return (
-    <Collapsible.Advanced open={appToggle} data-testid="notification-app" className="mb-5">
+    <Collapsible.Advanced open={appToggle} data-testid={`${appId}-app`} className="mb-5">
       <Collapsible.Trigger>
         <div className="d-flex align-items-center">
           <span className="mr-auto">

diff --git a/src/notification-preferences/NotificationPreferenceRow.jsx b/src/notification-preferences/NotificationPreferenceRow.jsx
@@ -78,7 +78,7 @@ const NotificationPreferenceRow = ({ appId, preferenceName }) => {
               value={preference[channel]}
               onChange={onToggle}
               disabled={nonEditable.includes(channel) || updatePreferencesStatus === LOADING_STATUS}
-              dataTestId={`${preferenceName}-${channel}`}
+              id={`${preferenceName}-${channel}`}
             />
           </div>
         ))}

diff --git a/src/notification-preferences/NotificationPreferences.test.jsx b/src/notification-preferences/NotificationPreferences.test.jsx
@@ -3,7 +3,7 @@ import { Provider } from 'react-redux';
 import { BrowserRouter as Router } from 'react-router-dom';
 import configureStore from 'redux-mock-store';
 import {
-  fireEvent, render, screen, waitFor, act,
+  fireEvent, render, screen, waitFor, act, within,
 } from '@testing-library/react';
 import * as auth from '@edx/frontend-platform/auth';
 import { IntlProvider } from '@edx/frontend-platform/i18n';
@@ -31,11 +31,11 @@ const defaultPreferences = {
   ],
   preferences: [
     {
-      id: 'newPost',
+      id: 'core',
       appId: 'discussion',
-      web: false,
-      push: false,
-      email: false,
+      web: true,
+      push: true,
+      email: true,
     },
     {
       id: 'newComment',
@@ -59,23 +59,20 @@ const defaultPreferences = {
       email: false,
     },
   ],
-  nonEditable: {},
+  nonEditable: {
+    discussion: {
+      core: [
+        'web',
+      ],
+    },
+  },
 };
 
 const updateChannelPreferences = (toggleVal = false) => ({
   preferences: [
-    {
-      id: 'newPost', appId: 'discussion', web: toggleVal, push: toggleVal, email: toggleVal,
-    },
-    {
-      id: 'newComment', appId: 'discussion', web: toggleVal, push: toggleVal, email: toggleVal,
-    },
-    {
-      id: 'newAssignment', appId: 'coursework', web: toggleVal, push: toggleVal, email: toggleVal,
-    },
-    {
-      id: 'newGrade', appId: 'coursework', web: toggleVal, push: toggleVal, email: toggleVal,
-    },
+    { id: 'core', appId: 'discussion', web: true },
+    { id: 'newComment', appId: 'discussion', web: toggleVal },
+    { id: 'newAssignment', appId: 'coursework', web: toggleVal },
   ],
 });
 
@@ -97,7 +94,7 @@ const setupStore = (override = {}) => {
   return store;
 };
 
-const renderComponent = (store = {}) => (
+const notificationPreferences = (store = {}) => (
   <Router>
     <IntlProvider locale="en">
       <Provider store={store}>
@@ -129,75 +126,76 @@ describe('Notification Preferences', () => {
   afterEach(() => jest.clearAllMocks());
 
   it('tests if all notification apps are listed', async () => {
-    await render(renderComponent(store));
-    expect(screen.queryAllByTestId('notification-app')).toHaveLength(2);
+    await render(notificationPreferences(store));
+    expect(screen.queryByTestId('discussion-app')).toBeInTheDocument();
+    expect(screen.queryByTestId('coursework-app')).toBeInTheDocument();
   });
 
   it('show spinner if api call is in progress', async () => {
     store = setupStore({ status: LOADING_STATUS });
-    await render(renderComponent(store));
+    await render(notificationPreferences(store));
     expect(screen.queryByTestId('loading-spinner')).toBeInTheDocument();
   });
 
   it('tests if all notification preferences are listed', async () => {
-    await render(renderComponent(store));
+    await render(notificationPreferences(store));
     expect(screen.queryAllByTestId('notification-preference')).toHaveLength(4);
   });
 
   it('update group on click', async () => {
-    const wrapper = await render(renderComponent(store));
+    const wrapper = await render(notificationPreferences(store));
     const element = wrapper.container.querySelector('#discussion-app-toggle');
     await fireEvent.click(element);
     expect(mockDispatch).toHaveBeenCalled();
   });
 
   it('update preference on click', async () => {
-    const wrapper = await render(renderComponent(store));
-    const element = wrapper.container.querySelector('#newPost-web');
+    const wrapper = await render(notificationPreferences(store));
+    const element = wrapper.container.querySelector('#core-web');
     expect(element).not.toBeChecked();
     await fireEvent.click(element);
     expect(mockDispatch).toHaveBeenCalled();
   });
 
   it('show not found page if invalid course id is entered in url', async () => {
     store = setupStore({ status: FAILURE_STATUS, selectedCourse: 'invalid-course-id' });
-    await render(renderComponent(store));
+    await render(notificationPreferences(store));
     expect(screen.queryByTestId('not-found-page')).toBeInTheDocument();
   });
 
-  it.each([false, true])(
-    'updates all preferences in the column on web channel click when toggle state is - %s',
-    async (toggleState) => {
-      store = setupStore(updateChannelPreferences(toggleState));
-      const wrapper = render(renderComponent(store));
+  it('updates all preferences in the column on web channel click', async () => {
+    store = setupStore(updateChannelPreferences(true));
+    const wrapper = render(notificationPreferences(store));
 
-      const getCheckbox = (id) => screen.queryByTestId(`${id}-web`);
-      const checkboxes = ['newPost', 'newComment', 'newAssignment', 'newGrade'];
+    const getChannelSwitch = (id) => screen.queryByTestId(`${id}-web`);
+    const notificationTypes = ['newComment', 'newAssignment'];
 
-      const verifyState = (expectedState) => {
-        checkboxes.forEach((checkbox) => {
-          if (expectedState) {
-            expect(getCheckbox(checkbox)).toBeChecked();
-          } else {
-            expect(getCheckbox(checkbox)).not.toBeChecked();
-          }
-        });
-      };
+    const verifyState = (toggleState) => {
+      notificationTypes.forEach((notificationType) => {
+        if (toggleState) {
+          expect(getChannelSwitch(notificationType)).toBeChecked();
+        } else {
+          expect(getChannelSwitch(notificationType)).not.toBeChecked();
+        }
+      });
+    };
 
-      verifyState(toggleState);
+    verifyState(true);
+    expect(getChannelSwitch('core')).toBeChecked();
 
-      const element = screen.queryAllByText('Web')[0];
+    const discussionApp = screen.queryByTestId('discussion-app');
+    const webChannel = within(discussionApp).queryByText('Web');
 
-      await act(async () => {
-        await fireEvent.click(element);
-      });
+    await act(async () => {
+      await fireEvent.click(webChannel);
+    });
 
-      store = setupStore(updateChannelPreferences(!toggleState));
-      wrapper.rerender(renderComponent(store));
+    store = setupStore(updateChannelPreferences(false));
+    wrapper.rerender(notificationPreferences(store));
 
-      await waitFor(() => {
-        verifyState(!toggleState);
-      });
-    },
-  );
+    await waitFor(() => {
+      verifyState(false);
+      expect(getChannelSwitch('core')).toBeChecked();
+    });
+  });
 });
diff --git a/src/notification-preferences/ToggleSwitch.jsx b/src/notification-preferences/ToggleSwitch.jsx
@@ -7,14 +7,14 @@ const ToggleSwitch = ({
   value,
   disabled,
   onChange,
-  dataTestId,
+  id,
 }) => (
   <Form.Switch
     name={name}
     checked={value}
     disabled={disabled}
     onChange={onChange}
-    data-testid={dataTestId}
+    data-testid={id}
   />
 );
 
@@ -23,13 +23,13 @@ ToggleSwitch.propTypes = {
   value: PropTypes.bool.isRequired,
   disabled: PropTypes.bool,
   onChange: PropTypes.func,
-  dataTestId: PropTypes.string,
+  id: PropTypes.string,
 };
 
 ToggleSwitch.defaultProps = {
   onChange: () => null,
   disabled: false,
-  dataTestId: '',
+  id: '',
 };
 
 export default React.memo(ToggleSwitch);