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: remove content transmission audits without a catalog uuid #1793

Merged
merged 6 commits into from
Jul 24, 2023

Conversation

katrinan029
Copy link
Contributor

@katrinan029 katrinan029 commented Jul 6, 2023

Description

There are currently content transmission audits that have no catalog UUID’s associated with them. As the system currently relies on these catalog uuids to update and read audits, these records have become effectively orphaned and useless. As such we would like to clean them up and remove them from the table.

Solution

Added a command to remove content transmission audit records without a catalog UUID.

Test Plan

  1. Checkout branch knguyen2/ENT-7268
  2. Visit this URL: http://localhost:18000/admin/integrated_channel/contentmetadataitemtransmission/ and click on the button ADD CONTENT METADATA ITEM TRANSMISSION. You will need to leave the Enterprise customer catalog uuid field empty.
  3. In your terminal run the following commands:
     $ ssh devstack
     $ cd edx-repos/devstack
     $ make lms-shell
     $ ./manage.py lms remove_null_catalog_transmission_audits
  1. Go back to the URL: http://localhost:18000/admin/integrated_channel/contentmetadataitemtransmission/ and ensure that the entry you created has been removed.

JIRA Ticket

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.

@katrinan029 katrinan029 requested a review from a team July 6, 2023 20:22
@katrinan029 katrinan029 marked this pull request as ready for review July 7, 2023 15:07
Copy link
Contributor

@kiram15 kiram15 left a comment

Choose a reason for hiding this comment

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

LGTM!

@katrinan029 katrinan029 merged commit aa37d50 into master Jul 24, 2023
6 checks passed
@katrinan029 katrinan029 deleted the knguyen2/ENT-7268 branch July 24, 2023 16:20
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