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: updates tasks usage of create_recipient to create_recipients #2090

Merged
merged 3 commits into from
May 13, 2024

Conversation

brobro10000
Copy link
Member

@brobro10000 brobro10000 commented May 2, 2024

Updates the use of create_recipient to create_recipients from the braze-client repo.
This includes newly added batching logic to limit the max number of dictionary objects for user_id_by_email per create_recipients call to 50 recommended by Braze for batching identifying users which is done within create_recipients.
Removes now unused create_recipient function.

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)
    • Trigger the 'Upgrade one Python dependency' action against master in edx-platform with new version number to generate version bump PR
    • 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.

@brobro10000 brobro10000 force-pushed the hu/ent-8713 branch 4 times, most recently from f6be8d6 to 931dfef Compare May 6, 2024 15:14
@brobro10000 brobro10000 marked this pull request as ready for review May 6, 2024 15:17
enterprise/tasks.py Outdated Show resolved Hide resolved
enterprise/tasks.py Outdated Show resolved Hide resolved
enterprise/utils.py Show resolved Hide resolved
@iloveagent57 iloveagent57 requested a review from katrinan029 May 6, 2024 18:46
@iloveagent57
Copy link
Contributor

Looks great, couple of small suggestions! I tagged in @katrinan029 for review, too.

Copy link
Contributor

@katrinan029 katrinan029 left a comment

Choose a reason for hiding this comment

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

other than small nit and linter errors, it lgtm!

enterprise/tasks.py Outdated Show resolved Hide resolved
@brobro10000 brobro10000 force-pushed the hu/ent-8713 branch 2 times, most recently from 62ed3be to 0ebe0d0 Compare May 13, 2024 15:41
@brobro10000 brobro10000 merged commit cc49d3b into master May 13, 2024
13 checks passed
@brobro10000 brobro10000 deleted the hu/ent-8713 branch May 13, 2024 16:37
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.

3 participants