Draft: feat: Add column to DB + Migration #377
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @yammesicka - I've reviewed your changes and they look great!
General suggestions:
- Consider aligning the naming of the new column across the model and migration function for consistency and clarity.
- Review the return value of the migration function to ensure it provides meaningful feedback about the migration's success.
- Explore abstracting column addition into a more generic function to simplify future migrations and adhere to DRY principles.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟡 Complexity: 1 issue found
- 🟢 Docstrings: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
| @@ -624,6 +624,7 @@ class Solution(BaseModel): | |||
| exercise = ForeignKeyField(Exercise, backref='solutions') | |||
| solver = ForeignKeyField(User, backref='solutions') | |||
| checker = ForeignKeyField(User, null=True, backref='solutions') | |||
| is_key_answer = BooleanField(default=False) | |||
There was a problem hiding this comment.
suggestion (code_clarification): Consider renaming is_key_answer to is_model_solution for consistency.
The new column added to the Solution model is referred to as is_model_solution in the migration function but is named is_key_answer here. Aligning these names would improve code readability and maintainability.
| def _add_is_model_solution_column() -> bool: | ||
| Solution = models.Solution | ||
| _migrate_column_in_table_if_needed(Solution, Solution.is_model_solution) | ||
| return True |
There was a problem hiding this comment.
suggestion (code_refinement): Ensure the return value of _add_is_model_solution_column is meaningful.
The function always returns True, which might not be informative. Consider returning a value that reflects whether the migration was necessary or successful.
| @@ -338,6 +338,12 @@ def _linter_email_migration(): | |||
| log.info(f'{new_mail_address} already exists in User') | |||
|
|
|||
|
|
|||
| def _add_is_model_solution_column() -> bool: | |||
There was a problem hiding this comment.
issue (complexity): Consider abstracting the column addition into a more generic function.
While the added functionality in _add_is_model_solution_column achieves the intended migration task, it introduces a higher level of complexity and specificity to the migration module. This approach could potentially make the codebase harder to maintain, especially as more migrations are added over time. To streamline the migration process and adhere to the DRY principle, consider abstracting the column addition into a more generic function. For instance:
def _migrate_add_column(model, column_name, column_type):
if not column_exists(model, column_name):
with models.database.atomic():
migrator = MySQLMigrator(models.database)
migrate(
migrator.add_column(model._meta.table_name, column_name, column_type())
)
log.info(f"Column {column_name} added to {model._meta.table_name}")
else:
log.info(f"Column {column_name} already exists in {model._meta.table_name}")This method can then be used for adding any column to any model, reducing the need for specific functions for each migration task. It simplifies the migration process, making the codebase easier to maintain and extend in the future.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #377 +/- ##
==========================================
- Coverage 80.48% 80.39% -0.10%
==========================================
Files 65 65
Lines 3049 3055 +6
==========================================
+ Hits 2454 2456 +2
- Misses 595 599 +4 ☔ View full report in Codecov by Sentry. |
No description provided.