Add username to export

apps/api/src/instrument-records/instrument-records.service.ts

@@ -186,7 +186,7 @@ export class InstrumentRecordsService {
             subjectId: removeSubjectIdScope(record.subject.id),
             subjectSex: record.subject.sex,
             timestamp: record.date.toISOString(),
-            userId: record.session.user?.username ?? 'N/A',
+            username: record.session.user?.username ?? 'N/A',
             value: measureValue
           });
         }
@@ -210,7 +210,7 @@ export class InstrumentRecordsService {
               subjectId: removeSubjectIdScope(record.subject.id),
               subjectSex: record.subject.sex,
               timestamp: record.date.toISOString(),
-              userId: record.session.user?.username ?? 'N/A',
+              username: record.session.user?.username ?? 'N/A',
               value: arrayEntry.measureValue
             });
           });

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

@@ -1,6 +1,7 @@
 import { CurrentUser } from '@douglasneuroinformatics/libnest';
-import { Body, Controller, Get, Param, Post } from '@nestjs/common';
+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';
@@ -20,6 +21,16 @@ export class SessionsController {
     return this.sessionsService.create(data);
   }
 
+  @ApiOperation({ description: 'Find all sessions and usernames attached to them' })
+  @Get()
+  @RouteAccess({ action: 'read', subject: 'Session' })
+  findAllIncludeUsernames(
+    @CurrentUser('ability') ability: AppAbility,
+    @Query('groupId') groupId?: string
+  ): Promise<SessionWithUser[]> {
+    return this.sessionsService.findAllIncludeUsernames(groupId, { ability });
+  }
+
   @ApiOperation({ description: 'Find Session by ID' })
   @Get(':id')
   @RouteAccess({ action: 'read', subject: 'Session' })

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({
@@ -94,6 +96,26 @@ export class SessionsService {
     });
   }
 
+  async findAllIncludeUsernames(groupId?: string, { ability }: EntityOperationOptions = {}) {
+    const sessionsWithUsers = await this.sessionModel.findMany({
+      include: {
+        subject: true,
+        user: {
+          select: {
+            username: true
+          }
+        }
+      },
+      where: {
+        AND: [accessibleQuery(ability, 'read', 'Session'), { groupId }]
+      }
+    });
+    if (sessionsWithUsers.length < 1) {
+      throw new NotFoundException(`Failed to find users`);
+    }
+    return sessionsWithUsers;
+  }
+
   async findById(id: string, { ability }: EntityOperationOptions = {}) {
     const session = await this.sessionModel.findFirst({
       where: { AND: [accessibleQuery(ability, 'read', 'Session')], id }

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

@@ -1,5 +1,5 @@
 import { toBasicISOString } from '@douglasneuroinformatics/libjs';
-import { act, renderHook } from '@testing-library/react';
+import { act, renderHook, waitFor } from '@testing-library/react';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
 import { useInstrumentVisualization } from '../useInstrumentVisualization';
@@ -32,7 +32,19 @@ const mockInstrumentRecords = {
     {
       computedMeasures: {},
       data: { someValue: 'abc' },
-      date: FIXED_TEST_DATE
+      date: FIXED_TEST_DATE,
+      sessionId: '123'
+    }
+  ]
+};
+
+const mockSessionWithUsername = {
+  data: [
+    {
+      id: '123',
+      user: {
+        username: 'testusername'
+      }
     }
   ]
 };
@@ -63,78 +75,97 @@ vi.mock('@/hooks/useInstrumentRecords', () => ({
   useInstrumentRecords: () => mockInstrumentRecords
 }));
 
+vi.mock('@/hooks/useFindSessionQuery', () => ({
+  useFindSessionQuery: () => mockSessionWithUsername
+}));
+
 describe('useInstrumentVisualization', () => {
   beforeEach(() => {
     vi.clearAllMocks();
   });
 
   describe('CSV', () => {
-    it('Should download', () => {
+    it('Should download', async () => {
       const { result } = renderHook(() => useInstrumentVisualization({ params: { subjectId: 'testId' } }));
       const { records } = result.current;
+      await waitFor(() => {
+        expect(result.current.records.length).toBeGreaterThan(0);
+      });
       act(() => result.current.dl('CSV'));
       expect(records).toBeDefined();
       expect(mockDownloadFn).toHaveBeenCalledTimes(1);
       const [filename, getContentFn] = mockDownloadFn.mock.calls[0] ?? [];
       expect(filename).toContain('.csv');
       const csvContents = getContentFn();
       expect(csvContents).toMatch(
-        `GroupID,subjectId,Date,someValue\r\ntestGroupId,testId,${toBasicISOString(FIXED_TEST_DATE)},abc`
+        `GroupID,subjectId,Date,Username,someValue\r\ntestGroupId,testId,${toBasicISOString(FIXED_TEST_DATE)},testusername,abc`
       );
     });
   });
   describe('TSV', () => {
-    it('Should download', () => {
+    it('Should download', async () => {
       const { result } = renderHook(() => useInstrumentVisualization({ params: { subjectId: 'testId' } }));
-      const { dl, records } = result.current;
-      act(() => dl('TSV'));
+      const { records } = result.current;
+      await waitFor(() => {
+        expect(result.current.records.length).toBeGreaterThan(0);
+      });
+      act(() => result.current.dl('TSV'));
       expect(records).toBeDefined();
       expect(mockDownloadFn).toHaveBeenCalledTimes(1);
       const [filename, getContentFn] = mockDownloadFn.mock.calls[0] ?? [];
       expect(filename).toContain('.tsv');
       const tsvContents = getContentFn();
       expect(tsvContents).toMatch(
-        `GroupID\tsubjectId\tDate\tsomeValue\r\ntestGroupId\ttestId\t${toBasicISOString(FIXED_TEST_DATE)}\tabc`
+        `GroupID\tsubjectId\tDate\tUsername\tsomeValue\r\ntestGroupId\ttestId\t${toBasicISOString(FIXED_TEST_DATE)}\ttestusername\tabc`
       );
     });
   });
   describe('CSV Long', () => {
-    it('Should download', () => {
+    it('Should download', async () => {
       const { result } = renderHook(() => useInstrumentVisualization({ params: { subjectId: 'testId' } }));
-      const { dl, records } = result.current;
-      act(() => dl('CSV Long'));
+      const { records } = result.current;
+      await waitFor(() => {
+        expect(result.current.records.length).toBeGreaterThan(0);
+      });
+      act(() => result.current.dl('CSV Long'));
       expect(records).toBeDefined();
       expect(mockDownloadFn).toHaveBeenCalledTimes(1);
 
       const [filename, getContentFn] = mockDownloadFn.mock.calls[0] ?? [];
       expect(filename).toContain('.csv');
       const csvLongContents = getContentFn();
       expect(csvLongContents).toMatch(
-        `GroupID,Date,SubjectID,Value,Variable\r\ntestGroupId,${toBasicISOString(FIXED_TEST_DATE)},testId,abc,someValue`
+        `GroupID,Date,SubjectID,Username,Value,Variable\r\ntestGroupId,${toBasicISOString(FIXED_TEST_DATE)},testId,testusername,abc,someValue`
       );
     });
   });
   describe('TSV Long', () => {
-    it('Should download', () => {
+    it('Should download', async () => {
       const { result } = renderHook(() => useInstrumentVisualization({ params: { subjectId: 'testId' } }));
-      const { dl, records } = result.current;
-      act(() => dl('TSV Long'));
+      const { records } = result.current;
+      await waitFor(() => {
+        expect(result.current.records.length).toBeGreaterThan(0);
+      });
+      act(() => result.current.dl('TSV Long'));
       expect(records).toBeDefined();
       expect(mockDownloadFn).toHaveBeenCalledTimes(1);
 
       const [filename, getContentFn] = mockDownloadFn.mock.calls[0] ?? [];
       expect(filename).toMatch('.tsv');
       const tsvLongContents = getContentFn();
       expect(tsvLongContents).toMatch(
-        `GroupID\tDate\tSubjectID\tValue\tVariable\r\ntestGroupId\t${toBasicISOString(FIXED_TEST_DATE)}\ttestId\tabc\tsomeValue`
+        `GroupID\tDate\tSubjectID\tUsername\tValue\tVariable\r\ntestGroupId\t${toBasicISOString(FIXED_TEST_DATE)}\ttestId\ttestusername\tabc\tsomeValue`
       );
     });
   });
   describe('Excel', () => {
-    it('Should download', () => {
+    it('Should download', async () => {
       const { result } = renderHook(() => useInstrumentVisualization({ params: { subjectId: 'testId' } }));
-      const { dl, records } = result.current;
-      act(() => dl('Excel'));
+      const { records } = result.current;
+      await waitFor(() => {
+        expect(result.current.records.length).toBeGreaterThan(0);
+      });
+      act(() => result.current.dl('Excel'));
       expect(records).toBeDefined();
       expect(mockExcelDownloadFn).toHaveBeenCalledTimes(1);
       const [filename, getContentFn] = mockExcelDownloadFn.mock.calls[0] ?? [];
@@ -143,20 +174,24 @@ describe('useInstrumentVisualization', () => {
 
       expect(excelContents).toEqual([
         {
+          Date: '2025-04-30',
           GroupID: 'testGroupId',
           subjectId: 'testId',
           // eslint-disable-next-line perfectionist/sort-objects
-          Date: '2025-04-30',
-          someValue: 'abc'
+          someValue: 'abc',
+          Username: 'testusername'
         }
       ]);
     });
   });
   describe('Excel Long', () => {
-    it('Should download', () => {
+    it('Should download', async () => {
       const { result } = renderHook(() => useInstrumentVisualization({ params: { subjectId: 'testId' } }));
-      const { dl, records } = result.current;
-      act(() => dl('Excel Long'));
+      const { records } = result.current;
+      await waitFor(() => {
+        expect(result.current.records.length).toBeGreaterThan(0);
+      });
+      act(() => result.current.dl('Excel Long'));
       expect(records).toBeDefined();
       expect(mockExcelDownloadFn).toHaveBeenCalledTimes(1);
 
@@ -169,6 +204,7 @@ describe('useInstrumentVisualization', () => {
           Date: '2025-04-30',
           GroupID: 'testGroupId',
           SubjectID: 'testId',
+          Username: 'testusername',
           Value: 'abc',
           Variable: 'someValue'
         }
@@ -178,8 +214,11 @@ describe('useInstrumentVisualization', () => {
   describe('JSON', () => {
     it('Should download', async () => {
       const { result } = renderHook(() => useInstrumentVisualization({ params: { subjectId: 'testId' } }));
-      const { dl, records } = result.current;
-      act(() => dl('JSON'));
+      const { records } = result.current;
+      await waitFor(() => {
+        expect(result.current.records.length).toBeGreaterThan(0);
+      });
+      act(() => result.current.dl('JSON'));
       expect(records).toBeDefined();
       expect(mockDownloadFn).toHaveBeenCalledTimes(1);
 

apps/web/src/hooks/useFindSessionQuery.ts

@@ -0,0 +1,27 @@
+import { $SessionWithUser } from '@opendatacapture/schemas/session';
+import type { SessionWithUserQueryParams } from '@opendatacapture/schemas/session';
+import { useQuery } from '@tanstack/react-query';
+import axios from 'axios';
+
+type UseSessionOptions = {
+  enabled?: boolean;
+  params: SessionWithUserQueryParams;
+};
+
+export const useFindSessionQuery = (
+  { enabled, params }: UseSessionOptions = {
+    enabled: true,
+    params: {}
+  }
+) => {
+  return useQuery({
+    enabled,
+    queryFn: async () => {
+      const response = await axios.get('/v1/sessions', {
+        params
+      });
+      return $SessionWithUser.array().parseAsync(response.data);
+    },
+    queryKey: ['sessions', ...Object.values(params)]
+  });
+};