Add Couse Cache System #69
Conversation
|
@elicampos is attempting to deploy a commit to the UF OSC Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
Run Prettier and commit :)
|
| const cacheKey = | ||
| searchBy === SearchBy.COURSE_CODE | ||
| ? upperPhrase | ||
| : `${searchBy}:${upperPhrase}`; |
There was a problem hiding this comment.
The cacheKey can always be ${searchBy}:${upperPhrase} as it is a unique identifier.
| results = this.courses.filter((c) => c.code.includes(upperPhrase)); | ||
| // Cache each individual course from the broad search result | ||
| results.forEach((course) => | ||
| this.courseCache.set(course.code.toUpperCase(), [course]), |
There was a problem hiding this comment.
This can lead to some nasty bugs with distinct courses that share the same course code (e.g. quest courses & special topics).
You cannot assume that a particular course code belongs to only one course.
You should only cache after searching for all possible courses as there may be more than one.
| this.courseCache.set(courseCode, [course]); | ||
| } |
| @@ -243,7 +281,7 @@ export class SOC_API extends SOC_Generic { | |||
| // Add each course, if appropriate | |||
| COURSES.forEach((courseJson: API_Course) => { | |||
| const courseID: string = courseJson.courseId, | |||
| courseCode: string = courseJson.code, | |||
| courseCode: string = courseJson.code.toUpperCase(), | |||
There was a problem hiding this comment.
Q: Did you find course codes that were not in uppercase?
| // Check cache for individual course code to avoid refetching | ||
| const upperPhrase = phrase.toUpperCase(); | ||
| if ( | ||
| searchBy === SearchBy.COURSE_CODE && | ||
| this.courseCache.has(upperPhrase) | ||
| ) { | ||
| console.log("Course already fetched and cached:", upperPhrase); | ||
| // Exit if the specific course is already cached | ||
| return Promise.resolve(); | ||
| } |
There was a problem hiding this comment.
fetchCourse(...) should only be called when needed, hence you don't need to check if the thing you're looking for is cached (i.e. it is the responsibility of the calling function to determine whether or not to call fetchCourses to fetch).
Issue: #51
I implemented a system in which it caches the searches and the individuals courses. So if you search something that was previously searched, it will still pull from the cache(Basic React Query which you guys already had), however during this process it also caches each course found. So now for each course search, it sees if the result is in the search or course cache and if neither it calls the API again. The only drawback to this is the fact that very large searches like "EEL" for example, take about 30% longer, as it's caching all the courses but again now every course with EEL pops up almost instantly.