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.

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

Fixed LTI duplicate roster error #2213

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

coder6583
Copy link
Contributor

An error occurs when we have a roster with duplicate email addresses, so changed it to only a warning.

Description

Before: When we sync the roster to a LTI course that has duplicate users, an error occured.
After: When we sync the roster, the sync works, but a warning is produced.
image

Motivation and Context

The LTI Test Course has duplicate users, and the roster sync was failing.

How Has This Been Tested?

I created a new course in my development environment, and linked the LTI test course, and synced the roster.
image

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
  • My change requires a change to the documentation, which is located at Autolab Docs
  • I have updated the documentation accordingly, included in this PR

Other issues / help required

If unsure, feel free to submit first and we'll help you along.

Copy link
Contributor

coderabbitai bot commented Sep 22, 2024

Walkthrough

Walkthrough

The changes introduce a mechanism for handling warnings during roster uploads in the courses_controller.rb. A new variable, rosterWarnings, is created to collect warnings related to duplicate emails, which are now treated as warnings instead of errors. The @roster_warnings instance variable is updated to store these warnings and display them to the user through the flash[:error] message.

Changes

File Change Summary
app/controllers/courses_controller.rb Introduced rosterWarnings variable for collecting warnings; updated @roster_warnings to handle duplicate email warnings instead of errors.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CoursesController
    participant Roster

    User->>CoursesController: Upload roster
    CoursesController->>Roster: Process roster data
    Roster-->>CoursesController: Return warnings/errors
    CoursesController->>CoursesController: Check for warnings
    alt Warnings exist
        CoursesController->>User: Display warnings
    end
    alt Errors exist
        CoursesController->>User: Display errors
    end
Loading

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
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 <commit_id>, please review it.
    -- Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Tip

Early access features: enabled

We are currently testing new code review model(s) that may lead to higher noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between be48fe4 and 2fb8c46.

Files selected for processing (1)
  • app/controllers/courses_controller.rb (4 hunks)
Additional comments not posted (1)
app/controllers/courses_controller.rb (1)

556-559: LGTM: Successfully implemented roster warning system

The changes successfully implement a warning system for roster uploads, focusing on detecting and reporting duplicate email addresses. This aligns well with the PR objectives of allowing roster synchronization to proceed while alerting users to potential issues.

Key improvements:

  1. Added a mechanism to collect and store warnings during the roster processing.
  2. Implemented specific handling for duplicate email warnings.
  3. Added logic to display warnings to the user after roster upload.

The implementation is sound and doesn't introduce any apparent bugs or issues. However, there are opportunities for minor improvements in naming conventions and error/warning handling, as mentioned in the previous comments.

Overall, this change enhances the user experience by providing more informative feedback during the roster upload process.

Also applies to: 805-805, 953-957, 960-961

Comment on lines +556 to +559
unless @roster_warnings.nil?
w = @roster_warnings.keys.join('\n')
flash[:error] = w
end
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider improving the warning display mechanism

The new warning system is a good addition, but there are a few points to consider:

  1. Using flash[:error] for warnings might be confusing. Consider using flash[:warning] instead to differentiate between errors and warnings.
  2. Joining warning messages with '\n' might not render properly in HTML. Consider using <br> for line breaks or formatting the warnings as an HTML list.
  3. The success message is still displayed even when there are warnings. Consider adjusting the logic to provide a more nuanced feedback.

Here's a suggested improvement:

if @roster_warnings.present?
  flash[:warning] = "Roster uploaded with warnings:"
  flash[:warning] += "<ul>"
  @roster_warnings.keys.each do |warning|
    flash[:warning] += "<li>#{warning}</li>"
  end
  flash[:warning] += "</ul>"
  flash[:partial_success] = "Roster updated, but with some warnings. Please review."
else
  flash[:success] = "Successfully updated roster!"
end
flash[:html_safe] = true

This change separates warnings from errors, formats the warnings as an HTML list, and provides a more accurate success message.

app/controllers/courses_controller.rb Show resolved Hide resolved
msg = "Validation failed: Duplicate email #{cud[:email]}"
if !rosterErrors.key?(msg)
rosterErrors[msg] = []
msg = "Warning : Duplicate email #{cud[:email]}"
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add that this duplicate email was ignored / which line the duplicate email was on?

Copy link
Contributor

@20wildmanj 20wildmanj left a comment

Choose a reason for hiding this comment

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

Changes look good to me, verified behavior on both roster upload and LTI roster sync

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants