Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only send relevant info about courses to frontend #726

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions src/components/planner/DegreePlanPDF/DegreePlanPDF.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,7 @@ interface DegreePlanPDFProps {
transferCredits: string[];
coursesData: {
title: string;
id: string;
course_number: string;
prerequisites: Prisma.JsonValue;
subject_prefix: string;
}[];
}
Expand Down Expand Up @@ -199,9 +197,7 @@ const convertSemestersToAcademicYears = (
semesters: Semester[],
coursesData: {
title: string;
id: string;
course_number: string;
prerequisites: Prisma.JsonValue;
subject_prefix: string;
}[],
) => {
Expand Down Expand Up @@ -283,9 +279,7 @@ const addCoursesToSemester = (
semester: Semester,
coursesData: {
title: string;
id: string;
course_number: string;
prerequisites: Prisma.JsonValue;
subject_prefix: string;
}[],
) => {
Expand Down
4 changes: 2 additions & 2 deletions src/components/planner/Sidebar/RequirementsContainer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { useState, useEffect } from 'react';

import useSearch from '@/components/search/search';
import { trpc } from '@/utils/trpc';
import { courses as Course } from 'prisma/generated/platform';
import { MinimalCourse } from '@server/trpc/router/courseCache';

import Accordion from './Accordion';
import { RecursiveRequirement } from './RecursiveRequirement';
Expand Down Expand Up @@ -76,7 +76,7 @@ function RequirementContainerHeader({

const getRequirementGroup = (
degreeRequirement: RequirementGroupTypes,
allCourses: Course[] | undefined,
allCourses: MinimalCourse[] | undefined,
): {
name: string;
progress: { value: number; max: number; unit: string };
Expand Down
129 changes: 9 additions & 120 deletions src/components/planner/useGetCourseInfo.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
import { useMemo } from 'react';

import { RouterOutputs, trpc } from '@/utils/trpc';

// TODO: Change implementation
// Highly inefficient
const useGetCourseInfo = (
courseCode: string,
): {
prereqs: string[];
coreqs: string[];
co_or_pre: string[];
title?: string;
description?: string;
} => {
Expand All @@ -18,136 +13,30 @@ const useGetCourseInfo = (
cacheTime: Infinity,
refetchOnWindowFocus: false,
});
const { prereqs, coreqs, co_or_pre, title } = useMemo(
() => (data ? getPrereqs(data, courseCode) : { prereqs: [], coreqs: [], co_or_pre: [] }),
[data, courseCode],
);
if (data === undefined) return {};
const title = getTitle(data, courseCode);

// Get course description
const description = useMemo(() => {
const courseInfo = data?.find(
(course) => course.subject_prefix + ' ' + course.course_number === courseCode,
);

return courseInfo ? courseInfo.description : '';
}, [data, courseCode]);
const courseInfo = data?.find(
(course) => course.subject_prefix + ' ' + course.course_number === courseCode,
);
const description = courseInfo ? courseInfo.description : '';

return { prereqs, coreqs, co_or_pre, title, description };
return { title, description };
};

export default useGetCourseInfo;

type CourseData = RouterOutputs['courses']['publicGetAllCourses'];

const getPrereqs = (
courseData: CourseData,
courseCode: string,
): { prereqs: string[]; coreqs: string[]; co_or_pre: string[]; title?: string } => {
const prereqs: string[] = [];
const coreqs: string[] = [];
const co_or_pre: string[] = [];

const getTitle = (courseData: CourseData, courseCode: string): string | undefined => {
let title;
courseData?.find(function (cNum) {
if (cNum.subject_prefix + ' ' + cNum.course_number === courseCode) {
title = cNum.title;

cNum.prerequisites?.options.map((elem) => {
if (elem.type !== 'course' && elem.type !== 'other' && elem.options) {
elem.options.map((elem2) => {
if (elem2.type !== 'course' && elem2.type !== 'other') {
elem2.options?.map((elem3) => {
courseData?.map((elem4) => {
if (elem4.id === elem3.class_reference) {
prereqs.push(elem4.subject_prefix + ' ' + elem4.course_number);
}
});
});
} else if (elem2.type === 'other') {
prereqs.push(elem2.description || '');
} else {
courseData?.map((elem4) => {
if (elem4.id === elem2.class_reference) {
prereqs.push(elem4.subject_prefix + ' ' + elem4.course_number);
}
});
}
});
} else if (elem.type === 'other') {
prereqs.push(elem.description || '');
} else {
courseData?.map((elem4) => {
if (elem4.id === elem.class_reference) {
prereqs.push(elem4.subject_prefix + ' ' + elem4.course_number);
}
});
}
});
cNum.corequisites?.options.map((elem) => {
if (elem.type !== 'course' && elem.type !== 'other' && elem.options) {
elem.options.map((elem2) => {
if (elem2.type !== 'course' && elem2.type !== 'other') {
elem2.options?.map((elem3) => {
courseData?.map((elem4) => {
if (elem4.id === elem3.class_reference) {
coreqs.push(elem4.subject_prefix + ' ' + elem4.course_number);
}
});
});
} else if (elem2.type === 'other') {
coreqs.push(elem2.description || '');
} else {
courseData?.map((elem4) => {
if (elem4.id === elem2.class_reference) {
coreqs.push(elem4.subject_prefix + ' ' + elem4.course_number);
}
});
}
});
} else if (elem.type === 'other') {
coreqs.push(elem.description || '');
} else {
courseData?.map((elem4) => {
if (elem4.id === elem.class_reference) {
coreqs.push(elem4.subject_prefix + ' ' + elem4.course_number);
}
});
}
});
cNum.co_or_pre_requisites?.options.map((elem) => {
if (elem.type !== 'course' && elem.type !== 'other' && elem.options) {
elem.options.map((elem2) => {
if (elem2.type !== 'course' && elem2.type !== 'other') {
elem2.options?.map((elem3) => {
courseData?.map((elem4) => {
if (elem4.id === elem3.class_reference) {
co_or_pre.push(elem4.subject_prefix + ' ' + elem4.course_number);
}
});
});
} else if (elem2.type === 'other') {
co_or_pre.push(elem2.description || '');
} else {
courseData?.map((elem4) => {
if (elem4.id === elem2.class_reference) {
co_or_pre.push(elem4.subject_prefix + ' ' + elem4.course_number);
}
});
}
});
} else if (elem.type === 'other') {
co_or_pre.push(elem.description || '');
} else {
courseData?.map((elem4) => {
if (elem4.id === elem.class_reference) {
co_or_pre.push(elem4.subject_prefix + ' ' + elem4.course_number);
}
});
}
});
return courseCode;
}
});

return { prereqs, coreqs, co_or_pre, title };
return title;
};
38 changes: 37 additions & 1 deletion src/server/trpc/router/courseCache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,18 @@ class CourseCacheError extends Error {
name = 'CourseCacheError';
}

export interface MinimalCourse {
title: string;
description: string;
subject_prefix: string;
course_number: string;
}

class CourseCache {
private coursesByYear: Map<number, Course[]> = new Map();
private coursesByYear: Map<number, MinimalCourse[]> = new Map();
private courseWithReqsByYear: Map<number, Course[]> = new Map();
private mutex = new Mutex();
private mutexReqs = new Mutex();

public async getCourses(year: number) {
// Acquire lock before success check so if another request is fetching, we don't fetch again.
Expand All @@ -24,6 +33,7 @@ class CourseCache {
return await platformPrisma.courses
.findMany({
distinct: ['title', 'course_number', 'subject_prefix'],
select: { title: true, description: true, subject_prefix: true, course_number: true },
})
.then((courses) => {
this.coursesByYear.set(year, courses);
Expand All @@ -36,6 +46,32 @@ class CourseCache {
})
.finally(release);
}

public async getCourseReqs(year: number) {
// Acquire lock before success check so if another request is fetching, we don't fetch again.
const release = await this.mutexReqs.acquire();
if (this.courseWithReqsByYear.has(year)) {
release();
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
return this.courseWithReqsByYear.get(year)!; // Must exist at this point
}

console.info(`Fetching courses for year ${year}...`);
return await platformPrisma.courses
.findMany({
distinct: ['title', 'course_number', 'subject_prefix'],
})
.then((courses) => {
this.courseWithReqsByYear.set(year, courses);
return courses;
})
.catch((err) => {
const message = `Error fetching courses for year ${year}: ${err}`;
console.error(message);
throw new CourseCacheError(message, { cause: err });
})
.finally(release);
}
}

const courseCache = new CourseCache();
Expand Down
25 changes: 0 additions & 25 deletions src/server/trpc/router/courses.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,4 @@ export const coursesRouter = router({
publicGetAllCourses: publicProcedure.query(async () => {
return await courseCache.getCourses(new Date().getFullYear());
}),
publicGetSanitizedCourses: publicProcedure.query(async ({ ctx }) => {
const courses = await ctx.platformPrisma.courses.findMany({
select: {
course_number: true,
subject_prefix: true,
id: true,
prerequisites: true,
corequisites: true,
},
});

const courseMapWithIdKey = new Map<string, Prisma.JsonValue>();
const courseMapWithCodeKey = new Map<string, Prisma.JsonValue>();

for (const course of courses) {
courseMapWithCodeKey.set(`${course.subject_prefix} ${course.course_number}`, {
prereq: course.prerequisites,
coreq: course.corequisites,
});
courseMapWithIdKey.set(course.id, `${course.subject_prefix} ${course.course_number}`);
}
// print the map

return courseMapWithCodeKey;
}),
});
2 changes: 1 addition & 1 deletion src/server/trpc/router/validator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export const validatorRouter = router({
year = Math.min(...planData.semesters.map((sem) => sem.year));
}

const coursesFromAPI: PlatformCourse[] = await courseCache.getCourses(year);
const coursesFromAPI: PlatformCourse[] = await courseCache.getCourseReqs(year);
/* sanitizing data from API db.
* TODO: Fix this later somehow
*/
Expand Down
7 changes: 1 addition & 6 deletions validator/degree_data/2022/Psychology(BS).json
Original file line number Diff line number Diff line change
Expand Up @@ -233,12 +233,7 @@
"metadata": {
"id": "Psychology(BS)-29"
},
"accepted_prefixes": [
"PSY",
"CGS",
"CLDP",
"NSC"
]
"accepted_prefixes": ["PSY", "CGS", "CLDP", "NSC"]
}
]
},
Expand Down
Loading