Several Bug Fixes to Optimiser (#4075)

* fix(module): Fixed the bug from semester timetable data crashing optimiser

* fix(UI): Fixed the problem with weirdly spaced info icon for mobiles

* fix(lessontype): Typo in lesson type

* refactor(optimiser): Adding support for lessons on Saturday

* feat(optimiser): add support for special terms in NUSMods shareable link generation

* refactor(optimiser): updated time components to handle 30 mins slots

- Added auto scroll effect when optimisation is completed

* style(optimiser): enhance layout and formatting in OptimiserForm

* refactor(optimiser): clarify comments and change to useRef

---------

Co-authored-by: Ravern Koh <[email protected]>

Author: thejus03

website/api/optimiser/README.md

@@ -81,14 +81,16 @@ The optimiser uses a **Beam Search algorithm** to efficiently explore the vast s
     [ /* Tuesday slots */ ],
     [ /* Wednesday slots */ ],
     [ /* Thursday slots */ ],
-    [ /* Friday slots */ ]
+    [ /* Friday slots */ ],
+    [ /* Saturday slots */ ]
   ],
   "DayDistance": [
     0, // Monday
     0, // Tuesday
     0.6879499381097249, // Wednesday
     34.33700778293036, // Thursday
-    7.738363670499865 // Friday
+    7.738363670499865, // Friday
+    0 // Saturday
   ],
   "TotalDistance": 42.76332139153995,
   "shareableLink": "https://nusmods.com/timetable/sem-1/share?CS1010S=LEC:1,REC:04&CS2030S=LEC:1&MA1521=LEC:1,TUT:01"
@@ -101,7 +103,7 @@ The optimiser uses a **Beam Search algorithm** to efficiently explore the vast s
 | -------------- | ---------- | -------------------------------------------------------------------------------------- |
 | `modules`      | `[]string` | Module codes to include in optimisation in Upper case (e.g. "CS1010S")                 |
 | `recordings`   | `[]string` | Lessons marked as recorded/online (format: "MODULE LessonType") e.g. "CS1010S Lecture" |
-| `freeDays`     | `[]string` | Weekdays to keep free of physical classes e.g. "Monday"                                |
+| `freeDays`     | `[]string` | Days to keep free of physical classes e.g. "Monday"                                    |
 | `earliestTime` | `string`   | Earliest acceptable class time (HHMM format)                                           |
 | `latestTime`   | `string`   | Latest acceptable class time (HHMM format)                                             |
 | `acadYear`     | `string`   | Academic year (format: "YYYY-YYYY") e.g. "2024-2025"                                   |

website/api/optimiser/_constants/constants.go

@@ -21,7 +21,7 @@ var LessonTypeAbbrev = map[string]string{
 	"PACKAGED TUTORIAL":             "PTUT",
 	"RECITATION":                    "REC",
 	"SECTIONAL TEACHING":            "SEC",
-	"SEMINAR-STYLE MODULE TEACHING": "SEM",
+	"SEMINAR-STYLE MODULE CLASS":	 "SEM",
 	"TUTORIAL":                      "TUT",
 	"TUTORIAL TYPE 2":               "TUT2",
 	"TUTORIAL TYPE 3":               "TUT3",

website/api/optimiser/_models/models.go

@@ -20,8 +20,8 @@ type OptimiserRequest struct {
 
 type TimetableState struct {
 	Assignments   map[string]string // lessonKey -> chosen classNo
-	DaySlots      [5][]ModuleSlot   // For each weekday, a time-sorted slice of slots
-	DayDistance   [5]float64        // Squared travel distance per day
+	DaySlots      [6][]ModuleSlot   // For each day, a time-sorted slice of slots
+	DayDistance   [6]float64        // Squared travel distance per day
 	TotalDistance float64           // Sum of all DayDistance
 }
 
@@ -37,7 +37,7 @@ type ModuleSlot struct {
 	// Parsed fields
 	StartMin  int    // Minutes from 00:00 (e.g., 540 for 09:00)
 	EndMin    int    // Minutes from 00:00
-	DayIndex  int    // 0=Monday, 1=Tuesday, 2=Wednesday, 3=Thursday, 4=Friday
+	DayIndex  int    // 0=Monday, 1=Tuesday, 2=Wednesday, 3=Thursday, 4=Friday, 5=Saturday
 	LessonKey string // "MODULE|LessonType"
 }
 
@@ -71,13 +71,14 @@ type Location struct {
 	Location Coordinates `json:"location"`
 }
 
-// dayToIndex maps uppercase weekday names to indices 0..4.
+// dayToIndex maps uppercase weekday names to indices 0..5.
 var dayToIndex = map[string]int{
 	"MONDAY":    0,
 	"TUESDAY":   1,
 	"WEDNESDAY": 2,
 	"THURSDAY":  3,
 	"FRIDAY":    4,
+	"SATURDAY":  5,
 }
 
 // Helper Functions

website/api/optimiser/_modules/modules.go

@@ -39,8 +39,17 @@ func GetAllModuleSlots(optimiserRequest models.OptimiserRequest) (map[string]map
 			return nil, err
 		}
 
-		// Store the module slots for the module in map
-		moduleSlots[module] = mergeAndFilterModuleSlots(moduleData.SemesterData[optimiserRequest.AcadSem-1].Timetable, venues, optimiserRequest, module)
+		// Get the module timetable for the semester
+		var moduleTimetable []models.ModuleSlot
+		for _, semester := range moduleData.SemesterData {
+			if semester.Semester == optimiserRequest.AcadSem {
+				moduleTimetable = semester.Timetable
+				break
+			}
+		}
+
+		// Store the module slots for the module 
+		moduleSlots[module] = mergeAndFilterModuleSlots(moduleTimetable, venues, optimiserRequest, module)
 
 	}
 

website/api/optimiser/_solver/nusmods_link.go

@@ -64,6 +64,10 @@ func GenerateNUSModsShareableLink(assignments map[string]string, req models.Opti
 		semesterPath = "sem-1"
 	case 2:
 		semesterPath = "sem-2"
+	case 3:
+		semesterPath = "st-i"
+	case 4:
+		semesterPath = "st-ii"
 	default:
 		semesterPath = "sem-1"
 	}

website/api/optimiser/_solver/solver.go

@@ -39,7 +39,7 @@ func BeamSearch(
 	initial := models.TimetableState{
 		Assignments: make(map[string]string),
 	}
-	for d := 0; d < 5; d++ {
+	for d := 0; d < 6; d++ {
 		initial.DaySlots[d] = make([]models.ModuleSlot, 0)
 	}
 	beam := []models.TimetableState{initial}
@@ -55,7 +55,7 @@ func BeamSearch(
 
 				validGroup := make([]models.ModuleSlot, 0, len(group))
 				for _, slot := range group {
-					if slot.DayIndex >= 0 && slot.DayIndex < 5 {
+					if slot.DayIndex >= 0 && slot.DayIndex < 6 {
 						validGroup = append(validGroup, slot)
 					}
 				}
@@ -186,7 +186,7 @@ func copyState(src models.TimetableState) models.TimetableState {
 	}
 
 	// Copy day slots
-	for i := 0; i < 5; i++ {
+	for i := 0; i < 6; i++ {
 		if len(src.DaySlots[i]) > 0 {
 			newState.DaySlots[i] = make([]models.ModuleSlot, len(src.DaySlots[i]))
 			copy(newState.DaySlots[i], src.DaySlots[i])
@@ -263,7 +263,7 @@ Lower score means a better (more preferred) timetable.
 */
 func scoreTimetableState(state models.TimetableState, recordings map[string]bool, optimiserRequest models.OptimiserRequest) float64 {
 	var totalScore float64
-	for d := 0; d < 5; d++ {
+	for d := 0; d < 6; d++ {
 		if len(state.DaySlots[d]) == 0 {
 			continue
 		}

website/src/views/optimiser/OptimiserButton.tsx

@@ -43,19 +43,18 @@ const OptimiserButton: React.FC<OptimiserButtonProps> = ({
       setIsOptimising(true);
       setShareableLink(''); // Reset shareable link
       const modulesList = Object.keys(timetable);
-      const formatTime = (time: string) => `${time.padStart(2, '0')}00`;
       const acadYearFormatted = `${acadYear.split('/')[0]}-${acadYear.split('/')[1]}`;
 
       const data = await sendOptimiseRequest(
         modulesList,
         acadYearFormatted,
         activeSemester,
         Array.from(selectedFreeDays),
-        formatTime(earliestTime),
-        formatTime(latestTime),
+        earliestTime,
+        latestTime,
         recordings,
-        formatTime(earliestLunchTime),
-        formatTime(latestLunchTime),
+        earliestLunchTime,
+        latestLunchTime,
       );
 
       if (data && data.shareableLink) {

website/src/views/optimiser/OptimiserContent.tsx

@@ -21,13 +21,14 @@ const OptimiserContent: React.FC = () => {
 
   const [selectedLessons, setSelectedLessons] = useState<LessonOption[]>([]);
   const [selectedFreeDays, setSelectedFreeDays] = useState<Set<string>>(new Set());
-  const [earliestTime, setEarliestTime] = useState<string>('08');
-  const [latestTime, setLatestTime] = useState<string>('19');
-  const [earliestLunchTime, setEarliestLunchTime] = useState<string>('12');
-  const [latestLunchTime, setLatestLunchTime] = useState<string>('14');
+  const [earliestTime, setEarliestTime] = useState<string>('0800');
+  const [latestTime, setLatestTime] = useState<string>('1900');
+  const [earliestLunchTime, setEarliestLunchTime] = useState<string>('1200');
+  const [latestLunchTime, setLatestLunchTime] = useState<string>('1400');
   const [freeDayConflicts, setFreeDayConflicts] = useState<FreeDayConflict[]>([]);
   const [unAssignedLessons, setUnAssignedLessons] = useState<LessonOption[]>([]);
   const [shareableLink, setShareableLink] = useState<string>('');
+  const [hasSaturday, setHasSaturday] = useState<boolean>(false);
 
   // Generate lesson options from current timetable
   const lessonOptions = useMemo(() => {
@@ -76,7 +77,9 @@ const OptimiserContent: React.FC = () => {
       lessonsForType.forEach((lesson) => {
         days.add(lesson.day);
       });
-
+      if (days.has('Saturday')) {
+        setHasSaturday(true);
+      }
       lessonDays.push({
         uniqueKey: option.uniqueKey,
         moduleCode: option.moduleCode,
@@ -179,6 +182,7 @@ const OptimiserContent: React.FC = () => {
         earliestLunchTime={earliestLunchTime}
         latestLunchTime={latestLunchTime}
         freeDayConflicts={freeDayConflicts}
+        hasSaturday={hasSaturday}
         onToggleLessonSelection={toggleLessonSelection}
         onToggleFreeDay={toggleFreeDay}
         onEarliestTimeChange={setEarliestTime}

website/src/views/optimiser/OptimiserForm.scss

@@ -30,6 +30,8 @@
 // Section headers
 .sectionHeader {
   display: flex;
+  flex-direction: row;
+  flex-wrap: wrap;
   align-items: center;
   margin-bottom: 1rem;
   font-size: 1rem;
@@ -185,7 +187,7 @@
 }
 
 .timeSelect {
-  width: 4.5rem;
+  width: 7.1rem;
   padding: 0.25rem 0.75rem;
   padding-left: 0.9rem;
   border: 1px solid var(--gray-lighter);