Merge branch 'dev' into feat/class-functionality
This commit is contained in:
		
						commit
						1635449962
					
				
					 37 changed files with 1320 additions and 2052 deletions
				
			
		
							
								
								
									
										21
									
								
								backend/.env-old
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								backend/.env-old
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,21 @@ | |||
| PORT=3000 | ||||
| DWENGO_DB_HOST=db | ||||
| DWENGO_DB_PORT=5432 | ||||
| DWENGO_DB_USERNAME=postgres | ||||
| DWENGO_DB_PASSWORD=postgres | ||||
| DWENGO_DB_UPDATE=false | ||||
| 
 | ||||
| DWENGO_AUTH_STUDENT_URL=http://localhost/idp/realms/student | ||||
| DWENGO_AUTH_STUDENT_CLIENT_ID=dwengo | ||||
| DWENGO_AUTH_STUDENT_JWKS_ENDPOINT=http://idp:7080/idp/realms/student/protocol/openid-connect/certs | ||||
| DWENGO_AUTH_TEACHER_URL=http://localhost/idp/realms/teacher | ||||
| DWENGO_AUTH_TEACHER_CLIENT_ID=dwengo | ||||
| DWENGO_AUTH_TEACHER_JWKS_ENDPOINT=http://idp:7080/idp/realms/teacher/protocol/openid-connect/certs | ||||
| 
 | ||||
| # Allow Vite dev-server to access the backend (for testing purposes). Don't forget to remove this in production! | ||||
| #DWENGO_CORS_ALLOWED_ORIGINS=http://localhost/,127.0.0.1:80,http://127.0.0.1,http://localhost:80,http://127.0.0.1:80,localhost | ||||
| DWENGO_CORS_ALLOWED_ORIGINS=http://localhost/*,http://idp:7080,https://idp:7080 | ||||
| 
 | ||||
| # Logging and monitoring | ||||
| 
 | ||||
| LOKI_HOST=http://logging:3102 | ||||
|  | @ -6,8 +6,9 @@ WORKDIR /app/dwengo | |||
| 
 | ||||
| COPY package*.json ./ | ||||
| COPY backend/package.json ./backend/ | ||||
| # Backend depends on common | ||||
| # Backend depends on common and docs | ||||
| COPY common/package.json ./common/ | ||||
| COPY docs/package.json ./docs/ | ||||
| 
 | ||||
| RUN npm install --silent | ||||
| 
 | ||||
|  | @ -34,6 +35,7 @@ COPY ./backend/i18n ./i18n | |||
| 
 | ||||
| COPY --from=build-stage /app/dwengo/common/dist ./common/dist | ||||
| COPY --from=build-stage /app/dwengo/backend/dist ./backend/dist | ||||
| COPY --from=build-stage /app/dwengo/docs/api/swagger.json ./docs/api/swagger.json | ||||
| 
 | ||||
| COPY package*.json ./ | ||||
| COPY backend/package.json ./backend/ | ||||
|  | @ -42,7 +44,6 @@ COPY common/package.json ./common/ | |||
| 
 | ||||
| RUN npm install --silent --only=production | ||||
| 
 | ||||
| COPY ./docs ./docs | ||||
| COPY ./backend/i18n ./backend/i18n | ||||
| 
 | ||||
| EXPOSE 3000 | ||||
|  |  | |||
							
								
								
									
										66
									
								
								backend/src/controllers/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										66
									
								
								backend/src/controllers/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,66 @@ | |||
| import { Request, Response } from 'express'; | ||||
| import { requireFields } from './error-helper'; | ||||
| import { createInvitation, deleteInvitation, getAllInvitations, getInvitation, updateInvitation } from '../services/teacher-invitations'; | ||||
| import { TeacherInvitationData } from '@dwengo-1/common/interfaces/teacher-invitation'; | ||||
| 
 | ||||
| export async function getAllInvitationsHandler(req: Request, res: Response): Promise<void> { | ||||
|     const username = req.params.username; | ||||
|     const by = req.query.sent === 'true'; | ||||
|     requireFields({ username }); | ||||
| 
 | ||||
|     const invitations = await getAllInvitations(username, by); | ||||
| 
 | ||||
|     res.json({ invitations }); | ||||
| } | ||||
| 
 | ||||
| export async function getInvitationHandler(req: Request, res: Response): Promise<void> { | ||||
|     const sender = req.params.sender; | ||||
|     const receiver = req.params.receiver; | ||||
|     const classId = req.params.classId; | ||||
|     requireFields({ sender, receiver, classId }); | ||||
| 
 | ||||
|     const invitation = await getInvitation(sender, receiver, classId); | ||||
| 
 | ||||
|     res.json({ invitation }); | ||||
| } | ||||
| 
 | ||||
| export async function createInvitationHandler(req: Request, res: Response): Promise<void> { | ||||
|     const sender = req.body.sender; | ||||
|     const receiver = req.body.receiver; | ||||
|     const classId = req.body.class; | ||||
|     requireFields({ sender, receiver, classId }); | ||||
| 
 | ||||
|     const data = req.body as TeacherInvitationData; | ||||
|     const invitation = await createInvitation(data); | ||||
| 
 | ||||
|     res.json({ invitation }); | ||||
| } | ||||
| 
 | ||||
| export async function updateInvitationHandler(req: Request, res: Response): Promise<void> { | ||||
|     const sender = req.body.sender; | ||||
|     const receiver = req.body.receiver; | ||||
|     const classId = req.body.class; | ||||
|     req.body.accepted = req.body.accepted !== 'false'; | ||||
|     requireFields({ sender, receiver, classId }); | ||||
| 
 | ||||
|     const data = req.body as TeacherInvitationData; | ||||
|     const invitation = await updateInvitation(data); | ||||
| 
 | ||||
|     res.json({ invitation }); | ||||
| } | ||||
| 
 | ||||
| export async function deleteInvitationHandler(req: Request, res: Response): Promise<void> { | ||||
|     const sender = req.params.sender; | ||||
|     const receiver = req.params.receiver; | ||||
|     const classId = req.params.classId; | ||||
|     requireFields({ sender, receiver, classId }); | ||||
| 
 | ||||
|     const data: TeacherInvitationData = { | ||||
|         sender, | ||||
|         receiver, | ||||
|         class: classId, | ||||
|     }; | ||||
|     const invitation = await deleteInvitation(data); | ||||
| 
 | ||||
|     res.json({ invitation }); | ||||
| } | ||||
|  | @ -2,14 +2,14 @@ import { DwengoEntityRepository } from '../dwengo-entity-repository.js'; | |||
| import { Class } from '../../entities/classes/class.entity.js'; | ||||
| import { ClassJoinRequest } from '../../entities/classes/class-join-request.entity.js'; | ||||
| import { Student } from '../../entities/users/student.entity.js'; | ||||
| import { ClassJoinRequestStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| export class ClassJoinRequestRepository extends DwengoEntityRepository<ClassJoinRequest> { | ||||
|     public async findAllRequestsBy(requester: Student): Promise<ClassJoinRequest[]> { | ||||
|         return this.findAll({ where: { requester: requester } }); | ||||
|     } | ||||
|     public async findAllOpenRequestsTo(clazz: Class): Promise<ClassJoinRequest[]> { | ||||
|         return this.findAll({ where: { class: clazz, status: ClassJoinRequestStatus.Open } }); // TODO check if works like this
 | ||||
|         return this.findAll({ where: { class: clazz, status: ClassStatus.Open } }); // TODO check if works like this
 | ||||
|     } | ||||
|     public async findByStudentAndClass(requester: Student, clazz: Class): Promise<ClassJoinRequest | null> { | ||||
|         return this.findOne({ requester, class: clazz }); | ||||
|  |  | |||
|  | @ -2,6 +2,7 @@ import { DwengoEntityRepository } from '../dwengo-entity-repository.js'; | |||
| import { Class } from '../../entities/classes/class.entity.js'; | ||||
| import { TeacherInvitation } from '../../entities/classes/teacher-invitation.entity.js'; | ||||
| import { Teacher } from '../../entities/users/teacher.entity.js'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| export class TeacherInvitationRepository extends DwengoEntityRepository<TeacherInvitation> { | ||||
|     public async findAllInvitationsForClass(clazz: Class): Promise<TeacherInvitation[]> { | ||||
|  | @ -11,7 +12,7 @@ export class TeacherInvitationRepository extends DwengoEntityRepository<TeacherI | |||
|         return this.findAll({ where: { sender: sender } }); | ||||
|     } | ||||
|     public async findAllInvitationsFor(receiver: Teacher): Promise<TeacherInvitation[]> { | ||||
|         return this.findAll({ where: { receiver: receiver } }); | ||||
|         return this.findAll({ where: { receiver: receiver, status: ClassStatus.Open } }); | ||||
|     } | ||||
|     public async deleteBy(clazz: Class, sender: Teacher, receiver: Teacher): Promise<void> { | ||||
|         return this.deleteWhere({ | ||||
|  | @ -20,4 +21,11 @@ export class TeacherInvitationRepository extends DwengoEntityRepository<TeacherI | |||
|             class: clazz, | ||||
|         }); | ||||
|     } | ||||
|     public async findBy(clazz: Class, sender: Teacher, receiver: Teacher): Promise<TeacherInvitation | null> { | ||||
|         return this.findOne({ | ||||
|             sender: sender, | ||||
|             receiver: receiver, | ||||
|             class: clazz, | ||||
|         }); | ||||
|     } | ||||
| } | ||||
|  |  | |||
|  | @ -2,7 +2,7 @@ import { Entity, Enum, ManyToOne } from '@mikro-orm/core'; | |||
| import { Student } from '../users/student.entity.js'; | ||||
| import { Class } from './class.entity.js'; | ||||
| import { ClassJoinRequestRepository } from '../../data/classes/class-join-request-repository.js'; | ||||
| import { ClassJoinRequestStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| @Entity({ | ||||
|     repository: () => ClassJoinRequestRepository, | ||||
|  | @ -20,6 +20,6 @@ export class ClassJoinRequest { | |||
|     }) | ||||
|     class!: Class; | ||||
| 
 | ||||
|     @Enum(() => ClassJoinRequestStatus) | ||||
|     status!: ClassJoinRequestStatus; | ||||
|     @Enum(() => ClassStatus) | ||||
|     status!: ClassStatus; | ||||
| } | ||||
|  |  | |||
|  | @ -1,7 +1,8 @@ | |||
| import { Entity, ManyToOne } from '@mikro-orm/core'; | ||||
| import { Entity, Enum, ManyToOne } from '@mikro-orm/core'; | ||||
| import { Teacher } from '../users/teacher.entity.js'; | ||||
| import { Class } from './class.entity.js'; | ||||
| import { TeacherInvitationRepository } from '../../data/classes/teacher-invitation-repository.js'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| /** | ||||
|  * Invitation of a teacher into a class (in order to teach it). | ||||
|  | @ -25,4 +26,7 @@ export class TeacherInvitation { | |||
|         primary: true, | ||||
|     }) | ||||
|     class!: Class; | ||||
| 
 | ||||
|     @Enum(() => ClassStatus) | ||||
|     status!: ClassStatus; | ||||
| } | ||||
|  |  | |||
|  | @ -4,7 +4,7 @@ import { getClassJoinRequestRepository } from '../data/repositories.js'; | |||
| import { Student } from '../entities/users/student.entity.js'; | ||||
| import { Class } from '../entities/classes/class.entity.js'; | ||||
| import { ClassJoinRequestDTO } from '@dwengo-1/common/interfaces/class-join-request'; | ||||
| import { ClassJoinRequestStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| export function mapToStudentRequestDTO(request: ClassJoinRequest): ClassJoinRequestDTO { | ||||
|     return { | ||||
|  | @ -18,6 +18,6 @@ export function mapToStudentRequest(student: Student, cls: Class): ClassJoinRequ | |||
|     return getClassJoinRequestRepository().create({ | ||||
|         requester: student, | ||||
|         class: cls, | ||||
|         status: ClassJoinRequestStatus.Open, | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| } | ||||
|  |  | |||
|  | @ -1,13 +1,17 @@ | |||
| import { TeacherInvitation } from '../entities/classes/teacher-invitation.entity.js'; | ||||
| import { mapToClassDTO } from './class.js'; | ||||
| import { mapToUserDTO } from './user.js'; | ||||
| import { TeacherInvitationDTO } from '@dwengo-1/common/interfaces/teacher-invitation'; | ||||
| import { getTeacherInvitationRepository } from '../data/repositories'; | ||||
| import { Teacher } from '../entities/users/teacher.entity'; | ||||
| import { Class } from '../entities/classes/class.entity'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| export function mapToTeacherInvitationDTO(invitation: TeacherInvitation): TeacherInvitationDTO { | ||||
|     return { | ||||
|         sender: mapToUserDTO(invitation.sender), | ||||
|         receiver: mapToUserDTO(invitation.receiver), | ||||
|         class: mapToClassDTO(invitation.class), | ||||
|         classId: invitation.class.classId!, | ||||
|         status: invitation.status, | ||||
|     }; | ||||
| } | ||||
| 
 | ||||
|  | @ -15,6 +19,16 @@ export function mapToTeacherInvitationDTOIds(invitation: TeacherInvitation): Tea | |||
|     return { | ||||
|         sender: invitation.sender.username, | ||||
|         receiver: invitation.receiver.username, | ||||
|         class: invitation.class.classId!, | ||||
|         classId: invitation.class.classId!, | ||||
|         status: invitation.status, | ||||
|     }; | ||||
| } | ||||
| 
 | ||||
| export function mapToInvitation(sender: Teacher, receiver: Teacher, cls: Class): TeacherInvitation { | ||||
|     return getTeacherInvitationRepository().create({ | ||||
|         sender, | ||||
|         receiver, | ||||
|         class: cls, | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| } | ||||
|  |  | |||
							
								
								
									
										22
									
								
								backend/src/routes/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								backend/src/routes/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,22 @@ | |||
| import express from 'express'; | ||||
| import { | ||||
|     createInvitationHandler, | ||||
|     deleteInvitationHandler, | ||||
|     getAllInvitationsHandler, | ||||
|     getInvitationHandler, | ||||
|     updateInvitationHandler, | ||||
| } from '../controllers/teacher-invitations'; | ||||
| 
 | ||||
| const router = express.Router({ mergeParams: true }); | ||||
| 
 | ||||
| router.get('/:username', getAllInvitationsHandler); | ||||
| 
 | ||||
| router.get('/:sender/:receiver/:classId', getInvitationHandler); | ||||
| 
 | ||||
| router.post('/', createInvitationHandler); | ||||
| 
 | ||||
| router.put('/', updateInvitationHandler); | ||||
| 
 | ||||
| router.delete('/:sender/:receiver/:classId', deleteInvitationHandler); | ||||
| 
 | ||||
| export default router; | ||||
|  | @ -10,6 +10,8 @@ import { | |||
|     getTeacherStudentHandler, | ||||
|     updateStudentJoinRequestHandler, | ||||
| } from '../controllers/teachers.js'; | ||||
| import invitationRouter from './teacher-invitations.js'; | ||||
| 
 | ||||
| const router = express.Router(); | ||||
| 
 | ||||
| // Root endpoint used to search objects
 | ||||
|  | @ -32,10 +34,6 @@ router.get('/:username/joinRequests/:classId', getStudentJoinRequestHandler); | |||
| router.put('/:username/joinRequests/:classId/:studentUsername', updateStudentJoinRequestHandler); | ||||
| 
 | ||||
| // Invitations to other classes a teacher received
 | ||||
| router.get('/:id/invitations', (_req, res) => { | ||||
|     res.json({ | ||||
|         invitations: ['0'], | ||||
|     }); | ||||
| }); | ||||
| router.get('/invitations', invitationRouter); | ||||
| 
 | ||||
| export default router; | ||||
|  |  | |||
							
								
								
									
										87
									
								
								backend/src/services/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										87
									
								
								backend/src/services/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,87 @@ | |||
| import { fetchTeacher } from './teachers'; | ||||
| import { getTeacherInvitationRepository } from '../data/repositories'; | ||||
| import { mapToInvitation, mapToTeacherInvitationDTO } from '../interfaces/teacher-invitation'; | ||||
| import { addClassTeacher, fetchClass } from './classes'; | ||||
| import { TeacherInvitationData, TeacherInvitationDTO } from '@dwengo-1/common/interfaces/teacher-invitation'; | ||||
| import { ConflictException } from '../exceptions/conflict-exception'; | ||||
| import { NotFoundException } from '../exceptions/not-found-exception'; | ||||
| import { TeacherInvitation } from '../entities/classes/teacher-invitation.entity'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| export async function getAllInvitations(username: string, sent: boolean): Promise<TeacherInvitationDTO[]> { | ||||
|     const teacher = await fetchTeacher(username); | ||||
|     const teacherInvitationRepository = getTeacherInvitationRepository(); | ||||
| 
 | ||||
|     let invitations; | ||||
|     if (sent) { | ||||
|         invitations = await teacherInvitationRepository.findAllInvitationsBy(teacher); | ||||
|     } else { | ||||
|         invitations = await teacherInvitationRepository.findAllInvitationsFor(teacher); | ||||
|     } | ||||
|     return invitations.map(mapToTeacherInvitationDTO); | ||||
| } | ||||
| 
 | ||||
| export async function createInvitation(data: TeacherInvitationData): Promise<TeacherInvitationDTO> { | ||||
|     const teacherInvitationRepository = getTeacherInvitationRepository(); | ||||
|     const sender = await fetchTeacher(data.sender); | ||||
|     const receiver = await fetchTeacher(data.receiver); | ||||
| 
 | ||||
|     const cls = await fetchClass(data.class); | ||||
| 
 | ||||
|     if (!cls.teachers.contains(sender)) { | ||||
|         throw new ConflictException('The teacher sending the invite is not part of the class'); | ||||
|     } | ||||
| 
 | ||||
|     const newInvitation = mapToInvitation(sender, receiver, cls); | ||||
|     await teacherInvitationRepository.save(newInvitation, { preventOverwrite: true }); | ||||
| 
 | ||||
|     return mapToTeacherInvitationDTO(newInvitation); | ||||
| } | ||||
| 
 | ||||
| async function fetchInvitation(usernameSender: string, usernameReceiver: string, classId: string): Promise<TeacherInvitation> { | ||||
|     const sender = await fetchTeacher(usernameSender); | ||||
|     const receiver = await fetchTeacher(usernameReceiver); | ||||
|     const cls = await fetchClass(classId); | ||||
| 
 | ||||
|     const teacherInvitationRepository = getTeacherInvitationRepository(); | ||||
|     const invite = await teacherInvitationRepository.findBy(cls, sender, receiver); | ||||
| 
 | ||||
|     if (!invite) { | ||||
|         throw new NotFoundException('Teacher invite not found'); | ||||
|     } | ||||
| 
 | ||||
|     return invite; | ||||
| } | ||||
| 
 | ||||
| export async function getInvitation(sender: string, receiver: string, classId: string): Promise<TeacherInvitationDTO> { | ||||
|     const invitation = await fetchInvitation(sender, receiver, classId); | ||||
|     return mapToTeacherInvitationDTO(invitation); | ||||
| } | ||||
| 
 | ||||
| export async function updateInvitation(data: TeacherInvitationData): Promise<TeacherInvitationDTO> { | ||||
|     const invitation = await fetchInvitation(data.sender, data.receiver, data.class); | ||||
|     invitation.status = ClassStatus.Declined; | ||||
| 
 | ||||
|     if (data.accepted) { | ||||
|         invitation.status = ClassStatus.Accepted; | ||||
|         await addClassTeacher(data.class, data.receiver); | ||||
|     } | ||||
| 
 | ||||
|     const teacherInvitationRepository = getTeacherInvitationRepository(); | ||||
|     await teacherInvitationRepository.save(invitation); | ||||
| 
 | ||||
|     return mapToTeacherInvitationDTO(invitation); | ||||
| } | ||||
| 
 | ||||
| export async function deleteInvitation(data: TeacherInvitationData): Promise<TeacherInvitationDTO> { | ||||
|     const invitation = await fetchInvitation(data.sender, data.receiver, data.class); | ||||
| 
 | ||||
|     const sender = await fetchTeacher(data.sender); | ||||
|     const receiver = await fetchTeacher(data.receiver); | ||||
|     const cls = await fetchClass(data.class); | ||||
| 
 | ||||
|     const teacherInvitationRepository = getTeacherInvitationRepository(); | ||||
|     await teacherInvitationRepository.deleteBy(cls, sender, receiver); | ||||
| 
 | ||||
|     return mapToTeacherInvitationDTO(invitation); | ||||
| } | ||||
|  | @ -28,7 +28,7 @@ import { ClassDTO } from '@dwengo-1/common/interfaces/class'; | |||
| import { StudentDTO } from '@dwengo-1/common/interfaces/student'; | ||||
| import { QuestionDTO, QuestionId } from '@dwengo-1/common/interfaces/question'; | ||||
| import { ClassJoinRequestDTO } from '@dwengo-1/common/interfaces/class-join-request'; | ||||
| import { ClassJoinRequestStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| import { ConflictException } from '../exceptions/conflict-exception.js'; | ||||
| 
 | ||||
| export async function getAllTeachers(full: boolean): Promise<TeacherDTO[] | string[]> { | ||||
|  | @ -160,10 +160,10 @@ export async function updateClassJoinRequestStatus(studentUsername: string, clas | |||
|         throw new NotFoundException('Join request not found'); | ||||
|     } | ||||
| 
 | ||||
|     request.status = ClassJoinRequestStatus.Declined; | ||||
|     request.status = ClassStatus.Declined; | ||||
| 
 | ||||
|     if (accepted) { | ||||
|         request.status = ClassJoinRequestStatus.Accepted; | ||||
|         request.status = ClassStatus.Accepted; | ||||
|         await addClassStudent(classId, studentUsername); | ||||
|     } | ||||
| 
 | ||||
|  |  | |||
							
								
								
									
										123
									
								
								backend/tests/controllers/teacher-invitations.test.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										123
									
								
								backend/tests/controllers/teacher-invitations.test.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,123 @@ | |||
| import { beforeAll, beforeEach, describe, expect, it, Mock, vi } from 'vitest'; | ||||
| import { Request, Response } from 'express'; | ||||
| import { setupTestApp } from '../setup-tests.js'; | ||||
| import { | ||||
|     createInvitationHandler, | ||||
|     deleteInvitationHandler, | ||||
|     getAllInvitationsHandler, | ||||
|     getInvitationHandler, | ||||
|     updateInvitationHandler, | ||||
| } from '../../src/controllers/teacher-invitations'; | ||||
| import { TeacherInvitationData } from '@dwengo-1/common/interfaces/teacher-invitation'; | ||||
| import { getClassHandler } from '../../src/controllers/classes'; | ||||
| import { BadRequestException } from '../../src/exceptions/bad-request-exception'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| describe('Teacher controllers', () => { | ||||
|     let req: Partial<Request>; | ||||
|     let res: Partial<Response>; | ||||
| 
 | ||||
|     let jsonMock: Mock; | ||||
| 
 | ||||
|     beforeAll(async () => { | ||||
|         await setupTestApp(); | ||||
|     }); | ||||
| 
 | ||||
|     beforeEach(() => { | ||||
|         jsonMock = vi.fn(); | ||||
|         res = { | ||||
|             json: jsonMock, | ||||
|         }; | ||||
|     }); | ||||
| 
 | ||||
|     it('Get teacher invitations by', async () => { | ||||
|         req = { params: { username: 'LimpBizkit' }, query: { sent: 'true' } }; | ||||
| 
 | ||||
|         await getAllInvitationsHandler(req as Request, res as Response); | ||||
| 
 | ||||
|         expect(jsonMock).toHaveBeenCalledWith(expect.objectContaining({ invitations: expect.anything() })); | ||||
| 
 | ||||
|         const result = jsonMock.mock.lastCall?.[0]; | ||||
|         // Console.log(result.invitations);
 | ||||
|         expect(result.invitations).to.have.length.greaterThan(0); | ||||
|     }); | ||||
| 
 | ||||
|     it('Get teacher invitations for', async () => { | ||||
|         req = { params: { username: 'FooFighters' }, query: { by: 'false' } }; | ||||
| 
 | ||||
|         await getAllInvitationsHandler(req as Request, res as Response); | ||||
| 
 | ||||
|         expect(jsonMock).toHaveBeenCalledWith(expect.objectContaining({ invitations: expect.anything() })); | ||||
| 
 | ||||
|         const result = jsonMock.mock.lastCall?.[0]; | ||||
|         expect(result.invitations).to.have.length.greaterThan(0); | ||||
|     }); | ||||
| 
 | ||||
|     it('Create and delete invitation', async () => { | ||||
|         const body = { | ||||
|             sender: 'LimpBizkit', | ||||
|             receiver: 'testleerkracht1', | ||||
|             class: '34d484a1-295f-4e9f-bfdc-3e7a23d86a89', | ||||
|         } as TeacherInvitationData; | ||||
|         req = { body }; | ||||
| 
 | ||||
|         await createInvitationHandler(req as Request, res as Response); | ||||
| 
 | ||||
|         req = { | ||||
|             params: { | ||||
|                 sender: 'LimpBizkit', | ||||
|                 receiver: 'testleerkracht1', | ||||
|                 classId: '34d484a1-295f-4e9f-bfdc-3e7a23d86a89', | ||||
|             }, | ||||
|             body: { accepted: 'false' }, | ||||
|         }; | ||||
| 
 | ||||
|         await deleteInvitationHandler(req as Request, res as Response); | ||||
|     }); | ||||
| 
 | ||||
|     it('Get invitation', async () => { | ||||
|         req = { | ||||
|             params: { | ||||
|                 sender: 'LimpBizkit', | ||||
|                 receiver: 'FooFighters', | ||||
|                 classId: '34d484a1-295f-4e9f-bfdc-3e7a23d86a89', | ||||
|             }, | ||||
|         }; | ||||
|         await getInvitationHandler(req as Request, res as Response); | ||||
| 
 | ||||
|         expect(jsonMock).toHaveBeenCalledWith(expect.objectContaining({ invitation: expect.anything() })); | ||||
|     }); | ||||
| 
 | ||||
|     it('Get invitation error', async () => { | ||||
|         req = { | ||||
|             params: { no: 'no params' }, | ||||
|         }; | ||||
| 
 | ||||
|         await expect(async () => getInvitationHandler(req as Request, res as Response)).rejects.toThrowError(BadRequestException); | ||||
|     }); | ||||
| 
 | ||||
|     it('Accept invitation', async () => { | ||||
|         const body = { | ||||
|             sender: 'LimpBizkit', | ||||
|             receiver: 'FooFighters', | ||||
|             class: '34d484a1-295f-4e9f-bfdc-3e7a23d86a89', | ||||
|         } as TeacherInvitationData; | ||||
|         req = { body }; | ||||
| 
 | ||||
|         await updateInvitationHandler(req as Request, res as Response); | ||||
| 
 | ||||
|         const result1 = jsonMock.mock.lastCall?.[0]; | ||||
|         expect(result1.invitation.status).toEqual(ClassStatus.Accepted); | ||||
| 
 | ||||
|         req = { | ||||
|             params: { | ||||
|                 id: '34d484a1-295f-4e9f-bfdc-3e7a23d86a89', | ||||
|             }, | ||||
|         }; | ||||
| 
 | ||||
|         await getClassHandler(req as Request, res as Response); | ||||
| 
 | ||||
|         const result = jsonMock.mock.lastCall?.[0]; | ||||
|         expect(result.class.teachers).toContain('FooFighters'); | ||||
|     }); | ||||
| }); | ||||
|  | @ -13,6 +13,7 @@ import { makeTestAttachments } from './test_assets/content/attachments.testdata. | |||
| import { makeTestQuestions } from './test_assets/questions/questions.testdata.js'; | ||||
| import { makeTestAnswers } from './test_assets/questions/answers.testdata.js'; | ||||
| import { makeTestSubmissions } from './test_assets/assignments/submission.testdata.js'; | ||||
| import { Collection } from '@mikro-orm/core'; | ||||
| 
 | ||||
| export async function setupTestApp(): Promise<void> { | ||||
|     dotenv.config({ path: '.env.test' }); | ||||
|  | @ -28,8 +29,8 @@ export async function setupTestApp(): Promise<void> { | |||
|     const assignments = makeTestAssignemnts(em, classes); | ||||
|     const groups = makeTestGroups(em, students, assignments); | ||||
| 
 | ||||
|     assignments[0].groups = groups.slice(0, 3); | ||||
|     assignments[1].groups = groups.slice(3, 4); | ||||
|     assignments[0].groups = new Collection(groups.slice(0, 3)); | ||||
|     assignments[1].groups = new Collection(groups.slice(3, 4)); | ||||
| 
 | ||||
|     const teacherInvitations = makeTestTeacherInvitations(em, teachers, classes); | ||||
|     const classJoinRequests = makeTestClassJoinRequests(em, students, classes); | ||||
|  |  | |||
|  | @ -2,31 +2,31 @@ import { EntityManager } from '@mikro-orm/core'; | |||
| import { ClassJoinRequest } from '../../../src/entities/classes/class-join-request.entity'; | ||||
| import { Student } from '../../../src/entities/users/student.entity'; | ||||
| import { Class } from '../../../src/entities/classes/class.entity'; | ||||
| import { ClassJoinRequestStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| export function makeTestClassJoinRequests(em: EntityManager, students: Student[], classes: Class[]): ClassJoinRequest[] { | ||||
|     const classJoinRequest01 = em.create(ClassJoinRequest, { | ||||
|         requester: students[4], | ||||
|         class: classes[1], | ||||
|         status: ClassJoinRequestStatus.Open, | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| 
 | ||||
|     const classJoinRequest02 = em.create(ClassJoinRequest, { | ||||
|         requester: students[2], | ||||
|         class: classes[1], | ||||
|         status: ClassJoinRequestStatus.Open, | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| 
 | ||||
|     const classJoinRequest03 = em.create(ClassJoinRequest, { | ||||
|         requester: students[4], | ||||
|         class: classes[2], | ||||
|         status: ClassJoinRequestStatus.Open, | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| 
 | ||||
|     const classJoinRequest04 = em.create(ClassJoinRequest, { | ||||
|         requester: students[3], | ||||
|         class: classes[2], | ||||
|         status: ClassJoinRequestStatus.Open, | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| 
 | ||||
|     return [classJoinRequest01, classJoinRequest02, classJoinRequest03, classJoinRequest04]; | ||||
|  |  | |||
|  | @ -2,30 +2,35 @@ import { EntityManager } from '@mikro-orm/core'; | |||
| import { TeacherInvitation } from '../../../src/entities/classes/teacher-invitation.entity'; | ||||
| import { Teacher } from '../../../src/entities/users/teacher.entity'; | ||||
| import { Class } from '../../../src/entities/classes/class.entity'; | ||||
| import { ClassStatus } from '@dwengo-1/common/util/class-join-request'; | ||||
| 
 | ||||
| export function makeTestTeacherInvitations(em: EntityManager, teachers: Teacher[], classes: Class[]): TeacherInvitation[] { | ||||
|     const teacherInvitation01 = em.create(TeacherInvitation, { | ||||
|         sender: teachers[1], | ||||
|         receiver: teachers[0], | ||||
|         class: classes[1], | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| 
 | ||||
|     const teacherInvitation02 = em.create(TeacherInvitation, { | ||||
|         sender: teachers[1], | ||||
|         receiver: teachers[2], | ||||
|         class: classes[1], | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| 
 | ||||
|     const teacherInvitation03 = em.create(TeacherInvitation, { | ||||
|         sender: teachers[2], | ||||
|         receiver: teachers[0], | ||||
|         class: classes[2], | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| 
 | ||||
|     const teacherInvitation04 = em.create(TeacherInvitation, { | ||||
|         sender: teachers[0], | ||||
|         receiver: teachers[1], | ||||
|         class: classes[0], | ||||
|         status: ClassStatus.Open, | ||||
|     }); | ||||
| 
 | ||||
|     return [teacherInvitation01, teacherInvitation02, teacherInvitation03, teacherInvitation04]; | ||||
|  |  | |||
|  | @ -1,8 +1,8 @@ | |||
| import { StudentDTO } from './student'; | ||||
| import { ClassJoinRequestStatus } from '../util/class-join-request'; | ||||
| import { ClassStatus } from '../util/class-join-request'; | ||||
| 
 | ||||
| export interface ClassJoinRequestDTO { | ||||
|     requester: StudentDTO; | ||||
|     class: string; | ||||
|     status: ClassJoinRequestStatus; | ||||
|     status: ClassStatus; | ||||
| } | ||||
|  |  | |||
|  | @ -1,8 +1,16 @@ | |||
| import { UserDTO } from './user'; | ||||
| import { ClassDTO } from './class'; | ||||
| import { ClassStatus } from '../util/class-join-request'; | ||||
| 
 | ||||
| export interface TeacherInvitationDTO { | ||||
|     sender: string | UserDTO; | ||||
|     receiver: string | UserDTO; | ||||
|     class: string | ClassDTO; | ||||
|     classId: string; | ||||
|     status: ClassStatus; | ||||
| } | ||||
| 
 | ||||
| export interface TeacherInvitationData { | ||||
|     sender: string; | ||||
|     receiver: string; | ||||
|     class: string; | ||||
|     accepted?: boolean; // Use for put requests, else skip
 | ||||
| } | ||||
|  |  | |||
|  | @ -1,4 +1,4 @@ | |||
| export enum ClassJoinRequestStatus { | ||||
| export enum ClassStatus { | ||||
|     Open = 'open', | ||||
|     Accepted = 'accepted', | ||||
|     Declined = 'declined', | ||||
|  |  | |||
							
								
								
									
										1
									
								
								docs/.gitignore
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								docs/.gitignore
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1 @@ | |||
| api/swagger.json | ||||
|  | @ -15,6 +15,10 @@ const doc = { | |||
|             url: 'http://localhost:3000/', | ||||
|             description: 'Development server', | ||||
|         }, | ||||
|         { | ||||
|             url: 'http://localhost/', | ||||
|             description: 'Staging server', | ||||
|         }, | ||||
|         { | ||||
|             url: 'https://sel2-1.ugent.be/', | ||||
|             description: 'Production server', | ||||
|  | @ -55,4 +59,4 @@ const doc = { | |||
| const outputFile = './swagger.json'; | ||||
| const routes = ['../../backend/src/app.ts']; | ||||
| 
 | ||||
| await swaggerAutogen({ openapi: '3.1.0' })(outputFile, routes, doc); | ||||
| void swaggerAutogen({ openapi: '3.1.0' })(outputFile, routes, doc); | ||||
|  |  | |||
										
											
												File diff suppressed because it is too large
												Load diff
											
										
									
								
							|  | @ -44,16 +44,16 @@ export default [ | |||
|             // All @typescript-eslint configuration options are listed.
 | ||||
|             // If the rules are commented, they are configured by the inherited configurations.
 | ||||
| 
 | ||||
|             '@typescript-eslint/adjacent-overload-signatures': 'warn', | ||||
|             '@typescript-eslint/array-type': 'warn', | ||||
|             '@typescript-eslint/adjacent-overload-signatures': 'error', | ||||
|             '@typescript-eslint/array-type': 'error', | ||||
|             '@typescript-eslint/await-thenable': 'error', | ||||
|             '@typescript-eslint/ban-ts-comment': ['error', { minimumDescriptionLength: 10 }], | ||||
|             '@typescript-eslint/ban-tslint-comment': 'error', | ||||
|             camelcase: 'off', | ||||
|             '@typescript-eslint/class-literal-property-style': 'warn', | ||||
|             '@typescript-eslint/class-literal-property-style': 'error', | ||||
|             'class-methods-use-this': 'off', | ||||
|             '@typescript-eslint/class-methods-use-this': ['error', { ignoreOverrideMethods: true }], | ||||
|             '@typescript-eslint/consistent-generic-constructors': 'warn', | ||||
|             '@typescript-eslint/consistent-generic-constructors': 'error', | ||||
|             '@typescript-eslint/consistent-indexed-object-style': 'error', | ||||
|             'consistent-return': 'off', | ||||
|             '@typescript-eslint/consistent-return': 'off', | ||||
|  | @ -64,18 +64,18 @@ export default [ | |||
|             'default-param-last': 'off', | ||||
|             '@typescript-eslint/default-param-last': 'error', | ||||
|             'dot-notation': 'off', | ||||
|             '@typescript-eslint/dot-notation': 'warn', | ||||
|             '@typescript-eslint/explicit-function-return-type': 'warn', | ||||
|             '@typescript-eslint/dot-notation': 'error', | ||||
|             '@typescript-eslint/explicit-function-return-type': 'error', | ||||
|             '@typescript-eslint/explicit-member-accessibility': 'off', | ||||
|             '@typescript-eslint/explicit-module-boundary-types': 'warn', | ||||
|             '@typescript-eslint/explicit-module-boundary-types': 'error', | ||||
|             'init-declarations': 'off', | ||||
|             '@typescript-eslint/init-declarations': 'off', | ||||
|             'max-params': 'off', | ||||
|             '@typescript-eslint/max-params': ['error', { max: 6 }], | ||||
|             '@typescript-eslint/member-ordering': 'warn', | ||||
|             '@typescript-eslint/member-ordering': 'error', | ||||
|             '@typescript-eslint/method-signature-style': 'off', // Don't care about TypeScript strict mode.
 | ||||
|             '@typescript-eslint/naming-convention': [ | ||||
|                 'warn', | ||||
|                 'error', | ||||
|                 { | ||||
|                     // Enforce that all variables, functions and properties are camelCase
 | ||||
|                     selector: 'variableLike', | ||||
|  | @ -113,7 +113,7 @@ export default [ | |||
|             '@typescript-eslint/no-empty-function': 'error', | ||||
|             '@typescript-eslint/no-empty-interface': 'off', | ||||
|             '@typescript-eslint/no-empty-object-type': 'error', | ||||
|             '@typescript-eslint/no-explicit-any': 'warn', // Once in production, this should be an error.
 | ||||
|             '@typescript-eslint/no-explicit-any': 'error', // Once in production, this should be an error.
 | ||||
|             '@typescript-eslint/no-extra-non-null-assertion': 'error', | ||||
|             '@typescript-eslint/no-extraneous-class': 'error', | ||||
|             '@typescript-eslint/no-floating-promises': 'error', | ||||
|  | @ -121,7 +121,7 @@ export default [ | |||
|             'no-implied-eval': 'off', | ||||
|             '@typescript-eslint/no-implied-eval': 'error', | ||||
|             '@typescript-eslint/no-import-type-side-effects': 'error', | ||||
|             '@typescript-eslint/no-inferrable-types': 'warn', | ||||
|             '@typescript-eslint/no-inferrable-types': 'error', | ||||
|             'no-invalid-this': 'off', | ||||
|             '@typescript-eslint/no-invalid-this': 'off', | ||||
|             '@typescript-eslint/no-invalid-void-type': 'error', | ||||
|  | @ -146,10 +146,10 @@ export default [ | |||
|             '@typescript-eslint/no-unsafe-function-type': 'error', | ||||
| 
 | ||||
|             'no-unused-expressions': 'off', | ||||
|             '@typescript-eslint/no-unused-expressions': 'warn', | ||||
|             '@typescript-eslint/no-unused-expressions': 'error', | ||||
|             'no-unused-vars': 'off', | ||||
|             '@typescript-eslint/no-unused-vars': [ | ||||
|                 'warn', | ||||
|                 'error', | ||||
|                 { | ||||
|                     args: 'all', | ||||
|                     argsIgnorePattern: '^_', | ||||
|  | @ -164,53 +164,53 @@ export default [ | |||
| 
 | ||||
|             '@typescript-eslint/parameter-properties': 'off', | ||||
| 
 | ||||
|             '@typescript-eslint/prefer-find': 'warn', | ||||
|             '@typescript-eslint/prefer-find': 'error', | ||||
| 
 | ||||
|             '@typescript-eslint/prefer-function-type': 'error', | ||||
| 
 | ||||
|             '@typescript-eslint/prefer-readonly-parameter-types': 'off', | ||||
|             '@typescript-eslint/prefer-reduce-type-parameter': 'error', | ||||
| 
 | ||||
|             '@typescript-eslint/promise-function-async': 'warn', | ||||
|             '@typescript-eslint/promise-function-async': 'error', | ||||
| 
 | ||||
|             '@typescript-eslint/require-array-sort-compare': 'warn', | ||||
|             '@typescript-eslint/require-array-sort-compare': 'error', | ||||
| 
 | ||||
|             'no-await-in-loop': 'warn', | ||||
|             'no-await-in-loop': 'error', | ||||
|             'no-constructor-return': 'error', | ||||
|             'no-inner-declarations': 'error', | ||||
|             'no-self-compare': 'error', | ||||
|             'no-template-curly-in-string': 'error', | ||||
|             'no-unmodified-loop-condition': 'warn', | ||||
|             'no-unreachable-loop': 'warn', | ||||
|             'no-unmodified-loop-condition': 'error', | ||||
|             'no-unreachable-loop': 'error', | ||||
|             'no-useless-assignment': 'error', | ||||
| 
 | ||||
|             'arrow-body-style': ['warn', 'as-needed'], | ||||
|             'block-scoped-var': 'warn', | ||||
|             'capitalized-comments': 'warn', | ||||
|             'arrow-body-style': ['error', 'as-needed'], | ||||
|             'block-scoped-var': 'error', | ||||
|             'capitalized-comments': 'error', | ||||
|             'consistent-this': 'error', | ||||
|             curly: 'error', | ||||
|             'default-case': 'error', | ||||
|             'default-case-last': 'error', | ||||
|             eqeqeq: 'error', | ||||
|             'func-names': 'warn', | ||||
|             'func-style': ['warn', 'declaration'], | ||||
|             'grouped-accessor-pairs': ['warn', 'getBeforeSet'], | ||||
|             'guard-for-in': 'warn', | ||||
|             'logical-assignment-operators': 'warn', | ||||
|             'max-classes-per-file': 'warn', | ||||
|             'func-names': 'error', | ||||
|             'func-style': ['error', 'declaration'], | ||||
|             'grouped-accessor-pairs': ['error', 'getBeforeSet'], | ||||
|             'guard-for-in': 'error', | ||||
|             'logical-assignment-operators': 'error', | ||||
|             'max-classes-per-file': 'error', | ||||
|             'no-alert': 'error', | ||||
|             'no-bitwise': 'warn', | ||||
|             'no-console': 'warn', | ||||
|             'no-continue': 'warn', | ||||
|             'no-else-return': 'warn', | ||||
|             'no-bitwise': 'error', | ||||
|             'no-console': 'error', | ||||
|             'no-continue': 'error', | ||||
|             'no-else-return': 'error', | ||||
|             'no-eq-null': 'error', | ||||
|             'no-eval': 'error', | ||||
|             'no-extend-native': 'error', | ||||
|             'no-extra-label': 'error', | ||||
|             'no-implicit-coercion': 'warn', | ||||
|             'no-implicit-coercion': 'error', | ||||
|             'no-iterator': 'error', | ||||
|             'no-label-var': 'warn', | ||||
|             'no-labels': 'warn', | ||||
|             'no-label-var': 'error', | ||||
|             'no-labels': 'error', | ||||
|             'no-multi-assign': 'error', | ||||
|             'no-nested-ternary': 'error', | ||||
|             'no-object-constructor': 'error', | ||||
|  |  | |||
|  | @ -20,6 +20,7 @@ | |||
|         "@tanstack/vue-query": "^5.69.0", | ||||
|         "axios": "^1.8.2", | ||||
|         "oidc-client-ts": "^3.1.0", | ||||
|         "uuid": "^11.1.0", | ||||
|         "vue": "^3.5.13", | ||||
|         "vue-i18n": "^11.1.2", | ||||
|         "vue-router": "^4.5.0", | ||||
|  |  | |||
|  | @ -2,8 +2,8 @@ import { BaseController } from "./base-controller"; | |||
| import type { ClassDTO } from "@dwengo-1/common/interfaces/class"; | ||||
| import type { StudentsResponse } from "./students"; | ||||
| import type { AssignmentsResponse } from "./assignments"; | ||||
| import type { TeacherInvitationDTO } from "@dwengo-1/common/interfaces/teacher-invitation"; | ||||
| import type { TeachersResponse } from "@/controllers/teachers.ts"; | ||||
| import type { TeacherInvitationsResponse } from "@/controllers/teacher-invitations.ts"; | ||||
| 
 | ||||
| export interface ClassesResponse { | ||||
|     classes: ClassDTO[] | string[]; | ||||
|  | @ -13,14 +13,6 @@ export interface ClassResponse { | |||
|     class: ClassDTO; | ||||
| } | ||||
| 
 | ||||
| export interface TeacherInvitationsResponse { | ||||
|     invites: TeacherInvitationDTO[]; | ||||
| } | ||||
| 
 | ||||
| export interface TeacherInvitationResponse { | ||||
|     invite: TeacherInvitationDTO; | ||||
| } | ||||
| 
 | ||||
| export class ClassController extends BaseController { | ||||
|     constructor() { | ||||
|         super("class"); | ||||
|  |  | |||
|  | @ -36,11 +36,11 @@ export class GroupController extends BaseController { | |||
|         return this.put<GroupResponse>(`/${num}`, data); | ||||
|     } | ||||
| 
 | ||||
|     async getSubmissions(groupNumber: number, full = true): Promise<SubmissionsResponse> { | ||||
|         return this.get<SubmissionsResponse>(`/${groupNumber}/submissions`, { full }); | ||||
|     async getSubmissions(num: number, full = true): Promise<SubmissionsResponse> { | ||||
|         return this.get<SubmissionsResponse>(`/${num}/submissions`, { full }); | ||||
|     } | ||||
| 
 | ||||
|     async getQuestions(groupNumber: number, full = true): Promise<QuestionsResponse> { | ||||
|         return this.get<QuestionsResponse>(`/${groupNumber}/questions`, { full }); | ||||
|     async getQuestions(num: number, full = true): Promise<QuestionsResponse> { | ||||
|         return this.get<QuestionsResponse>(`/${num}/questions`, { full }); | ||||
|     } | ||||
| } | ||||
|  |  | |||
|  | @ -11,7 +11,7 @@ export interface SubmissionResponse { | |||
| 
 | ||||
| export class SubmissionController extends BaseController { | ||||
|     constructor(classid: string, assignmentNumber: number, groupNumber: number) { | ||||
|         super(`class/${classid}/assignments/${assignmentNumber}/groups/${groupNumber}`); | ||||
|         super(`class/${classid}/assignments/${assignmentNumber}/groups/${groupNumber}/submissions`); | ||||
|     } | ||||
| 
 | ||||
|     async getAll(full = true): Promise<SubmissionsResponse> { | ||||
|  | @ -22,7 +22,7 @@ export class SubmissionController extends BaseController { | |||
|         return this.get<SubmissionResponse>(`/${submissionNumber}`); | ||||
|     } | ||||
| 
 | ||||
|     async createSubmission(data: unknown): Promise<SubmissionResponse> { | ||||
|     async createSubmission(data: SubmissionDTO): Promise<SubmissionResponse> { | ||||
|         return this.post<SubmissionResponse>(`/`, data); | ||||
|     } | ||||
| 
 | ||||
|  |  | |||
							
								
								
									
										36
									
								
								frontend/src/controllers/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										36
									
								
								frontend/src/controllers/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,36 @@ | |||
| import { BaseController } from "@/controllers/base-controller.ts"; | ||||
| import type { TeacherInvitationData, TeacherInvitationDTO } from "@dwengo-1/common/interfaces/teacher-invitation"; | ||||
| 
 | ||||
| export interface TeacherInvitationsResponse { | ||||
|     invitations: TeacherInvitationDTO[]; | ||||
| } | ||||
| 
 | ||||
| export interface TeacherInvitationResponse { | ||||
|     invitation: TeacherInvitationDTO; | ||||
| } | ||||
| 
 | ||||
| export class TeacherInvitationController extends BaseController { | ||||
|     constructor() { | ||||
|         super("teachers/invitations"); | ||||
|     } | ||||
| 
 | ||||
|     async getAll(username: string, sent: boolean): Promise<TeacherInvitationsResponse> { | ||||
|         return this.get<TeacherInvitationsResponse>(`/${username}`, { sent }); | ||||
|     } | ||||
| 
 | ||||
|     async getBy(data: TeacherInvitationData): Promise<TeacherInvitationResponse> { | ||||
|         return this.get<TeacherInvitationResponse>(`/${data.sender}/${data.receiver}/${data.class}`); | ||||
|     } | ||||
| 
 | ||||
|     async create(data: TeacherInvitationData): Promise<TeacherInvitationResponse> { | ||||
|         return this.post<TeacherInvitationResponse>("/", data); | ||||
|     } | ||||
| 
 | ||||
|     async remove(data: TeacherInvitationData): Promise<TeacherInvitationResponse> { | ||||
|         return this.delete<TeacherInvitationResponse>(`/${data.sender}/${data.receiver}/${data.class}`); | ||||
|     } | ||||
| 
 | ||||
|     async respond(data: TeacherInvitationData): Promise<TeacherInvitationResponse> { | ||||
|         return this.put<TeacherInvitationResponse>("/", data); | ||||
|     } | ||||
| } | ||||
							
								
								
									
										188
									
								
								frontend/src/queries/assignments.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										188
									
								
								frontend/src/queries/assignments.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,188 @@ | |||
| import { AssignmentController, type AssignmentResponse, type AssignmentsResponse } from "@/controllers/assignments"; | ||||
| import type { QuestionsResponse } from "@/controllers/questions"; | ||||
| import type { SubmissionsResponse } from "@/controllers/submissions"; | ||||
| import { | ||||
|     useMutation, | ||||
|     useQuery, | ||||
|     useQueryClient, | ||||
|     type UseMutationReturnType, | ||||
|     type UseQueryReturnType, | ||||
| } from "@tanstack/vue-query"; | ||||
| import { computed, toValue, type MaybeRefOrGetter } from "vue"; | ||||
| import { groupsQueryKey, invalidateAllGroupKeys } from "./groups"; | ||||
| import type { GroupsResponse } from "@/controllers/groups"; | ||||
| import type { AssignmentDTO } from "@dwengo-1/common/interfaces/assignment"; | ||||
| import type { QueryClient } from "@tanstack/react-query"; | ||||
| import { invalidateAllSubmissionKeys } from "./submissions"; | ||||
| 
 | ||||
| function assignmentsQueryKey(classid: string, full: boolean) { | ||||
|     return ["assignments", classid, full]; | ||||
| } | ||||
| function assignmentQueryKey(classid: string, assignmentNumber: number) { | ||||
|     return ["assignment", classid, assignmentNumber]; | ||||
| } | ||||
| function assignmentSubmissionsQueryKey(classid: string, assignmentNumber: number, full: boolean) { | ||||
|     return ["assignment-submissions", classid, assignmentNumber, full]; | ||||
| } | ||||
| function assignmentQuestionsQueryKey(classid: string, assignmentNumber: number, full: boolean) { | ||||
|     return ["assignment-questions", classid, assignmentNumber, full]; | ||||
| } | ||||
| 
 | ||||
| export async function invalidateAllAssignmentKeys( | ||||
|     queryClient: QueryClient, | ||||
|     classid?: string, | ||||
|     assignmentNumber?: number, | ||||
| ) { | ||||
|     const keys = ["assignment", "assignment-submissions", "assignment-questions"]; | ||||
| 
 | ||||
|     for (const key of keys) { | ||||
|         const queryKey = [key, classid, assignmentNumber].filter((arg) => arg !== undefined); | ||||
|         await queryClient.invalidateQueries({ queryKey: queryKey }); | ||||
|     } | ||||
| 
 | ||||
|     await queryClient.invalidateQueries({ queryKey: ["assignments", classid].filter((arg) => arg !== undefined) }); | ||||
| } | ||||
| 
 | ||||
| function checkEnabled( | ||||
|     classid: string | undefined, | ||||
|     assignmentNumber: number | undefined, | ||||
|     groupNumber: number | undefined, | ||||
| ): boolean { | ||||
|     return Boolean(classid) && !isNaN(Number(groupNumber)) && !isNaN(Number(assignmentNumber)); | ||||
| } | ||||
| function toValues( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean>, | ||||
| ) { | ||||
|     return { cid: toValue(classid), an: toValue(assignmentNumber), gn: toValue(groupNumber), f: toValue(full) }; | ||||
| } | ||||
| 
 | ||||
| export function useAssignmentsQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<AssignmentsResponse, Error> { | ||||
|     const { cid, f } = toValues(classid, 1, 1, full); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => assignmentsQueryKey(cid!, f)), | ||||
|         queryFn: async () => new AssignmentController(cid!).getAll(f), | ||||
|         enabled: () => checkEnabled(cid, 1, 1), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useAssignmentQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
| ): UseQueryReturnType<AssignmentsResponse, Error> { | ||||
|     const { cid, an } = toValues(classid, assignmentNumber, 1, true); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => assignmentQueryKey(cid!, an!)), | ||||
|         queryFn: async () => new AssignmentController(cid!).getByNumber(an!), | ||||
|         enabled: () => checkEnabled(cid, an, 1), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useCreateAssignmentMutation(): UseMutationReturnType< | ||||
|     AssignmentResponse, | ||||
|     Error, | ||||
|     { cid: string; data: AssignmentDTO }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ cid, data }) => new AssignmentController(cid).createAssignment(data), | ||||
|         onSuccess: async (_) => { | ||||
|             await queryClient.invalidateQueries({ queryKey: ["assignments"] }); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useDeleteAssignmentMutation(): UseMutationReturnType< | ||||
|     AssignmentResponse, | ||||
|     Error, | ||||
|     { cid: string; an: number }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ cid, an }) => new AssignmentController(cid).deleteAssignment(an), | ||||
|         onSuccess: async (response) => { | ||||
|             const cid = response.assignment.within; | ||||
|             const an = response.assignment.id; | ||||
| 
 | ||||
|             await invalidateAllAssignmentKeys(queryClient, cid, an); | ||||
|             await invalidateAllGroupKeys(queryClient, cid, an); | ||||
|             await invalidateAllSubmissionKeys(queryClient, cid, an); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useUpdateAssignmentMutation(): UseMutationReturnType< | ||||
|     AssignmentResponse, | ||||
|     Error, | ||||
|     { cid: string; an: number; data: Partial<AssignmentDTO> }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ cid, an, data }) => new AssignmentController(cid).updateAssignment(an, data), | ||||
|         onSuccess: async (response) => { | ||||
|             const cid = response.assignment.within; | ||||
|             const an = response.assignment.id; | ||||
| 
 | ||||
|             await invalidateAllGroupKeys(queryClient, cid, an); | ||||
|             await queryClient.invalidateQueries({ queryKey: ["assignments"] }); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useAssignmentSubmissionsQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<SubmissionsResponse, Error> { | ||||
|     const { cid, an, gn, f } = toValues(classid, assignmentNumber, groupNumber, full); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => assignmentSubmissionsQueryKey(cid!, an!, f)), | ||||
|         queryFn: async () => new AssignmentController(cid!).getSubmissions(gn!, f), | ||||
|         enabled: () => checkEnabled(cid, an, gn), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useAssignmentQuestionsQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<QuestionsResponse, Error> { | ||||
|     const { cid, an, gn, f } = toValues(classid, assignmentNumber, groupNumber, full); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => assignmentQuestionsQueryKey(cid!, an!, f)), | ||||
|         queryFn: async () => new AssignmentController(cid!).getQuestions(gn!, f), | ||||
|         enabled: () => checkEnabled(cid, an, gn), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useAssignmentGroupsQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<GroupsResponse, Error> { | ||||
|     const { cid, an, gn, f } = toValues(classid, assignmentNumber, groupNumber, full); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => groupsQueryKey(cid!, an!, f)), | ||||
|         queryFn: async () => new AssignmentController(cid!).getQuestions(gn!, f), | ||||
|         enabled: () => checkEnabled(cid, an, gn), | ||||
|     }); | ||||
| } | ||||
							
								
								
									
										224
									
								
								frontend/src/queries/classes.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										224
									
								
								frontend/src/queries/classes.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,224 @@ | |||
| import { ClassController, type ClassesResponse, type ClassResponse } from "@/controllers/classes"; | ||||
| import type { StudentsResponse } from "@/controllers/students"; | ||||
| import type { ClassDTO } from "@dwengo-1/common/interfaces/class"; | ||||
| import { | ||||
|     QueryClient, | ||||
|     useMutation, | ||||
|     useQuery, | ||||
|     useQueryClient, | ||||
|     type UseMutationReturnType, | ||||
|     type UseQueryReturnType, | ||||
| } from "@tanstack/vue-query"; | ||||
| import { computed, toValue, type MaybeRefOrGetter } from "vue"; | ||||
| import { invalidateAllAssignmentKeys } from "./assignments"; | ||||
| import { invalidateAllGroupKeys } from "./groups"; | ||||
| import { invalidateAllSubmissionKeys } from "./submissions"; | ||||
| 
 | ||||
| const classController = new ClassController(); | ||||
| 
 | ||||
| /* Query cache keys */ | ||||
| function classesQueryKey(full: boolean) { | ||||
|     return ["classes", full]; | ||||
| } | ||||
| function classQueryKey(classid: string) { | ||||
|     return ["class", classid]; | ||||
| } | ||||
| function classStudentsKey(classid: string, full: boolean) { | ||||
|     return ["class-students", classid, full]; | ||||
| } | ||||
| function classTeachersKey(classid: string, full: boolean) { | ||||
|     return ["class-teachers", classid, full]; | ||||
| } | ||||
| function classTeacherInvitationsKey(classid: string, full: boolean) { | ||||
|     return ["class-teacher-invitations", classid, full]; | ||||
| } | ||||
| function classAssignmentsKey(classid: string, full: boolean) { | ||||
|     return ["class-assignments", classid, full]; | ||||
| } | ||||
| 
 | ||||
| export async function invalidateAllClassKeys(queryClient: QueryClient, classid?: string) { | ||||
|     const keys = ["class", "class-students", "class-teachers", "class-teacher-invitations", "class-assignments"]; | ||||
| 
 | ||||
|     for (const key of keys) { | ||||
|         const queryKey = [key, classid].filter((arg) => arg !== undefined); | ||||
|         await queryClient.invalidateQueries({ queryKey: queryKey }); | ||||
|     } | ||||
| 
 | ||||
|     await queryClient.invalidateQueries({ queryKey: ["classes"] }); | ||||
| } | ||||
| 
 | ||||
| /* Queries */ | ||||
| export function useClassesQuery(full: MaybeRefOrGetter<boolean> = true): UseQueryReturnType<ClassesResponse, Error> { | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => classesQueryKey(toValue(full))), | ||||
|         queryFn: async () => classController.getAll(toValue(full)), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useClassQuery(id: MaybeRefOrGetter<string | undefined>): UseQueryReturnType<ClassResponse, Error> { | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => classQueryKey(toValue(id)!)), | ||||
|         queryFn: async () => classController.getById(toValue(id)!), | ||||
|         enabled: () => Boolean(toValue(id)), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useCreateClassMutation(): UseMutationReturnType<ClassResponse, Error, ClassDTO, unknown> { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async (data) => classController.createClass(data), | ||||
|         onSuccess: async () => { | ||||
|             await queryClient.invalidateQueries({ queryKey: ["classes"] }); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useDeleteClassMutation(): UseMutationReturnType<ClassResponse, Error, string, unknown> { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async (id) => classController.deleteClass(id), | ||||
|         onSuccess: async (data) => { | ||||
|             await invalidateAllClassKeys(queryClient, data.class.id); | ||||
|             await invalidateAllAssignmentKeys(queryClient, data.class.id); | ||||
|             await invalidateAllGroupKeys(queryClient, data.class.id); | ||||
|             await invalidateAllSubmissionKeys(queryClient, data.class.id); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useUpdateClassMutation(): UseMutationReturnType< | ||||
|     ClassResponse, | ||||
|     Error, | ||||
|     { cid: string; data: Partial<ClassDTO> }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ cid, data }) => classController.updateClass(cid, data), | ||||
|         onSuccess: async (data) => { | ||||
|             await invalidateAllClassKeys(queryClient, data.class.id); | ||||
|             await invalidateAllAssignmentKeys(queryClient, data.class.id); | ||||
|             await invalidateAllGroupKeys(queryClient, data.class.id); | ||||
|             await invalidateAllSubmissionKeys(queryClient, data.class.id); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useClassStudentsQuery( | ||||
|     id: MaybeRefOrGetter<string | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<StudentsResponse, Error> { | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => classStudentsKey(toValue(id)!, toValue(full))), | ||||
|         queryFn: async () => classController.getStudents(toValue(id)!, toValue(full)), | ||||
|         enabled: () => Boolean(toValue(id)), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useClassAddStudentMutation(): UseMutationReturnType< | ||||
|     ClassResponse, | ||||
|     Error, | ||||
|     { id: string; username: string }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ id, username }) => classController.addStudent(id, username), | ||||
|         onSuccess: async (data) => { | ||||
|             await queryClient.invalidateQueries({ queryKey: classQueryKey(data.class.id) }); | ||||
|             await queryClient.invalidateQueries({ queryKey: classStudentsKey(data.class.id, true) }); | ||||
|             await queryClient.invalidateQueries({ queryKey: classStudentsKey(data.class.id, false) }); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useClassDeleteStudentMutation(): UseMutationReturnType< | ||||
|     ClassResponse, | ||||
|     Error, | ||||
|     { id: string; username: string }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ id, username }) => classController.deleteStudent(id, username), | ||||
|         onSuccess: async (data) => { | ||||
|             await queryClient.invalidateQueries({ queryKey: classQueryKey(data.class.id) }); | ||||
|             await queryClient.invalidateQueries({ queryKey: classStudentsKey(data.class.id, true) }); | ||||
|             await queryClient.invalidateQueries({ queryKey: classStudentsKey(data.class.id, false) }); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useClassTeachersQuery( | ||||
|     id: MaybeRefOrGetter<string | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<StudentsResponse, Error> { | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => classTeachersKey(toValue(id)!, toValue(full))), | ||||
|         queryFn: async () => classController.getTeachers(toValue(id)!, toValue(full)), | ||||
|         enabled: () => Boolean(toValue(id)), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useClassAddTeacherMutation(): UseMutationReturnType< | ||||
|     ClassResponse, | ||||
|     Error, | ||||
|     { id: string; username: string }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ id, username }) => classController.addTeacher(id, username), | ||||
|         onSuccess: async (data) => { | ||||
|             await queryClient.invalidateQueries({ queryKey: classQueryKey(data.class.id) }); | ||||
|             await queryClient.invalidateQueries({ queryKey: classTeachersKey(data.class.id, true) }); | ||||
|             await queryClient.invalidateQueries({ queryKey: classTeachersKey(data.class.id, false) }); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useClassDeleteTeacherMutation(): UseMutationReturnType< | ||||
|     ClassResponse, | ||||
|     Error, | ||||
|     { id: string; username: string }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ id, username }) => classController.deleteTeacher(id, username), | ||||
|         onSuccess: async (data) => { | ||||
|             await queryClient.invalidateQueries({ queryKey: classQueryKey(data.class.id) }); | ||||
|             await queryClient.invalidateQueries({ queryKey: classTeachersKey(data.class.id, true) }); | ||||
|             await queryClient.invalidateQueries({ queryKey: classTeachersKey(data.class.id, false) }); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useClassTeacherInvitationsQuery( | ||||
|     id: MaybeRefOrGetter<string | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<StudentsResponse, Error> { | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => classTeacherInvitationsKey(toValue(id)!, toValue(full))), | ||||
|         queryFn: async () => classController.getTeacherInvitations(toValue(id)!, toValue(full)), | ||||
|         enabled: () => Boolean(toValue(id)), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useClassAssignmentsQuery( | ||||
|     id: MaybeRefOrGetter<string | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<StudentsResponse, Error> { | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => classAssignmentsKey(toValue(id)!, toValue(full))), | ||||
|         queryFn: async () => classController.getAssignments(toValue(id)!, toValue(full)), | ||||
|         enabled: () => Boolean(toValue(id)), | ||||
|     }); | ||||
| } | ||||
							
								
								
									
										191
									
								
								frontend/src/queries/groups.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										191
									
								
								frontend/src/queries/groups.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,191 @@ | |||
| import type { ClassesResponse } from "@/controllers/classes"; | ||||
| import { GroupController, type GroupResponse, type GroupsResponse } from "@/controllers/groups"; | ||||
| import type { QuestionsResponse } from "@/controllers/questions"; | ||||
| import type { SubmissionsResponse } from "@/controllers/submissions"; | ||||
| import type { GroupDTO } from "@dwengo-1/common/interfaces/group"; | ||||
| import { | ||||
|     QueryClient, | ||||
|     useMutation, | ||||
|     useQuery, | ||||
|     useQueryClient, | ||||
|     type UseMutationReturnType, | ||||
|     type UseQueryReturnType, | ||||
| } from "@tanstack/vue-query"; | ||||
| import { computed, toValue, type MaybeRefOrGetter } from "vue"; | ||||
| import { invalidateAllAssignmentKeys } from "./assignments"; | ||||
| import { invalidateAllSubmissionKeys } from "./submissions"; | ||||
| 
 | ||||
| export function groupsQueryKey(classid: string, assignmentNumber: number, full: boolean) { | ||||
|     return ["groups", classid, assignmentNumber, full]; | ||||
| } | ||||
| function groupQueryKey(classid: string, assignmentNumber: number, groupNumber: number) { | ||||
|     return ["group", classid, assignmentNumber, groupNumber]; | ||||
| } | ||||
| function groupSubmissionsQueryKey(classid: string, assignmentNumber: number, groupNumber: number, full: boolean) { | ||||
|     return ["group-submissions", classid, assignmentNumber, groupNumber, full]; | ||||
| } | ||||
| function groupQuestionsQueryKey(classid: string, assignmentNumber: number, groupNumber: number, full: boolean) { | ||||
|     return ["group-questions", classid, assignmentNumber, groupNumber, full]; | ||||
| } | ||||
| 
 | ||||
| export async function invalidateAllGroupKeys( | ||||
|     queryClient: QueryClient, | ||||
|     classid?: string, | ||||
|     assignmentNumber?: number, | ||||
|     groupNumber?: number, | ||||
| ) { | ||||
|     const keys = ["group", "group-submissions", "group-questions"]; | ||||
| 
 | ||||
|     for (const key of keys) { | ||||
|         const queryKey = [key, classid, assignmentNumber, groupNumber].filter((arg) => arg !== undefined); | ||||
|         await queryClient.invalidateQueries({ queryKey: queryKey }); | ||||
|     } | ||||
| 
 | ||||
|     await queryClient.invalidateQueries({ | ||||
|         queryKey: ["groups", classid, assignmentNumber].filter((arg) => arg !== undefined), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| function checkEnabled( | ||||
|     classid: string | undefined, | ||||
|     assignmentNumber: number | undefined, | ||||
|     groupNumber: number | undefined, | ||||
| ): boolean { | ||||
|     return Boolean(classid) && !isNaN(Number(groupNumber)) && !isNaN(Number(assignmentNumber)); | ||||
| } | ||||
| function toValues( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean>, | ||||
| ) { | ||||
|     return { cid: toValue(classid), an: toValue(assignmentNumber), gn: toValue(groupNumber), f: toValue(full) }; | ||||
| } | ||||
| 
 | ||||
| export function useGroupsQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<GroupsResponse, Error> { | ||||
|     const { cid, an, f } = toValues(classid, assignmentNumber, 1, full); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => groupsQueryKey(cid!, an!, f)), | ||||
|         queryFn: async () => new GroupController(cid!, an!).getAll(f), | ||||
|         enabled: () => checkEnabled(cid, an, 1), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useGroupQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
| ): UseQueryReturnType<GroupResponse, Error> { | ||||
|     const { cid, an, gn } = toValues(classid, assignmentNumber, groupNumber, true); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => groupQueryKey(cid!, an!, gn!)), | ||||
|         queryFn: async () => new GroupController(cid!, an!).getByNumber(gn!), | ||||
|         enabled: () => checkEnabled(cid, an, gn), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useCreateGroupMutation(): UseMutationReturnType< | ||||
|     GroupResponse, | ||||
|     Error, | ||||
|     { cid: string; an: number; data: GroupDTO }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ cid, an, data }) => new GroupController(cid, an).createGroup(data), | ||||
|         onSuccess: async (response) => { | ||||
|             const cid = typeof response.group.class === "string" ? response.group.class : response.group.class.id; | ||||
|             const an = | ||||
|                 typeof response.group.assignment === "number" | ||||
|                     ? response.group.assignment | ||||
|                     : response.group.assignment.id; | ||||
| 
 | ||||
|             await queryClient.invalidateQueries({ queryKey: groupsQueryKey(cid, an, true) }); | ||||
|             await queryClient.invalidateQueries({ queryKey: groupsQueryKey(cid, an, false) }); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useDeleteGroupMutation(): UseMutationReturnType< | ||||
|     GroupResponse, | ||||
|     Error, | ||||
|     { cid: string; an: number; gn: number }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ cid, an, gn }) => new GroupController(cid, an).deleteGroup(gn), | ||||
|         onSuccess: async (response) => { | ||||
|             const cid = typeof response.group.class === "string" ? response.group.class : response.group.class.id; | ||||
|             const an = | ||||
|                 typeof response.group.assignment === "number" | ||||
|                     ? response.group.assignment | ||||
|                     : response.group.assignment.id; | ||||
|             const gn = response.group.groupNumber; | ||||
| 
 | ||||
|             await invalidateAllGroupKeys(queryClient, cid, an, gn); | ||||
|             await invalidateAllSubmissionKeys(queryClient, cid, an, gn); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useUpdateGroupMutation(): UseMutationReturnType< | ||||
|     GroupResponse, | ||||
|     Error, | ||||
|     { cid: string; an: number; gn: number; data: Partial<GroupDTO> }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ cid, an, gn, data }) => new GroupController(cid, an).updateGroup(gn, data), | ||||
|         onSuccess: async (response) => { | ||||
|             const cid = typeof response.group.class === "string" ? response.group.class : response.group.class.id; | ||||
|             const an = | ||||
|                 typeof response.group.assignment === "number" | ||||
|                     ? response.group.assignment | ||||
|                     : response.group.assignment.id; | ||||
|             const gn = response.group.groupNumber; | ||||
| 
 | ||||
|             await invalidateAllGroupKeys(queryClient, cid, an, gn); | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useGroupSubmissionsQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<SubmissionsResponse, Error> { | ||||
|     const { cid, an, gn, f } = toValues(classid, assignmentNumber, groupNumber, full); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => groupSubmissionsQueryKey(cid!, an!, gn!, f)), | ||||
|         queryFn: async () => new GroupController(cid!, an!).getSubmissions(gn!, f), | ||||
|         enabled: () => checkEnabled(cid, an, gn), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useGroupQuestionsQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<QuestionsResponse, Error> { | ||||
|     const { cid, an, gn, f } = toValues(classid, assignmentNumber, groupNumber, full); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => groupQuestionsQueryKey(cid!, an!, gn!, f)), | ||||
|         queryFn: async () => new GroupController(cid!, an!).getSubmissions(gn!, f), | ||||
|         enabled: () => checkEnabled(cid, an, gn), | ||||
|     }); | ||||
| } | ||||
							
								
								
									
										157
									
								
								frontend/src/queries/submissions.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										157
									
								
								frontend/src/queries/submissions.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,157 @@ | |||
| import { SubmissionController, type SubmissionResponse, type SubmissionsResponse } from "@/controllers/submissions"; | ||||
| import type { SubmissionDTO } from "@dwengo-1/common/interfaces/submission"; | ||||
| import { | ||||
|     QueryClient, | ||||
|     useMutation, | ||||
|     useQuery, | ||||
|     useQueryClient, | ||||
|     type UseMutationReturnType, | ||||
|     type UseQueryReturnType, | ||||
| } from "@tanstack/vue-query"; | ||||
| import { computed, toValue, type MaybeRefOrGetter } from "vue"; | ||||
| 
 | ||||
| function submissionsQueryKey(classid: string, assignmentNumber: number, groupNumber: number, full: boolean) { | ||||
|     return ["submissions", classid, assignmentNumber, groupNumber, full]; | ||||
| } | ||||
| function submissionQueryKey(classid: string, assignmentNumber: number, groupNumber: number, submissionNumber: number) { | ||||
|     return ["submission", classid, assignmentNumber, groupNumber, submissionNumber]; | ||||
| } | ||||
| 
 | ||||
| export async function invalidateAllSubmissionKeys( | ||||
|     queryClient: QueryClient, | ||||
|     classid?: string, | ||||
|     assignmentNumber?: number, | ||||
|     groupNumber?: number, | ||||
|     submissionNumber?: number, | ||||
| ) { | ||||
|     const keys = ["submission"]; | ||||
| 
 | ||||
|     for (const key of keys) { | ||||
|         const queryKey = [key, classid, assignmentNumber, groupNumber, submissionNumber].filter( | ||||
|             (arg) => arg !== undefined, | ||||
|         ); | ||||
|         await queryClient.invalidateQueries({ queryKey: queryKey }); | ||||
|     } | ||||
| 
 | ||||
|     await queryClient.invalidateQueries({ | ||||
|         queryKey: ["submissions", classid, assignmentNumber, groupNumber].filter((arg) => arg !== undefined), | ||||
|     }); | ||||
|     await queryClient.invalidateQueries({ | ||||
|         queryKey: ["group-submissions", classid, assignmentNumber, groupNumber].filter((arg) => arg !== undefined), | ||||
|     }); | ||||
|     await queryClient.invalidateQueries({ | ||||
|         queryKey: ["assignment-submissions", classid, assignmentNumber].filter((arg) => arg !== undefined), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| function checkEnabled( | ||||
|     classid: string | undefined, | ||||
|     assignmentNumber: number | undefined, | ||||
|     groupNumber: number | undefined, | ||||
|     submissionNumber: number | undefined, | ||||
| ): boolean { | ||||
|     return ( | ||||
|         Boolean(classid) && | ||||
|         !isNaN(Number(groupNumber)) && | ||||
|         !isNaN(Number(assignmentNumber)) && | ||||
|         !isNaN(Number(submissionNumber)) | ||||
|     ); | ||||
| } | ||||
| function toValues( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     submissionNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean>, | ||||
| ) { | ||||
|     return { | ||||
|         cid: toValue(classid), | ||||
|         an: toValue(assignmentNumber), | ||||
|         gn: toValue(groupNumber), | ||||
|         sn: toValue(submissionNumber), | ||||
|         f: toValue(full), | ||||
|     }; | ||||
| } | ||||
| 
 | ||||
| export function useSubmissionsQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     full: MaybeRefOrGetter<boolean> = true, | ||||
| ): UseQueryReturnType<SubmissionsResponse, Error> { | ||||
|     const { cid, an, gn, sn, f } = toValues(classid, assignmentNumber, groupNumber, 1, full); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => submissionsQueryKey(cid!, an!, gn!, f)), | ||||
|         queryFn: async () => new SubmissionController(cid!, an!, gn!).getAll(f), | ||||
|         enabled: () => checkEnabled(cid, an, gn, sn), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useSubmissionQuery( | ||||
|     classid: MaybeRefOrGetter<string | undefined>, | ||||
|     assignmentNumber: MaybeRefOrGetter<number | undefined>, | ||||
|     groupNumber: MaybeRefOrGetter<number | undefined>, | ||||
| ): UseQueryReturnType<SubmissionResponse, Error> { | ||||
|     const { cid, an, gn, sn, f } = toValues(classid, assignmentNumber, groupNumber, 1, true); | ||||
| 
 | ||||
|     return useQuery({ | ||||
|         queryKey: computed(() => submissionQueryKey(cid!, an!, gn!, sn!)), | ||||
|         queryFn: async () => new SubmissionController(cid!, an!, gn!).getByNumber(sn!), | ||||
|         enabled: () => checkEnabled(cid, an, gn, sn), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useCreateSubmissionMutation(): UseMutationReturnType< | ||||
|     SubmissionResponse, | ||||
|     Error, | ||||
|     { cid: string; an: number; gn: number; data: SubmissionDTO }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ cid, an, gn, data }) => new SubmissionController(cid, an, gn).createSubmission(data), | ||||
|         onSuccess: async (response) => { | ||||
|             if (!response.submission.group) { | ||||
|                 await invalidateAllSubmissionKeys(queryClient); | ||||
|             } else { | ||||
|                 const cls = response.submission.group.class; | ||||
|                 const assignment = response.submission.group.assignment; | ||||
| 
 | ||||
|                 const cid = typeof cls === "string" ? cls : cls.id; | ||||
|                 const an = typeof assignment === "number" ? assignment : assignment.id; | ||||
|                 const gn = response.submission.group.groupNumber; | ||||
| 
 | ||||
|                 await invalidateAllSubmissionKeys(queryClient, cid, an, gn); | ||||
|             } | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useDeleteSubmissionMutation(): UseMutationReturnType< | ||||
|     SubmissionResponse, | ||||
|     Error, | ||||
|     { cid: string; an: number; gn: number; sn: number }, | ||||
|     unknown | ||||
| > { | ||||
|     const queryClient = useQueryClient(); | ||||
| 
 | ||||
|     return useMutation({ | ||||
|         mutationFn: async ({ cid, an, gn, sn }) => new SubmissionController(cid, an, gn).deleteSubmission(sn), | ||||
|         onSuccess: async (response) => { | ||||
|             if (!response.submission.group) { | ||||
|                 await invalidateAllSubmissionKeys(queryClient); | ||||
|             } else { | ||||
|                 const cls = response.submission.group.class; | ||||
|                 const assignment = response.submission.group.assignment; | ||||
| 
 | ||||
|                 const cid = typeof cls === "string" ? cls : cls.id; | ||||
|                 const an = typeof assignment === "number" ? assignment : assignment.id; | ||||
|                 const gn = response.submission.group.groupNumber; | ||||
| 
 | ||||
|                 await invalidateAllSubmissionKeys(queryClient, cid, an, gn); | ||||
|             } | ||||
|         }, | ||||
|     }); | ||||
| } | ||||
							
								
								
									
										78
									
								
								frontend/src/queries/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										78
									
								
								frontend/src/queries/teacher-invitations.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,78 @@ | |||
| import { useMutation, useQuery, type UseMutationReturnType, type UseQueryReturnType } from "@tanstack/vue-query"; | ||||
| import { computed, toValue } from "vue"; | ||||
| import type { MaybeRefOrGetter } from "vue"; | ||||
| import { | ||||
|     TeacherInvitationController, | ||||
|     type TeacherInvitationResponse, | ||||
|     type TeacherInvitationsResponse, | ||||
| } from "@/controllers/teacher-invitations.ts"; | ||||
| import type { TeacherInvitationData } from "@dwengo-1/common/interfaces/teacher-invitation"; | ||||
| import type { TeacherDTO } from "@dwengo-1/common/interfaces/teacher"; | ||||
| 
 | ||||
| const controller = new TeacherInvitationController(); | ||||
| 
 | ||||
| /** | ||||
|     All the invitations the teacher sent | ||||
| **/ | ||||
| export function useTeacherInvitationsSentQuery( | ||||
|     username: MaybeRefOrGetter<string | undefined>, | ||||
| ): UseQueryReturnType<TeacherInvitationsResponse, Error> { | ||||
|     return useQuery({ | ||||
|         queryFn: computed(async () => controller.getAll(toValue(username), true)), | ||||
|         enabled: () => Boolean(toValue(username)), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| /** | ||||
|     All the pending invitations sent to this teacher | ||||
|  */ | ||||
| export function useTeacherInvitationsReceivedQuery( | ||||
|     username: MaybeRefOrGetter<string | undefined>, | ||||
| ): UseQueryReturnType<TeacherInvitationsResponse, Error> { | ||||
|     return useQuery({ | ||||
|         queryFn: computed(async () => controller.getAll(toValue(username), false)), | ||||
|         enabled: () => Boolean(toValue(username)), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useTeacherInvitationQuery( | ||||
|     data: MaybeRefOrGetter<TeacherInvitationData | undefined>, | ||||
| ): UseQueryReturnType<TeacherInvitationResponse, Error> { | ||||
|     return useQuery({ | ||||
|         queryFn: computed(async () => controller.getBy(toValue(data))), | ||||
|         enabled: () => Boolean(toValue(data)), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useCreateTeacherInvitationMutation(): UseMutationReturnType< | ||||
|     TeacherInvitationResponse, | ||||
|     Error, | ||||
|     TeacherDTO, | ||||
|     unknown | ||||
| > { | ||||
|     return useMutation({ | ||||
|         mutationFn: async (data: TeacherInvitationData) => controller.create(data), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useRespondTeacherInvitationMutation(): UseMutationReturnType< | ||||
|     TeacherInvitationResponse, | ||||
|     Error, | ||||
|     TeacherDTO, | ||||
|     unknown | ||||
| > { | ||||
|     return useMutation({ | ||||
|         mutationFn: async (data: TeacherInvitationData) => controller.respond(data), | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| export function useDeleteTeacherInvitationMutation(): UseMutationReturnType< | ||||
|     TeacherInvitationResponse, | ||||
|     Error, | ||||
|     TeacherDTO, | ||||
|     unknown | ||||
| > { | ||||
|     return useMutation({ | ||||
|         mutationFn: async (data: TeacherInvitationData) => controller.remove(data), | ||||
|     }); | ||||
| } | ||||
|  | @ -250,10 +250,11 @@ | |||
|                 <tbody> | ||||
|                     <tr | ||||
|                         v-for="i in invitations" | ||||
|                         :key="(i.class as ClassDTO).id" | ||||
|                         :key="i.classId" | ||||
|                     > | ||||
|                         <td> | ||||
|                             {{ (i.class as ClassDTO).displayName }} | ||||
|                             {{ i.classId }} | ||||
|                             <!-- TODO fetch display name via classId because db only returns classId field --> | ||||
|                         </td> | ||||
|                         <td>{{ (i.sender as TeacherDTO).firstName + " " + (i.sender as TeacherDTO).lastName }}</td> | ||||
|                         <td class="text-right"> | ||||
|  |  | |||
							
								
								
									
										1
									
								
								package-lock.json
									
										
									
										generated
									
									
									
								
							
							
						
						
									
										1
									
								
								package-lock.json
									
										
									
										generated
									
									
									
								
							|  | @ -273,6 +273,7 @@ | |||
|                 "@tanstack/vue-query": "^5.69.0", | ||||
|                 "axios": "^1.8.2", | ||||
|                 "oidc-client-ts": "^3.1.0", | ||||
|                 "uuid": "^11.1.0", | ||||
|                 "vue": "^3.5.13", | ||||
|                 "vue-i18n": "^11.1.2", | ||||
|                 "vue-router": "^4.5.0", | ||||
|  |  | |||
|  | @ -5,7 +5,7 @@ | |||
|     "private": true, | ||||
|     "type": "module", | ||||
|     "scripts": { | ||||
|         "prebuild": "npm run clean", | ||||
|         "prebuild": "npm run clean && npm run swagger --workspace=docs", | ||||
|         "build": "tsc --build tsconfig.build.json", | ||||
|         "clean": "tsc --build tsconfig.build.json --clean", | ||||
|         "watch": "tsc --build tsconfig.build.json --watch", | ||||
|  |  | |||
		Reference in a new issue
	
	 laurejablonski
						laurejablonski