sort courses api results by course name

test plan:
 - calls to /api/v1/courses should return results sorted by
   course name (or nickname if the student sets this)

closes CNVS-35202

Change-Id: Ia675ec165c0c6b7175d780778a06731c8e6394a4
Reviewed-on: https://gerrit.instructure.com/103094
Tested-by: Jenkins
Reviewed-by: Dan Minkevitch <dan@instructure.com>
QA-Review: Heath Hales <hhales@instructure.com>
Product-Review: Jeremy Stanley <jeremy@instructure.com>

Author: jstanley0

app/controllers/courses_controller.rb

@@ -2755,9 +2755,11 @@ def courses_for_user(user, paginate_url: api_v1_courses_url)
 
     hash = []
 
-    enrollments.sort_by!(&:course_id)
     Canvas::Builders::EnrollmentDateBuilder.preload_state(enrollments)
     enrollments_by_course = enrollments.group_by(&:course_id).values
+    enrollments_by_course.sort_by! do |course_enrollments|
+      Canvas::ICU.collation_key(course_enrollments.first.course.nickname_for(user))
+    end
     enrollments_by_course = Api.paginate(enrollments_by_course, self, paginate_url) if api_request?
     courses = enrollments_by_course.map(&:first).map(&:course)
     preloads = [:account, :root_account]

spec/apis/v1/courses_api_spec.rb

@@ -375,11 +375,14 @@ def method_missing(method_name, *args)
     expect(courses.length).to eq 2
   end
 
-  it "returns course list in id sort order", priority: "2", test_id: 3058053 do
-    json = api_call(:get, "/api/v1/courses.json",
-    {controller: 'courses', action: 'index', format: 'json'})
-    course_ids = json.map{ |c| c["id"]}
-    expect(course_ids).to eq course_ids.sort
+  it "returns course list ordered by name (including nicknames)" do
+    c1 = course_with_student(course_name: 'def', active_all: true).course
+    c2 = course_with_student(user: @student, course_name: 'abc', active_all: true).course
+    c3 = course_with_student(user: @student, course_name: 'jkl', active_all: true).course
+    c4 = course_with_student(user: @student, course_name: 'xyz', active_all: true).course
+    @student.course_nicknames[c4.id] = 'ghi'; @student.save!
+    json = api_call(:get, "/api/v1/courses.json", controller: 'courses', action: 'index', format: 'json')
+    expect(json.map { |course| course['name'] }).to eq %w(abc def ghi jkl)
   end
 
   describe "user index" do