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

[ENT-7725] - Add try catch block for enhanced debugging #1918

Merged
merged 3 commits into from
Oct 23, 2023

Conversation

hamzawaleed01
Copy link
Member

Context: https://2u-internal.atlassian.net/browse/ENT-7725?focusedCommentId=741115

TLDR: An exception was being thrown due to invalid customer configuration which took us days to trace in Splunk. So, adding a try catch block in this PR with a log including customer and LMS user id for enhanced debugging.

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.

@hamzawaleed01 hamzawaleed01 force-pushed the hamza/ENT-7725 branch 2 times, most recently from 3d4ed75 to bfb36c5 Compare October 20, 2023 10:25
@hamzawaleed01 hamzawaleed01 reopened this Oct 20, 2023
@hamzawaleed01 hamzawaleed01 force-pushed the hamza/ENT-7725 branch 2 times, most recently from d34f480 to 8bd3405 Compare October 23, 2023 10:08
@hamzawaleed01 hamzawaleed01 merged commit b8dfb34 into master Oct 23, 2023
@hamzawaleed01 hamzawaleed01 deleted the hamza/ENT-7725 branch October 23, 2023 12:29
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