Skip to content

Conversation

@ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Dec 5, 2025

Description

  • Updates the library sync icon with new states: error, broken, ready to sync and with overrides.
  • Which user roles will this change impact? "Course Author".
image image image image

Supporting information

Testing instructions

  • In a course outline add from library: a Section, a Subsection, and a Unit.
  • Verify the new icon in the OK state in all containers.
  • Make an override and verify the new icon in the override state.
  • In the library, update one container and publish it.
  • Refresh the course outline page and verify the new icon in the ready-to-sync state.
  • Click on the icon and verify that you can open the sync modal.
  • In the library, delete one container.
  • Refresh the course outline page and verify the new icon in the broken state.

Other information

N/A

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 5, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 5, 2025

Thanks for the pull request, @ChrisChV!

This repository is currently maintained by @bradenmacdonald.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@ChrisChV ChrisChV marked this pull request as draft December 5, 2025 23:09
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Dec 5, 2025
@codecov
Copy link

codecov bot commented Dec 5, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.90%. Comparing base (50f4f70) to head (aa7b32f).
⚠️ Report is 10 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2739      +/-   ##
==========================================
+ Coverage   94.88%   94.90%   +0.01%     
==========================================
  Files        1236     1235       -1     
  Lines       28102    28281     +179     
  Branches     6206     6418     +212     
==========================================
+ Hits        26664    26839     +175     
+ Misses       1380     1371       -9     
- Partials       58       71      +13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ChrisChV ChrisChV marked this pull request as ready for review December 10, 2025 01:34
Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
Thank you for your work, @ChrisChV!

  • I tested this using the instructions from the PR
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

I added one comment about the title alignment on the UnitCard (not totally related to this code).

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Dec 11, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Dec 11, 2025
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, but with some suggestions

Comment on lines +35 to +36
let hasTwoIcons = false;
let secondIconProps = {};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: personally, instead of two separate variables, I would just put

let secondIcon: JSX.Element | undefined;
...
    secondIcon = (
      <Icon
        size={size}
        title={intl.formatMessage(messages.upstreamLinkError)}
        ariaLabel={intl.formatMessage(messages.upstreamLinkError)}
        src={LinkOff}
      />
    );
-        {hasTwoIcons && (
-          <Icon
-            size={size}
-            {...secondIconProps}
-          />
-        )}
+        {secondIcon}

tooltipMessage = intl.formatMessage(messages.upstreamLinkError);
secondIconProps = {
title: intl.formatMessage(messages.upstreamLinkError),
ariaLabel: intl.formatMessage(messages.upstreamLinkError),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the change I suggested above, TypeScript is warnings that it should be aria-label not ariaLabel. Whichever approach you use, please check that the prop is right and make sure the aria-label is actually showing up in the final HTML.

color: white;
}
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Sizes with one icon:

width: 28px;
height: 22px;
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Sizes with two icons:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

5 participants