Replace family and stage tables with enum fields #238
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
omar-selo
commented
Jan 7, 2025
Comment on lines
+31
to
+37
| class StageName(str, Enum): | ||
| proposed = "proposed" | ||
| updates = "updates" | ||
| edge = "edge" | ||
| beta = "beta" | ||
| candidate = "candidate" | ||
| stable = "stable" |
There was a problem hiding this comment.
We could further distinguish between the stages of each family. But I think that's not necessary right now
nadzyah
approved these changes
Jan 7, 2025
nadzyah
reviewed
Jan 7, 2025
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.
Description
Changes:
Reasoning:
Families and stages were first introduced as tables with the idea of it being easier to add families in the future. That turned out not to be so simple though. Adding families requires specific code changes for each family. Hence the code base ended up knowing the families and in fact using them in conditionals. That beats the purpose of storing them as data tables. So this PR removes these tables. Doing so simplified our queries as it avoids the need for joins to figure out an artefact's family or stage.
Resolved issues
A refactor to help towards https://warthogs.atlassian.net/browse/RTW-301
Documentation
Web service API changes
Family.nametoArtefact.family(these endpoints are only used by us)Tests
Updated tests.