Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: make notification channel headings clickable in notification pr… #981

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 34 additions & 4 deletions src/notification-preferences/NotificationPreferenceApp.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,21 @@
import PropTypes from 'prop-types';
import { useDispatch, useSelector } from 'react-redux';
import { useIntl } from '@edx/frontend-platform/i18n';
import { Collapsible } from '@edx/paragon';
import { Collapsible, NavItem } from '@edx/paragon';
import classNames from 'classnames';
import messages from './messages';
import ToggleSwitch from './ToggleSwitch';
import {
selectPreferenceAppToggleValue,
selectNonEditablePreferences,
selectPreferencesOfApp,
selectSelectedCourseId,
selectUpdatePreferencesStatus,
} from './data/selectors';
import NotificationPreferenceRow from './NotificationPreferenceRow';
import { updateAppPreferenceToggle } from './data/thunks';
import { updateAppPreferenceToggle, updateChannelPreferenceToggle } from './data/thunks';
import { LOADING_STATUS } from '../constants';
import NOTIFICATION_CHANNELS from './data/constants';

const NotificationPreferenceApp = ({ appId }) => {
const dispatch = useDispatch();
Expand All @@ -22,6 +25,18 @@
const appPreferences = useSelector(selectPreferencesOfApp(appId));
const appToggle = useSelector(selectPreferenceAppToggleValue(appId));
const updatePreferencesStatus = useSelector(selectUpdatePreferencesStatus());
const nonEditable = useSelector(selectNonEditablePreferences(appId));

const onChannelToggle = useCallback((event) => {
const { id: notificationChannel } = event.target;
const isPreferenceNonEditable = (preference) => nonEditable?.[preference.id]?.includes(notificationChannel);

Check warning on line 32 in src/notification-preferences/NotificationPreferenceApp.jsx

View check run for this annotation

Codecov / codecov/patch

src/notification-preferences/NotificationPreferenceApp.jsx#L31-L32

Added lines #L31 - L32 were not covered by tests

const hasActivePreferences = appPreferences.some(

Check warning on line 34 in src/notification-preferences/NotificationPreferenceApp.jsx

View check run for this annotation

Codecov / codecov/patch

src/notification-preferences/NotificationPreferenceApp.jsx#L34

Added line #L34 was not covered by tests
(preference) => preference[notificationChannel] && !isPreferenceNonEditable(preference),
);

dispatch(updateChannelPreferenceToggle(courseId, appId, notificationChannel, !hasActivePreferences));

Check warning on line 38 in src/notification-preferences/NotificationPreferenceApp.jsx

View check run for this annotation

Codecov / codecov/patch

src/notification-preferences/NotificationPreferenceApp.jsx#L38

Added line #L38 was not covered by tests
}, [appId, appPreferences, courseId, dispatch, nonEditable]);

const preferences = useMemo(() => (
appPreferences.map(preference => (
Expand All @@ -36,10 +51,10 @@
dispatch(updateAppPreferenceToggle(courseId, appId, event.target.checked));
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [appId]);
eemaanamir marked this conversation as resolved.
Show resolved Hide resolved

if (!courseId) {
return null;
}

return (
<Collapsible.Advanced open={appToggle} data-testid="notification-app" className="mb-5">
<Collapsible.Trigger>
Expand All @@ -62,7 +77,22 @@
<div className="d-flex flex-row header-label">
<span className="col-8 px-0">{intl.formatMessage(messages.typeLabel)}</span>
<span className="d-flex col-4 px-0">
<span className="ml-auto">{intl.formatMessage(messages.webLabel)}</span>
{NOTIFICATION_CHANNELS.map((channel) => (
<NavItem
eemaanamir marked this conversation as resolved.
Show resolved Hide resolved
id={channel}
key={channel}
className={classNames(
'd-flex',
{ 'ml-auto': channel === 'web' },
{ 'mx-auto': channel === 'email' },
{ 'ml-auto mr-0': channel === 'push' },
)}
role="button"
onClick={onChannelToggle}
>
{intl.formatMessage(messages.notificationChannel, { text: channel })}
</NavItem>
))}
</span>
</div>
<div className="my-3">
Expand Down
4 changes: 4 additions & 0 deletions src/notification-preferences/data/selectors.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ export const selectPreferenceNonEditableChannels = (appId, name) => state => (
state?.notificationPreferences.preferences.nonEditable[appId]?.[name] || []
);

export const selectNonEditablePreferences = appId => state => (
state?.notificationPreferences.preferences.nonEditable[appId] || []
);

export const selectSelectedCourseId = () => state => (
state.notificationPreferences.preferences.selectedCourse
);
Expand Down
7 changes: 7 additions & 0 deletions src/notification-preferences/data/service.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,10 @@
const { data } = await getAuthenticatedHttpClient().patch(url, patchData);
return data;
};

export const patchChannelPreferenceToggle = async (courseId, notificationApp, notificationChannel, value) => {
const patchData = snakeCaseObject({ notificationApp, notificationChannel, value });
const url = `${getConfig().LMS_BASE_URL}/api/notifications/channel/configurations/${courseId}`;
const { data } = await getAuthenticatedHttpClient().patch(url, patchData);
return data;

Check warning on line 50 in src/notification-preferences/data/service.js

View check run for this annotation

Codecov / codecov/patch

src/notification-preferences/data/service.js#L47-L50

Added lines #L47 - L50 were not covered by tests
};
13 changes: 13 additions & 0 deletions src/notification-preferences/data/thunks.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
getCourseList,
getCourseNotificationPreferences,
patchAppPreferenceToggle,
patchChannelPreferenceToggle,
patchPreferenceToggle,
} from './service';

Expand Down Expand Up @@ -148,3 +149,15 @@
}
}
);

export const updateChannelPreferenceToggle = (courseId, notificationApp, notificationChannel, value) => (
async (dispatch) => {
try {
const data = await patchChannelPreferenceToggle(courseId, notificationApp, notificationChannel, value);
const normalizedData = normalizePreferences(camelCaseObject(data));
dispatch(fetchNotificationPreferenceSuccess(courseId, normalizedData));

Check warning on line 158 in src/notification-preferences/data/thunks.js

View check run for this annotation

Codecov / codecov/patch

src/notification-preferences/data/thunks.js#L154-L158

Added lines #L154 - L158 were not covered by tests
} catch (errors) {
dispatch(fetchNotificationPreferenceFailed());

Check warning on line 160 in src/notification-preferences/data/thunks.js

View check run for this annotation

Codecov / codecov/patch

src/notification-preferences/data/thunks.js#L160

Added line #L160 was not covered by tests
}
}
);
11 changes: 11 additions & 0 deletions src/notification-preferences/messages.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ const messages = defineMessages({
}`,
description: 'Display text for Notification Types',
},
notificationChannel: {
id: 'notification.preference.channel',
defaultMessage: `{
text, select,
web {Web}
email {Email}
push {Push}
other {{text}}
}`,
description: 'Display text for Notification Channel',
},
typeLabel: {
id: 'notification.preference.type.label',
defaultMessage: 'Type',
Expand Down
Loading