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.

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

[FC-0040] feat: Add CONTENT_OBJECT_TAGS_CHANGED signal #327

Conversation

yusuf-musleh
Copy link
Contributor

@yusuf-musleh yusuf-musleh commented Mar 24, 2024

This signal is emitted when tags on a content object have changed.

Description: This PR adds a new CONTENT_OBJECT_TAGGED signal, which is emitted when a content object's tags have changed.

ISSUE: openedx/modular-learning#197

Dependencies:

Testing instructions:

Follow instructions mentioned in open-craft/edx-platform#647

Reviewers:

  • tag reviewer
  • tag reviewer

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

Author concerns: List any concerns about this PR - inelegant
solutions, hacks, quick-and-dirty implementations, concerns about
migrations, etc.


Private-ref: FAL-3691

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 24, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Mar 24, 2024

Thanks for the pull request, @yusuf-musleh! 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.

@yusuf-musleh yusuf-musleh force-pushed the yusuf-musleh/content-object-tagged-signal branch 2 times, most recently from 0b0e2a5 to ee63ddb Compare March 24, 2024 04:44
@yusuf-musleh yusuf-musleh marked this pull request as ready for review March 25, 2024 11:16
@yusuf-musleh yusuf-musleh requested a review from a team as a code owner March 25, 2024 11:16
@yusuf-musleh yusuf-musleh changed the title [WIP] feat: Add CONTENT_OBJECT_TAGGED signal feat: Add CONTENT_OBJECT_TAGGED signal Mar 25, 2024
openedx_events/__init__.py Outdated Show resolved Hide resolved
Comment on lines 187 to 188
"""
Data about content object where tags changed
Copy link
Member

Choose a reason for hiding this comment

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

The docstring says where tags changed but the data attributes themselves are not associated with tagging, so could this be simply a data representation of the content?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed, I changed it to be more generic, representing the content object.

openedx_events/content_authoring/signals.py Outdated Show resolved Hide resolved
Copy link
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

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

I left a few comments for you to review. Thanks!

@yusuf-musleh yusuf-musleh force-pushed the yusuf-musleh/content-object-tagged-signal branch 2 times, most recently from e4b9f69 to 758ba31 Compare March 26, 2024 04:39
@yusuf-musleh
Copy link
Contributor Author

@mariajgrimaldi Thanks for the review! I've updated the PR addressing the comments.

@yusuf-musleh yusuf-musleh changed the title feat: Add CONTENT_OBJECT_TAGGED signal feat: Add CONTENT_OBJECT_TAGS_CHANGED signal Mar 26, 2024
@yusuf-musleh yusuf-musleh changed the title feat: Add CONTENT_OBJECT_TAGS_CHANGED signal [FC-0040] feat: Add CONTENT_OBJECT_TAGS_CHANGED signal Mar 26, 2024
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.

Good work @yusuf-musleh! 👍

@mariajgrimaldi
Copy link
Member

I left a few questions here: open-craft/edx-platform#647. I'll return once they've answered. Thanks!

This signal is emitted when tags on a content object have changed.
@yusuf-musleh yusuf-musleh force-pushed the yusuf-musleh/content-object-tagged-signal branch from 758ba31 to e967b0a Compare March 31, 2024 10:58
@mariajgrimaldi mariajgrimaldi merged commit 197690d into openedx:main Apr 1, 2024
9 checks passed
@openedx-webhooks
Copy link

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

@mariajgrimaldi
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

4 participants