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

Use instance variables instead of flash to display duplicates during roster import #2071

Closed damianhxy closed 4 months ago

damianhxy commented 5 months ago

Description

Use instance variables instead of flash to properly render roster import errors with large numbers of duplicates.

Motivation and Context

Currently, roster errors are propagated to the view using a flash. However, this results in a cookie overflow error when there are too many duplicates. By using instance variables, we can avoid this problem.

Closes #906

How Has This Been Tested?

roster_duplicates.csv roster_noduplicates.csv

Before PR - duplicates

Screenshot 2024-02-03 at 16 52 37

After PR - duplicates

Screenshot 2024-02-03 at 16 53 35

Also check that uploading rosters with no errors (roster_noduplicates.csv) works as expected.

Types of changes

Checklist:

coderabbitai[bot] commented 5 months ago
Walkthrough ## Walkthrough The recent changes focus on improving the roster import process by handling errors more gracefully, specifically addressing issues with duplicate email addresses. Modifications include shifting from a flash-based error message to an instance variable for errors, refining exception handling during CSV parsing, standardizing key access in views, and simplifying flash message rendering. These adjustments aim to provide clearer feedback to the user and avoid import failure due to duplicates, aligning with the objective to make the roster import process more robust and user-friendly. ## Changes | Files | Summary | |-------|---------| | `app/controllers/courses_controller.rb` | Changed the assignment of `flash[:roster_error]` to `@roster_error` and improved exception handling in `parse_roster_csv` method. | | `app/views/courses/upload_roster.html.erb`
`app/views/layouts/application.html.erb` | Standardized key access to use symbols, added conditional error message display, and simplified flash message rendering logic. | ## Assessment against linked issues | Objective | Addressed | Explanation | |-----------|-----------|-------------| | Roster import should not fail on duplicate email addresses (#906) | ✅ | The changes made to the error handling and messaging indicate an approach to allow users to identify and resolve issues with duplicate emails without causing the import process to fail outright. However, without explicit mention of handling duplicates in the provided summaries, the direct approach to cherry-picking duplicates as described in the issue cannot be confirmed. |

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.` - 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 from git 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.