Convert Rule label/annotation storage to JsonField #427
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
When Promgen was written, there was not a default JsonField, so labels and annotations were implemented as a class. Now that JsonField has been in Django since 3.1, it's a good time to change the implementation. Previously, our audit log did *not* store change to labels/annotations (because they were separate objects), so one benefit of this migration is that those changes now show up in the edit log. We also expect some queries to be a bit faster now that we do not need to query the other table relations for labels/annotations.
vincent-olivert-riera
approved these changes
Jul 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When Promgen was written, there was not a default JsonField, so labels and annotations were implemented as a class. Now that JsonField has been in Django since 3.1, it's a good time to change the implementation.
Previously, our audit log did not store change to labels/annotations (because they were separate objects), so one benefit of this migration is that those changes now show up in the edit log.
We also expect some queries to be a bit faster now that we do not need to query the other table relations for labels/annotations.
There may be some bits that could use better comments so feel free to point out the lines where the current explanation is insufficient.