Skip to content

Conversation

@rtibbles
Copy link
Member

Summary

Description of the change(s) you made

  • Adds preemptive handling of channels that are completely empty, to prevent Integrity Errors caused by trying to create a ChannelMetadata object when there is no root node to make a Foreign Key to
  • Adds a regression test to handle this
  • Adds some better clean up of database connections that are created by the content database context manager - otherwise tests that test errors in the publishing process always produce errors during teardown
  • Migrates to a custom exception class for errors raised when the root node is not publishable, so it can be specially handled to not set the channel as publishable again

Manual verification steps performed

  1. Created a regression test that replicated the issue
  2. Fixed the issue
  3. Reran the test
  4. Profit!

Reviewer guidance

How can a reviewer test these changes?

This doesn't do anything about how someone was able to publish a channel while in this state, I think there's still more to work on there, but we should at least handle these things a bit better until we can fix that up better.

References

Fixes #4214


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@bjester bjester merged commit 1e3e05b into learningequality:hotfixes Jul 19, 2023
@bjester bjester mentioned this pull request Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants