Skip to content

UPDATE_GUIDE.md

Latest commit

 

History

History
55 lines (34 loc) · 4.12 KB

UPDATE_GUIDE.md

File metadata and controls

55 lines (34 loc) · 4.12 KB

TigerJunction Update Guide

When the courses for a new semester are released, there are a few steps that need to be taken to update the codebase and database. Please follow the steps below carefully to update the app.

Step 1: Update the Database

Login to Supabase and go to the Database tab on the left bar. Click on the functions subtab and click the 3 dots next to handle_new_user and click Edit function. In the function definition, there will be a part that looks like:

-- Create default schedules for terms (1242, 1234, 1232)
INSERT INTO public.schedules (user_id, title, term)
VALUES (new.id, 'My Schedule', 1242),
       (new.id, 'My Schedule', 1234),
       (new.id, 'My Schedule', 1244);

Find the oldest term and replace it with the new term. For example, in the example above, the oldest term is 1234, so you would replace that with whatever the new term is.

Additionally, you should update the db/createUser.sql file in the codebase with the new term. While this is not necessary, it is good practice to keep the codebase up to date with the database.

Step 2: Update the Codebase

Create a new branch. There is only 1 file that needs to be updated: src/lib/changeme.ts. There are 5 things that need to be updated in the file, and they all have comments next to them explaining what needs to be done. Once you have updated the file, commit the changes and push the branch to GitHub.

Step 3: Check Department List

In src/lib/constants.ts check the array titled DEPARTMENTS against the list of departments on the Princeton course offerings website. If there are any new departments, add them to the array. Do not remove anything from the array.

Step 4: Populate the Database

Database population is done via CLI scripts in apps/database. Make sure your apps/database/.env file is configured with the required environment variables (see apps/database/.env.example): PUBLIC_SUPABASE_URL, SERVICE_ROLE_KEY, API_ACCESS_TOKEN, REDIS_PASSWORD, and REG_COOKIE.

Before running the scripts, add the new term code to the TERMS array in apps/database/src/scripts/supabase/shared.ts, or the scripts will reject it as invalid.

From the apps/database directory, run the following commands in order:

  1. Push Listings + Courses + Redis: bun run update-supabase <term> --grading

    • This populates listings, courses (with grading info), and syncs to Redis in one step.
    • The --grading (or -g) flag refreshes grading fields. Omit it if you don't need to update grading.
    • This will take a while (~30 minutes).

  2. Push Ratings: bun run ratings-supabase <term>

    • This scrapes course evaluation ratings and updates them in Supabase, then syncs to Redis.
    • Requires REG_COOKIE to be set (a valid PHPSESSID cookie from the registrar evaluations site).
    • You can optionally pass a startIndex as a second argument to resume from a specific course if the script is interrupted.

Step 5: Test and Deploy

Run the branch locally with npx sst dev and npm run dev (in a separate terminal window). Play around with the app to ensure that there are no bugs. If there are, fix them and push the changes to the branch. Once the update branch is bug-free, create a pull request and merge the branch into main. GitHub Actions will automatically create a production deployment of the new branch through SST onto AWS. Once the branch has been merged, you can delete the branch.

Step 6: Clean Up the Database

WARNING: EXERCISE EXTREME CAUTION WHILE PERFORMING THIS STEP!!!

In Supabase, go to the Table Editor tab on the left bar. Click on the schedules table and filter by the term column for the term that was just removed. Delete all of the rows that show up. Similarly, in the courses table, filter by the term column for the term that was just removed. Delete all of the rows that show up. DO NOT DELETE ANY ROWS THAT ARE NOT IN THE TERM THAT WAS JUST REMOVED. If you do, it is game over as there is no way to recover the data. If you are unsure, please ask someone for help.