fix #5518 -- improve sorting of students in a course

Author: williamstein

src/packages/frontend/course/util.ts

@@ -169,8 +169,8 @@ export function immutable_to_list<T, P>(
 ): T extends TypedMap<infer S>
   ? S[]
   : T extends Map<string, infer S>
-    ? S[]
-    : any;
+  ? S[]
+  : any;
 export function immutable_to_list(x: any, primary_key?): any {
   if (x == null || x == undefined) {
     return;
@@ -242,34 +242,56 @@ export function order_list<T extends { deleted: boolean }>(opts: {
   return { list, deleted: x, num_deleted: sorted_deleted.length };
 }
 
-const sort_on_string_field = (field) => (a, b) =>
-  cmp(a[field].toLowerCase(), b[field].toLowerCase());
+const cmp_strings = (a, b, field) => {
+  return cmp(a[field]?.toLowerCase() ?? "", b[field]?.toLowerCase() ?? "");
+};
 
-const sort_on_numerical_field = (field) => (a, b) =>
-  cmp(a[field] * -1, b[field] * -1);
+// first sort by domain, then address at that domain... since there will be many students
+// at same domain, and '[email protected]' > '[email protected]' > '[email protected]' is true but not helpful
+const cmp_email = (a, b) => {
+  const v = a.split("@");
+  const w = b.split("@");
+  const c = cmp(v[1], w[1]);
+  if (c) {
+    return c;
+  }
+  return cmp(v[0], w[0]);
+};
 
-export enum StudentField {
-  email = "email",
-  first_name = "first_name",
-  last_name = "last_name",
-  last_active = "last_active",
-  hosting = "hosting",
-}
+const sort_on_string_field = (field, field2) => (a, b) => {
+  const c =
+    field == "email_address"
+      ? cmp_email(a[field], b[field])
+      : cmp_strings(a, b, field);
+  return c != 0 ? c : cmp_strings(a, b, field2);
+};
+
+const sort_on_numerical_field = (field, field2) => (a, b) => {
+  const c = cmp((a[field] ?? 0) * -1, (b[field] ?? 0) * -1);
+  return c != 0 ? c : cmp_strings(a, b, field2);
+};
+
+type StudentField =
+  | "email"
+  | "first_name"
+  | "last_name"
+  | "last_active"
+  | "hosting";
 
 export function pick_student_sorter<T extends { column_name: StudentField }>(
   sort: T,
 ) {
   switch (sort.column_name) {
     case "email":
-      return sort_on_string_field("email_address");
+      return sort_on_string_field("email_address", "last_name");
     case "first_name":
-      return sort_on_string_field("first_name");
+      return sort_on_string_field("first_name", "last_name");
     case "last_name":
-      return sort_on_string_field("last_name");
+      return sort_on_string_field("last_name", "first_name");
     case "last_active":
-      return sort_on_numerical_field("last_active");
+      return sort_on_numerical_field("last_active", "last_name");
     case "hosting":
-      return sort_on_string_field("hosting");
+      return sort_on_string_field("hosting", "email_address");
   }
 }
 

src/packages/frontend/frame-editors/course-editor/course-panel-wrapper.tsx

@@ -195,7 +195,7 @@ const CoursePanelWrapper: React.FC<FrameProps> = React.memo(
           error={error}
           setError={(error) => {
             const actions = redux.getActions(name) as CourseActions;
-            if (actions != null) actions.set_error("");
+            actions?.set_error(error);
           }}
         />
       );