feat(backup): Enable shimming deleted fields #66248
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We need to support deleted fields on Django model schemas for a number of self-hosted released (currently 2). This means that even if we delete a field on HEAD, we still need to make the import script aware that the field could exit on imported JSON, and pre-process that JSON in such a way that the field is removed in cases where the JSON was generated by an old version that still contained the field. There is no purpose in testing this code standalone. It passes tests in #65923, which is the first actual use of this shimming mechanism.
d829ac9 to
40cc7a0
Compare
src/sentry/backup/imports.py
Outdated
| # around even if the dict is empty, to ensure that there is a ready place to pop shims into. For | ||
| # each entry in this dict, please leave a TODO comment pointed to a github issue for removing | ||
| # the shim, noting in the comment which self-hosted release will trigger the removal. | ||
| deleted_fields: dict[str, set[str]] = {} |
There was a problem hiding this comment.
Is deleted_fields being updated over time to store all the deleted fields? If so, would it be better to place this as a global variable at the top of the file or somewhere more clear?
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #66248 +/- ##
=======================================
Coverage 84.27% 84.27%
=======================================
Files 5304 5304
Lines 237049 237058 +9
Branches 41024 41030 +6
=======================================
+ Hits 199768 199779 +11
+ Misses 37062 37060 -2
Partials 219 219
|
hubertdeng123
approved these changes
Mar 4, 2024
aliu39
pushed a commit
that referenced
this pull request
Mar 6, 2024
We need to support deleted fields on Django model schemas for a number of self-hosted released (currently 2). This means that even if we delete a field on HEAD, we still need to make the import script aware that the field could exit on imported JSON, and pre-process that JSON in such a way that the field is removed in cases where the JSON was generated by an old version that still contained the field. There is no purpose in testing this code standalone. It passes tests in #65923, which is the first actual use of this shimming mechanism.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
We need to support deleted fields on Django model schemas for a number of self-hosted released (currently 2). This means that even if we delete a field on HEAD, we still need to make the import script aware that the field could exit on imported JSON, and pre-process that JSON in such a way that the field is removed in cases where the JSON was generated by an old version that still contained the field.
There is no purpose in testing this code standalone. It passes tests in #65923, which is the first actual use of this shimming mechanism.