Merge branch 'master' into feat-stats-dissolvedby-differentiate

Author: realmayus

.certificate-version

@@ -1 +1 @@
-21a45888d9a49b70b1e98740eadfb745e2aacf84
+e2769b5f644fb1aa1b82b94df09d1aa8ab5a7c21

assets/instantCertificateTemplate.de.html

@@ -14,6 +14,10 @@ <h2>Deutsches Sofort-Zertifikat</h2>
         <%= NAMESTUDENT %> unterstützte <%= MATCHES_COUNT %> Schüler:innen in der 1:1 Lernunterstützung und führte <%= MATCH_APPOINTMENTS_COUNT %> Nachhilfetermine durch. Zudem agierte <%= NAMESTUDENT %> als Gruppenkurs-Leiter und unterstütze so <%= COURSE_PARTICIPANTS_COUNT %> Schüler:innen in <%= COURSE_APPOINTMENTS_COUNT %> Lektionen.
 
         Insgesamt unterstützte <%= NAMESTUDENT %> bildungsbenachteiligte Kinder und Jugendliche in <%= TOTAL_APPOINTMENTS_DURATION %> Stunden in dieser Zeit.
+
+        <% if(HOMEWORK_HELP_DURATION) { %>
+            Zusätzlich unterstützte <%= NAMESTUDENT %> Schüler:innen in der Hausaufgabenhilfe im Umfang von <%= HOMEWORK_HELP_DURATION %> Stunden.
+        <% } %>
         <br/>
         <img src="<%=QR_CODE%>" alt="Verifizierung code" width="100px" />
 

common/appointment/util.ts

@@ -4,7 +4,7 @@ import * as ics from 'ics';
 import { EventAttributes } from 'ics';
 import moment from 'moment-timezone';
 import { prisma } from '../prisma';
-import { getUsers } from '../user';
+import { getUsers, UserID } from '../user';
 import { getLogger } from '../logger/logger';
 
 const language = 'de-DE';
@@ -59,10 +59,10 @@ export async function getDisplayName(appointment: Appointment, isOrganizer: bool
     switch (appointment.appointmentType) {
         case lecture_appointmenttype_enum.match: {
             if (isOrganizer) {
-                const [tutee] = await getUsers(appointment.participantIds);
+                const [tutee] = await getUsers(appointment.participantIds as UserID[]);
                 return `${tutee.firstname} ${tutee.lastname}`;
             } else {
-                const [tutor] = await getUsers(appointment.organizerIds);
+                const [tutor] = await getUsers(appointment.organizerIds as UserID[]);
                 return `${tutor.firstname} ${tutor.lastname}`;
             }
         }

common/certificate-of-conduct/certificateOfConduct.ts

@@ -3,7 +3,7 @@ import { prisma } from '../prisma';
 import { deactivateStudent } from '../student/activation';
 import { getStudent } from '../../graphql/util';
 import * as Notification from '../notification';
-import { userForStudent } from '../user';
+import { DeactivationReason, userForStudent } from '../user';
 import moment from 'moment';
 import { cancelRemissionRequest } from '../remission-request';
 
@@ -25,7 +25,7 @@ export async function create(dateOfInspection: Date, dateOfIssue: Date, criminal
         expirationDate: moment(dateOfIssue).add(3, 'years').format('DD.MM.YYYY'),
     });
     if (criminalRecords) {
-        await deactivateStudent(student);
+        await deactivateStudent(student, false, DeactivationReason.hasCriminalRecord);
     } else {
         await Notification.actionTaken(userForStudent(student), 'student_coc_approved', {});
     }

common/certificate/index.ts

@@ -5,6 +5,7 @@ import { randomBytes } from 'crypto';
 import EJS from 'ejs';
 import * as Notification from '../notification';
 import {
+    course_category_enum,
     instant_certificate as InstantCertificate,
     participation_certificate as ParticipationCertificate,
     Prisma,
@@ -124,13 +125,24 @@ export async function createInstantCertificate(requester: Student, lang: Languag
         _sum: { duration: true },
     });
 
-    const [matchesCount, matchAppointmentsCount, courseParticipants, courseAppointmentsCount, totalAppointmentsDuration] = await Promise.all([
-        matchesCountPromise,
-        matchAppointmentsCountPromise,
-        uniqueCourseParticipantsPromise,
-        courseAppointmentsCountPromise,
-        totalAppointmentsDurationPromise,
-    ]);
+    const homeworkHelpDurationPromise = prisma.lecture.aggregate({
+        where: {
+            isCanceled: false,
+            subcourse: { course: { category: course_category_enum.homework_help } },
+            joinedBy: { has: userForStudent(requester).userID },
+        },
+        _sum: { duration: true },
+    });
+
+    const [matchesCount, matchAppointmentsCount, courseParticipants, courseAppointmentsCount, totalAppointmentsDuration, homeworkHelpDuration] =
+        await Promise.all([
+            matchesCountPromise,
+            matchAppointmentsCountPromise,
+            uniqueCourseParticipantsPromise,
+            courseAppointmentsCountPromise,
+            totalAppointmentsDurationPromise,
+            homeworkHelpDurationPromise,
+        ]);
     const courseParticipantsCount = courseParticipants.length;
 
     const certificate = await prisma.instant_certificate.create({
@@ -143,6 +155,7 @@ export async function createInstantCertificate(requester: Student, lang: Languag
             courseParticipantsCount,
             courseAppointmentsCount,
             totalAppointmentsDuration: totalAppointmentsDuration._sum.duration ?? 0,
+            homeworkHelpDuration: homeworkHelpDuration._sum.duration === 0 ? undefined : homeworkHelpDuration._sum.duration,
         },
         include: { student: true },
     });
@@ -265,6 +278,7 @@ export async function getConfirmationPage(certificateId: string, lang: Language,
             COURSE_PARTICIPANTS_COUNT: certificate.courseParticipantsCount,
             COURSE_APPOINTMENTS_COUNT: certificate.courseAppointmentsCount,
             TOTAL_APPOINTMENTS_DURATION: formatFloat(certificate.totalAppointmentsDuration / 60, lang),
+            HOMEWORK_HELP_DURATION: certificate.homeworkHelpDuration ? formatFloat(certificate.homeworkHelpDuration / 60, lang) : undefined,
             DATUMHEUTE: moment(certificate.createdAt).format('D.M.YYYY'),
         });
     }
@@ -471,6 +485,7 @@ async function createInstantPDFBinary(certificate: InstantCertificate & { studen
         COURSE_PARTICIPANTS_COUNT: certificate.courseParticipantsCount,
         COURSE_APPOINTMENTS_COUNT: certificate.courseAppointmentsCount,
         TOTAL_APPOINTMENTS_DURATION: formatFloat(certificate.totalAppointmentsDuration / 60, lang),
+        HOMEWORK_HELP_DURATION: certificate.homeworkHelpDuration ? formatFloat(certificate.homeworkHelpDuration / 60, lang) : undefined,
         DATUMHEUTE: moment().format('D.M.YYYY'),
         QR_CODE: await QRCode.toDataURL(link),
     });

common/chat/create.ts

@@ -1,4 +1,4 @@
-import { User } from '../user';
+import { User, UserID } from '../user';
 import { ChatMetaData, ContactReason, Conversation, ConversationInfos, FinishedReason, SystemMessage, TJConversation } from './types';
 import { checkChatMembersAccessRights, convertTJConversation, createOneOnOneId, userIdToTalkJsId } from './helper';
 import { createConversation, getConversation, markConversationAsWriteable, sendSystemMessage, updateConversation } from './conversation';
@@ -10,6 +10,15 @@ import { getLogger } from '../logger/logger';
 import assert from 'assert';
 import { createHmac } from 'crypto';
 
+// We do not replicate TalkJS data in the Backend but instead always fetch their REST API which is particularily slow.
+// As Users cannot be deleted in TalkJS, if a user once had an account, we can cache their TalkJS signature.
+const signatureCache = new Map<UserID, string>();
+
+// If it returns true, the user definetly has a TalkJS user. If it returns false, the TalkJS API needs to be checked
+export function hasCachedChatUser(user: User) {
+    return signatureCache.has(user.userID);
+}
+
 const logger = getLogger('Chat');
 const getOrCreateOneOnOneConversation = async (
     participants: [User, User],
@@ -57,19 +66,28 @@ const getOrCreateOneOnOneConversation = async (
 
 async function ensureChatUsersExist(participants: [User, User] | User[]): Promise<void> {
     await Promise.all(
-        participants.map(async (participant) => {
-            await getOrCreateChatUser(participant);
-        })
+        participants
+            .filter((it) => !hasCachedChatUser(it))
+            .map(async (participant) => {
+                await getOrCreateChatUser(participant);
+            })
     );
 }
 
 const createChatSignature = async (user: User): Promise<string> => {
+    if (signatureCache.has(user.userID)) {
+        return signatureCache.get(user.userID);
+    }
+
     const TALKJS_SECRET_KEY = process.env.TALKJS_API_KEY;
     assert(TALKJS_SECRET_KEY, `No TalkJS secret key to create a chat signature for user ${user.userID}.`);
     const userId = (await getOrCreateChatUser(user)).id;
     const key = TALKJS_SECRET_KEY;
     const hash = createHmac('sha256', key).update(userIdToTalkJsId(userId));
-    return hash.digest('hex');
+    const signature = hash.digest('hex');
+
+    signatureCache.set(user.userID, signature);
+    return signature;
 };
 
 async function handleExistingConversation(

common/chat/helper.ts

@@ -1,21 +1,20 @@
 import { match } from '@prisma/client';
 import { prisma } from '../prisma';
-import { User, getUser } from '../user';
+import { User, UserID, getUser } from '../user';
 import { sha1 } from 'object-hash';
 import { truncate } from 'lodash';
 import { Subcourse } from '../../graphql/generated';
 import { ChatMetaData, Conversation, ConversationInfos, TJConversation } from './types';
 import { type MatchContactPupil, type MatchContactStudent } from './contacts';
 
 type TalkJSUserId = `${'pupil' | 'student'}_${number}`;
-export type UserId = `${'pupil' | 'student'}/${number}`;
 
 const userIdToTalkJsId = (userId: string): TalkJSUserId => {
     return userId.replace('/', '_') as TalkJSUserId;
 };
 
-const talkJsIdToUserId = (userId: string): UserId => {
-    return userId.replace('_', '/') as UserId;
+const talkJsIdToUserId = (userId: string): UserID => {
+    return userId.replace('_', '/') as UserID;
 };
 
 function createOneOnOneId(userA: Pick<User, 'userID'>, userB: Pick<User, 'userID'>): string {

common/notification/actions.ts

@@ -568,10 +568,18 @@ const _notificationActions = {
         description: 'Pupil / Account deactivated by admin',
         sampleContext: {},
     },
+    pupil_account_deactivated_no_more_interest: {
+        description: 'Pupil / Account deactivated - no more interest',
+        sampleContext: {},
+    },
     student_account_deactivated: {
         description: 'Student / Account deactivated',
         sampleContext: {},
     },
+    student_account_deactivated_no_more_interest: {
+        description: 'Student / Account deactivated - no more interest',
+        sampleContext: {},
+    },
 
     'user-verify-email': {
         description: 'User / Verify E-Mail',

common/notification/hooks.ts

@@ -5,16 +5,18 @@ import { registerPupilHook, registerStudentHook } from './hook';
 import { deactivateStudent } from '../student/activation';
 import { cancelRemissionRequest } from '../remission-request';
 import { prisma } from '../prisma';
-import { userForStudent } from '../user';
+import { DeactivationReason, userForStudent } from '../user';
 import * as Notification from '../../common/notification';
 import { SpecificNotificationContext } from './actions';
 import { dissolve_reason } from '@prisma/client';
+import { deletePupilMatchRequest } from '../match/request';
+import { deactivatePupil } from '../pupil/activation';
 
 registerStudentHook(
     'deactivate-student',
     'Account gets deactivated, matches are dissolved, courses are cancelled',
     async (student) => {
-        await deactivateStudent(student, true, 'missing coc', [dissolve_reason.accountDeactivatedNoCoC]);
+        await deactivateStudent(student, true, DeactivationReason.missingCoC, undefined, [dissolve_reason.accountDeactivatedNoCoC]);
     } // the hook does not send out a notification again, the user already knows that their account was deactivated
 );
 
@@ -44,13 +46,10 @@ registerStudentHook(
     }
 );
 
-import { deletePupilMatchRequest } from '../match/request';
-import { deactivatePupil } from '../pupil/activation';
-
 registerPupilHook('revoke-pupil-match-request', 'Match Request is taken back, pending Pupil Screenings are invalidated', async (pupil) => {
     await deletePupilMatchRequest(pupil);
 });
 
 registerPupilHook('deactivate-pupil', 'Account gets deactivated, matches are dissolved, courses are left', async (pupil) => {
-    await deactivatePupil(pupil, true, 'deactivated by admin', true);
+    await deactivatePupil(pupil, true, DeactivationReason.deactivatedByAdmin, undefined, true);
 });

common/pupil/activation.ts

@@ -4,7 +4,7 @@ import { dissolveMatch } from '../match/dissolve';
 import { RedundantError } from '../util/error';
 import * as Notification from '../notification';
 import { logTransaction } from '../transactionlog/log';
-import { userForPupil } from '../user';
+import { DeactivationReason, userForPupil } from '../user';
 import { dissolved_by_enum } from '../../graphql/generated';
 import { leaveSubcourse } from '../courses/participants';
 import { getLogger } from '../logger/logger';
@@ -28,13 +28,18 @@ export async function activatePupil(pupil: Pupil) {
     return updatedPupil;
 }
 
-export async function deactivatePupil(pupil: Pupil, silent = false, reason?: string, byAdmin = false) {
+export async function deactivatePupil(pupil: Pupil, silent = false, reason?: DeactivationReason, otherReason?: string, byAdmin = false) {
     if (!pupil.active) {
         throw new RedundantError('Pupil was already deactivated');
     }
 
     if (!silent) {
-        const action = byAdmin ? 'pupil_account_deactivated_by_admin' : 'pupil_account_deactivated';
+        let action;
+        if (reason === DeactivationReason.noMoreInterest) {
+            action = 'pupil_account_deactivated_no_more_interest';
+        } else {
+            action = byAdmin ? 'pupil_account_deactivated_by_admin' : 'pupil_account_deactivated';
+        }
         await Notification.actionTaken(userForPupil(pupil), action, {});
     }
 
@@ -74,7 +79,7 @@ export async function deactivatePupil(pupil: Pupil, silent = false, reason?: str
         where: { id: pupil.id },
     });
 
-    await logTransaction('deActivate', userForPupil(pupil), { newStatus: false, deactivationReason: reason });
+    await logTransaction('deActivate', userForPupil(pupil), { newStatus: false, deactivationReason: reason, otherReason });
     logger.info(`Deactivated Pupil(${pupil.id})`);
 
     return updatedPupil;