Skip to content

feat: Sync units in course outline [FC-0083] #1850

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.

Sign up for GitHub

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

Merged
ChrisChV merged 1 commit into from
Apr 24, 2025
Merged

feat: Sync units in course outline [FC-0083] #1850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
110 changes: 110 additions & 0 deletions src/course-outline/__mocks__/courseOutlineIndex.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
],
},
Expand Down Expand Up @@ -675,6 +680,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@vertical_2dbb0072785e',
Expand Down Expand Up @@ -759,6 +769,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@vertical_98cf62510471',
Expand Down Expand Up @@ -843,6 +858,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@vertical_d32bf9b2242c',
Expand Down Expand Up @@ -927,6 +947,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@4e592689563243c484af947465eaef0d',
Expand Down Expand Up @@ -1011,6 +1036,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
],
},
Expand Down Expand Up @@ -1196,6 +1226,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@vertical_aae927868e55',
Expand Down Expand Up @@ -1280,6 +1315,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@vertical_c037f3757df1',
Expand Down Expand Up @@ -1364,6 +1404,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@vertical_bc69a47c6fae',
Expand Down Expand Up @@ -1448,6 +1493,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@8f89194410954e768bde1764985454a7',
Expand Down Expand Up @@ -1532,6 +1582,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
],
},
Expand Down Expand Up @@ -1717,6 +1772,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
],
},
Expand Down Expand Up @@ -1995,6 +2055,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@vertical_f04afeac0131',
Expand Down Expand Up @@ -2079,6 +2144,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@b6662b497c094bcc9b870d8270c90c93',
Expand Down Expand Up @@ -2163,6 +2233,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@f91d8d31f7cf48ce990f8d8745ae4cfa',
Expand Down Expand Up @@ -2247,6 +2322,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@vertical_ac391cde8a91',
Expand Down Expand Up @@ -2331,6 +2411,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@vertical_36e0beb03f0a',
Expand Down Expand Up @@ -2415,6 +2500,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@1b0e2c2c84884b95b1c99fb678cc964c',
Expand Down Expand Up @@ -2499,6 +2589,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@c7e98fd39a6944edb6b286c32e1150ff',
Expand Down Expand Up @@ -2583,6 +2678,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
{
id: 'block-v1:edX+DemoX+Demo_Course+type@vertical+block@d6eaa391d2be41dea20b8b1bfbcb1c45',
Expand Down Expand Up @@ -2667,6 +2767,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
],
},
Expand Down Expand Up @@ -2945,6 +3050,11 @@ module.exports = {
selectedPartitionIndex: -1,
selectedGroupsLabel: '',
},
upstreamInfo: {
readyToSync: false,
upstreamRef: undefined,
versionSynced: undefined,
},
},
],
},
Expand Down
18 changes: 17 additions & 1 deletion src/course-outline/card-header/CardHeader.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
import {
MoreVert as MoveVertIcon,
EditOutline as EditIcon,
Sync as SyncIcon,
} from '@openedx/paragon/icons';

import { useContentTagsCount } from '../../generic/data/apiHooks';
Expand Down Expand Up @@ -55,6 +56,8 @@ const CardHeader = ({
discussionsSettings,
parentInfo,
extraActionsComponent,
onClickSync,
readyToSync,
}) => {
const intl = useIntl();
const [searchParams] = useSearchParams();
Expand Down Expand Up @@ -130,8 +133,17 @@ const CardHeader = ({
) : (
<>
{titleComponent}
{readyToSync && (
<IconButton
className="item-card-button-icon"
data-testid={`${namePrefix}-sync-button`}
alt={intl.formatMessage(messages.readyToSyncButtonAlt)}
iconAs={SyncIcon}
onClick={onClickSync}
/>
)}
<IconButton
className="item-card-edit-icon"
className="item-card-button-icon"
data-testid={`${namePrefix}-edit-button`}
alt={intl.formatMessage(messages.altButtonEdit)}
iconAs={EditIcon}
Expand Down Expand Up @@ -259,6 +271,8 @@ CardHeader.defaultProps = {
parentInfo: {},
cardId: '',
extraActionsComponent: null,
readyToSync: false,
onClickSync: null,
};

CardHeader.propTypes = {
Expand Down Expand Up @@ -305,6 +319,8 @@ CardHeader.propTypes = {
// An optional component that is rendered before the dropdown. This is used by the Subsection
// and Unit card components to render their plugin slots.
extraActionsComponent: PropTypes.node,
onClickSync: PropTypes.func,
readyToSync: PropTypes.bool,
};

export default CardHeader;
4 changes: 2 additions & 2 deletions src/course-outline/card-header/CardHeader.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
color: $black;
}

.item-card-edit-icon {
.item-card-button-icon {
opacity: 0;
transition: opacity .3s linear;
margin-right: .5rem;
Expand All @@ -23,7 +23,7 @@
}

&:hover {
.item-card-edit-icon {
.item-card-button-icon {
opacity: 1;
}
}
Expand Down
15 changes: 15 additions & 0 deletions src/course-outline/card-header/CardHeader.test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,4 +368,19 @@ describe('<CardHeader />', () => {
renderComponent();
expect(screen.queryByText('0')).not.toBeInTheDocument();
});

it('should render sync button when is ready to sync', () => {
const mockClickSync = jest.fn();

renderComponent({
readyToSync: true,
onClickSync: mockClickSync,
});

const syncButton = screen.getByRole('button', { name: /update available - click to sync/i });
expect(syncButton).toBeInTheDocument();
fireEvent.click(syncButton);

expect(mockClickSync).toHaveBeenCalled();
});
});
5 changes: 5 additions & 0 deletions src/course-outline/card-header/messages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ const messages = defineMessages({
id: 'course-authoring.course-outline.card.menu.manageTags',
defaultMessage: 'Manage tags',
},
readyToSyncButtonAlt: {
id: 'course-authoring.course-outline.card.button.sync.alt',
defaultMessage: 'Update available - click to sync',
description: 'Alt text for the sync icon button.',
},
});

export default messages;
Loading