feat: caching & linking to prof (#15)

.gitignore

@@ -3,4 +3,5 @@ png/.DS_Store
 .vscode
 node_modules
 dist
-.parcel-cache
+.parcel-cache
+*.zip

.parcelrc

@@ -0,0 +1,8 @@
+{
+  "extends": "@parcel/config-default",
+  "transformers": {
+    "*.ts": [
+      "@parcel/transformer-typescript-tsc"
+    ]
+  }
+}

eslint.config.mjs

@@ -7,6 +7,17 @@ export default [
     languageOptions: {
       globals: { ...globals.browser, ...globals.webextensions },
     },
+    rules: {
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^_',
+        },
+      ],
+    },
   },
   pluginJs.configs.recommended,
   ...tseslint.configs.recommended,

package.json

@@ -11,6 +11,7 @@
     },
     "service_worker": {
       "source": "src/service_worker/background.ts",
+      "includeNodeModules": true,
       "outputFormat": "esmodule"
     }
   },
@@ -62,7 +63,10 @@
     "release": "chrome-webstore-upload"
   },
   "devDependencies": {
+    "@babel/core": "^7.12.0",
     "@eslint/js": "^9.4.0",
+    "@parcel/config-default": "^2.12.0",
+    "@parcel/transformer-typescript-tsc": "^2.12.0",
     "@semantic-release/exec": "^6.0.3",
     "@tsconfig/recommended": "^1.0.2",
     "@types/chrome": "^0.0.241",
@@ -72,12 +76,13 @@
     "eslint": "^9.4.0",
     "globals": "^15.4.0",
     "nodemon": "^3.1.3",
-    "parcel": "^2.9.0",
+    "parcel": "^2.12.0",
     "semantic-release": "^24.0.0",
-    "typescript": "^5.2.2",
+    "typescript": "<5.5.0",
     "typescript-eslint": "^7.13.0"
   },
   "dependencies": {
-    "jquery": "^3.7.0"
+    "jquery": "^3.7.0",
+    "string-similarity-js": "^2.1.4"
   }
 }

src/api/RateMyProfessor/RateMyProfessorApi.ts

@@ -34,7 +34,38 @@ export const getResult = async <T>(
   return result.filter((r) => r && r.length > 0).reverse()[0] ?? [];
 };
 
+export function withCache<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Method extends (...args: any[]) => Promise<Teacher[]>
+>(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  target: any,
+  propertyKey: string,
+  descriptor: PropertyDescriptor
+) {
+  const originalMethod = descriptor.value;
+  descriptor.value = async function replacementMethod(
+    this: RateMyProfessorApi,
+    ...args: Parameters<Method>
+  ) {
+    const key = args.join('');
+
+    if (key in this.cache) {
+      console.log('found in cache', key, this.cache[key]);
+      return this.cache[key];
+    }
+    const result = await originalMethod?.call(this, ...args);
+
+    console.log('not found in cache', key, result);
+
+    this.cache[key] = result;
+    return result;
+  };
+}
+
 export abstract class RateMyProfessorApi implements IRateMyProfessor {
+  protected cache: Record<string, Teacher[]> = {};
+
   protected apiEndpoint = 'https://www.ratemyprofessors.com/';
 
   protected getUrl(

src/api/RateMyProfessor/RateMyProfessorGraphql.ts

@@ -1,5 +1,6 @@
 import { DEFAULT_SCHOOL_ID, DEFAULT_SCHOOL_NAME } from '../../constants';
-import { RateMyProfessorApi, getResult } from './RateMyProfessorApi';
+import { RateMyProfessorApi, getResult, withCache } from './RateMyProfessorApi';
+import { stringSimilarity } from 'string-similarity-js';
 import {
   TeacherQueryVariables,
   TeacherQueryResponse,
@@ -39,6 +40,7 @@ export class RateMyProfessorGraphql extends RateMyProfessorApi {
           avgDifficultyRounded
           avgRatingRounded
           id
+          legacyId
           firstName
           lastName
           numRatings
@@ -141,32 +143,40 @@ export class RateMyProfessorGraphql extends RateMyProfessorApi {
     return this.parseSchoolQueryResponse(res)[0]?.id;
   }
 
-  async getProfId(
+  @withCache
+  private async getTeachers(
     profName: string,
     schoolId = DEFAULT_SCHOOL_ID
-  ): Promise<string | undefined> {
-    const queryResult = await getResult(profName, (n) =>
+  ): Promise<Teacher[]> {
+    const result = await getResult(profName, (n) =>
       this.queryTeachers({
         teacherName: n,
         schoolId,
-        number: 1,
+        number: 3,
       }).then(this.getTeachersFromQuery)
     );
 
-    return queryResult[0]?.id;
+    return result
+      .map((t) => ({
+        similarity: stringSimilarity(profName, `${t.lastName}, ${t.firstName}`),
+        teacher: t,
+      }))
+      .sort((a, b) => b.similarity - a.similarity)
+      .map(({ teacher }) => teacher);
+  }
+
+  async getProfId(
+    ...args: Parameters<typeof this.getTeachers>
+  ): Promise<string | undefined> {
+    const queryResult = await this.getTeachers(...args);
+    // TODO: if more than one result, we should allow the user to see different options
+    return queryResult[0]?.legacyId;
   }
 
   async getOverallScore(
-    profName: string,
-    schoolId = DEFAULT_SCHOOL_ID
+    ...args: Parameters<typeof this.getTeachers>
   ): Promise<number | undefined> {
-    const queryResult = await getResult(profName, (n) =>
-      this.queryTeachers({
-        teacherName: n,
-        schoolId,
-        number: 1,
-      }).then(this.getTeachersFromQuery)
-    );
+    const queryResult = await this.getTeachers(...args);
 
     return queryResult[0]?.avgRatingRounded;
   }

src/api/RateMyProfessor/graphql.types.ts

@@ -29,6 +29,7 @@ export type Teacher = {
   avgDifficultyRounded: number;
   avgRatingRounded: number;
   id: string;
+  legacyId: string;
   firstName: string;
   lastName: string;
   numRatings: number;

src/content_scripts/index.ts

@@ -1,3 +1,4 @@
+import './ratemyprof';
+
 export * from './content';
-export * from './ratemyprof';
 export * from './constants';