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

feat: adding management command to remove expired pending group memberships #2040

Merged
merged 1 commit into from
Mar 6, 2024

Conversation

alex-sheehan-edx
Copy link
Contributor

@alex-sheehan-edx alex-sheehan-edx commented Mar 1, 2024

https://2u-internal.atlassian.net/browse/ENT-8524

In this PR:

  • Updated EnterpriseCustomerUser readonly serializer to pull group UUIDs instead of membership records
  • Updated EnterpriseCustomerUser readonly serializer to account for groups that apply to all contexts
  • Updated EnterpriseGroup /learners/ endpoint to account for groups that apply to all contexts
  • New applies_to_all_contexts flag on EnterpriseGroup records
  • New management command remove_expired_pending_group_memberships that will remove pending membership records if they are older than 90 days
  • Updated factories
  • Associated unit tests
  • Fix to the enterprise UserFactory class to avoid collisions in test data

Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • base.in if needed in production but edx-platform doesn't install it
    • test-master.in if edx-platform pins it, with a matching version
    • make upgrade && make requirements have been run to regenerate requirements
  • make static has been run to update webpack bundling if any static content was updated
  • ./manage.py makemigrations has been run
    • Checkout the Database Migration Confluence page for helpful tips on creating migrations.
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.
    • This should be run from either a venv with all the lms/edx-enterprise requirements installed or if you checked out edx-enterprise into the src directory used by lms, you can run this command through an lms shell.
      • It would be ./manage.py lms makemigrations in the shell.
  • Version bumped
  • Changelog record added
  • Translations updated (see docs/internationalization.rst but also this isn't blocking for merge atm)

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in GitHub Actions, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in edx-platform to upgrade dependencies (including edx-enterprise)
    • This must be done after the version is visible in PyPi as make upgrade in edx-platform will look for the latest version in PyPi.
    • Note: the edx-enterprise constraint in edx-platform must also be bumped to the latest version in PyPi.

@alex-sheehan-edx alex-sheehan-edx requested a review from a team March 1, 2024 18:24
@alex-sheehan-edx alex-sheehan-edx force-pushed the asheehan-edx/ENT-8524 branch 4 times, most recently from 454124e to 19f5224 Compare March 1, 2024 21:16

def handle(self, *args, **options):
queryset = EnterpriseGroupMembership.objects.all()
if enterprise_arg := options.get("enterprise_customer"):
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we documenting the optional enterprise_customer argument somewhere?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

uhhh Let me add it to the doc string, it's not necessary for the overnight job that's to run however I liked the added flexibility for other users down the line

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 the doc string- I'll write a quick unit test for it just to be certain

@alex-sheehan-edx alex-sheehan-edx requested a review from a team March 4, 2024 17:53
@alex-sheehan-edx alex-sheehan-edx force-pushed the asheehan-edx/ENT-8524 branch 4 times, most recently from 588bbde to 872a80d Compare March 4, 2024 20:44
@alex-sheehan-edx alex-sheehan-edx merged commit beb2832 into master Mar 6, 2024
9 checks passed
@alex-sheehan-edx alex-sheehan-edx deleted the asheehan-edx/ENT-8524 branch March 6, 2024 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants