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

Tag in Collections [FC-0062] #35383

Merged
merged 14 commits into from
Sep 13, 2024
Merged

Tag in Collections [FC-0062] #35383

merged 14 commits into from
Sep 13, 2024

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Aug 28, 2024 •
edited
Loading

Description

Updates tagging_api to enable tags objects with LibCollectionKey as key.

Supporting information

Testing instructions

  • Check all the code
  • Verify that the test covers the changes

Other information

  • Before merge: Bump version of edx-opaque-keys

@openedx-webhooks
Copy link

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:

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 Aug 28, 2024
@ChrisChV ChrisChV changed the title Chris/fal 3785 tags to collections Tag in Collections [FC-0062] Aug 28, 2024
ChrisChV
ChrisChV commented Aug 28, 2024
View reviewed changes
requirements/edx/kernel.in Outdated
@@ -76,7 +76,7 @@ edx-event-bus-kafka>=5.6.0 # Kafka implementation of event bus
edx-event-bus-redis
edx-milestones
edx-name-affirmation
edx-opaque-keys
git+https://github.com/open-craft/opaque-keys.git@chris/FAL-3785-collections-key#egg=edx-opaque-keys
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: Bump opaque-keys version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@ChrisChV ChrisChV mentioned this pull request Aug 28, 2024
Merged
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Aug 28, 2024
rpenido
rpenido suggested changes Aug 28, 2024
View reviewed changes
Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

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

Thank you for your work @ChrisChV ! 👍

Could you add some tests for the view to check the permissions?

From the code, I think they will just work but I think it is worth the extra tests.

openedx/core/djangoapps/content_tagging/utils.py Outdated
try:
return LibCollectionKey.from_string(key_str)
except InvalidKeyError as usage_key_error:
raise ValueError("object_id must be a CourseKey, LibraryLocatorV2 or a UsageKey") from usage_key_error
Copy link
Contributor

Choose a reason for hiding this comment

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

nit:

Suggested change
raise ValueError("object_id must be a CourseKey, LibraryLocatorV2 or a UsageKey") from usage_key_error
raise ValueError("object_id must be one of the following keys: CourseKey, LibraryLocatorV2, UsageKey or LibCollectionKey") from usage_key_error

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated here: 2849d4b

@ChrisChV
Copy link
Contributor Author

@rpenido Thanks for the review.

Could you add some tests for the view to check the permissions?

I'm unsure how to test that at the Python API level, as that has not been checked there. As far as I understand that permission is checked in openedx-learning rest_api, just like all other object types.

pomegranited
pomegranited approved these changes Aug 30, 2024
View reviewed changes
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.

👍 Looks good thank you @ChrisChV !

  • I tested this by tagging some collections from the command line.
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes documentation
  • User-facing strings are extracted for translation

openedx/core/djangoapps/content_tagging/helpers/objecttag_export_helpers.py Outdated
@@ -135,7 +135,7 @@ def _get_library_block_tagged_object(


def build_object_tree_with_objecttags(
content_key: LibraryLocatorV2 | CourseKey,
content_key: LibraryLocatorV2 | CourseKey | LibraryCollectionKey,
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it ok to use content_tagging.types.ContentKey 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.

Updated: 4bc07a0

@rpenido
Copy link
Contributor

rpenido commented Aug 30, 2024

I'm unsure how to test that at the Python API level, as that has not been checked there. As far as I understand that, permission is checked in openedx-learning rest_api, just like all other object types.

It is a bit of back-and-forth. The permission is checked in openedx-learning, but we override the permission rules here.

You updated this file, so I think the permission was updated.

Here we test tagging a course, a block and a library. I think we should also test tagging a collection.

rpenido
rpenido approved these changes Sep 2, 2024
View reviewed changes
Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

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

LGTM 👍
Thank you @ChrisChV!

  • I tested this using the instructions from the PR
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@ChrisChV ChrisChV merged commit dd59dc6 into openedx:master Sep 13, 2024
49 checks passed
@ChrisChV ChrisChV deleted the chris/FAL-3785-tags-to-collections branch September 13, 2024 14:19
@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

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

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

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

@ormsbee ormsbee mentioned this pull request Sep 27, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pomegranited pomegranited pomegranited approved these changes

@rpenido rpenido rpenido 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
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@ChrisChV @openedx-webhooks @rpenido @edx-pipeline-bot @pomegranited @mphilbrick211