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

fix: properly avoid race condition when provisioning licenses #768

Merged
merged 1 commit into from
Feb 18, 2025

Conversation

iloveagent57
Copy link
Contributor

@iloveagent57 iloveagent57 commented Feb 18, 2025

ENT-10064
We should have been using transaction.on_commit() here all along.
https://docs.djangoproject.com/en/5.1/topics/db/transactions/#performing-actions-after-commit

Link to the associated ticket: https://openedx.atlassian.net/browse/ENT-10064

Testing considerations

  1. Tail the worker logs make worker-logs.
  2. Create a new subs plan with say, 20k licenses. Save it.
  3. Observe in the worker logs that the worker asynchronously provisions license records for the plan.
  • Include instructions for any required manual tests, and any manual testing that has
    already been performed.
  • Include unit and a11y tests as appropriate
  • Consider performance issues.
  • Check that Database migrations are backwards-compatible

Post-review

Squash commits into discrete sets of changes

@openedx-webhooks
Copy link

Thanks for the pull request, @iloveagent57!

This repository is currently maintained by @openedx/2u-enterprise.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.


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 Feb 18, 2025
@iloveagent57 iloveagent57 force-pushed the aed/fix-race-condition branch from 086fdd6 to 7974dd6 Compare February 18, 2025 16:20
assert obj.licenses.count() == 0 # Verify no Licenses have been created yet
change = False

with self.captureOnCommitCallbacks(execute=True):
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved to a TestCase class so I can utilize this on_commit test utility to actually execute the provision_licenses() function.

@iloveagent57 iloveagent57 merged commit 2559da6 into master Feb 18, 2025
5 checks passed
@iloveagent57 iloveagent57 deleted the aed/fix-race-condition branch February 18, 2025 16:34
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