Move submission version logic to be handled by AUD

[20wildmanj]

Summary

Summary generated by Reviewpad on 08 Dec 23 19:44 UTC

This pull request includes multiple patches:

1. [PATCH 1/6] Move submission version logic to be handled by AUD:

   • Moves the logic for handling submission versions from the Submission model to the AssessmentUserDatum model.
   • Adds a new migration to add a version_number column to the assessment_user_data table.
   • Updates the validateHandin and validateHandinForGroups methods in the AssessmentHandinCore helper to account for the version number changes.

2. [PATCH 2/6] Update migration variable naming:

   • Renames the variable test to max_submission_version in the migration file.

3. [PATCH 3/6] Fix unit tests, version number for new AUDs:

   • Adds a check to handle the case where the version_number attribute of an AssessmentUserDatum is nil.

4. [PATCH 4/6] Fix CodeRabbit issues:

   • Updates the migration file to remove unused code related to reverting version numbers.

5. [PATCH 5/6] Add version number to schema:

   • Adds a new version_number column to the assessment_user_data table in the schema.

6. [PATCH 6/6] Change schema timestamp:

   • Updates the schema timestamp in the schema.rb file.

Please review and test these patches as needed.

Description

Move submission version logic to be handled by AUD instead of being generated by submission model, which allows for mutual exclusion of updating the version in the case multiple submissions are made in quick succession. A lock was not used on the code in Submission since it would require a global lock on that piece of code, which would likely slow down submissions for all students significantly, especially given the query to determine the maximum submission.

Motivation and Context

Closes #1954

How Has This Been Tested?

• Run rails db:migrate to migrate version number (can check DB to see that version number matches highest version in submissions)

• Install the puma gem using gem install puma in order to allow for multithreaded support of rails in dev
• Run puma to start up your autolab instance
• Go to an assessment index, open up developer tools, and submit to an assessment with no previous submissions
• See that submission works, and version number is 1
• Then copy the POST request handin as a curl request, and then you can use the following command to run multiple handin requests at once:
  • seq 1 5 | xargs -I $ -n1 -P10 curl {your curl body}
• See that submissions are given submission values in order, and there are no duplicated version numbers. On the AUD side, version_number should be updated to match the most recent submission, and latest_submission_id still works, points to id of most recent submission
  

Also check that adding new users to an assessment and then making submissions as that user works (testing that system works with creation of new AUDs)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting

[coderabbitai]

Walkthrough

Walkthrough

The codebase has undergone a series of changes to introduce and manage a new version_number attribute for handling concurrent submissions. This includes atomic updates to the version number, removal of a uniqueness validation for a version attribute, and a database migration to add the new column. Additionally, test specifications have been updated to accommodate the new versioning logic.

Changes

File Path	Change Summary
app/helpers/assessment_handin_core.rb app/models/assessment_user_datum.rb	Added empty lines, unless conditions, and introduced update_version_number method for control flow adjustments and atomic version updates.
app/models/submission.rb	Removed validates declaration for version attribute; updated version setting logic.
db/migrate/.../add_version_number_to_assessment_user_data.rb	Added version_number column and logic for populating and reverting it.
spec/sets/submissions.rb	Updated create_submissions_for_student function to include version_number argument in a method call.

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

[damianhxy]

Successfully followed testing steps. LGTM!