Skip to content

Latest commit

 

History

History
300 lines (250 loc) · 19 KB

CHANGELOG.md

File metadata and controls

300 lines (250 loc) · 19 KB

Changelog

Unreleased

🚨 Breaking changes

✨ New features/enhancements

  • Changed the colour of hybrid nodes to avoid a visual clash with the darkened background when selecting a focus

🐛 Bug fixes

  • Updated the campus map in CampusMap.tsx to comply with the OpenStreetMap tile usage policy (attribution, canonical tile URL, max zoom)
  • Fixed campus map not rendering in timetable modal by adding explicit height to #campus-map container
  • Fixed "Zoom to Fit" button: resolved sidebar overlap and enabled view reset for single-marker maps

🔧 Internal changes

  • Updated Cypress to 15.21.2, resolving the extract-zip and qs pnpm audit vulnerabilities, and disabled allowCypressEnv
  • Updated Cypress to 14.5.4, migrated cypress.json to cypress.config.js, fixed outdated end-to-end tests, added cypress:run/cypress:open scripts and README instructions for running them, and added an end-to-end test run to CI
  • Added test coverage for CampusMap component (7 test cases covering rendering, markers, and zoom functionality)
  • Simplified timetable availability check in Description.tsx by removing redundant Object.keys(sessions).length !== 0 condition
  • Updated OpenStreetMap tile layer URL from HTTP to HTTPS in CampusMap.tsx for improved security
  • Extracted read-only selection, prerequisite, and status computations (isSelected, arePrereqsSatisfied*, compute*Status, totalSelectedCredits) from Graph.js into a typed graphState.ts module
  • Fixed lint-staged pre-commit hook running Prettier and ESLint over the whole repository instead of only staged files, and added pnpm-lock.yaml to .prettierignore
  • Extracted the root <svg> setup (viewBox calculation, shared filters/markers) of Graph.js into a typed GraphCanvas.tsx component
  • Refactored react_modal.js.jsx into modular functional TypeScript components (CampusMap.tsx, CourseModal.tsx, DayBox.tsx, Description.tsx, FocusModal.tsx, MapModal.tsx, MapSidebar.tsx), added shared types.ts, and removed unused dead code
  • Migrated Sidebar.js, FocusBar.js, and NavBar.js.jsx to TypeScript
  • Removed Time' data type in favour of (MeetingId -> Times) function type in Database.Tables
  • Refactored Database.Tables.MeetTime' into Models.Meeting and renamed it to MeetingData
  • Refactored Database.Tables.Time into Models.Time and renamed it to TimeData
  • Refactored parseReqs into a new module Models.Requirement and updated its input type from String to Text
  • Added a test case for the getGraphJSON function in Controllers/Graph
  • Migrated JS package manager from yarn to pnpm
  • Updated react-leaflet to v5.0.0 and @eslint/compat to v2.1.0
  • Added peer dependency overrides for eslint-plugin-react (for eslint v10) and @babel/plugin-syntax-* (for @babel/core v8.0.1)
  • Set NODE_ENV=production for webpack build command
  • Fixed dynamic graph centering bug by updating parseTransform in app/Svg/Parser.hs to parse multiple transform functions and removing getShapesMinXY in js/components/graph/Graph.js
  • Switched CI provider from CircleCI to GitHub Actions
  • Cleared up documentation for various graph-related front-end functions
  • Adopted TypeScript v7 into build and CI pipelines and converted js/components/graph/Button.js to Button.tsx as a proof of concept
  • Added .gitattributes file to standardize to LF line endings and renormalized codebase
  • Added invalid JSON graph test coverage for saveGraphJSON in app/Controllers/Graph.hs
  • Converted various JS files to TypeScript
  • Fixed lint-staged check for CSS files
  • Removed deprecated Draw feature and remaining references to previously deprecated Search and Post features
  • Added static info existence test for Database/Database.hs
  • Converted more JS files to TypeScript
  • Enabled noUnusedLocals/noUnusedParameters in tsconfig.json and disabled ESLint's no-unused-vars for .ts/.tsx files
  • Refactored backend database runDb helper in app/Config.hs
  • Refactored Database.Tables.MeetTime into Models.Meeting and renamed it to MeetingParsedData; consolidated and refactored timetable JSON parsing helpers
  • Restructured courseography.cabal to separate executable from library, extract shared settings, and remove hlint
  • Refactored createReqBody in app/Config.hs to use session field from config.yaml
  • Refactored the Times table to Time with a database migration
  • Extracted loadGraphData.ts and util.ts (both TypeScript) out of js/components/graph/Graph.js, and moved js/util/util.ts to js/components/graph/requirementParser.ts
  • Changed SVG parsing to leave the fill column empty when inserting hybrid nodes into the database
  • Refactored js/components/grid/course_panel.js.jsx into separate typescript react components
  • Fixed type-only Typescript imports and added verbatimModuleSyntax: true to tsconfig.json
  • Extracted js/components/grid/calendar.js.jsx into TypeScript components

[0.8.1] - 2026-08-10

✨ New features/enhancements

  • Added recommended preparation field to courses and updated the course info modal
  • Configured minimum space between nodes in Generate graphs

🐛 Bug fixes

  • Fixed CSS styling of background colour and let the application have full height
  • 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
  • Introduced getShapesMinXY in js/components/graph/Graph.js to fix graph centering in Generate page
  • Fixed course node dimensions and centering in Generate graph to match main graph
  • Fixed the positions of the Theory of Computing and Artificial Intelligence labels
  • Fixed MAT237 prerequisite parsing by enabling lParen and rParen in WebParsing.ReqParser to handle square brackets
  • Fix hybrid node text parsing not properly accounting for all types of logical prerequisite strings
  • Fixed "Corequisite" field not showing up in the course info modal

🔧 Internal changes

  • Refactored the Courses table to Course with a database migration
  • Refactor parseArtSci function in app/WebParsing/ArtSciParser.hs by introducing parseDepartmentList
  • Updated CircleCI download link for ImageMagick
  • Began Babel 8 migration prep: bumped CI/engines to Node 24, pinned an explicit browserslist target, consolidated the duplicated Babel preset config between babel.config.json and webpack.common.js, fixed corejs version pinning, and removed the unused @babel/plugin-proposal-class-properties dependency
  • Upgraded to Babel 8 (@babel/core, @babel/preset-env, @babel/preset-react, @babel/eslint-parser, babel-loader, babel-jest); replaced the removed preset-env useBuiltIns/corejs options with the babel-plugin-polyfill-corejs3 plugin
  • Refactored styling colors into CSS variables
  • Removed dead CSS rules including ids, classNames, and colors
  • Switched Haskell formatter to fourmolu and ran on all files
  • Ran fourmolu on Haskell files in backend-test/
  • Cleaned up test data to match the new single-session Time' data format
  • Added WebParsing.ArtSciParserTests to the cabal file
  • Refactored UtsgJsonParser by replacing the DB and DBList datatypes with helper functions
  • Defined stack run generate-dot command

[0.8.0] - 2026-06-09

✨ New features/enhancements

  • Added 404 status code return to retrieveCourse in Controllers/Course and added front-end tests for affected components
  • Updated Computer Science graph and configuration for 2026-27
  • Added privacy-preserving analytics using GoatCounter and updated privacy policy

🐛 Bug fixes

  • Fixed a bug where duplicate graph components were being added
  • Fixed CSS styling to center course modal and lighten overlay
  • Fixed a bug in SVG parsing where path elements with a Z path directive were not being ignored

🔧 Internal changes

  • Refactor GraphDropdown component from being a child of Graph to being a child of NavBar
  • Added test cases for the saveGraphJSON function in Controllers/Graph
  • Added test cases for the getGraphJSON function in Controllers/Graph
  • Fix unused variable from Graph.js, formatting in Container.js and GraphDropdown.js, and eslint config
  • Refactor Controllers/Graph.hs and Controllers/Timetable.hs to use temporary files
  • Remove unused getTimetableImage function in Export/GetImages.hs
  • Refactored various backend text functions and tests to avoid String data in favour of Text when feasible
  • Removed unused files
  • Refactored returnPDF, exportTimetablePDFResponse, and graphImageResponse to use stdin instead of temporary .tex and .svg files
  • Refactored controllers to retrieve graph info data using lookText' instead of look
  • Removed Location datatype in favour of Building
  • Refactor tests to run directly on tuple input to prevent unnecessary unpacking and repacking
  • Renamed usages of the word "room" to "location" in the codebase to better reflect the data represented
  • Added test cases for JSON parsing of Meeting data type in backend-test/Database/TablesTests.hs
  • Added test cases for JSON parsing of Time' data type in backend-test/Database/TablesTests.hs
  • Refactored functions relating to Building and Time into Models/Building and Models/Time respectively
  • Refactor graph helper functions from app/Svg/Database.hs to app/Models/Graph.hs
  • Refactor functions for performing matrix operations from app/Svg/Parser.hs to app/Util/Matrix.hs
  • Updated documentation in app/Util/Blaze.hs
  • Moved the Course data type from Database/Tables.hs into Models/Course.hs, renamed it to CourseData
  • Removed SvgJSON data type in favour of ([Text], [Shape], [Path])

[0.7.2] - 2025-12-10

✨ New features/enhancements

  • Updated the Zoom In/Zoom Out buttons on the graph page to Awesome Icons from +/-
  • Added the React ErrorBoundary library and implemented an ErrorBoundary for the Graph component in the Container component and js/components/draw/main.js
  • Updated the export button on the graph and grid pages to Awesome Icons; also added highlight effect and tooltip popup on hover
  • Added an autocomplete feature to the search bar js/components/generate/GenerateForm, also rewrote tests related to this feature
  • Added a route to access all POST codes stored in the database with test coverage
  • Added the js/components/generate/AutocompleteDropdown.js component to the program field of Generate
  • Updated the colour of the rendered options for the AutocompleteDropdown component
  • Added a database-migrate CLI option that runs SQL migrations
  • Updated the course info modal timetable styling and layout
  • Updated drag and drop functionality on the graph page to support mobile devices
  • Added a recursive function to remove Requirements from the Requirement Tree

🐛 Bug fixes

  • Fixed a bug that was causing the focus info popup to appear blank
  • Fixed a bug on the generate page causing extraneous ellipses to appear when hovering over a course to highlight its prerequisites
  • Fixed a bug on the generate page where an extraneous info popup would appear when hovering over the top left corner of the graph viewing window
  • Fixed a bug that led code to crash when parsing all pre-generated graphs from svg (i.e., program graphs)
  • Fixed a bug where redundant boolean nodes were being generated
  • Fixed a bug where the course info modal title did not display the H1/Y1 suffix
  • Fixed a bug where the focus tab functionality was not working as intended

🔧 Internal changes

  • Upgraded Jest to v30
  • Upgraded jest-environment-jsdom to v30
  • Refactored navigation bar into a React component (for the graph, grid and generate pages only - the about page navigation bar is still rendered using Blaze)
  • Refactored backend tests to use tasty and tasty-hunit instead of HUnit
  • Refactored course insertion and query functions to align with MVC architectural principles
  • Renamed functions that query the database for post/program information from post -> program
  • Modified CircleCI configuration so that Jest tests now emit coverage reports which are then uploaded to Coveralls
  • Refactored export modal behaviour such that it is handled entirely through React state, rather than through DOM manipulation with vanilla JS
  • Added test cases for the ExportModal component in js/components/common
  • Updated backend tests to use tasty-discover
  • Added documentation for running a subset of the backend tests
  • Renamed Post and PostCategory database tables to Program and ProgramCategory respectively through a database migration
  • Deleted app/Response/Image file and refactored app/Util/Helpers to include returnImageData
  • Added test cases for the retrieveProgram function in Controllers/Program
  • Removed duplicate code from mockRequest and runServerPartWith in backend-test/TestHelpers.hs
  • Initialized a SchemaVersion table for the purposes of running robust database migrations
  • Updated CircleCI configuration to update wget version (to fix ImageMagick download error)
  • Reverted previous CircleCI configuration change
  • Switched CircleCI ImageMagick download to use http
  • Modified CI config to take advantage of partial dependency caching and exploit parallelism when resolving/updating dependencies
  • Migrate graph-related components (FocusBar, FocusTab, GraphDropdown, GraphFallback, Infobox, and Sidebar) from classes to functions
  • Added lint-staged development dependency and fixed eslint issues
  • Updated CircleCI ImageMagick setup to avoid using AppImage executable and to cache download

[0.7.1] - 2025-06-16

✨ New features/enhancements

  • Updated configuration for 2025-26

[0.7.0] - 2025-06-15

✨ New features/enhancements

  • Added text warning when there's no timetable information available to display
  • Updated course info modal to display field labels if and only if they are non-empty
  • Ensured corequisites and exclusions for courses are displayed in the course info modal, if available
  • Added text warnings and validations for each field in GenerateForm
  • Redesigned generate form UI
  • Allow option to log server request accesses to a file
  • Added search by program to create graphs on Generate Page
  • Updated Computer Science graph for 2025-26

🐛 Bug fixes

  • Fix React state mutation
  • Fixed timetable parsing issue, querying page numbers rather than course codes
  • Fixed bug to count FCE correctly
  • Fixed parsing of graph transformations
  • Fixed choppiness of the graphs generated in the export modal
  • Fixed matrix transformation and intersection checking bug when sending graph data to front end
  • Fixed inverse matrix storage from column-major to row-major order
  • Fixed the issue with transformation matricies not being applied to SVG attributes when generating PDFs in the export modal
  • Fixed bug where region label transforms were not correctly applied

🔧 Internal changes

  • Upgraded to React v18
  • Upgraded the Testing Library from 12.0 to 16.0
  • Replace react-test-renderer (deprecated) for snapshot testing
  • Use user-event for user interactions (instead of fireEvent)
  • Add ag-grid group to dependabot configuration
  • Refactored strictRoutes by removing query parameters into functions for symmetry
  • Refactored graph and generation related route functionality into controllers
  • Moved the routes related to downloads to the Timetable controller to be triggered
  • Refactored the HTTPS response generation from App/Database/CourseQueries to the controller App/Controllers/
  • Moved config values from .hs file to .yaml file
  • Changed representation from translation to matrix in App/Svg/Parser
  • Optimized about page using Webpack and new dependencies html-loader and markdown-loader
  • Removed privacy route and codes related to it
  • Improved general testing infrastructure
  • Added test cases for the index function in Controllers/Course
  • Added test cases for the depts function in Controllers/Course
  • Added test cases for the courseInfo function in Controllers/Course
  • Removed unused components Search and Post, backend routes/functions used exclusively by these components, and references to the components in the webpack files
  • Refactored the class components in /grid folder to function components
  • Update stylelint integration with development environment and fix existing stylelint violations
  • Use magick command instead of convert when serving graph images
  • Restructured code base for coverage reports
  • Reorganized .cabal file
  • Added coverage report to test suite
  • Added test cases for the retrieveCourse function in Controllers/Course
  • Fixed CSS issues: modal padding, "and/or" centering, and FCE Count arrow alignment
  • ⁠Fixed issue with "Info" popup disappearing when hovering over it and reduced the delay before it disappears
  • ⁠Fixed issue where scrolling in the course modal triggered graph zoom
  • Added dependency formik and replaced standard React forms with Formik in GenerateForm
  • Added parsers for all SVG transformations in App/Svg/Parser
  • Added intersection tests for buildRect, buildEllipse, intersectsWithPoint and buildPath
  • Allowed lowercase courses and departments on the Generate page
  • Added Debugging Guide
  • Added Haskell Language Server (HLS) Guide
  • Upgraded to Stackage lts-23.18
  • Added stylish-haskell dependency and ran it on .hs source files
  • Upgraded to React v19
  • Added dependabot group for react and react-dom
  • Switched from Yarn PnP to node-modules to fix issues running tests with Node v20+
  • Switched connection for timetable parsing from RequireEMS to AllowEMS
  • Fixed dependency caching in CircleCI configuration
  • Added dependency groups to Dependabot configuration
  • Added tests for the index function in Controllers/Graph
  • Added Models folder and a new Course.hs module within it
  • Added the Graph.hs module in the App/Models
  • Updated eslint configuration for eslint v9
  • Removed calls to head and tail

[0.6.0] - 2024-06-24

🚨 Breaking changes

  • Update Computer Science graph for 2024
  • Update course information for 2024
  • Do not display room numbers in timetable information

✨ New features/enhancements

  • Added button to deselect courses in "FCE count" side panel
  • Increase font size for hybrid nodes in graphs
  • Added warning message modal for when the user enters invalid courses in Generate
  • Added spotlight for highlighting dependencies (when hovering over a course)

🐛 Bug fixes

  • Fixed bug that causes FCE count to increase when toggling course via sidebar
  • Fixed bug that forced users to input a course codes in a specific way when generating a dependency graph
  • Correctly handle 'l' directives in svg path attributes
  • Fixed bug that prevented timetable information from loading in Grid page
  • Fixed bug that prevented the course info modal from displaying in Grid page

🔧 Internal changes

  • Started a changelog.
  • Updated pull request template
  • Refactored graph and course related route functionality into controllers

[0.5.0] - 2023-08-13

See commit history for changes at this release and earlier.