Add endpoint for getting a class's measurements without reference to a specific student.

Author: Carifio24

src/stories/hubbles_law/database.ts

@@ -287,6 +287,55 @@ async function getHubbleMeasurementsForStudentClass(studentID: number,
   });
 }
 
+export async function getClassMeasurements(classID: number,
+                                           includeMergedClasses: boolean = true,
+                                           excludeWithNull: boolean = false
+): Promise<HubbleMeasurement[]> {
+
+  const classWhereConditions: WhereOptions<Class> = [];
+  if (includeMergedClasses) {
+    const classIDs = await getMergedIDsForClass(classID);
+    classWhereConditions.push({ id: { [Op.in]: classIDs } });
+  } else {
+    classWhereConditions.push({ id: classID });
+  }
+
+  const measurementWhereConditions: WhereOptions<HubbleMeasurement> = [];
+  if (excludeWithNull) {
+    measurementWhereConditions.push(EXCLUDE_MEASUREMENTS_WITH_NULL_CONDITION);
+  }
+
+  return HubbleMeasurement.findAll({
+    where: measurementWhereConditions,
+    include: [{
+      model: Student,
+      attributes: ["id"],
+      as: "student",
+      required: true,
+      include: [{
+        model: Class,
+        attributes: ["id"],
+        where: classWhereConditions,
+      },
+      {
+        model: IgnoreStudent,
+        required: false,
+        attributes: [],
+        where: {
+          story_name: "hubbles_law",
+          student_id: { [Op.is]: null },
+        }
+      }],
+    },
+    {
+      model: Galaxy,
+      attributes: galaxyAttributes,
+      as: "galaxy",
+      required: true,
+    }]
+  });
+}
+
 async function getHubbleStudentDataForClasses(classIDs: number[]): Promise<HubbleStudentData[]> {
   return HubbleStudentData.findAll({
     include: [{
@@ -390,11 +439,11 @@ export async function getClassDataIDsForStudent(studentID: number): Promise<numb
   return state?.getDataValue("class_data_students") ?? [];
 }
 
-export async function getClassMeasurements(studentID: number,
-                                           classID: number,
-                                           lastChecked: number | null = null,
-                                           excludeWithNull: boolean = false,
-                                           excludeStudent: boolean = false,
+export async function getClassMeasurementsForStudent(studentID: number,
+                                                     classID: number,
+                                                     lastChecked: number | null = null,
+                                                     excludeWithNull: boolean = false,
+                                                     excludeStudent: boolean = false,
 ): Promise<HubbleMeasurement[]> {
   let data = await getHubbleMeasurementsForStudentClass(studentID, classID, excludeWithNull, excludeStudent);
   if (data.length > 0 && lastChecked != null) {
@@ -409,11 +458,11 @@ export async function getClassMeasurements(studentID: number,
 // The advantage of this over the function above is that it saves bandwidth,
 // since we aren't sending the data itself.
 // This is intended to be used with cases where we need to frequently check the number of measurements
-export async function getClassMeasurementCount(studentID: number,
-                                               classID: number,
-                                               excludeWithNull: boolean = false,
+export async function getClassMeasurementCountForStudent(studentID: number,
+                                                         classID: number,
+                                                         excludeWithNull: boolean = false,
 ): Promise<number> {
-  const data = await getClassMeasurements(studentID, classID, null, excludeWithNull);
+  const data = await getClassMeasurementsForStudent(studentID, classID, null, excludeWithNull);
   return data?.length ?? 0;
 }
 

src/stories/hubbles_law/router.ts

@@ -24,6 +24,7 @@ import {
   setGalaxySpectrumStatus,
   getUncheckedSpectraGalaxies,
   getClassMeasurements,
+  getClassMeasurementsForStudent,
   getAllHubbleMeasurements,
   getAllHubbleStudentData,
   getAllHubbleClassData,
@@ -35,7 +36,7 @@ import {
   getGalaxyById,
   removeSampleHubbleMeasurement,
   getAllNthSampleHubbleMeasurements,
-  getClassMeasurementCount,
+  getClassMeasurementCountForStudent,
   getStudentsWithCompleteMeasurementsCount,
   getMergedIDsForClass,
   addClassToMergeGroup,
@@ -203,6 +204,25 @@ router.delete("/sample-measurement/:studentID/:measurementNumber", async (req, r
     });
 });
 
+router.get("/measurements/classes/:classID", async (req, res) => {
+  const classID = parseInt(req.params.classID);
+  const isValidClass = (await findClassById(classID)) !== null;
+  if (!isValidClass) {
+    res.status(404).json({
+      message: `No class with ID ${classID}`,
+    });
+    return;
+  }
+
+  const completeOnly = (req.query.complete_only as string)?.toLowerCase() === "true";
+  const excludeMergedClasses = (req.query.exclude_merge as string)?.toLowerCase() === "true";
+  const measurements = await getClassMeasurements(classID, !excludeMergedClasses, completeOnly);
+  res.status(200).json({
+    class_id: classID,
+    measurements,
+  });
+});
+
 router.get("/measurements/:studentID", async (req, res) => {
   const params = req.params;
   const studentID = parseInt(params.studentID);
@@ -298,7 +318,7 @@ router.get("/class-measurements/size/:studentID/:classID", async (req, res) => {
   }
 
   const completeOnly = (req.query.complete_only as string)?.toLowerCase() === "true";
-  const count = await getClassMeasurementCount(studentID, classID, completeOnly);
+  const count = await getClassMeasurementCountForStudent(studentID, classID, completeOnly);
   res.status(200).json({
     student_id: studentID,
     class_id: classID,
@@ -369,7 +389,7 @@ router.get(["/class-measurements/:studentID/:classID", "/stage-3-data/:studentID
     return;
   }
 
-  const measurements = await getClassMeasurements(student.id, cls.id, lastChecked, completeOnly, excludeStudent);
+  const measurements = await getClassMeasurementsForStudent(student.id, cls.id, lastChecked, completeOnly, excludeStudent);
   res.status(200).json({
     student_id: studentID,
     class_id: classID,
@@ -397,7 +417,7 @@ router.get(["/class-measurements/:studentID", "stage-3-measurements/:studentID"]
   }
 
   const excludeStudent = (req.query.exclude_student as string)?.toLowerCase() === "true";
-  const measurements = await getClassMeasurements(studentID, cls.id, null, excludeStudent);
+  const measurements = await getClassMeasurementsForStudent(studentID, cls.id, null, excludeStudent);
   res.status(200).json({
     student_id: studentID,
     class_id: null,