fix: Delete tags_count from LibraryXBlockMetadata [FC-0062]

[ChrisChV]

Description

This deletes tags_count from the library block metadata. Currently not used and confusing to have in code

• Which edX user roles will this change impact? "Course Author",

Supporting information

• Github Issue: Implement "Add tags" on the component sidebar  frontend-app-authoring#1286
• Internal ticket: FAL-3847

Testing instructions

• Read the code
• Test the API, you can follow the testing instructions of this feat: Add tags to info sidebar of library component [FC-0062] frontend-app-authoring#1299, and verify that all is OK.

Deadline

ASAP

[openedx-webhooks]

Thanks for the pull request, @ChrisChV!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[rpenido]

LGTM 👍
Thank you for your work @ChrisChV!

• I tested this using the instructions from feat: Add tags to info sidebar of library component [FC-0062] frontend-app-authoring#1299
• I read through the code
• I checked for accessibility issues
• Includes documentation

I left a suggestion about getting the tag count only for the component, instead of the whole library.

[rpenido]

I think we can get the tags only for the block here:

Suggested change

	if load_tags_count:
	# Build 'lib:' component usage_key from component slug and library_key
	component_key = str(component).replace('xblock.v1:', f'{str(library_key)}:').replace('lib:', 'lb:')
	components_tags = _get_library_component_tags_count(library_key)
	if component_key in components_tags:
	tags_count = components_tags[component_key]
	if load_tags_count:
	from openedx.core.djangoapps.content_tagging.api import get_object_tag_counts
	component_tags = get_object_tag_counts(str(component), count_implicit=True)
	if component_key in components_tags:
	tags_count = components_tags[component_key]

[bradenmacdonald]

We don't necessarily need the changes from this PR if you're just wanting the tags count for a single component. You can use the existing API /api/content_tagging/v1/object_tags/:usageKey to get the tags. In fact, we already have a nice hook for it in the Authoring MFE, useContentTaxonomyTagsData(). As long as you make the request in parallel with the "get block metadata" request, it's really not any less efficient. In fact, it's now considered best practice to make several small requests like that at the same time rather than one "big" request, because the "big" request often computes data that isn't needed - like tags_count in this place isn't needed in many places.

Edit: in fact, the tags widget is probably going to be calling that same API anyways, so it's actually more efficient to re-use the same useContentTaxonomyTagsData hook (react-query will de-duplicate the request) rather than adding an additional query to the metadata API.

[ChrisChV]

We don't necessarily need the changes from this PR if you're just wanting the tags count for a single component. You can use the existing API /api/content_tagging/v1/object_tags/:usageKey to get the tags. In fact, we already have a nice hook for it in the Authoring MFE, useContentTaxonomyTagsData(). As long as you make the request in parallel with the "get block metadata" request, it's really not any less efficient. In fact, it's now considered best practice to make several small requests like that at the same time rather than one "big" request, because the "big" request often computes data that isn't needed - like tags_count in this place isn't needed in many places.

Edit: in fact, the tags widget is probably going to be calling that same API anyways, so it's actually more efficient to re-use the same useContentTaxonomyTagsData hook (react-query will de-duplicate the request) rather than adding an additional query to the metadata API.

@bradenmacdonald Thanks! It's true! I updated the MFE PR with your suggestion: openedx/frontend-app-authoring@0ec25b4

But before these changes, tags_count was not used, I was wondering if we should remove it?

[bradenmacdonald]

But before these changes, tags_count was not used, I was wondering if we should remove it?

Good point. We should remove it. It's confusing to have there if it's not used.

[ChrisChV]

@rpenido @bradenmacdonald I updated this PR to delete tags_count, it's ready for review

[bradenmacdonald]

👍

• I tested this
• I read through the code
• I checked for accessibility issues
• Includes documentation

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.