Skip to content

refactor: add lazy field to LibraryCollectionData - #404

Merged
mariajgrimaldi merged 3 commits into
openedx:mainfrom
open-craft:navin/update-library-collection-data
Oct 12, 2024
Merged

refactor: add lazy field to LibraryCollectionData#404
mariajgrimaldi merged 3 commits into
openedx:mainfrom
open-craft:navin/update-library-collection-data

Conversation

@navinkarkera

Copy link
Copy Markdown
Contributor

This is required to handle the signal asynchronously whenever the sender does not care about the handler execution completion.

For example, whenever multiple collections are updated due to a component being added or removed, we do not want to wait for all collection update handlers to complete.

Dependencies:

Merge deadline: ASAP

Testing instructions:

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)

This is required to handle the signal asynchronously whenever the sender
does not care about the handler execution completion.

For example, whenever multiple collections are updated due to a
component being added or removed, we do not want to wait for all
collection update handlers to complete.
@navinkarkera
navinkarkera requested a review from a team October 10, 2024 06:57
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 10, 2024
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @navinkarkera!

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/hooks-extension-framework. 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.

@rpenido rpenido left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍
Thank you for your work, @navinkarkera!

@ChrisChV

Copy link
Copy Markdown

@felipemontoya @mariajgrimaldi @brian-smith-tcril Could you review this as CC? Thanks!

Comment thread openedx_events/content_authoring/data.py Outdated

@mariajgrimaldi mariajgrimaldi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for addressing my comments! Feel free to merge and release when you see fit.

@ChrisChV ChrisChV left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks good! 👍

@bradenmacdonald

Copy link
Copy Markdown
Contributor

@mariajgrimaldi Would you mind merging for us? I don't think we have permission.

@mariajgrimaldi

mariajgrimaldi commented Oct 12, 2024

Copy link
Copy Markdown
Member

@bradenmacdonald: @navinkarkera has merge rights. But yes, I’ll merge as soon as I can - I'm seeing this from my phone.

@mariajgrimaldi
mariajgrimaldi merged commit 03dc087 into openedx:main Oct 12, 2024
@navinkarkera
navinkarkera deleted the navin/update-library-collection-data branch October 12, 2024 09:19
@navinkarkera

Copy link
Copy Markdown
Contributor Author

@mariajgrimaldi Thank you!

mariajgrimaldi pushed a commit that referenced this pull request Oct 15, 2024
This is required to handle the signal asynchronously whenever the sender
does not care about the handler execution completion.

For example, whenever multiple collections are updated due to a
component being added or removed, we do not want to wait for all
collection update handlers to complete.
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.

6 participants