Background Work - Quiz pass status (#168)

Lan2u · web-flow · commit ddc19d807e7e · 2026-02-24T21:49:32.000Z
* Rename getFullQuizResults for equipment

* Tests for getFullQuizResultsForMember

* Implement getting quiz results on a per-member basis

* Tests pass

* Typecheck pass

* Fix merge conflict issue
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -13,7 +13,8 @@
 	"customizations": {
 		"vscode": {
 			"extensions": [
-				"dbaeumer.vscode-eslint"
+				"dbaeumer.vscode-eslint",
+				"Orta.vscode-jest"
 			]
 		}
 	}
diff --git a/src/dependencies.ts b/src/dependencies.ts
@@ -46,6 +46,9 @@ export type Dependencies = {
     sheetId: string,
     from: O.Option<Date>
   ) => TE.TaskEither<string, SheetDataTable['rows']>;
+  getSheetDataByMemberNumber: (
+    memberNumber: number,
+  ) => TE.TaskEither<string, SheetDataTable['rows']>,
   getTroubleTicketData: (
     from: O.Option<Date>
   ) => TE.TaskEither<string, O.Option<TroubleTicketDataTable['rows']>>;
diff --git a/src/init-dependencies/init-dependencies.ts b/src/init-dependencies/init-dependencies.ts
@@ -12,7 +12,7 @@ import {Client} from '@libsql/client';
 
 import {initSharedReadModel} from '../read-models/shared-state';
 import {lastSync} from '../sync-worker/db/last_sync';
-import {getSheetData} from '../sync-worker/db/get_sheet_data';
+import {getSheetData, getSheetDataByMemberNumber} from '../sync-worker/db/get_sheet_data';
 import {getTroubleTicketData} from '../sync-worker/db/get_trouble_ticket_data';
 
 export const initLogger = (conf: Config) => {
@@ -79,6 +79,7 @@ export const initDependencies = (
     logger,
     lastQuizSync: lastSync(googleDB),
     getSheetData: getSheetData(googleDB),
+    getSheetDataByMemberNumber: getSheetDataByMemberNumber(googleDB),
     getTroubleTicketData: getTroubleTicketData(
       googleDB,
       O.fromNullable(conf.TROUBLE_TICKET_SHEET)
diff --git a/src/queries/equipment/construct-view-model.ts b/src/queries/equipment/construct-view-model.ts
@@ -11,8 +11,8 @@ import {User} from '../../types';
 import {UUID} from 'io-ts-types';
 import {StatusCodes} from 'http-status-codes';
 import {
-  FullQuizResults,
-  getFullQuizResults,
+  FullQuizResultsForEquipment,
+  getFullQuizResultsForEquipment,
 } from '../../read-models/external-state/equipment-quiz';
 
 export const constructViewModel =
@@ -63,8 +63,8 @@ export const constructViewModel =
           return TE.right(O.none);
         }
         return pipe(
-          getFullQuizResults(deps, equipment.trainingSheetId.value, equipment),
-          TE.map<FullQuizResults, O.Option<FullQuizResults>>(O.some),
+          getFullQuizResultsForEquipment(deps, equipment.trainingSheetId.value, equipment),
+          TE.map<FullQuizResultsForEquipment, O.Option<FullQuizResultsForEquipment>>(O.some),
           TE.mapLeft(err_str => {
             deps.logger.error(
               'Failed to read sheet sync metadata: %s',
diff --git a/src/queries/equipment/view-model.ts b/src/queries/equipment/view-model.ts
@@ -1,4 +1,4 @@
-import {FullQuizResults} from '../../read-models/external-state/equipment-quiz';
+import {FullQuizResultsForEquipment} from '../../read-models/external-state/equipment-quiz';
 import {Equipment} from '../../read-models/shared-state/return-types';
 import {User} from '../../types';
 import * as O from 'fp-ts/Option';
@@ -9,5 +9,5 @@ export type ViewModel = {
   isSuperUserOrTrainerOfArea: boolean;
   isSuperUser: boolean;
   equipment: Equipment;
-  quizResults: O.Option<FullQuizResults>;
+  quizResults: O.Option<FullQuizResultsForEquipment>;
 };
diff --git a/src/read-models/external-state/equipment-quiz.ts b/src/read-models/external-state/equipment-quiz.ts
@@ -1,12 +1,15 @@
 import * as O from 'fp-ts/Option';
 import * as TE from 'fp-ts/TaskEither';
 import * as RA from 'fp-ts/ReadonlyArray';
+import * as RR from 'fp-ts/ReadonlyRecord';
 
 import {Dependencies} from '../../dependencies';
 import {SheetDataTable} from '../../sync-worker/google/sheet-data-table';
 import {pipe} from 'fp-ts/lib/function';
 import {Equipment, MemberCoreInfo} from '../shared-state/return-types';
 import {DateTime, Duration} from 'luxon';
+import { ReadonlyRecord } from 'fp-ts/lib/ReadonlyRecord';
+import { EquipmentId } from '../../types/equipment-id';
 
 export type EquipmentQuizResults = {
   passedQuizes: SheetDataTable['rows'];
@@ -27,20 +30,23 @@ export type MemberAwaitingTraining = Pick<
   waitingSince: Date;
 };
 
+const isPassed = (row: SheetDataTable['rows'][0]) => row.percentage >= 100;
+const isFailed = (row: SheetDataTable['rows'][0]) => !isPassed(row);
+
 const extractPassedQuizes = (
   sheetData: SheetDataTable['rows']
 ): SheetDataTable['rows'] =>
   pipe(
     sheetData,
-    RA.filter(row => row.percentage === 100)
+    RA.filter(isPassed)
   );
 
 const extractFailedQuizes = (
   sheetData: SheetDataTable['rows']
 ): SheetDataTable['rows'] =>
   pipe(
     sheetData,
-    RA.filter(row => row.percentage < 100)
+    RA.filter(isFailed)
   );
 
 const getQuizResults = (
@@ -70,18 +76,18 @@ const getQuizResults = (
   );
 };
 
-export type FullQuizResults = {
+export type FullQuizResultsForEquipment = {
   lastQuizSync: O.Option<Date>;
   membersAwaitingTraining: ReadonlyArray<MemberAwaitingTraining>;
   unknownMembersAwaitingTraining: ReadonlyArray<OrphanedPassedQuiz>;
   failedQuizes: SheetDataTable['rows'];
 };
 
-export const getFullQuizResults = (
+export const getFullQuizResultsForEquipment = (
   deps: Pick<Dependencies, 'sharedReadModel' | 'lastQuizSync' | 'getSheetData'>,
   sheetId: string,
   equipment: Equipment
-): TE.TaskEither<string, FullQuizResults> =>
+): TE.TaskEither<string, FullQuizResultsForEquipment> =>
   pipe(
     getQuizResults(deps, sheetId, equipment.trainedMembers),
     TE.map(qr => {
@@ -124,3 +130,71 @@ export const getFullQuizResults = (
       };
     })
   );
+
+export type FullQuizResultsForMember = {
+  equipmentQuizPassedAt: ReadonlyRecord<EquipmentId, ReadonlyArray<Date>>,
+  equipmentQuizAttempted: ReadonlyRecord<EquipmentId, ReadonlyArray<{
+    response_submitted: Date,
+    sheet_id: string;
+    score: number;
+    max_score: number;
+    percentage: number;
+  }>>,
+  orphanedQuizAttempts: ReadonlyArray<{
+    response_submitted: Date,
+    sheet_id: string;
+    score: number;
+    max_score: number;
+    percentage: number;
+  }>,
+};
+
+export const getFullQuizResultsForMember = (
+  deps: Pick<Dependencies, 'sharedReadModel' | 'getSheetDataByMemberNumber'>,
+  memberNumber: number
+): TE.TaskEither<string, FullQuizResultsForMember> => pipe(
+  deps.getSheetDataByMemberNumber(memberNumber),
+  TE.map(
+    qr => {
+      const equipmentQuizPassedAt: Record<EquipmentId, Date[]> = {};
+      const equipmentQuizAttempted: Record<EquipmentId, {
+        response_submitted: Date,
+        sheet_id: string;
+        score: number;
+        max_score: number;
+        percentage: number;
+      }[]> = {};
+      const orphanedQuizAttempts: {
+        response_submitted: Date,
+        sheet_id: string;
+        score: number;
+        max_score: number;
+        percentage: number;
+      }[] = [];
+      const trainingSheetMapping = deps.sharedReadModel.equipment.getTrainingSheetIdMapping();
+      for (const row of qr) {
+        const equipmentId = RR.lookup(row.sheet_id)(trainingSheetMapping);
+        if (O.isNone(equipmentId)) {
+          orphanedQuizAttempts.push(row);
+        } else {
+          if (isPassed(row)) {
+            if (!equipmentQuizPassedAt[equipmentId.value]) {
+              equipmentQuizPassedAt[equipmentId.value] = [];
+            }
+            equipmentQuizPassedAt[equipmentId.value].push(row.response_submitted);
+          } else {
+            if (!equipmentQuizAttempted[equipmentId.value]) {
+              equipmentQuizAttempted[equipmentId.value] = [];
+            }
+            equipmentQuizAttempted[equipmentId.value].push(row);
+          }
+        }
+      }
+      return {
+        equipmentQuizPassedAt,
+        equipmentQuizAttempted,
+        orphanedQuizAttempts,
+      }
+    }
+  )
+);
diff --git a/src/read-models/shared-state/equipment/get.ts b/src/read-models/shared-state/equipment/get.ts
@@ -1,11 +1,15 @@
 import {pipe} from 'fp-ts/lib/function';
 import {BetterSQLite3Database} from 'drizzle-orm/better-sqlite3';
-import {eq} from 'drizzle-orm';
+import {eq, isNotNull} from 'drizzle-orm';
 import * as O from 'fp-ts/Option';
 import * as RA from 'fp-ts/ReadonlyArray';
+import * as RR from 'fp-ts/ReadonlyRecord';
 import {equipmentTable} from '../state';
 import {MinimalEquipment} from '../return-types';
 import {UUID} from 'io-ts-types';
+import { ReadonlyRecord } from 'fp-ts/lib/ReadonlyRecord';
+import { TrainingSheetId } from '../../../types/training-sheet';
+import { EquipmentId } from '../../../types/equipment-id';
 
 const transformRow = <
   R extends {
@@ -47,3 +51,18 @@ export const getAllEquipmentMinimal = (
   db: BetterSQLite3Database
 ): ReadonlyArray<MinimalEquipment> =>
   pipe(db.select().from(equipmentTable).all(), RA.map(transformRow));
+
+export const getTrainingSheetIdMapping = (
+  db: BetterSQLite3Database
+) => (): ReadonlyRecord<TrainingSheetId, EquipmentId> => 
+  pipe(
+    db.select({
+      trainingSheetId: equipmentTable.trainingSheetId,
+      id: equipmentTable.id,
+    }).from(equipmentTable).where(isNotNull(equipmentTable.trainingSheetId)).all(),
+    RA.map(
+      row => ([row.trainingSheetId!, row.id as UUID])
+    ),
+    (x: ReadonlyArray<[string, UUID]>) => x,
+    RR.fromEntries
+  )
diff --git a/src/read-models/shared-state/index.ts b/src/read-models/shared-state/index.ts
@@ -27,6 +27,10 @@ import {dumpCurrentState, SharedDatabaseDump} from './debug/dump';
 import {MemberLinking} from './member-linking';
 import {DateTime} from 'luxon';
 import {getLastSent} from './training-stat-notifications/get-last-sent';
+import { ReadonlyRecord } from 'fp-ts/lib/ReadonlyRecord';
+import { TrainingSheetId } from '../../types/training-sheet';
+import { EquipmentId } from '../../types/equipment-id';
+import { getTrainingSheetIdMapping } from './equipment/get';
 
 export type SharedReadModel = {
   db: BetterSQLite3Database;
@@ -44,6 +48,7 @@ export type SharedReadModel = {
   equipment: {
     get: (id: UUID) => O.Option<Equipment>;
     getAll: () => ReadonlyArray<Equipment>;
+    getTrainingSheetIdMapping: () => ReadonlyRecord<TrainingSheetId, EquipmentId>;
   };
   area: {
     get: (id: UUID) => O.Option<Area>;
@@ -94,6 +99,7 @@ export const initSharedReadModel = (
     equipment: {
       get: getEquipmentFull(readModelDb, linking),
       getAll: getAllEquipmentFull(readModelDb, linking),
+      getTrainingSheetIdMapping: getTrainingSheetIdMapping(readModelDb),
     },
     area: {
       get: getAreaFull(readModelDb, linking),
diff --git a/src/read-models/shared-state/member-linking.ts b/src/read-models/shared-state/member-linking.ts
@@ -1,4 +1,4 @@
-type MemberNumber = number;
+import { MemberNumber } from "../../types/member-number";
 
 export class MemberLinking {
   // Stores the linking between member numbers.
diff --git a/src/sync-worker/db/get_sheet_data.ts b/src/sync-worker/db/get_sheet_data.ts
@@ -49,3 +49,33 @@ export const getSheetData =
       ),
       TE.map(data => data.rows)
     );
+
+export const getSheetDataByMemberNumber =
+  (googleDB: Client) =>
+  (
+    memberNumber: number,
+  ): TE.TaskEither<string, SheetDataTable['rows']> =>
+    pipe(
+      TE.tryCatch<string, ResultSet>(
+        () => googleDB.execute(
+          ` SELECT *
+            FROM sheet_data
+            WHERE member_number_provided = ?
+          `, [memberNumber]
+        ),
+        reason =>
+          `Failed to get sheet data for memberNumber '${memberNumber}': ${(reason as Error).message}`
+      ),
+      TE.flatMapEither<ResultSet, string, SheetDataTable>(data =>
+        pipe(
+          data,
+          SheetDataTable.decode,
+          E.mapLeft(
+            e =>
+              'Failed to pull sheet data due to malformed data: ' +
+              formatValidationErrors(e).join(',')
+          )
+        )
+      ),
+      TE.map(data => data.rows)
+    );
diff --git a/src/sync-worker/training-summary/gather-email-content.ts b/src/sync-worker/training-summary/gather-email-content.ts
@@ -5,7 +5,7 @@ import * as S from 'fp-ts/string';
 import * as RA from 'fp-ts/ReadonlyArray';
 import {Equipment} from '../../read-models/shared-state/return-types';
 import {SanitizedString, sanitizeString} from '../../types/html';
-import {getFullQuizResults} from '../../read-models/external-state/equipment-quiz';
+import {getFullQuizResultsForEquipment} from '../../read-models/external-state/equipment-quiz';
 import {pipe} from 'fp-ts/lib/function';
 import {contramap} from 'fp-ts/lib/Ord';
 import {TrainingSummaryDeps} from './training-summary-deps';
@@ -44,7 +44,7 @@ const gatherEmailContentForEquipment =
   ): Promise<EquipmentTrainingStats> => {
     const qzResults = O.isNone(equipment.trainingSheetId)
       ? E.left('No training sheet registered')
-      : await getFullQuizResults(
+      : await getFullQuizResultsForEquipment(
           deps,
           equipment.trainingSheetId.value,
           equipment
diff --git a/src/types/equipment-id.ts b/src/types/equipment-id.ts
@@ -0,0 +1,4 @@
+import { UUID } from "io-ts-types";
+
+// Simple type alias to make typing easier to follow.
+export type EquipmentId = UUID;
diff --git a/src/types/member-number.ts b/src/types/member-number.ts
@@ -0,0 +1,2 @@
+// Simple type alias to make typing easier to follow.
+export type MemberNumber = number;
diff --git a/src/types/training-sheet.ts b/src/types/training-sheet.ts
@@ -0,0 +1,2 @@
+// Simple type alias to make typing easier to follow.
+export type TrainingSheetId = string;
diff --git a/tests/init-dependencies/happy-path-adapters.helper.ts b/tests/init-dependencies/happy-path-adapters.helper.ts
@@ -27,5 +27,6 @@ export const happyPathAdapters: Dependencies = {
   getAllEventsByType: <T extends EventName>(_eventType: T) => TE.right([]),
   lastQuizSync: (_sheetId: string) => TE.right(O.none),
   getSheetData: (_sheetId: string) => TE.right([]),
+  getSheetDataByMemberNumber: (_memberNumber: number) => TE.right([]),
   getTroubleTicketData: () => TE.right(O.none),
 };
diff --git a/tests/queries/equipment/render.test.ts b/tests/queries/equipment/render.test.ts
@@ -15,8 +15,8 @@ import { Equipment, TrainedMember, TrainerInfo } from '../../../src/read-models/
 import { User } from '../../../src/types/user';
 import { faker } from '@faker-js/faker';
 import { EmailAddress } from '../../../src/types';
-import { FullQuizResults } from '../../../src/read-models/external-state/equipment-quiz';
 import { UUID } from 'io-ts-types';
+import { FullQuizResultsForEquipment } from '../../../src/read-models/external-state/equipment-quiz';
 
 describe('Render equipment page', () => {
     const renderPage = (vm: ViewModel) => {
@@ -74,7 +74,7 @@ describe('Render equipment page', () => {
             email: O.some(faker.internet.email() as EmailAddress),
         }
     };
-    const quizResults: Readonly<FullQuizResults> = {
+    const quizResults: Readonly<FullQuizResultsForEquipment> = {
         lastQuizSync: O.none,
         membersAwaitingTraining: [],
         unknownMembersAwaitingTraining: [],
diff --git a/tests/read-models/external-state/get-equipment-quiz.test.ts b/tests/read-models/external-state/get-equipment-quiz.test.ts
diff --git a/tests/read-models/test-framework.ts b/tests/read-models/test-framework.ts

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,8 @@`
`13`	`13`	`"customizations": {`
`14`	`14`	`"vscode": {`
`15`	`15`	`"extensions": [`
`16`		`- "dbaeumer.vscode-eslint"`
	`16`	`+ "dbaeumer.vscode-eslint",`
	`17`	`+ "Orta.vscode-jest"`
`17`	`18`	`]`
`18`	`19`	`}`
`19`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-type MemberNumber = number;`
	`1`	`+import { MemberNumber } from "../../types/member-number";`
`2`	`2`
`3`	`3`	`export class MemberLinking {`
`4`	`4`	`// Stores the linking between member numbers.`