Ensure only one active InstanceConfig can exist #5974
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Status
Ready for review
Description of Changes
Fixes #5973.
Adds a unique partial index on
InstanceConfig.valid_until
where it is null, and inInstanceConfig.get_current
, handles the now-possibleIntegrityError
and queries again to pick up the row added between the previous query and the insertion attempt.Testing
git checkout develop
git checkout origin/there_can_be_only_one -- securedrop/tests/test_db.py
make test TESTFILES="tests/test_db.py::test_only_one_active_instance_config_can_exist"
will fail because it doesn't encounterIntegrityError
.git checkout there_can_be_only_one
Deployment
The migration that adds the index could conceivably fail if a site had multiple rows in
instance_config
withvalid_until
null, but every production database should have been created with migrations, which would have created a default row ininstance_config
. Any site that did somehow have multiple active configurations would not be functioning.Checklist
If you made changes to the server application code:
make lint
) and tests (make test
) pass in the development containerIf you made non-trivial code changes:
Choose one of the following: