Fixed support for Y-session courses (#1757)

Co-authored-by: Jason D. / Purplegaze <purplecoin64@gmail.com>

Author: david-yz-liu

CHANGELOG.md

@@ -12,6 +12,7 @@
 - Remove period after instructor's first name in course info modal
 - Fixed a bug regarding the scrollbar appearing on the /graph and /generate pages
 - Fix bool node centering in Generate page
+- Fixed support for year-long ("Y" session) courses
 
 ### 🔧 Internal changes
 

app/Config.hs

@@ -183,7 +183,7 @@ createReqBody page = object [ "campuses" .= ([] :: [T.Text]),
                         "page" .= page,
                         "pageSize" .= (300 :: Int),
                         "requirementProps" .= ([] :: [T.Text]),
-                        "sessions" .= (["20269", "20271"] :: [T.Text]),
+                        "sessions" .= (["20269", "20271", "20269-20271"] :: [T.Text]),
                         "timePreferences" .= ([] :: [T.Text])
                      ]
 

app/Database/Migrations.hs

@@ -33,6 +33,7 @@ applyMigrations currVersion migrations = do
 migrationList :: [MigrationWrapper]
 migrationList = [ MigrationWrapper {version=2, script=renamePostTables}
                 , MigrationWrapper {version=3, script=renameCoursesTable}
+                , MigrationWrapper {version=4, script=splitTimes}
                 ]
 
 -- | Migration script which renames the Post tables to Program
@@ -47,6 +48,13 @@ renameCoursesTable :: Migration
 renameCoursesTable =
     addMigration True "ALTER TABLE courses RENAME TO course;"
 
+-- | Migration script to add proper support for year-long courses
+splitTimes :: Migration
+splitTimes = do
+    addMigration True "ALTER TABLE times RENAME COLUMN first_room TO location;"
+    addMigration True "ALTER TABLE times DROP COLUMN second_room;"
+    addMigration True "ALTER TABLE times ADD session varchar(32);"
+
 -- | Gets the current version of the database.
 -- If no version is defined, initialize the
 -- version to the latest version and return that.

app/Database/Tables.hs

@@ -70,12 +70,12 @@ Meeting
     UniqueMeeting code session section
 
 Times
+    session T.Text Maybe
     weekDay Double
     startHour Double
     endHour Double
     meeting MeetingId
-    firstRoom T.Text Maybe
-    secondRoom T.Text Maybe
+    location T.Text Maybe
 
 Breadth
     description T.Text
@@ -161,20 +161,20 @@ SchemaVersion
 -- ** TODO: Remove these extra types and class instances
 
 data Time' =
-  Time' { weekDay' :: Double,
+  Time' { timeSession' :: Maybe T.Text,
+          weekDay' :: Double,
           startHour' :: Double,
           endHour' :: Double,
-          firstLocation' :: Maybe T.Text,
-          secondLocation' :: Maybe T.Text
+          timeLocation' :: Maybe T.Text
         } deriving (Show, Eq, Generic)
 
 data Time =
-  Time { weekDay :: Double,
-          startHour :: Double,
-          endHour :: Double,
-          firstLocation :: Maybe Building,
-          secondLocation :: Maybe Building
-        } deriving (Show, Generic)
+  Time { timeSession :: Maybe T.Text,
+         weekDay :: Double,
+         startHour :: Double,
+         endHour :: Double,
+         timeLocation :: Maybe Building
+       } deriving (Show, Generic)
 
 -- | A Meeting with its associated Times.
 data MeetTime = MeetTime {meetInfo :: Meeting, timeInfo :: [Time'] }
@@ -229,12 +229,11 @@ instance FromJSON Time' where
 
     building <- o .: "building"
     buildingCode <- building .: "buildingCode"
-    buildingRoomNumber <- building .: "buildingRoomNumber"
-    let meetingRoom1 = Just (T.concat [buildingCode, buildingRoomNumber])
-    meetingRoom2 <- o .:? "assignedRoom2" .!= Nothing
+
+    session <- o .: "sessionCode"
 
     let (adjustedDay, adjustedStartTime, adjustedEndTime) = convertTimeVals meetingDay meetingStartTime meetingEndTime
-    return $ Time' adjustedDay adjustedStartTime adjustedEndTime meetingRoom1 meetingRoom2
+    return $ Time' session adjustedDay adjustedStartTime adjustedEndTime buildingCode
 
 instance FromJSON MeetTime where
   parseJSON (Object o) = do

app/Models/Time.hs

@@ -8,19 +8,18 @@ import Models.Building (getBuilding)
 -- | Convert a Times record into a Time by resolving room codes to Buildings
 buildTime :: Times -> SqlPersistM Time
 buildTime t = do
-    room1 <- getBuilding (timesFirstRoom t)
-    room2 <- getBuilding (timesSecondRoom t)
-    return $ Time (timesWeekDay t)
+    location <- getBuilding (timesLocation t)
+    return $ Time (timesSession t)
+        (timesWeekDay t)
         (timesStartHour t)
         (timesEndHour t)
-        room1
-        room2
+        location
 
 buildTimes :: MeetingId -> Time' -> Times
 buildTimes meetingKey t =
-    Times (weekDay' t)
+    Times (timeSession' t) 
+        (weekDay' t)
         (startHour' t)
         (endHour' t)
         meetingKey
-        (firstLocation' t)
-        (secondLocation' t)
+        (timeLocation' t)

backend-test/Controllers/CourseControllerTests.hs

@@ -58,18 +58,18 @@ retrieveCourseTestCases =
                 }
                 [
                     Time' {
+                        timeSession' = Just "F",
                         weekDay' = 0.0,
                         startHour' = 10.0,
                         endHour' = 11.0,
-                        firstLocation' = Just "MP",
-                        secondLocation' = Nothing
+                        timeLocation' = Just "MP"
                     },
                     Time' {
+                        timeSession' = Just "F",
                         weekDay' = 2.0,
                         startHour' = 13.0,
                         endHour' = 14.0,
-                        firstLocation' = Just "SS",
-                        secondLocation' = Nothing
+                        timeLocation' = Just "SS"
                     }
                 ],
             MeetTime
@@ -85,23 +85,23 @@ retrieveCourseTestCases =
                 }
                 [
                     Time' {
+                        timeSession' = Just "S",
                         weekDay' = 1.0,
                         startHour' = 10.0,
                         endHour' = 11.0,
-                        firstLocation' = Just "WW",
-                        secondLocation' = Nothing
+                        timeLocation' = Just "WW"
                     },
                     Time' {
+                        timeSession' = Just "S",
                         weekDay' = 4.0,
                         startHour' = 13.0,
                         endHour' = 14.0,
-                        firstLocation' = Just "SS",
-                        secondLocation' = Nothing
+                        timeLocation' = Just "SS"
                     }
                 ]
         ],
         200,
-        "{\"allMeetingTimes\":[{\"meetData\":{\"cap\":50,\"code\":\"STA238\",\"enrol\":15,\"extra\":0,\"instructor\":\"Instructor Name\",\"section\":\"LEC0101\",\"session\":\"F\",\"wait\":0},\"timeData\":[{\"endHour\":11,\"firstLocation\":{\"buildingAddress\":\"N/A\",\"buildingCode\":\"MP\",\"buildingLat\":1,\"buildingLng\":1,\"buildingName\":\"MP\",\"buildingPostalCode\":\"A1A 1A1\"},\"secondLocation\":null,\"startHour\":10,\"weekDay\":0},{\"endHour\":14,\"firstLocation\":{\"buildingAddress\":\"N/A\",\"buildingCode\":\"SS\",\"buildingLat\":1,\"buildingLng\":1,\"buildingName\":\"SS\",\"buildingPostalCode\":\"A1A 1A1\"},\"secondLocation\":null,\"startHour\":13,\"weekDay\":2}]}],\"breadth\":null,\"coreqs\":\"CSC108H1/  CSC110Y1/  CSC148H1 *Note: the corequisite may be completed either concurrently or in advance.\",\"description\":\"An introduction to statistical inference and practice. Statistical models and parameters, estimators of parameters and their statistical properties, methods of estimation, confidence intervals, hypothesis testing, likelihood function, the linear model. Use of statistical computation for data analysis and simulation.\",\"distribution\":null,\"exclusions\":\"ECO220Y1/  ECO227Y1/  GGR270H1/  PSY201H1/  SOC300H1/  SOC202H1/  SOC252H1/  STA220H1/  STA221H1/  STA255H1/  STA248H1/  STA261H1/  STA288H1/  EEB225H1/  STAB22H3/  STAB27H3/  STAB57H3/  STA220H5/  STA221H5/  STA258H5/  STA260H5/  ECO220Y5/  ECO227Y5\",\"name\":\"STA238H1\",\"prereqString\":\"STA237H1/  STA247H1/  STA257H1/  STAB52H3/  STA256H5\",\"title\":\"Probability, Statistics and Data Analysis II\",\"videoUrls\":[\"https://example.com/video1\",\"https://example.com/video2\"]}"
+        "{\"allMeetingTimes\":[{\"meetData\":{\"cap\":50,\"code\":\"STA238\",\"enrol\":15,\"extra\":0,\"instructor\":\"Instructor Name\",\"section\":\"LEC0101\",\"session\":\"F\",\"wait\":0},\"timeData\":[{\"endHour\":11,\"startHour\":10,\"timeLocation\":{\"buildingAddress\":\"N/A\",\"buildingCode\":\"MP\",\"buildingLat\":1,\"buildingLng\":1,\"buildingName\":\"MP\",\"buildingPostalCode\":\"A1A 1A1\"},\"timeSession\":\"F\",\"weekDay\":0},{\"endHour\":14,\"startHour\":13,\"timeLocation\":{\"buildingAddress\":\"N/A\",\"buildingCode\":\"SS\",\"buildingLat\":1,\"buildingLng\":1,\"buildingName\":\"SS\",\"buildingPostalCode\":\"A1A 1A1\"},\"timeSession\":\"F\",\"weekDay\":2}]}],\"breadth\":null,\"coreqs\":\"CSC108H1/  CSC110Y1/  CSC148H1 *Note: the corequisite may be completed either concurrently or in advance.\",\"description\":\"An introduction to statistical inference and practice. Statistical models and parameters, estimators of parameters and their statistical properties, methods of estimation, confidence intervals, hypothesis testing, likelihood function, the linear model. Use of statistical computation for data analysis and simulation.\",\"distribution\":null,\"exclusions\":\"ECO220Y1/  ECO227Y1/  GGR270H1/  PSY201H1/  SOC300H1/  SOC202H1/  SOC252H1/  STA220H1/  STA221H1/  STA255H1/  STA248H1/  STA261H1/  STA288H1/  EEB225H1/  STAB22H3/  STAB27H3/  STAB57H3/  STA220H5/  STA221H5/  STA258H5/  STA260H5/  ECO220Y5/  ECO227Y5\",\"name\":\"STA238H1\",\"prereqString\":\"STA237H1/  STA247H1/  STA257H1/  STAB52H3/  STA256H5\",\"title\":\"Probability, Statistics and Data Analysis II\",\"videoUrls\":[\"https://example.com/video1\",\"https://example.com/video2\"]}"
     ),
 
     ("Course exists with meeting times",
@@ -132,23 +132,23 @@ retrieveCourseTestCases =
                 }
                 [
                     Time' {
+                        timeSession' = Just "F",
                         weekDay' = 0.0,
                         startHour' = 10.0,
                         endHour' = 11.0,
-                        firstLocation' = Just "MP",
-                        secondLocation' = Nothing
+                        timeLocation' = Just "MP"
                     },
                     Time' {
+                        timeSession' = Just "F",
                         weekDay' = 2.0,
                         startHour' = 13.0,
                         endHour' = 14.0,
-                        firstLocation' = Just "SS",
-                        secondLocation' = Nothing
+                        timeLocation' = Just "SS"
                     }
                 ]
         ],
         200,
-        "{\"allMeetingTimes\":[{\"meetData\":{\"cap\":50,\"code\":\"STA238\",\"enrol\":15,\"extra\":0,\"instructor\":\"Instructor Name\",\"section\":\"LEC0101\",\"session\":\"F\",\"wait\":0},\"timeData\":[{\"endHour\":11,\"firstLocation\":{\"buildingAddress\":\"N/A\",\"buildingCode\":\"MP\",\"buildingLat\":1,\"buildingLng\":1,\"buildingName\":\"MP\",\"buildingPostalCode\":\"A1A 1A1\"},\"secondLocation\":null,\"startHour\":10,\"weekDay\":0},{\"endHour\":14,\"firstLocation\":{\"buildingAddress\":\"N/A\",\"buildingCode\":\"SS\",\"buildingLat\":1,\"buildingLng\":1,\"buildingName\":\"SS\",\"buildingPostalCode\":\"A1A 1A1\"},\"secondLocation\":null,\"startHour\":13,\"weekDay\":2}]}],\"breadth\":null,\"coreqs\":\"CSC108H1/  CSC110Y1/  CSC148H1 *Note: the corequisite may be completed either concurrently or in advance.\",\"description\":\"An introduction to statistical inference and practice. Statistical models and parameters, estimators of parameters and their statistical properties, methods of estimation, confidence intervals, hypothesis testing, likelihood function, the linear model. Use of statistical computation for data analysis and simulation.\",\"distribution\":null,\"exclusions\":\"ECO220Y1/  ECO227Y1/  GGR270H1/  PSY201H1/  SOC300H1/  SOC202H1/  SOC252H1/  STA220H1/  STA221H1/  STA255H1/  STA248H1/  STA261H1/  STA288H1/  EEB225H1/  STAB22H3/  STAB27H3/  STAB57H3/  STA220H5/  STA221H5/  STA258H5/  STA260H5/  ECO220Y5/  ECO227Y5\",\"name\":\"STA238H1\",\"prereqString\":\"STA237H1/  STA247H1/  STA257H1/  STAB52H3/  STA256H5\",\"title\":\"Probability, Statistics and Data Analysis II\",\"videoUrls\":[\"https://example.com/video1\",\"https://example.com/video2\"]}"
+        "{\"allMeetingTimes\":[{\"meetData\":{\"cap\":50,\"code\":\"STA238\",\"enrol\":15,\"extra\":0,\"instructor\":\"Instructor Name\",\"section\":\"LEC0101\",\"session\":\"F\",\"wait\":0},\"timeData\":[{\"endHour\":11,\"startHour\":10,\"timeLocation\":{\"buildingAddress\":\"N/A\",\"buildingCode\":\"MP\",\"buildingLat\":1,\"buildingLng\":1,\"buildingName\":\"MP\",\"buildingPostalCode\":\"A1A 1A1\"},\"timeSession\":\"F\",\"weekDay\":0},{\"endHour\":14,\"startHour\":13,\"timeLocation\":{\"buildingAddress\":\"N/A\",\"buildingCode\":\"SS\",\"buildingLat\":1,\"buildingLng\":1,\"buildingName\":\"SS\",\"buildingPostalCode\":\"A1A 1A1\"},\"timeSession\":\"F\",\"weekDay\":2}]}],\"breadth\":null,\"coreqs\":\"CSC108H1/  CSC110Y1/  CSC148H1 *Note: the corequisite may be completed either concurrently or in advance.\",\"description\":\"An introduction to statistical inference and practice. Statistical models and parameters, estimators of parameters and their statistical properties, methods of estimation, confidence intervals, hypothesis testing, likelihood function, the linear model. Use of statistical computation for data analysis and simulation.\",\"distribution\":null,\"exclusions\":\"ECO220Y1/  ECO227Y1/  GGR270H1/  PSY201H1/  SOC300H1/  SOC202H1/  SOC252H1/  STA220H1/  STA221H1/  STA255H1/  STA248H1/  STA261H1/  STA288H1/  EEB225H1/  STAB22H3/  STAB27H3/  STAB57H3/  STA220H5/  STA221H5/  STA258H5/  STA260H5/  ECO220Y5/  ECO227Y5\",\"name\":\"STA238H1\",\"prereqString\":\"STA237H1/  STA247H1/  STA257H1/  STAB52H3/  STA256H5\",\"title\":\"Probability, Statistics and Data Analysis II\",\"videoUrls\":[\"https://example.com/video1\",\"https://example.com/video2\"]}"
     ),
 
     ("Course exists",
@@ -253,11 +253,11 @@ insertBuildings = mapM_ insertBuilding
     where
         insertBuilding code = insert_ Building {buildingCode = code, buildingName = code, buildingAddress = "N/A", buildingPostalCode = "A1A 1A1", buildingLat = 1.0, buildingLng = 1.0}
 
--- | Helper function to get a list of unique firstLocation' and secondLocation' values involved in a MeetTime
+-- | Helper function to get a list of unique locations involved in a MeetTime
 getUniqueBuildings :: [MeetTime] -> [T.Text]
 getUniqueBuildings = nub . concatMap getMeetBuildings
     where
-        getMeetBuildings (MeetTime _ times') = mapMaybe firstLocation' times' ++ mapMaybe secondLocation' times'
+        getMeetBuildings (MeetTime _ times') = mapMaybe timeLocation' times'
 
 -- | List of test cases as (label, input courses, expected output)
 indexTestCases :: [(String, [T.Text], String)]