autolab / Autolab

Course management service that enables auto-graded programming assignments.
http://www.autolabproject.com/
Apache License 2.0
743 stars 209 forks source link

Add first batch of submissions tests, refactor backend code to have more error handling / validation #2107

Closed 20wildmanj closed 3 months ago

20wildmanj commented 4 months ago

Description

  1. Remove the #show route, which is unused, from routes.rb and submissions_controller.rb
  2. Refactor #new to have better and correct error-checking so that a 500 error wouldn't occur when a CUD ID didn't exist in the list of CUD IDs provided to the action
  3. Add validation of params / error-checking in #create on invalid submission creation
  4. Add similar error-checking to #update
  5. Update the submission destroy interface to be more user-friendly and make more sense, by disabling the button to destroy the submission unless the instructor has checked the box indicating the read the disclaimer and still wish to destroy the submission. Made buttons and checkbox more descriptive as well.

Before: Instructor could still click button to destroy the submission without checking the box but would get an "error" back.

Screenshot 2024-03-08 at 6 22 03 PM Screenshot 2024-03-08 at 6 22 08 PM

After: Instructor can't click button without having checked the box first.

Screenshot 2024-03-08 at 6 20 49 PM Screenshot 2024-03-08 at 6 21 00 PM
  1. Add tests for:
    • new
    • create
    • edit

(also try to fix flaky assessment_spec test by giving capybara expect more wait time)

  1. Fix version number not decreasing when assessment is deleted
    • add method delete_version_number to decrease version number when submission is destroyed, and update update_latest_submission so that it finds the latest submission based on creation date (and checks with version number)

Motivation and Context

Fixes #2109

How Has This Been Tested?

Screenshot 2024-03-08 at 7 12 49 PM

Types of changes

Checklist:

coderabbitai[bot] commented 4 months ago

[!WARNING]

Rate Limit Exceeded

@20wildmanj has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 20 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 50318c907a4b66462b499ffb5c739d7bc4550ed3 and 154227bbb7e4091b4bbe79eeb68a8bc4c8a557db.

Walkthrough

This set of changes focuses on refining the functionality related to submissions in a Ruby on Rails application. Key improvements include enhanced error handling and user feedback across controller actions, a significant modification in version numbering logic for submissions, and streamlined redirection and user interaction in views. The adjustments aim to make the application more robust, user-friendly, and maintainable by removing outdated code and implementing more intuitive behavior, particularly around submission versioning and error messaging.

Changes

File Path Change Summary
app/controllers/submissions_controller.rb Enhanced error handling and messaging; Removed unused code; Updated redirection logic.
app/models/submission.rb & app/models/assessment_user_datum.rb Added after_destroy callback for version number reset; Adjusted submission lookup logic.
config/routes.rb Excluded :show action from submissions resources.
spec/controllers/submissions_controller_spec.rb Added shared examples for testing various scenarios and user roles.
app/views/submissions/destroyConfirm.html.erb & app/views/submissions/edit.html.erb Updated UI elements and interaction logic for submission deletion and editing.

Assessment against linked issues

Objective Addressed Explanation
Version numbering should reset on submission deletion (#2109) The addition of the after_destroy :delete_version_number callback in the Submission model and the corresponding logic in assessment_user_datum.rb directly address the issue's requirement for resetting version numbering upon submission deletion.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
damianhxy commented 3 months ago

Unrelated but submission edit page is missing a title (and hence breadcrumb)

Could you add a <% @title = "Edit Submission" %> to the top of submissions/edit.html.erb? And also change the h2 to a h4 for consistency

Screenshot 2024-03-16 at 12 29 53