Merge pull request #110 from TigerAppsOrg/staging

Begin drizzle setup

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "bocovo.dbml-erd-visualizer",
+        "1yib.svelte-bundle",
+        "oven.bun-vscode",
+        "bradlc.vscode-tailwindcss",
+    ]
+}

.vscode/settings.json

@@ -5,5 +5,6 @@
   "[typescript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "editor.formatOnSave": true
+  "editor.formatOnSave": true,
+  "dbmlERDPreviewer.preferredTheme": "dark"
 }

apps/database/.env.example

@@ -0,0 +1,6 @@
+PUBLIC_SUPABASE_URL=
+PUBLIC_SUPABASE_ANON_KEY=
+REDIS_PASSWORD=
+API_ACCESS_TOKEN=
+SERVICE_ROLE_KEY=
+DATABASE_URL=

apps/server/.gitignore → apps/database/.gitignore

@@ -1,5 +1,14 @@
 # Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
 
+# User Additions
+
+# This is not sensitive info, but it's just to help the developer
+# To recreate it, run `bun run db:schema` in the root of the project
+schema.dbml
+
+# We are using Bun, so this should be ignored in case someone runs npm install
+package-lock.json
+
 # Logs
 
 logs

apps/server/.prettierignore → apps/database/.prettierignore

@@ -1,6 +1,5 @@
 pnpm-lock.yaml
 package-lock.json
-package.json
 yarn.lock
 *.config.*
 *.json

apps/database/README.md

@@ -0,0 +1,9 @@
+# TigerJunction Database
+
+This is where the Drizzle database schema is defined and where the scripts that update the course data are located. This is separated from the main web app in order to maintain a clean separation of concerns. Additionally, as we are migrating off Supabase, this will keep the migration process as clean and simple as possible.
+
+## Getting Started
+
+Make sure to have [Bun](https://bun.sh) installed and the environment variables set according to the `.env.example` file. Run `bun install` to install the dependencies. Check the `package.json` file for the available scripts.
+
+There are 2 main directories. `db` contains the Drizzle database schema. `scripts` contains a collection of scripts used to keep course data up to date.

apps/database/docker-compose.yml

@@ -0,0 +1,10 @@
+services:
+  db:
+    image: postgres
+    restart: always
+    ports:
+      - 5432:5432
+    environment:
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: mysecretpassword
+      POSTGRES_DB: local

apps/database/drizzle.config.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from "drizzle-kit";
+
+if (!process.env.DATABASE_URL) throw new Error("DATABASE_URL is not set");
+
+export default defineConfig({
+    dialect: "postgresql",
+    schema: "./src/db/schema.ts",
+    dbCredentials: {
+        url: process.env.DATABASE_URL
+    },
+    verbose: true,
+    strict: true
+});

apps/database/package.json

@@ -0,0 +1,36 @@
+{
+    "name": "tiger-junction-server",
+    "module": "index.ts",
+    "type": "module",
+    "scripts": {
+        "lint": "prettier --check . && eslint src/",
+        "format": "prettier --write .",
+        "update-supabase": "bun src/scripts/supabase/index.ts",
+        "ratings-supabase": "bun src/scripts/supabase/ratings.ts",
+        "db:start": "docker compose up",
+        "db:schema": "bun src/db/generate-dbml.ts",
+        "db:push": "drizzle-kit push",
+        "db:migrate": "drizzle-kit migrate",
+        "db:studio": "drizzle-kit studio"
+    },
+    "devDependencies": {
+        "@types/jsdom": "^21.1.7",
+        "bun-types": "latest",
+        "drizzle-kit": "^0.27.0",
+        "eslint": "^9.9.0",
+        "eslint-config-prettier": "^9.1.0",
+        "prettier": "^3.3.3",
+        "typescript-eslint": "^8.2.0"
+    },
+    "peerDependencies": {
+        "typescript": "^5.0.0"
+    },
+    "dependencies": {
+        "@supabase/supabase-js": "^2.45.1",
+        "drizzle-dbml-generator": "^0.9.0",
+        "drizzle-orm": "^0.36.0",
+        "jsdom": "^25.0.1",
+        "postgres": "^3.4.5",
+        "redis": "^4.7.0"
+    }
+}

apps/database/src/db/generate-dbml.ts

@@ -0,0 +1,16 @@
+/**
+ * @file db/generate-dbml.ts
+ * @description Used to create a schema.dbml file from the Drizzle ORM schema.
+ * This is useful for visualization. The schema.dbml file can be opened with
+ * the VSCode extension "bocovo.dbml-erd-visualizer"
+ * @link https://github.com/drizzle-team/drizzle-orm/discussions/1480
+ */
+
+import * as schema from "./schema";
+import { pgGenerate } from "drizzle-dbml-generator";
+
+const out = "./schema.dbml";
+const relational = true;
+
+pgGenerate({ schema, out, relational });
+console.log("Successfully created the schema.dbml file.");

apps/database/src/db/schema.ts

@@ -0,0 +1,66 @@
+/**
+ * @file db/schema.ts
+ * @description This file contains the Drizzle ORM schema for the database.
+ * @author Joshua Lau
+ */
+
+import { relations } from "drizzle-orm";
+import {
+    pgTable,
+    text,
+    smallint,
+    integer,
+    real,
+    pgEnum,
+    boolean,
+    serial
+} from "drizzle-orm/pg-core";
+
+//----------------------------------------------------------------------
+// Enums
+//----------------------------------------------------------------------
+
+export const statusEnum = pgEnum("status", ["open", "closed", "cancelled"]);
+
+//----------------------------------------------------------------------
+// Tables
+//----------------------------------------------------------------------
+
+export const listings = pgTable("listings", {
+    id: text("id").notNull().primaryKey(),
+    code: text("code").notNull(),
+    title: text("title").notNull(),
+    aka: text("aka").array(),
+    recentTerm: smallint("recent_term"),
+    terms: smallint("terms").array()
+});
+
+export const listingsRelations = relations(listings, ({ many }) => ({
+    courses: many(courses)
+}));
+
+export const courses = pgTable("courses", {
+    id: serial("id").primaryKey().notNull(),
+    listingId: text("listing_id")
+        .notNull()
+        .references(() => listings.id, {
+            onDelete: "cascade"
+        }),
+    term: smallint("term").notNull(),
+    code: text("code").notNull(),
+    title: text("title").notNull(),
+    gradingBasis: text("grading_basis").notNull(),
+    dists: text("dists").array(),
+    rating: real("rating"),
+    status: statusEnum("status").notNull().default("open"),
+    numEvals: integer("num_evals"),
+    instructors: text("instructors").array(),
+    hasFinal: boolean("has_final")
+});
+
+export const coursesRelations = relations(courses, ({ one }) => ({
+    listing: one(listings, {
+        fields: [courses.listingId],
+        references: [listings.id]
+    })
+}));

apps/server/src/fetchers.ts → apps/database/src/scripts/reg-fetchers.ts

@@ -1,6 +1,15 @@
-// Functions to fetch course data from the registrar API
+/**
+ * @file scripts/reg-fetchers.ts
+ * @description Functions for fetching course listings and details from
+ * the registrar API.
+ * @author Joshua Lau
+ */
 
-import type { RegCourseDetails, RegDeptCourses, RegListings } from "./types";
+import type {
+    RegCourseDetails,
+    RegDeptCourses,
+    RegListings
+} from "./reg-types";
 
 //----------------------------------------------------------------------
 // Helpers and Constants

apps/server/src/types.ts → apps/database/src/scripts/reg-types.ts

@@ -1,3 +1,10 @@
+/**
+ * @file scripts/reg-types.ts
+ * @description This file contains types for the registrar API data.
+ * I pray this does not change anytime in the near future.
+ * @author Joshua Lau
+ */
+
 export type StringBoolean = "Y" | "N";
 
 export type RegListings = {

apps/server/src/courses.ts → apps/database/src/scripts/supabase/courses.ts

@@ -2,9 +2,9 @@ import {
     fetchRegCourseDetails,
     fetchRegDeptCourses,
     fetchRegListings
-} from "./fetchers";
+} from "../reg-fetchers";
 import { supabase } from "./shared";
-import type { RegDeptCourses } from "./types";
+import type { RegDeptCourses } from "../reg-types";
 
 //----------------------------------------------------------------------
 // Types
@@ -352,7 +352,7 @@ export const populateCourses = async (
 
     const { data: supaSections, error: sectionError } = await supabase
         .from("sections")
-        .select("id,course_id,num")
+        .select("id,course_id,num,start_time,days")
         .eq("term", term);
 
     if (sectionError) {
@@ -382,7 +382,16 @@ export const populateCourses = async (
         for (const newSection of courseSections) {
             const matchingSectionIndices: number[] = [];
             for (let i = 0; i < supaCourseSections.length; i++) {
-                if (supaCourseSections[i].num === newSection.num) {
+                const supaSection = supaCourseSections[i];
+                // All of these conditions have to be checked
+                // because there are edge cases where there's a
+                // section with multiple times or days, which
+                // requires multiple db rows (sadly)
+                const numMatch = supaSection.num === newSection.num;
+                const timeMatch =
+                    supaSection.start_time === newSection.start_time;
+                const dayMatch = supaSection.days === newSection.days;
+                if (numMatch && timeMatch && dayMatch) {
                     matchingSectionIndices.push(i);
                 }
             }

apps/server/src/index.ts → apps/database/src/scripts/supabase/index.ts

@@ -2,7 +2,7 @@
 
 import { populateListings } from "./listings";
 import { populateCourses } from "./courses";
-import { redisTransfer } from "./transfer";
+import { redisTransfer } from "./redis";
 import { TERMS } from "./shared";
 
 const args = process.argv.slice(2);

apps/server/src/listings.ts → apps/database/src/scripts/supabase/listings.ts

@@ -1,6 +1,6 @@
-import { fetchRegListings } from "./fetchers";
+import { fetchRegListings } from "../reg-fetchers";
 import { supabase } from "./shared";
-import type { RegListings } from "./types";
+import type { RegListings } from "../reg-types";
 
 type FormattedListing = {
     id: string;

apps/server/src/ratings.ts → apps/database/src/scripts/supabase/ratings.ts

@@ -1,6 +1,6 @@
 import { supabase, TERMS } from "./shared";
 import { JSDOM } from "jsdom";
-import { redisTransfer } from "./transfer";
+import { redisTransfer } from "./redis";
 
 type IdPair = {
     listingId: string;