fix(degreeworks): Provide Polymorphic requirements for majors with specializations

apps/api/src/graphql/resolvers/programs.ts

@@ -20,9 +20,12 @@ export const programResolvers = {
       const service = new ProgramsService(db);
       const res = await service.getMajorRequirements(parsedArgs);
       if (!res)
-        throw new GraphQLError(`Major ${parsedArgs.programId} not found`, {
-          extensions: { code: "NOT_FOUND" },
-        });
+        throw new GraphQLError(
+          `No requirements found for major ${parsedArgs.programId}${parsedArgs.specializationId ? ` with specialization ${parsedArgs.specializationId}` : ""}.`,
+          {
+            extensions: { code: "NOT_FOUND" },
+          },
+        );
       return res;
     },
     minor: async (_: unknown, args: { query?: unknown }, { db }: GraphQLContext) => {

apps/api/src/graphql/schema/programs.ts

@@ -106,6 +106,11 @@ type UgradRequirements @cacheControl(maxAge: 86400) {
     requirements: [ProgramRequirement!]!,
 }
 
+input MajorRequirementsQuery {
+    programId: String!
+    specializationId: String
+}
+
 input ProgramRequirementsQuery {
     programId: String!
 }
@@ -130,7 +135,7 @@ extend type Query {
     majors(query: MajorsQuery): [MajorPreview!]!
     minors(query: MinorsQuery): [MinorPreview!]!
     specializations(query: SpecializationsQuery): [SpecializationPreview!]!
-    major(query: ProgramRequirementsQuery!): Major!
+    major(query: MajorRequirementsQuery!): Major!
     minor(query: ProgramRequirementsQuery!): Minor!
     specialization(query: ProgramRequirementsQuery!): Specialization!
     ugradRequirements(query: UgradRequrementsQuery!): UgradRequirements!

apps/api/src/rest/routes/programs.ts

@@ -80,9 +80,7 @@ const majorRequirements = createRoute({
   tags: ["Programs"],
   method: "get",
   path: "/major",
-  description:
-    "Retrieve course requirements for a major in UCI's current catalogue. Note that these are the requirements for the major itself; " +
-    "if this major has specializations, then one is mandatory and its requirements apply as well.",
+  description: "Retrieve course requirements for a major in UCI's current catalogue.",
   request: { query: majorRequirementsQuerySchema },
   responses: {
     200: response200(majorRequirementsResponseSchema),
@@ -190,7 +188,8 @@ programsRouter.openapi(majorRequirements, async (c) => {
     : c.json(
         {
           ok: false,
-          message: "Couldn't find this major; check your ID?",
+          message:
+            "Couldn't find major requirements associated with this major and specialization; check your IDs?",
         },
         404,
       );

apps/api/src/schema/programs.ts

@@ -30,6 +30,11 @@ export const majorRequirementsQuerySchema = z.object({
     description: "A major ID to query requirements for",
     example: "BS-201",
   }),
+  specializationId: programIdBase.optional().openapi({
+    description:
+      "if provided, fetch major requirements given this specialization; providing no specialization when one is required has unspecified behavior",
+    example: "BS-201A",
+  }),
 });
 
 export const minorRequirementsQuerySchema = z.object({
@@ -200,8 +205,7 @@ export const majorsResponseSchema = z.array(
       description: "Whether a specialization must be completed to complete this degree",
     }),
     specializations: z.array(z.string()).openapi({
-      description:
-        "The ID(s) of specialization(s) associated with this major; if any are present, one is mandatory for this major.",
+      description: "The ID(s) of specialization(s) associated with this major",
       example: [
         "BS-201A",
         "BS-201B",

apps/api/src/services/programs.ts

@@ -9,12 +9,14 @@ import type {
   ugradRequirementsQuerySchema,
 } from "$schema";
 import type { database } from "@packages/db";
-import { eq, sql } from "@packages/db/drizzle";
+import { and, eq, sql } from "@packages/db/drizzle";
 import {
   catalogProgram,
   collegeRequirement,
   degree,
   major,
+  majorRequirement,
+  majorSpecializationToRequirement,
   minor,
   sampleProgramVariation,
   schoolRequirement,
@@ -102,32 +104,48 @@ export class ProgramsService {
         programType: "specialization";
         query: z.infer<typeof specializationRequirementsQuerySchema>;
       }) {
+    if (programType === "major") {
+      const [got] = await this.db
+        .select({
+          id: major.id,
+          name: major.name,
+          requirements: majorRequirement.requirements,
+          schoolRequirements: {
+            name: collegeRequirement.name,
+            requirements: collegeRequirement.requirements,
+          },
+        })
+        .from(major)
+        .where(
+          and(
+            eq(major.id, query.programId),
+            query.specializationId
+              ? eq(majorSpecializationToRequirement.specId, query.specializationId)
+              : undefined,
+          ),
+        )
+        .leftJoin(collegeRequirement, eq(major.collegeRequirement, collegeRequirement.id))
+        .leftJoin(
+          majorSpecializationToRequirement,
+          eq(major.id, majorSpecializationToRequirement.majorId),
+        )
+        .leftJoin(
+          majorRequirement,
+          eq(majorSpecializationToRequirement.requirementId, majorRequirement.id),
+        )
+        .limit(1);
+      return orNull(got);
+    }
+
     const table = {
-      major,
       minor,
       specialization,
     }[programType];
-
-    const [got] = await (programType !== "major"
-      ? this.db
-          .select({ id: table.id, name: table.name, requirements: table.requirements })
-          .from(table)
-      : this.db
-          .select({
-            id: major.id,
-            name: major.name,
-            requirements: major.requirements,
-            schoolRequirements: {
-              name: collegeRequirement.name,
-              requirements: collegeRequirement.requirements,
-            },
-          })
-          .from(major)
-          .leftJoin(collegeRequirement, eq(major.collegeRequirement, collegeRequirement.id))
-    )
+    const [got] = await this.db
+      .select({ id: table.id, name: table.name, requirements: table.requirements })
+      .from(table)
       .where(eq(table.id, query.programId))
       .limit(1);
-
     return orNull(got);
   }
 

apps/data-pipeline/degreeworks-scraper/src/components/DegreeworksClient.ts

@@ -97,12 +97,14 @@ export class DegreeworksClient {
    * @param degree a degree code, e.g. "BS"
    * @param school this corresponds to the UCI notion of division, e.g. "U" or "G"
    * @param majorCode a major code
+   * @param specCode a specialization code
    * @param college this corresponds to the UCI notion of school, e.g. 55 for the school of bio sci
    */
   async getMajorAudit(
     degree: string,
     school: string,
     majorCode: string,
+    specCode?: string,
     college?: string,
   ): Promise<
     | {
@@ -122,6 +124,7 @@ export class DegreeworksClient {
         goals: [
           { code: "MAJOR", value: majorCode },
           ...(college ? [{ code: "COLLEGE", value: college }] : []),
+          ...(specCode ? [{ code: "SPEC", value: specCode }] : []),
         ],
       }),
       headers: this.headers,