Merge pull request #2783 from gradido/events-contribution-message

feat(backend): events for contribution messages

backend/src/event/EVENT_ADMIN_CONTRIBUTION_MESSAGE_CREATE.ts

@@ -0,0 +1,23 @@
+import { User as DbUser } from '@entity/User'
+import { Contribution as DbContribution } from '@entity/Contribution'
+import { ContributionMessage as DbContributionMessage } from '@entity/ContributionMessage'
+import { Event as DbEvent } from '@entity/Event'
+import { Event, EventType } from './Event'
+
+export const EVENT_ADMIN_CONTRIBUTION_MESSAGE_CREATE = async (
+  user: DbUser,
+  moderator: DbUser,
+  contribution: DbContribution,
+  contributionMessage: DbContributionMessage,
+): Promise<DbEvent> =>
+  Event(
+    EventType.ADMIN_CONTRIBUTION_MESSAGE_CREATE,
+    user,
+    moderator,
+    null,
+    null,
+    contribution,
+    contributionMessage,
+    null,
+    null,
+  ).save()

backend/src/event/EVENT_CONTRIBUTION_MESSAGE_CREATE.ts

@@ -0,0 +1,22 @@
+import { User as DbUser } from '@entity/User'
+import { Contribution as DbContribution } from '@entity/Contribution'
+import { ContributionMessage as DbContributionMessage } from '@entity/ContributionMessage'
+import { Event as DbEvent } from '@entity/Event'
+import { Event, EventType } from './Event'
+
+export const EVENT_CONTRIBUTION_MESSAGE_CREATE = async (
+  user: DbUser,
+  contribution: DbContribution,
+  contributionMessage: DbContributionMessage,
+): Promise<DbEvent> =>
+  Event(
+    EventType.CONTRIBUTION_MESSAGE_CREATE,
+    user,
+    user,
+    null,
+    null,
+    contribution,
+    contributionMessage,
+    null,
+    null,
+  ).save()

backend/src/event/Event.ts

@@ -45,10 +45,12 @@ export { EVENT_ADMIN_CONTRIBUTION_UPDATE } from './EVENT_ADMIN_CONTRIBUTION_UPDA
 export { EVENT_ADMIN_CONTRIBUTION_LINK_CREATE } from './EVENT_ADMIN_CONTRIBUTION_LINK_CREATE'
 export { EVENT_ADMIN_CONTRIBUTION_LINK_DELETE } from './EVENT_ADMIN_CONTRIBUTION_LINK_DELETE'
 export { EVENT_ADMIN_CONTRIBUTION_LINK_UPDATE } from './EVENT_ADMIN_CONTRIBUTION_LINK_UPDATE'
+export { EVENT_ADMIN_CONTRIBUTION_MESSAGE_CREATE } from './EVENT_ADMIN_CONTRIBUTION_MESSAGE_CREATE'
 export { EVENT_ADMIN_SEND_CONFIRMATION_EMAIL } from './EVENT_ADMIN_SEND_CONFIRMATION_EMAIL'
 export { EVENT_CONTRIBUTION_CREATE } from './EVENT_CONTRIBUTION_CREATE'
 export { EVENT_CONTRIBUTION_DELETE } from './EVENT_CONTRIBUTION_DELETE'
 export { EVENT_CONTRIBUTION_UPDATE } from './EVENT_CONTRIBUTION_UPDATE'
+export { EVENT_CONTRIBUTION_MESSAGE_CREATE } from './EVENT_CONTRIBUTION_MESSAGE_CREATE'
 export { EVENT_LOGIN } from './EVENT_LOGIN'
 export { EVENT_REGISTER } from './EVENT_REGISTER'
 export { EVENT_SEND_ACCOUNT_MULTIREGISTRATION_EMAIL } from './EVENT_SEND_ACCOUNT_MULTIREGISTRATION_EMAIL'

backend/src/event/EventType.ts

@@ -9,10 +9,12 @@ export enum EventType {
   ADMIN_CONTRIBUTION_LINK_CREATE = 'ADMIN_CONTRIBUTION_LINK_CREATE',
   ADMIN_CONTRIBUTION_LINK_DELETE = 'ADMIN_CONTRIBUTION_LINK_DELETE',
   ADMIN_CONTRIBUTION_LINK_UPDATE = 'ADMIN_CONTRIBUTION_LINK_UPDATE',
+  ADMIN_CONTRIBUTION_MESSAGE_CREATE = 'ADMIN_CONTRIBUTION_MESSAGE_CREATE',
   ADMIN_SEND_CONFIRMATION_EMAIL = 'ADMIN_SEND_CONFIRMATION_EMAIL',
   CONTRIBUTION_CREATE = 'CONTRIBUTION_CREATE',
   CONTRIBUTION_DELETE = 'CONTRIBUTION_DELETE',
   CONTRIBUTION_UPDATE = 'CONTRIBUTION_UPDATE',
+  CONTRIBUTION_MESSAGE_CREATE = 'CONTRIBUTION_MESSAGE_CREATE',
   LOGIN = 'LOGIN',
   REGISTER = 'REGISTER',
   REDEEM_REGISTER = 'REDEEM_REGISTER',

backend/src/graphql/resolver/ContributionMessageResolver.test.ts

@@ -20,6 +20,8 @@ import { userFactory } from '@/seeds/factory/user'
 import { bibiBloxberg } from '@/seeds/users/bibi-bloxberg'
 import { peterLustig } from '@/seeds/users/peter-lustig'
 import { sendAddedContributionMessageEmail } from '@/emails/sendEmailVariants'
+import { EventType } from '@/event/Event'
+import { Event as DbEvent } from '@entity/Event'
 
 jest.mock('@/emails/sendEmailVariants', () => {
   const originalModule = jest.requireActual('@/emails/sendEmailVariants')
@@ -197,6 +199,18 @@ describe('ContributionMessageResolver', () => {
             contributionMemo: 'Test env contribution',
           })
         })
+
+        it('stores the ADMIN_CONTRIBUTION_MESSAGE_CREATE event in the database', async () => {
+          await expect(DbEvent.find()).resolves.toContainEqual(
+            expect.objectContaining({
+              type: EventType.ADMIN_CONTRIBUTION_MESSAGE_CREATE,
+              affectedUserId: expect.any(Number),
+              actingUserId: expect.any(Number),
+              involvedContributionId: result.data.createContribution.id,
+              involvedContributionMessageId: expect.any(Number),
+            }),
+          )
+        })
       })
     })
   })
@@ -322,6 +336,18 @@ describe('ContributionMessageResolver', () => {
             }),
           )
         })
+
+        it('stores the CONTRIBUTION_MESSAGE_CREATE event in the database', async () => {
+          await expect(DbEvent.find()).resolves.toContainEqual(
+            expect.objectContaining({
+              type: EventType.CONTRIBUTION_MESSAGE_CREATE,
+              affectedUserId: expect.any(Number),
+              actingUserId: expect.any(Number),
+              involvedContributionId: result.data.createContribution.id,
+              involvedContributionMessageId: expect.any(Number),
+            }),
+          )
+        })
       })
     })
   })

backend/src/graphql/resolver/ContributionMessageResolver.ts

@@ -4,7 +4,8 @@ import { getConnection } from '@dbTools/typeorm'
 
 import { ContributionMessage as DbContributionMessage } from '@entity/ContributionMessage'
 import { Contribution as DbContribution } from '@entity/Contribution'
-import { UserContact } from '@entity/UserContact'
+import { UserContact as DbUserContact } from '@entity/UserContact'
+import { User as DbUser } from '@entity/User'
 
 import { ContributionMessage, ContributionMessageListResult } from '@model/ContributionMessage'
 import ContributionMessageArgs from '@arg/ContributionMessageArgs'
@@ -17,6 +18,10 @@ import { RIGHTS } from '@/auth/RIGHTS'
 import { Context, getUser } from '@/server/context'
 import { sendAddedContributionMessageEmail } from '@/emails/sendEmailVariants'
 import LogError from '@/server/LogError'
+import {
+  EVENT_ADMIN_CONTRIBUTION_MESSAGE_CREATE,
+  EVENT_CONTRIBUTION_MESSAGE_CREATE,
+} from '@/event/Event'
 
 @Resolver()
 export class ContributionMessageResolver {
@@ -57,6 +62,11 @@ export class ContributionMessageResolver {
         await queryRunner.manager.update(DbContribution, { id: contributionId }, contribution)
       }
       await queryRunner.commitTransaction()
+      await EVENT_CONTRIBUTION_MESSAGE_CREATE(
+        user,
+        { id: contributionMessage.contributionId } as DbContribution,
+        contributionMessage,
+      )
     } catch (e) {
       await queryRunner.rollbackTransaction()
       throw new LogError(`ContributionMessage was not sent successfully: ${e}`, e)
@@ -98,7 +108,7 @@ export class ContributionMessageResolver {
     @Args() { contributionId, message }: ContributionMessageArgs,
     @Ctx() context: Context,
   ): Promise<ContributionMessage> {
-    const user = getUser(context)
+    const moderator = getUser(context)
 
     const queryRunner = getConnection().createQueryRunner()
     await queryRunner.connect()
@@ -112,18 +122,18 @@ export class ContributionMessageResolver {
       if (!contribution) {
         throw new LogError('Contribution not found', contributionId)
       }
-      if (contribution.userId === user.id) {
+      if (contribution.userId === moderator.id) {
         throw new LogError('Admin can not answer on his own contribution', contributionId)
       }
       if (!contribution.user.emailContact) {
-        contribution.user.emailContact = await UserContact.findOneOrFail({
+        contribution.user.emailContact = await DbUserContact.findOneOrFail({
           where: { id: contribution.user.emailId },
         })
       }
       contributionMessage.contributionId = contributionId
       contributionMessage.createdAt = new Date()
       contributionMessage.message = message
-      contributionMessage.userId = user.id
+      contributionMessage.userId = moderator.id
       contributionMessage.type = ContributionMessageType.DIALOG
       contributionMessage.isModerator = true
       await queryRunner.manager.insert(DbContributionMessage, contributionMessage)
@@ -142,17 +152,23 @@ export class ContributionMessageResolver {
         lastName: contribution.user.lastName,
         email: contribution.user.emailContact.email,
         language: contribution.user.language,
-        senderFirstName: user.firstName,
-        senderLastName: user.lastName,
+        senderFirstName: moderator.firstName,
+        senderLastName: moderator.lastName,
         contributionMemo: contribution.memo,
       })
       await queryRunner.commitTransaction()
+      await EVENT_ADMIN_CONTRIBUTION_MESSAGE_CREATE(
+        { id: contribution.userId } as DbUser,
+        moderator,
+        contribution,
+        contributionMessage,
+      )
     } catch (e) {
       await queryRunner.rollbackTransaction()
       throw new LogError(`ContributionMessage was not sent successfully: ${e}`, e)
     } finally {
       await queryRunner.release()
     }
-    return new ContributionMessage(contributionMessage, user)
+    return new ContributionMessage(contributionMessage, moderator)
   }
 }