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

Jump to bottom

Fixed LTI duplicate roster error #2213

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

Fixed LTI duplicate roster error #2213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
234f8e3
Filters out duplicate user
coder6583 Sep 22, 2024
2fb8c46
show warning message
coder6583 Sep 22, 2024
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
17 changes: 12 additions & 5 deletions app/controllers/courses_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,10 @@ def upload_roster
begin
save_uploaded_roster
flash[:success] = "Successfully updated roster!"
unless @roster_warnings.nil?
w = @roster_warnings.keys.join('\n')
flash[:error] = w
end
Comment on lines +556 to +559
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.

redirect_to(action: "users") && return
rescue StandardError => e
if e != "Roster validation error"
Expand Down Expand Up @@ -798,6 +802,7 @@ def categorize_courses_for_listing(courses)
def write_cuds(cuds)
rowNum = 0
rosterErrors = {}
rosterWarnings = {}
Copy link
Contributor

Choose a reason for hiding this comment

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

Improve warning handling and follow Ruby conventions

The implementation of the warning system for duplicate emails is a good addition. However, there are a few suggestions for improvement:

  1. The warning message is hardcoded. Consider making it more descriptive or customizable.
  2. The warning system currently only handles duplicate emails. It might be beneficial to design it to handle other types of warnings in the future.
  3. The rosterWarnings variable uses camelCase, which is not consistent with Ruby naming conventions.

Here's a suggested improvement:

roster_warnings = {}

# ... (other code)

duplicate_email_msg = "Warning: Duplicate email detected"
if !roster_warnings.key?(duplicate_email_msg)
  roster_warnings[duplicate_email_msg] = []
end
roster_warnings[duplicate_email_msg].push(cud)

# ... (other code)

@roster_warnings = roster_warnings

This change uses snake_case for variable naming, makes the warning message slightly more descriptive, and sets up the structure to potentially handle different types of warnings in the future.

Also applies to: 953-957, 960-961

rowCUDs = []
duplicates = Set.new

Expand Down Expand Up @@ -863,7 +868,7 @@ def write_cuds(cuds)
new_cud.delete(:year)

# Build cud
if !user.nil?
if !user.nil? && !existing
cud = @course.course_user_data.new
cud.user = user
params = ActionController::Parameters.new(
Expand Down Expand Up @@ -945,13 +950,15 @@ def write_cuds(cuds)
rowCUDs.each do |cud|
next unless duplicates.include?(cud[:email])

msg = "Validation failed: Duplicate email #{cud[:email]}"
if !rosterErrors.key?(msg)
rosterErrors[msg] = []
msg = "Warning : Duplicate email #{cud[:email]}"
if !rosterWarnings.key?(msg)
rosterWarnings[msg] = []
end
rosterErrors[msg].push(cud)
rosterWarnings[msg].push(cud)
end

@roster_warnings = rosterWarnings

return if rosterErrors.empty?

@roster_error = rosterErrors
Expand Down