Skip to content
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.

Sign up for GitHub

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

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −0
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions lms/lmsdb/bootstrap.py
View file
Original file line number Diff line number Diff line change
@@ -338,6 +338,12 @@
log.info(f'{new_mail_address} already exists in User')


def _add_is_model_solution_column() -> bool:
Copy link

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.

Solution = models.Solution
_migrate_column_in_table_if_needed(Solution, Solution.is_model_solution)
return True

Check warning on line 344 in lms/lmsdb/bootstrap.py

Codecov / codecov/patch

lms/lmsdb/bootstrap.py#L342-L344 

Added lines #L342 - L344 were not covered by tests
Comment on lines +341 to +344
Copy link

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.



def is_tables_exists(tables: Union[Model, Iterable[Model]]) -> bool:
if not isinstance(tables, (tuple, list)):
tables = (tables,)
@@ -369,6 +375,8 @@
_add_user_course_constaint()
_linter_email_migration()

_add_is_model_solution_column()

Check warning on line 378 in lms/lmsdb/bootstrap.py

Codecov / codecov/patch

lms/lmsdb/bootstrap.py#L378 

Added line #L378 was not covered by tests

models.create_basic_roles()
if models.User.select().count() == 0:
models.create_demo_users()
1 change: 1 addition & 0 deletions lms/lmsdb/models.py
View file
Original file line number Diff line number Diff line change
@@ -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

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.

state = CharField(
choices=STATES.to_choices(),
default=STATES.CREATED.name,