Merge pull request #209 from alkem-io/develop

Release: Notifications for forum discussions

lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alkemio/notifications-lib",
-  "version": "0.3.2",
+  "version": "0.4.1",
   "description": "Library for interacting with Alkemio notifications service",
   "author": "Alkemio Foundation",
   "private": false,

lib/src/dto/index.ts

@@ -1,6 +1,5 @@
 export * from './base.event.payload';
 export * from './journey.payload';
-export * from './communication.discussion.created.event.payload';
 export * from './communication.update.event.payload';
 export * from './communication.user.message.event.payload';
 export * from './communication.organization.message.event.payload';
@@ -18,3 +17,5 @@ export * from './collaboration.callout.published.event.payload';
 export * from './collaboration.discussion.comment.event.payload';
 export * from './platform.user.registration.event.payload';
 export * from './platform.user.removed.event.payload';
+export * from './platform.forum.discussion.comment.event.payload';
+export * from './platform.forum.discussion.created.event.payload';

lib/src/dto/platform.forum.discussion.comment.event.payload.ts

@@ -0,0 +1,14 @@
+import { BaseEventPayload } from './base.event.payload';
+
+export interface PlatformForumDiscussionCommentEventPayload
+  extends BaseEventPayload {
+  discussion: {
+    displayName: string;
+    createdBy: string;
+    url: string;
+  };
+  comment: {
+    message: string;
+    createdBy: string;
+  };
+}

lib/src/dto/platform.forum.discussion.created.event.payload.ts

@@ -0,0 +1,11 @@
+import { BaseEventPayload } from './base.event.payload';
+
+export interface PlatformForumDiscussionCreatedEventPayload
+  extends BaseEventPayload {
+  discussion: {
+    id: string;
+    createdBy: string;
+    displayName: string;
+    url: string;
+  };
+}

lib/src/notification.event.type.ts

@@ -3,7 +3,6 @@ export enum NotificationEventType {
   COMMUNITY_NEW_MEMBER = 'communityNewMember',
   COMMUNICATION_COMMENT_SENT = 'communicationCommentSent',
   COMMUNICATION_UPDATE_SENT = 'communicationUpdateSent',
-  COMMUNICATION_DISCUSSION_CREATED = 'communicationDiscussionCreated',
   COMMUNICATION_USER_MESSAGE = 'communicationUserMessage',
   COMMUNICATION_ORGANIZATION_MESSAGE = 'communicationOrganizationMessage',
   COMMUNICATION_COMMUNITY_MESSAGE = 'communicationCommunityMessage',
@@ -18,4 +17,6 @@ export enum NotificationEventType {
   COLLABORATION_CALLOUT_PUBLISHED = 'collaborationCalloutPublished',
   PLATFORM_USER_REGISTERED = 'platformUserRegistered',
   PLATFORM_USER_REMOVED = 'platformUserRemoved',
+  PLATFORM_FORUM_DISCUSSION_COMMENT = 'platformForumDiscussionComment',
+  PLATFORM_FORUM_DISCUSSION_CREATED = 'platformForumDiscussionCreated',
 }

service/notifications.yml

@@ -146,26 +146,6 @@ recipients:
         - rule:
             type: OPPORTUNITY_MEMBER
             resource_id: <journeyID>
-  communication_discussion_created:
-    - name: admin
-      rules:
-        - rule:
-            type: GLOBAL_ADMIN_COMMUNITY
-            resource_id:
-        - rule:
-            type: GLOBAL_ADMIN
-            resource_id:
-    - name: member
-      rules:
-        - rule:
-            type: HUB_MEMBER
-            resource_id: <journeyID>
-        - rule:
-            type: CHALLENGE_MEMBER
-            resource_id: <journeyID>
-        - rule:
-            type: OPPORTUNITY_MEMBER
-            resource_id: <journeyID>
   communication_user_message:
     - name: sender
       rules:
@@ -344,3 +324,15 @@ recipients:
         - rule:
             type: GLOBAL_ADMIN_HUBS
             resource_id:
+  platform_forum_discussion_comment:
+    - name: discussionCreator
+      rules:
+        - rule:
+            type: USER_SELF_MANAGEMENT
+            resource_id: <discussionCreatorID>
+  platform_forum_discussion_created:
+    - name: user
+      rules:
+        - rule:
+            type: GLOBAL_REGISTERED
+            resource_id:

service/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alkemio-notifications",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Alkemio notifications service",
   "author": "Alkemio Foundation",
   "private": false,
@@ -35,8 +35,8 @@
     "validate-connection": "ts-node src/utils/validate-connection.ts"
   },
   "dependencies": {
-    "@alkemio/client-lib": "^0.18.1",
-    "@alkemio/notifications-lib": "^0.3.1",
+    "@alkemio/client-lib": "^0.18.6",
+    "@alkemio/notifications-lib": "^0.4.1",
     "@nestjs/common": "^8.0.5",
     "@nestjs/config": "^1.0.1",
     "@nestjs/core": "^8.0.5",

service/src/app.controller.ts

@@ -16,7 +16,7 @@ import {
   CommunityApplicationCreatedEventPayload,
   CollaborationCardCommentEventPayload,
   CollaborationCardCreatedEventPayload,
-  CommunicationDiscussionCreatedEventPayload,
+  PlatformForumDiscussionCreatedEventPayload,
   CommunicationUserMessageEventPayload,
   CommunicationOrganizationMessageEventPayload,
   CommunicationCommunityLeadsMessageEventPayload,
@@ -31,6 +31,7 @@ import {
   BaseEventPayload,
   CollaborationCanvasCreatedEventPayload,
   CollaborationDiscussionCommentEventPayload,
+  PlatformForumDiscussionCommentEventPayload,
 } from '@alkemio/notifications-lib';
 import { NotificationService } from './services/domain/notification/notification.service';
 import { ALKEMIO_CLIENT_ADAPTER, LogContext } from './common/enums';
@@ -136,19 +137,34 @@ export class AppController {
     );
   }
 
-  @EventPattern(NotificationEventType.COMMUNICATION_DISCUSSION_CREATED)
-  async sendCommunicationDiscussionCreatedNotifications(
+  @EventPattern(NotificationEventType.PLATFORM_FORUM_DISCUSSION_CREATED)
+  async sendPlatformForumDiscussionCreatedNotifications(
     // todo is auto validation possible
-    @Payload() eventPayload: CommunicationDiscussionCreatedEventPayload,
+    @Payload() eventPayload: PlatformForumDiscussionCreatedEventPayload,
     @Ctx() context: RmqContext
   ) {
     this.sendNotifications(
       eventPayload,
       context,
-      this.notificationService.sendCommunicationDiscussionCreatedNotification(
+      this.notificationService.sendPlatformForumDiscussionCreatedNotification(
         eventPayload
       ),
-      NotificationEventType.COMMUNICATION_DISCUSSION_CREATED
+      NotificationEventType.PLATFORM_FORUM_DISCUSSION_CREATED
+    );
+  }
+
+  @EventPattern(NotificationEventType.PLATFORM_FORUM_DISCUSSION_COMMENT)
+  async sendPlatformForumDiscussionCommentNotifications(
+    @Payload() eventPayload: PlatformForumDiscussionCommentEventPayload,
+    @Ctx() context: RmqContext
+  ) {
+    this.sendNotifications(
+      eventPayload,
+      context,
+      this.notificationService.sendPlatformForumDiscussionCommentNotification(
+        eventPayload
+      ),
+      NotificationEventType.PLATFORM_FORUM_DISCUSSION_COMMENT
     );
   }
 

service/src/app.module.ts

@@ -13,7 +13,7 @@ import {
 } from '@src/services';
 import { AlkemioClientModule, NotifmeModule } from '@src/services/external';
 import {
-  CommunicationDiscussionCreatedNotificationBuilder,
+  PlatformForumDiscussionCreatedNotificationBuilder,
   CommunicationUpdateCreatedNotificationBuilder,
   CollaborationContextReviewSubmittedNotificationBuilder,
   CommunityNewMemberNotificationBuilder,
@@ -28,6 +28,7 @@ import {
   CommunicationCommunityLeadsMessageNotificationBuilder,
   CommunicationUserMentionNotificationBuilder,
   CommunicationOrganizationMentionNotificationBuilder,
+  PlatformForumDiscussionCommentNotificationBuilder,
 } from './services/domain/builders';
 import { NotificationService } from './services/domain/notification/notification.service';
 import {
@@ -62,8 +63,9 @@ import { CollaborationDiscussionCommentNotificationBuilder } from './services/do
     CommunityApplicationCreatedNotificationBuilder,
     PlatformUserRegisteredNotificationBuilder,
     PlatformUserRemovedNotificationBuilder,
+    PlatformForumDiscussionCommentNotificationBuilder,
     CommunicationUpdateCreatedNotificationBuilder,
-    CommunicationDiscussionCreatedNotificationBuilder,
+    PlatformForumDiscussionCreatedNotificationBuilder,
     CommunicationUserMessageNotificationBuilder,
     CommunicationOrganizationMessageNotificationBuilder,
     CommunicationCommunityLeadsMessageNotificationBuilder,

service/src/common/email-template-payload/index.ts

@@ -9,11 +9,12 @@ export * from './collaboration.callout.published.email.payload';
 export * from './collaboration.interest.email.payload';
 export * from './collaboration.context.email.payload';
 export * from './collaboration.discussion.comment.email.payload';
-export * from './communication.discussion.created.email.payload';
 export * from './communication.update.created.email.payload';
 export * from './communication.user.message.email.payload';
 export * from './communication.organization.message.email.payload';
 export * from './communication.community.leads.message.email.payload';
 export * from './communication.user.mention.email.payload';
 export * from './communication.organization.mention.email.payload';
 export * from './platform.user.registered.email.payload';
+export * from './platform.forum.discussion.comment.email.payload';
+export * from './platform.forum.discussion.created.email.payload';

service/src/common/email-template-payload/platform.forum.discussion.comment.email.payload.ts

@@ -0,0 +1,14 @@
+import { BaseEmailPayload } from './base.email.payload';
+
+export interface PlatformForumDiscussionCommentEmailPayload
+  extends BaseEmailPayload {
+  comment: {
+    message: string;
+    createdBy: string;
+  };
+  discussion: {
+    displayName: string;
+    createdBy: string;
+    url: string;
+  };
+}

service/src/common/email-template-payload/platform.forum.discussion.created.email.payload.ts

@@ -0,0 +1,12 @@
+import { BaseEmailPayload } from './base.email.payload';
+
+export interface PlatformForumDiscussionCreatedEmailPayload
+  extends BaseEmailPayload {
+  createdBy: {
+    firstName: string;
+  };
+  discussion: {
+    displayName: string;
+    url: string;
+  };
+}

service/src/common/enums/email.template.ts

@@ -3,8 +3,6 @@ export enum EmailTemplate {
   COMMUNITY_NEW_MEMBER_MEMBER = 'community.new.member.member',
   COMMUNITY_USER_APPLICATION_APPLICANT = 'community.user.application.applicant',
   COMMUNITY_USER_APPLICATION_ADMIN = 'community.user.application.admin',
-  COMMUNICATION_DISCUSSION_CREATED_ADMIN = 'communication.discussion.created.admin',
-  COMMUNICATION_DISCUSSION_CREATED_MEMBER = 'communication.discussion.created.member',
   COMMUNICATION_UPDATE_ADMIN = 'communication.update.admin',
   COMMUNICATION_UPDATE_MEMBER = 'communication.update.member',
   COMMUNICATION_USER_MESSAGE_SENDER = 'communication.user.message.sender',
@@ -29,4 +27,6 @@ export enum EmailTemplate {
   PLATFORM_USER_REGISTRATION_REGISTRANT = 'platform.user.registration.registrant',
   PLATFORM_USER_REGISTRATION_ADMIN = 'platform.user.registration.admin',
   PLATFORM_USER_REMOVED_ADMIN = 'platform.user.removed.admin',
+  PLATFORM_FORUM_DISCUSSION_CREATED = 'platform.forum.discussion.created',
+  PLATFORM_FORUM_DISCUSSION_COMMENT = 'platform.forum.discussion.comment',
 }

service/src/core/contracts/notification.recipient.template.provider.interface.ts

@@ -17,7 +17,7 @@ export type TemplateConfig = {
   community_application_created?: TemplateRuleSet[];
   community_new_member?: TemplateRuleSet[];
   communication_update_sent?: TemplateRuleSet[];
-  communication_discussion_created?: TemplateRuleSet[];
+  platform_forum_discussion_created?: TemplateRuleSet[];
   communication_user_message?: TemplateRuleSet[];
   communication_organization_message?: TemplateRuleSet[];
   communication_community_leads_message?: TemplateRuleSet[];
@@ -32,6 +32,7 @@ export type TemplateConfig = {
   collaboration_callout_published?: TemplateRuleSet[];
   platform_user_registered?: TemplateRuleSet[];
   platform_user_removed?: TemplateRuleSet[];
+  platform_forum_discussion_comment?: TemplateRuleSet[];
 };
 
 export interface INotificationRecipientTemplateProvider {