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

Update backend change event generation to mark some changes as unpublishable #4632

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

rtibbles
Copy link
Member

@rtibbles rtibbles commented Aug 9, 2024

Summary

Description of the change(s) you made

  • Adds an additional field to the backend Change model to flag some changes as unpublishable, defaulting to False
  • Does this as two migration operations to not back fill the current table, but instead leave as null
  • Excludes unpublishable changes from the unpublished changes query
  • Automatically set changes to tables that do not constitute a publishable change as unpublishable - so only changes that directly affect the channel contents will be marked as publishable.
  • Automatically set published changes as unpublishable
  • Update all backend change generation that is only intended to signal for an update of frontend state, and not an actual edit of the channel contents, to save the changes as unpublishable
  • Add new tests to make sure the publishable changes query operates as intended in a range of circumstances

Manual verification steps performed

Published a channel. Refreshed the page. Confirmed that it wasn't publishable if I made no further changes.

References

Fixes #4202

Comments


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

…ishable.

Mark all changes from tables that are not important for channel publishing as unpublishable.
Add test coverage for new behaviour.
Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

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

Code looks good, tests look good. It all makes sense

@bjester bjester merged commit 9db159a into learningequality:unstable Aug 23, 2024
13 checks passed
@akolson akolson mentioned this pull request Aug 24, 2024
@akolson akolson mentioned this pull request Oct 1, 2024
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.

Unpublished change query can pickup changes originating from the backend
2 participants