Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Draft: feat: Add column to DB + Migration #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yammesicka wants to merge 1 commit into master
base: master
Choose a base branch
Loading
from add-example-solution

Conversation

Copy link
Member

@yammesicka yammesicka commented Mar 24, 2024

No description provided.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

sourcery-ai[bot] reacted with thumbs up emoji sourcery-ai[bot] reacted with thumbs down emoji
@@ -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)
Copy link

@sourcery-ai sourcery-ai bot Mar 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

sourcery-ai[bot] reacted with thumbs up emoji sourcery-ai[bot] reacted with thumbs down emoji
Comment on lines +341 to +344
def _add_is_model_solution_column() -> bool:
Solution = models.Solution
_migrate_column_in_table_if_needed(Solution, Solution.is_model_solution)
return True
Copy link

@sourcery-ai sourcery-ai bot Mar 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

sourcery-ai[bot] reacted with thumbs up emoji sourcery-ai[bot] reacted with thumbs down emoji
@@ -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:
Copy link

@sourcery-ai sourcery-ai bot Mar 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

sourcery-ai[bot] reacted with thumbs up emoji sourcery-ai[bot] reacted with thumbs down emoji
Copy link

codecov bot commented Mar 24, 2024

Codecov Report

Attention: Patch coverage is 33.33333% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 80.39%. Comparing base (d9264ad) to head (315f1c2).
Report is 1 commits behind head on master.

Files Patch % Lines
lms/lmsdb/bootstrap.py 20.00% 4 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /