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.

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

Jump to bottom

feat: add component usage data in the ComponentDetails component [FC-0076] #1656

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

feat: add component usage data in the ComponentDetails component [FC-0076] #1656

wants to merge 3 commits into from

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Feb 14, 2025 •
edited
Loading

Description

This PR adds the list of Courses using a component to the "Details" tab on the sidebar.

image

Addition Information

Testing Instructions

  • Add Library Component to multiple courses
  • Check if the course list shows in the Component Details Sidebar
  • Check if the link redirects to the Course Page

Private ref: FAL-4005

@openedx-webhooks
Copy link

Thanks for the pull request, @rpenido!

This repository is currently maintained by @openedx/2u-tnl.

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

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 14, 2025
@rpenido rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch from c2ce1e2 to 644b0a4 Compare February 14, 2025 03:19
@rpenido rpenido changed the title feat: add component usage data in the ComponentDetails component feat: add component usage data in the ComponentDetails component [FC-0076] Feb 14, 2025
@codecov Codecov
Copy link

codecov bot commented Feb 14, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.31%. Comparing base (59243b0) to head (aadf958).

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #1656   +/-   ##
=======================================
  Coverage   93.30%   93.31%           
=======================================
  Files        1101     1101           
  Lines       21856    21871   +15     
  Branches     4741     4731   -10     
=======================================
+ Hits        20393    20408   +15     
  Misses       1392     1392           
  Partials       71       71

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

@rpenido rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch 2 times, most recently from 645e914 to f235183 Compare February 14, 2025 03:45
@rpenido rpenido force-pushed the rpenido/fal-4005/list-courses-using-library branch from f235183 to 8ad175a Compare February 14, 2025 03:56
@rpenido rpenido mentioned this pull request Feb 14, 2025
Draft
navinkarkera
navinkarkera approved these changes Feb 14, 2025
View reviewed changes
Copy link
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

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

@rpenido Looks good 👍

  • I tested this: Verified list of courses in library block details
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@rpenido rpenido mentioned this pull request Feb 14, 2025
Draft
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 14, 2025
ChrisChV
ChrisChV approved these changes Feb 17, 2025
View reviewed changes
Copy link
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

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

Looks good. Only one nit

src/library-authoring/data/apiHooks.ts
@@ -542,3 +544,11 @@ export const useUpdateComponentCollections = (libraryId: string, usageKey: strin
},
});
};

export const useComponentDownstreamContexts = (usageKey: string) => (
Copy link
Contributor

Choose a reason for hiding this comment

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

@rpenido Docstring is missing here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! Fixed here: aadf958

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

@navinkarkera navinkarkera navinkarkera approved these changes

@ChrisChV ChrisChV ChrisChV approved these changes

Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Waiting on Author
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@rpenido @openedx-webhooks @navinkarkera @ChrisChV @mphilbrick211