Skip to content

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Jun 12, 2025

Description

  • Add functionality to open the manage tags when clicking the tag count in the section/subsection page.
  • Which edX user roles will this change impact? "Course Author".

Supporting information

Testing instructions

  • Open the library home of the library.
  • Create one subsection
  • Add/create some units in the subsection.
  • Verify that you can open the manage tags in the sidebar.
  • Create one section
  • Add/create some subsections in the section.
  • Verify that you can open the manage tags in the sidebar.

Other information

  • Currently, the tag counter is not updated when updating unit/subsection tags while on the subsection/section page. I'm going to address this in a separate PR as more code is needed and probably a solution that can be backported to Teak, as this also happens with components inside units.

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

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.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jun 12, 2025
@ChrisChV ChrisChV changed the title feat: Open Manage tags on click tag count in section/subsection page feat: Open Manage tags on click tag count in section/subsection page [FC-0090] Jun 12, 2025
Copy link

codecov bot commented Jun 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.12%. Comparing base (962b30b) to head (83c47ab).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2136      +/-   ##
==========================================
+ Coverage   94.11%   94.12%   +0.01%     
==========================================
  Files        1164     1164              
  Lines       24507    24527      +20     
  Branches     5201     5320     +119     
==========================================
+ Hits        23065    23087      +22     
+ Misses       1374     1363      -11     
- Partials       68       77       +9     

☔ 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.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Jun 12, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jun 12, 2025
Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 This is working well (so long as I refresh the container page), but I left some suggestions on the tests.

Oddly, since we use the search index when showing container cards, its tag counts update immediately, but not so for the queries using the container API. Maybe we need a similar kind of cache clearing for these hits too?

  • I tested this: (describe what you tested)
  • I read through the code
  • I checked for accessibility issues by using my keyboard to navigate
  • Includes documentation
  • User-facing strings are extracted for translation N/A

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.

One question, but not a blocker.

Comment on lines +64 to +68
const scheduleJumpToTags = useRunOnNextRender(() => {
// TODO: Ugly hack to make sure sidebar shows manage tags section
// This needs to run after all changes to url takes place to avoid conflicts.
setTimeout(() => setSidebarAction(SidebarActions.JumpToManageTags), 250);
});
Copy link
Contributor

Choose a reason for hiding this comment

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

Wow, I wish there were a better way to do this. I see we're already using it in a few other places.

What is the reason we can't just do something like

navigateTo({ selectedItemId: container.originalId, sidebarAction: SidebarActions.JumpToManageTags });

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am working on this in open-craft#91

@mphilbrick211 mphilbrick211 moved this from Waiting on Author to In Eng Review in Contributions Jun 20, 2025
@ChrisChV ChrisChV merged commit ebf4b7c into openedx:master Jun 23, 2025
7 checks passed
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Jun 23, 2025
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: Done
Development

Successfully merging this pull request may close these issues.

5 participants