Merge pull request #1238 from david-roper/add-username-to-export

Refactors of useFindSessionQuery, useEffect, and nullable subject in $Session schema

Author: joshunrau

apps/api/src/sessions/sessions.controller.ts

@@ -1,14 +1,14 @@
 import { CurrentUser } from '@douglasneuroinformatics/libnest';
 import { Body, Controller, Get, Param, Post, Query } from '@nestjs/common';
 import { ApiOperation } from '@nestjs/swagger';
+import type { SessionWithUser } from '@opendatacapture/schemas/session';
 import type { Session } from '@prisma/client';
 
 import type { AppAbility } from '@/auth/auth.types';
 import { RouteAccess } from '@/core/decorators/route-access.decorator';
 
 import { CreateSessionDto } from './dto/create-session.dto';
 import { SessionsService } from './sessions.service';
-import type { SessionWithUser } from '@opendatacapture/schemas/session';
 
 @Controller('sessions')
 export class SessionsController {

apps/api/src/sessions/sessions.service.ts

@@ -46,7 +46,9 @@ export class SessionsService {
     let group: Group | null = null;
     if (groupId && !subject.groupIds.includes(groupId)) {
       group = await this.groupsService.findById(groupId);
-      await this.subjectsService.addGroupForSubject(subject.id, group.id);
+      if (group) {
+        await this.subjectsService.addGroupForSubject(subject.id, group.id);
+      }
     }
 
     const { id } = await this.sessionModel.create({
@@ -97,12 +99,12 @@ export class SessionsService {
   async findAllIncludeUsernames(groupId?: string, { ability }: EntityOperationOptions = {}) {
     const sessionsWithUsers = await this.sessionModel.findMany({
       include: {
+        subject: true,
         user: {
           select: {
             username: true
           }
-        },
-        subject: true
+        }
       },
       where: {
         AND: [accessibleQuery(ability, 'read', 'Session'), { groupId }]

apps/web/src/components/Sidebar/Sidebar.tsx

@@ -88,7 +88,7 @@ export const Sidebar = () => {
           >
             <h5 className="text-sm font-medium">{t('common.sessionInProgress')}</h5>
             <hr className="my-1.5 h-[1px] border-none bg-slate-700" />
-            {isSubjectWithPersonalInfo(currentSession.subject) ? (
+            {isSubjectWithPersonalInfo(currentSession.subject!) ? (
               <div data-testid="current-session-info">
                 <p>{`${t('core.fullName')}: ${currentSession.subject.firstName} ${currentSession.subject.lastName}`}</p>
                 <p>
@@ -100,7 +100,7 @@ export const Sidebar = () => {
               </div>
             ) : (
               <div data-testid="current-session-info">
-                <p>ID: {removeSubjectIdScope(currentSession.subject.id)}</p>
+                <p>ID: {removeSubjectIdScope(currentSession.subject!.id)}</p>
               </div>
             )}
           </motion.div>

apps/web/src/hooks/__tests__/useInstrumentVisualization.test.ts

@@ -38,13 +38,15 @@ const mockInstrumentRecords = {
   ]
 };
 
-const mockSession = {
-  userId: '111'
-};
-
-const mockUser = {
-  id: '111',
-  username: 'testusername'
+const mockSessionWithUsername = {
+  data: [
+    {
+      id: '123',
+      user: {
+        username: 'testusername'
+      }
+    }
+  ]
 };
 
 vi.mock('@/hooks/useInstrument', () => ({
@@ -73,12 +75,8 @@ vi.mock('@/hooks/useInstrumentRecords', () => ({
   useInstrumentRecords: () => mockInstrumentRecords
 }));
 
-vi.mock('@/hooks/useFindSession', () => ({
-  sessionInfo: () => Promise.resolve(mockSession)
-}));
-
-vi.mock('@/hooks/useFindUser', () => ({
-  userInfo: () => Promise.resolve(mockUser)
+vi.mock('@/hooks/useFindSessionQuery', () => ({
+  useFindSessionQuery: () => mockSessionWithUsername
 }));
 
 describe('useInstrumentVisualization', () => {

apps/web/src/hooks/useFindSessionQuery.ts

@@ -1,5 +1,5 @@
 import { $SessionWithUser } from '@opendatacapture/schemas/session';
-import type { Session, SessionWithUserQueryParams } from '@opendatacapture/schemas/session';
+import type { SessionWithUserQueryParams } from '@opendatacapture/schemas/session';
 import { useQuery } from '@tanstack/react-query';
 import axios from 'axios';
 
@@ -14,19 +14,6 @@ type UseSessionOptions = {
   params: SessionWithUserQueryParams;
 };
 
-export const sessionInfo = async (sessionId: string): Promise<Session> => {
-  try {
-    const response = await axios.get(`/v1/sessions/${encodeURIComponent(sessionId)}`);
-    if (!response.data) {
-      throw new Error('Session data does not exist');
-    }
-    return response.data as Session;
-  } catch (error) {
-    console.error('Error fetching session:', error);
-    throw error;
-  }
-};
-
 export const useFindSessionQuery = (
   { enabled, params }: UseSessionOptions = {
     enabled: true,
@@ -36,7 +23,7 @@ export const useFindSessionQuery = (
   return useQuery({
     enabled,
     queryFn: async () => {
-      const response = await axios.get('/v1/sessions/', {
+      const response = await axios.get('/v1/sessions', {
         params
       });
       return $SessionWithUser.array().parseAsync(response.data);

apps/web/src/hooks/useFindUser.ts

@@ -13,8 +13,7 @@ import { useInstrumentRecords } from '@/hooks/useInstrumentRecords';
 import { useAppStore } from '@/store';
 import { downloadSubjectTableExcel } from '@/utils/excel';
 
-import { sessionInfo, useFindSessionQuery } from './useFindSessionQuery';
-import { userInfo } from './useFindUser';
+import { useFindSessionQuery } from './useFindSessionQuery';
 
 type InstrumentVisualizationRecord = {
   [key: string]: unknown;
@@ -57,12 +56,12 @@ export function useInstrumentVisualization({ params }: UseInstrumentVisualizatio
     }
   });
 
-  // const sessionsUsernameQuery = useFindSessionQuery({
-  //   enabled: instrumentId !== null,
-  //   params: {
-  //     groupId: currentGroup?.id
-  //   }
-  // });
+  const sessionsUsernameQuery = useFindSessionQuery({
+    enabled: instrumentId !== null,
+    params: {
+      groupId: currentGroup?.id
+    }
+  });
 
   // Create a new sessionsUsernameQuery which uses the useFindSessionQuery hook
   // have use a different return type with
@@ -219,27 +218,18 @@ export function useInstrumentVisualization({ params }: UseInstrumentVisualizatio
   };
 
   useEffect(() => {
-    let cancelled = false;
-    const fetchRecords = async () => {
+    const fetchRecords = () => {
       try {
-        if (recordsQuery.data) {
+        const sessions = sessionsUsernameQuery.data;
+        if (recordsQuery.data && sessions) {
           // Fetch all sessions in parallel
-          const sessionPromises = recordsQuery.data.map((record) => sessionInfo(record.sessionId));
-          const sessions = await Promise.all(sessionPromises);
-
-          // Extract unique userIds and fetch users in parallel
-          const userIds = [...new Set(sessions.filter((s) => s?.userId).map((s) => s.userId))];
-
-          //assume userId exists in userId set as we already filtered out the non-existing userIds
-          const userPromises = userIds.map((userId) => userInfo(userId!).catch(() => null));
-          const users = await Promise.all(userPromises);
-          const userMap = new Map(users.filter((u) => u).map((u) => [u!.id, u!.username]));
 
           // Build records with looked-up data
-          const records: InstrumentVisualizationRecord[] = recordsQuery.data.map((record, i) => {
+          const records: InstrumentVisualizationRecord[] = recordsQuery.data.map((record) => {
             const props = record.data && typeof record.data === 'object' ? record.data : {};
-            const session = sessions[i];
-            const username = session?.userId ? (userMap.get(session.userId) ?? 'N/A') : 'N/A';
+            const usersSession = sessions.find((s) => s.id === record.sessionId);
+
+            const username = usersSession?.user?.username ?? 'N/A';
 
             return {
               __date__: record.date,
@@ -250,9 +240,7 @@ export function useInstrumentVisualization({ params }: UseInstrumentVisualizatio
             };
           });
 
-          if (!cancelled) {
-            setRecords(records);
-          }
+          setRecords(records);
         }
       } catch (error) {
         console.error('Error occurred: ', error);
@@ -266,9 +254,6 @@ export function useInstrumentVisualization({ params }: UseInstrumentVisualizatio
       }
     };
     void fetchRecords();
-    return () => {
-      cancelled = true;
-    };
   }, [recordsQuery.data]);
 
   const instrumentOptions: { [key: string]: string } = useMemo(() => {

apps/web/src/hooks/useInstrumentVisualization.ts

@@ -42,7 +42,7 @@ const RouteComponent = () => {
       groupId: currentGroup?.id,
       instrumentId,
       sessionId: currentSession!.id,
-      subjectId: currentSession!.subject.id
+      subjectId: currentSession!.subject!.id
     } satisfies CreateInstrumentRecordData);
     notifications.addNotification({ type: 'success' });
   };
@@ -61,7 +61,7 @@ const RouteComponent = () => {
       <div className="grow">
         <InstrumentRenderer
           className="mx-auto max-w-3xl"
-          subject={currentSession?.subject}
+          subject={currentSession?.subject ?? undefined}
           target={instrumentBundleQuery.data}
           onSubmit={handleSubmit}
         />

apps/web/src/routes/_app/instruments/render/$id.tsx

@@ -10,7 +10,7 @@ export type Session = z.infer<typeof $Session>;
 export const $Session = $BaseModel.extend({
   date: z.coerce.date(),
   groupId: z.string().nullable(),
-  subject: $Subject,
+  subject: $Subject.nullable(),
   subjectId: z.string(),
   type: $SessionType,
   userId: z.string().nullish()
@@ -27,9 +27,11 @@ export const $CreateSessionData = z.object({
 
 export type SessionWithUser = z.infer<typeof $SessionWithUser>;
 export const $SessionWithUser = $Session.extend({
-  user: z.object({
-    username: z.string().nullish()
-  })
+  user: z
+    .object({
+      username: z.string().nullish()
+    })
+    .nullable()
 });
 
 export type SessionWithUserQueryParams = {