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

fix: update outline sidebar hooks for plugins #1586

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

KristinAoki
Copy link
Member

@KristinAoki KristinAoki commented Feb 11, 2025

This PR moves all the useSelector and dispatch calls for the outline sidebar to outline-sidebar/hooks.jsx and moves Link into a separate component for the SidebarUnits.jsx. These changes are necessary to fully support plugins. When using any of those functions inside of a plugin it causes conflicts with redux and the router.

@openedx-webhooks
Copy link

Thanks for the pull request, @KristinAoki!

This repository is currently maintained by @openedx/committers-frontend-app-learning.

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.

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

codecov bot commented Feb 11, 2025

Codecov Report

Attention: Patch coverage is 96.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 84.61%. Comparing base (9dc45e1) to head (41c0173).

Files with missing lines Patch % Lines
...e/course/sidebar/sidebars/course-outline/hooks.jsx 95.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1586      +/-   ##
==========================================
+ Coverage   84.60%   84.61%   +0.01%     
==========================================
  Files         331      332       +1     
  Lines        5656     5661       +5     
  Branches     1357     1394      +37     
==========================================
+ Hits         4785     4790       +5     
+ Misses        854      852       -2     
- Partials       17       19       +2     

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

@KristinAoki
Copy link
Member Author

@openedx/committers-frontend-app-learning this PR is ready for review

@itsjeyd itsjeyd added core contributor PR author is a Core Contributor (who may or may not have write access to this repo). waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Feb 13, 2025
@itsjeyd itsjeyd requested a review from a team February 13, 2025 13:55
@bradenmacdonald
Copy link
Contributor

I'll try to take a look by tomorrow.

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.

I'm not sure I totally understand the necessity of this, but the refactor looks reasonable to me. Thanks!

children?: React.ReactNode;
}

const UnitLinkWrapper: React.FC<Props> = ({
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it would be useful to have a JSDoc string here explaining why we have this component.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U waiting for eng review PR is ready for review. Review and merge it, or suggest changes.
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

4 participants