Merge branch 'develop' into redesign

README.md

@@ -1,33 +1,51 @@
-This is a [Plasmo extension](https://docs.plasmo.com/) project bootstrapped with [`plasmo init`](https://www.npmjs.com/package/plasmo).
+# Skedge
 
-## Getting Started
+_Get all of your Rate My Professors and grade distribution data without ever leaving schedule planner!_
 
-First, run the development server:
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
-```bash
-pnpm dev
-# or
-npm run dev
-```
+## About
+
+### Features
+
+- Multiple Sources
+  - Find grade distributions and Rate My Professors scores for any given class.
+- Aggregate
+  - Powerful query abilities that aggregate grade and Rate My Professors data across several years to give you a more wholistic view.
+- Schedule Planner Integration
+  - Direct integration means getting the exact information you need, right when you need it.
 
-Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`.
+## Contributing
 
-You can start editing the popup by modifying `popup.tsx`. It should auto-update as you make changes. To add an options page, simply add a `options.tsx` file to the root of the project, with a react component default exported. Likewise to add a content page, add a `content.ts` file to the root of the project, importing some module and do some logic, then reload the extension on your browser.
+Contributions are welcome!
 
-For further guidance, [visit our Documentation](https://docs.plasmo.com/)
+This project uses the MIT License.
 
-## Making production build
+### Process
 
-Run the following:
+Once you're ready to make some changes, see the
+[issues](https://github.com/UTDNebula/skedge/issues) for the repository.
+
+If you want to brainstorm, share ideas or ask questions, start a discussion in
+our [Discord](https://discord.utdnebula.com/).
+
+### Set-up
+
+This project requires a working [Node.js](https://nodejs.org/en/) and NPM
+installation. To start, clone the repository, and then run `npm run dev:chrome` or `npm run dev:firefox` to launch
+a local development server.
 
 ```bash
-pnpm build
-# or
-npm run build
+git clone https://github.com/UTDNebula/skedge.git
+cd skedge
+npm install
 ```
 
-This should create a production bundle for your extension, ready to be zipped and published to the stores.
+If you are developing for the Chrome browser run `npm run dev:chrome` and load `build/chrome-mv3-dev` on `chrome://extensions/`
+
+If you are developing for the Firefox browser run `npm run dev:firefox` and load `build/firefox-mv3-dev` on `about:debugging`
 
-## Submit to the webstores
+### Contact
 
-The easiest way to deploy your Plasmo extension is to use the built-in [bpp](https://bpp.browser.market) GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow [this setup instruction](https://docs.plasmo.com/framework/workflows/submit) and you should be on your way for automated submission!
+This project is maintained by Nebula Labs. If you have
+any questions about this project or Nebula Labs, see the [discord server](https://discord.utdnebula.com/)

src/data/config.ts

@@ -3,15 +3,58 @@ export const HEADERS = {
   'User-Agent':
     'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36',
   'Content-Type': 'application/json',
+  Referer: 'https://www.ratemyprofessors.com/',
 };
 
-export const PROFESSOR_QUERY = {
-  query:
-    'query RatingsListQuery($id: ID!) {node(id: $id) {... on Teacher {legacyId school {id} courseCodes {courseName courseCount} firstName lastName numRatings avgDifficulty avgRating department wouldTakeAgainPercent teacherRatingTags { tagCount tagName } ratingsDistribution { total r1 r2 r3 r4 r5 } }}}',
-  variables: {},
+export const PROFESSOR_SEARCH_QUERY = {
+  query: `
+    query TeacherSearchQuery($query: TeacherSearchQuery!) {
+      newSearch {
+        teachers(query: $query) {
+          edges {
+            node {
+              id
+              legacyId
+              firstName
+              lastName
+              school {
+                id
+                name
+              }
+              department
+              avgRating
+              numRatings
+              avgDifficulty
+              wouldTakeAgainPercent
+              teacherRatingTags {
+                tagName
+                tagCount
+              }
+              ratingsDistribution {
+                total
+                r1
+                r2
+                r3
+                r4
+                r5
+              }
+            }
+          }
+        }
+      }
+    }
+  `,
+  variables: {
+    query: {
+      text: '',
+      schoolID: '',
+    },
+  },
 };
 
 export const SCHOOL_ID = '1273';
+export const SCHOOL_NAME = 'The University of Texas at Dallas';
+
 export const RMP_GRAPHQL_URL = 'https://www.ratemyprofessors.com/graphql';
 
 export const TRENDS_URL = 'https://trends.utdnebula.com/';

src/data/fetchFromRmp.ts

@@ -1,161 +1,76 @@
-import { HEADERS, PROFESSOR_QUERY, RMP_GRAPHQL_URL } from '~data/config';
-import fetchWithCache, { cacheIndexRmp } from '~data/fetchWithCache';
-
-function reportError(context, err) {
-  console.error('Error in ' + context + ': ' + err);
-}
-
-function getProfessorUrl(professorName: string, schoolId: string): string {
-  const url = new URL(
-    'https://www.ratemyprofessors.com/search/professors/' + schoolId + '?',
-  ); //UTD
-  url.searchParams.append('q', professorName);
-  return url.href;
-}
-
-function getProfessorId(text: string, professorName: string): string {
-  const lowerCaseProfessorName = professorName.toLowerCase();
-
-  let pendingMatch = null;
-  const regex =
-    /"legacyId":(\d+).*?"numRatings":(\d+).*?"firstName":"(.*?)","lastName":"(.*?)"/g;
-  const allMatches: string[] = text.match(regex);
-  const highestNumRatings = 0;
-
-  if (allMatches) {
-    for (const fullMatch of allMatches) {
-      for (const match of fullMatch.matchAll(regex)) {
-        console.log(
-          match[3].split(' ')[0].toLowerCase() +
-            ' ' +
-            match[4].toLowerCase() +
-            ' ',
-        );
-        const numRatings = parseInt(match[2]);
-        if (
-          lowerCaseProfessorName.includes(
-            match[3].split(' ')[0].toLowerCase() + ' ' + match[4].toLowerCase(),
-          ) &&
-          numRatings >= highestNumRatings
-        ) {
-          pendingMatch = match[1];
-        }
-      }
-    }
-  }
-
-  return pendingMatch;
-}
-
-function getGraphQlUrlProp(professorId: string) {
-  HEADERS['Referer'] =
-    `https://www.ratemyprofessors.com/ShowRatings.jsp?tid=${professorId}`;
-  PROFESSOR_QUERY['variables']['id'] = btoa(`Teacher-${professorId}`);
+import { HEADERS, PROFESSOR_SEARCH_QUERY, RMP_GRAPHQL_URL } from '~data/config';
+import fetchWithCache, {
+  cacheIndexRmp,
+  expireTime,
+} from '~data/fetchWithCache';
+
+function getGraphQlUrlProp(name: string, schoolID: string) {
+  PROFESSOR_SEARCH_QUERY.variables.query.text = name;
+  PROFESSOR_SEARCH_QUERY.variables.query.schoolID = btoa('School-' + schoolID);
   return {
     method: 'POST',
     headers: HEADERS,
-    body: JSON.stringify(PROFESSOR_QUERY),
+    body: JSON.stringify(PROFESSOR_SEARCH_QUERY),
   };
 }
 
-function wait(delay) {
-  return new Promise((resolve) => setTimeout(resolve, delay));
-}
-
-function fetchRetry(url: string, delay: number, tries: number, fetchOptions) {
-  function onError(err) {
-    const triesLeft: number = tries - 1;
-    if (!triesLeft) {
-      throw err;
-    }
-    return wait(delay).then(() =>
-      fetchRetry(url, delay, triesLeft, fetchOptions),
-    );
-  }
-  return fetchWithCache(url, fetchOptions, cacheIndexRmp, 2629800000).catch(
-    onError,
-  );
-}
-
-async function validateResponse(response, fetchOptions) {
-  const notOk = response?.status !== 200;
-  if (notOk && response && response.url) {
-    const details = {
-      status: response.status,
-      statusText: response.statusText,
-      redirected: response.redirected,
-      url: response.url,
-    };
-    reportError(
-      'validateResponse',
-      'Status not OK for fetch request. Details are: ' +
-        JSON.stringify(details),
-    );
-    // If we don't have fetch options, we just use an empty object.
-    response = await fetchRetry(response?.url, 200, 3, fetchOptions || {});
-  }
-  return response;
-}
-
-function fetchWithGraphQl(graphQlUrlProp, resolve) {
-  try {
-    fetchWithCache(
-      RMP_GRAPHQL_URL,
-      graphQlUrlProp,
-      cacheIndexRmp,
-      2629800000,
-    ).then((response) =>
-      validateResponse(response, graphQlUrlProp).then((rating) => {
-        if (
-          rating != null &&
-          Object.hasOwn(rating, 'data') &&
-          Object.hasOwn(rating['data'], 'node')
-        ) {
-          rating = rating['data']['node'];
-        }
-        resolve(rating);
-      }),
-    );
-  } catch (err) {
-    reportError('fetchWithGraphQl', err);
-    resolve(null); ///
-  }
-}
-
 export interface RmpRequest {
-  professorName: string;
+  profFirst: string;
+  profLast: string;
   schoolId: string;
+  schoolName: string;
 }
-export function requestProfessorFromRmp(
-  request: RmpRequest,
-): Promise<RMPInterface> {
+export function requestProfessorFromRmp({
+  profFirst,
+  profLast,
+  schoolId,
+  schoolName,
+}: RmpRequest): Promise<RMPInterface> {
+  profFirst = profFirst.split(' ')[0];
+  const name = profFirst + ' ' + profLast;
+  // create fetch object for professor
+  const graphQlUrlProp = getGraphQlUrlProp(name, schoolId);
   return new Promise((resolve, reject) => {
-    // url for promises
-    const professorUrl = getProfessorUrl(
-      request.professorName,
-      request.schoolId,
-    );
-
-    // fetch professor id from url
-    fetchWithCache(
-      professorUrl,
-      { method: 'GET' },
-      cacheIndexRmp,
-      2629800000,
-      true,
-    )
-      .then((text) => {
-        const professorId = getProfessorId(text, request.professorName);
-
-        // create fetch object for professor id
-        const graphQlUrlProp = getGraphQlUrlProp(professorId);
-
-        // fetch professor info by id with graphQL
-        fetchWithGraphQl(graphQlUrlProp, resolve);
+    // fetch professor info by name with graphQL
+    fetchWithCache(RMP_GRAPHQL_URL, graphQlUrlProp, cacheIndexRmp, expireTime)
+      .then((response) => {
+        if (
+          response == null ||
+          !Object.hasOwn(response, 'data') ||
+          !Object.hasOwn(response.data, 'newSearch') ||
+          !Object.hasOwn(response.data.newSearch, 'teachers') ||
+          !Object.hasOwn(response.data.newSearch.teachers, 'edges')
+        ) {
+          reject({ message: 'Data for professor not found' });
+          return;
+        }
+        //Remove profs not at UTD and with bad name match
+        const professors = response.data.newSearch.teachers.edges.filter(
+          (prof: { node: RMPInterface }) =>
+            prof.node.school.name === schoolName &&
+            prof.node.firstName.includes(profFirst) &&
+            prof.node.lastName.includes(profLast),
+        );
+        if (professors.length === 0) {
+          reject({ message: 'Data for professor not found' });
+          return;
+        }
+        //Pick prof instance with most ratings
+        let maxRatingsProfessor = professors[0];
+        for (let i = 1; i < professors.length; i++) {
+          if (
+            professors[i].node.numRatings > maxRatingsProfessor.node.numRatings
+          ) {
+            maxRatingsProfessor = professors[i];
+          }
+        }
+        resolve({
+          message: 'success',
+          data: maxRatingsProfessor.node,
+        });
       })
       .catch((error) => {
-        reportError('requestProfessorFromRmp', error);
-        reject(error);
+        reject({ message: error.message });
       });
   });
 }

src/data/fetchWithCache.ts

@@ -5,8 +5,11 @@ const storage = new Storage({
 });
 
 //Increment these to reset cache on next deployment
-export const cacheIndexNebula = 0;
-export const cacheIndexRmp = 0;
+export const cacheIndexProfessor = 0;
+export const cacheIndexGrades = 0;
+export const cacheIndexRmp = 1;
+
+export const expireTime = 604800; //1 week
 
 function getCache(key: string, cacheIndex: number) {
   return new Promise((resolve, reject) => {