Skip to content

Conversation

@bradenmacdonald
Copy link
Contributor

@bradenmacdonald bradenmacdonald commented Feb 7, 2024

This PR updates the APIs for retrieving the tags in the taxonomy, so that they state not only how many direct children they have, but also how many total descendants.

The direct children count is still included, not only to preserve backwards compatibility, but because it's necessary to compute pagination and display a "load more children" button when necessary.

What about performance of these queries? I ran the whole test suite before and after this change, which includes some very large taxonomies, and there was no measurable difference on average.

Ref: openedx/modular-learning#191

Private ref: FAL-3655

Note: needs a version bump when merged.

@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 7, 2024
@bradenmacdonald bradenmacdonald changed the title Add total descendant count to tag list APIs Add total descendant count to tag list APIs [FC-0036] Feb 7, 2024
@bradenmacdonald bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Feb 7, 2024
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.

👍 with one suggested change.

Once you address that and do a version bump, I think this is good to merge.

  • I tested this on my devstack using openedx/frontend-app-authoring#826
    • Navigated to the taxonomies list and selected a taxonomy
    • Ensured that the descendant counts are showing as expected next to each tag in the tree.
  • 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

@bradenmacdonald bradenmacdonald merged commit c827081 into openedx:main Feb 8, 2024
@openedx-webhooks
Copy link

@bradenmacdonald 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

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

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants