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.

Sign up for GitHub

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

Add Couse Cache System #69

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+47 −6
Open

Add Couse Cache System #69

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bd80af
Add Couse Cache System
elicampos Feb 9, 2024
3ce551d
Fix formatting
elicampos Feb 11, 2024
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
56 changes: 43 additions & 13 deletions app/src/scripts/soc/soc.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,16 @@ interface UID {
export abstract class SOC_Generic {
info: SOCInfo;
courses: Course[];
// Initialize cache for broad search results and individual courses
courseCache: Map<string, Course[]>;

/* CONSTRUCT & INITIALIZE */

protected constructor(info: SOCInfo, courses: Course[]) {
this.info = info;
this.courses = courses;
// Initialize the cache as an empty Map
this.courseCache = new Map();
}

static async initialize(): Promise<SOC_Generic> {
Expand Down Expand Up @@ -120,27 +124,42 @@ export abstract class SOC_Generic {
*/
searchCourses(searchBy: SearchBy, phrase: string): Course[] {
console.log(`Searching by ${searchBy} for "${phrase}"`);
if (!phrase)
if (!phrase)
// Empty search phrase should not return all courses
return [];
return [];

const upperPhrase: string = phrase.toUpperCase();

// Check cache first for both broad and specific course searches
// Use course code as cache key for specific searches
const cacheKey = searchBy === SearchBy.COURSE_CODE ? upperPhrase : `${searchBy}:${upperPhrase}`;
if (this.courseCache.has(cacheKey)) {
console.log("Returning cached results for:", cacheKey);
// Return cached results
return this.courseCache.get(cacheKey) || [];
}

let results: Course[] = [];
if (searchBy === SearchBy.COURSE_CODE) {
return this.courses.filter((c) => c.code.includes(upperPhrase));
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]));
} else if (searchBy === SearchBy.COURSE_TITLE) {
return this.courses.filter((c) =>
c.name.toUpperCase().includes(upperPhrase),
);
results = this.courses.filter((c) => c.name.toUpperCase().includes(upperPhrase));
} else if (searchBy === SearchBy.INSTRUCTOR) {
return this.courses.filter((c) =>
results = this.courses.filter((c) =>
c.sections.some((s) =>
s.instructors.some((inst) =>
inst.toUpperCase().includes(upperPhrase),
),
s.instructors.some((inst) => inst.toUpperCase().includes(upperPhrase)),
),
);
} else {
throw new Error("Unhandled SearchBy.");
}
throw new Error("Unhandled SearchBy.");

// Store broad search results in cache
this.courseCache.set(cacheKey, results);

return results;
}

/* UTILS */
Expand Down Expand Up @@ -217,6 +236,13 @@ export class SOC_API extends SOC_Generic {
lcn = 0,
): Promise<void> {
if (!phrase) return Promise.resolve();
// 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();
}

const search = JSON.stringify({ by: searchBy, phrase });
if (this.fetchCache.has(search)) {
Expand All @@ -243,7 +269,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(),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: Did you find course codes that were not in uppercase?

courseInd: number = this.courses.length;

// Prevent duplicates
Expand All @@ -266,7 +292,11 @@ export class SOC_API extends SOC_Generic {
);
},
);
this.courses.push(course); // Add the course to the courses array
// Add the course to the courses array
this.courses.push(course);
// Cache the course by its code
this.courseCache.set(courseCode, [course]);

}
});

Expand Down