feat(timetable): exclude hidden modules from being exported into iCal (#3682)

* Implement logic to exclude events from hidden modules during export

* Pass hiddenModules: string[] as a parameter to icalUtils.default

* Add new test for hidden module in iCalForTimetable

* Pluralize hiddenModule to hiddenModules

* Update hiddenModules type

---------

Co-authored-by: maverick-g00se <[email protected]>
Co-authored-by: kokrui <[email protected]>

Author: 3 people

website/src/actions/export.ts

@@ -1,4 +1,4 @@
-import type { Module, Semester } from 'types/modules';
+import type { Module, ModuleCode, Semester } from 'types/modules';
 import type { ExportData } from 'types/export';
 import type { Dispatch, GetState } from 'types/redux';
 import { hydrateSemTimetableWithLessons } from 'utils/timetables';
@@ -31,11 +31,12 @@ export function downloadAsIcal(semester: Semester) {
       .then(([ical, icalUtils]) => {
         const state = getState();
         const { modules } = state.moduleBank;
+        const hiddenModules: ModuleCode[] = state.timetables.hidden[semester] || [];
 
         const timetable = getSemesterTimetableLessons(state)(semester);
         const timetableWithLessons = hydrateSemTimetableWithLessons(timetable, modules, semester);
 
-        const events = icalUtils.default(semester, timetableWithLessons, modules);
+        const events = icalUtils.default(semester, timetableWithLessons, modules, hiddenModules);
         const cal = ical.default({
           domain: 'nusmods.com',
           prodId: '//NUSMods//NUSMods//EN',

website/src/utils/ical.test.ts

@@ -307,8 +307,18 @@ describe(iCalForTimetable, () => {
       CS1010S,
       CS3216,
     };
-    const actual = iCalForTimetable(1, mockTimetable, moduleData);
+    const actual = iCalForTimetable(1, mockTimetable, moduleData, []);
     // 5 lesson types for cs1010s, 1 for cs3216, 1 exam for cs1010s
     expect(actual).toHaveLength(7);
   });
+
+  test('should produce the correct number of lesson after excluding hidden mod', () => {
+    const moduleData = {
+      CS1010S,
+      CS3216,
+    };
+    const actual = iCalForTimetable(1, mockTimetable, moduleData, ['CS3216']);
+    // 5 lesson types for cs1010s, 1 exam for cs1010s, ( 1 lesson for cs3216 will be exluded)
+    expect(actual).toHaveLength(6);
+  });
 });

website/src/utils/ical.ts

@@ -174,6 +174,7 @@ export default function iCalForTimetable(
   semester: Semester,
   timetable: SemTimetableConfigWithLessons,
   moduleData: { [moduleCode: string]: Module },
+  hiddenModules: string[],
   academicYear: string = config.academicYear,
 ): EventOption[] {
   const [year, month, day] = academicCalendar[academicYear][semester].start;
@@ -182,6 +183,8 @@ export default function iCalForTimetable(
   const events: EventOption[] = [];
 
   _.each(timetable, (lessonConfig, moduleCode) => {
+    if (hiddenModules.includes(moduleCode)) return;
+
     _.each(lessonConfig, (lessons) => {
       lessons.forEach((lesson) => {
         events.push(iCalEventForLesson(lesson, moduleData[moduleCode], semester, firstDayOfSchool));